audioamp  2.0.0.0
Functions
Public function

Functions

void audioamp_cfg_setup (audioamp_cfg_t *cfg)
 Config Object Initialization function. More...
 
AUDIOAMP_RETVAL audioamp_init (audioamp_t *ctx, audioamp_cfg_t *cfg)
 Initialization function. More...
 
void audioamp_generic_write (audioamp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void audioamp_generic_read (audioamp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void audioamp_power_on (audioamp_t *ctx)
 Turn on the Audio Amp click function. More...
 
void audioamp_power_off (audioamp_t *ctx)
 Turn off the Audio Amp click function. More...
 
void audioamp_set_volume (audioamp_t *ctx, uint8_t volume_value)
 Set mux volume function. More...
 
void audioamp_set_volume_channel (audioamp_t *ctx, uint8_t channel, uint8_t volume_value)
 Set channel volume function. More...
 
void audioamp_enable (audioamp_t *ctx)
 Enable amplifier function. More...
 
void audioamp_disable (audioamp_t *ctx)
 Disable amplifier function. More...
 
void audioamp_mute_mode (audioamp_t *ctx)
 Set mute mode function. More...
 
void audioamp_unmute_mode (audioamp_t *ctx)
 Set unmute mode function. More...
 
void audioamp_set_normal_operation (audioamp_t *ctx)
 Set normal opeation function. More...
 
void audioamp_set_fault_detecton_control (audioamp_t *ctx, uint8_t input_command)
 Set fault detection control function. More...
 
void audioamp_set_input (audioamp_t *ctx, uint8_t input_mode)
 Set input mixer mode function. More...
 
uint8_t audioamp_check_status (audioamp_t *ctx)
 Check interrupt status function. More...
 

Detailed Description

Function Documentation

◆ audioamp_cfg_setup()

void audioamp_cfg_setup ( audioamp_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ audioamp_check_status()

uint8_t audioamp_check_status ( audioamp_t ctx)

Check interrupt status function.

Parameters
ctxClick object.
result
  • 0 : detected;
  • 1 : not detected;

@description Function check interrupt status by return value of INT pin of LM48100Q-Q1 chip on AudioAmp Click board.

◆ audioamp_disable()

void audioamp_disable ( audioamp_t ctx)

Disable amplifier function.

Parameters
ctxClick object.

@description Function disable the Audio Amp click by set POEWR_OFF bits to MODE CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_enable()

void audioamp_enable ( audioamp_t ctx)

Enable amplifier function.

Parameters
ctxClick object.

@description Function enable the Audio Amp click by set POEWR_ON bits to MODE CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_generic_read()

void audioamp_generic_read ( audioamp_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ audioamp_generic_write()

void audioamp_generic_write ( audioamp_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ audioamp_init()

AUDIOAMP_RETVAL audioamp_init ( audioamp_t ctx,
audioamp_cfg_t cfg 
)

Initialization function.

Parameters
audioampClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

◆ audioamp_mute_mode()

void audioamp_mute_mode ( audioamp_t ctx)

Set mute mode function.

Parameters
ctxClick object.

@description Function set mute mode by claer INPUT_2 and INPUT_1 bits to MODE CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_power_off()

void audioamp_power_off ( audioamp_t ctx)

Turn off the Audio Amp click function.

Parameters
ctxClick object.

@description Function turn off the Audio Amp click by set POEWR_OFF bits to MODE CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_power_on()

void audioamp_power_on ( audioamp_t ctx)

Turn on the Audio Amp click function.

Parameters
ctxClick object.

@description Function turn on the Audio Amp click by set POEWR_ON and set INPUT_2 and INPUT_1 bits to MODE CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_set_fault_detecton_control()

void audioamp_set_fault_detecton_control ( audioamp_t ctx,
uint8_t  input_command 
)

Set fault detection control function.

Parameters
ctxClick object.
input_command
  • 0 : Ignore output short circuit fault (outputs shorted together);
  • 1 : Ignore output short circuit fault;
  • 2 : Ignore output short to VDD or GND fault;
  • 3 : Ignore output over-current fault;
  • 4 : Ignore thermal overload fault;

@description Function set fault detection control by set command to FAULT DETECTION CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_set_input()

void audioamp_set_input ( audioamp_t ctx,
uint8_t  input_mode 
)

Set input mixer mode function.

Parameters
ctxClick object.
input_mode
  • 0 : INPUT 1 only;
  • 1 : INPUT 2 only;
  • 2 : INPUT 1 & INPUT 2;
  • 3 : MUTE;

@description Function set input mixer mode by sets command to MODE CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_set_normal_operation()

void audioamp_set_normal_operation ( audioamp_t ctx)

Set normal opeation function.

Parameters
ctxClick object.

@description Function set mute mode by claer all bits to FAULT DETECTION CONTROL register of LM48100Q-Q1 chip.

◆ audioamp_set_volume()

void audioamp_set_volume ( audioamp_t ctx,
uint8_t  volume_value 
)

Set mux volume function.

Parameters
ctxClick object.
volume_value
8-bit value from 0 to 31

@description Function sets mux volume to LM48100Q-Q1 chip on AudioAmp Click board.

◆ audioamp_set_volume_channel()

void audioamp_set_volume_channel ( audioamp_t ctx,
uint8_t  channel,
uint8_t  volume_value 
)

Set channel volume function.

Parameters
ctxClick object.
channel
  • 0 : CHANNEL 1;
  • 1 : CHANNEL 2;
volume_value
8-bit value from 0 to 31

@description Function sets volume of selected channel of LM48100Q-Q1 chip on AudioAmp Click board.

◆ audioamp_unmute_mode()

void audioamp_unmute_mode ( audioamp_t ctx)

Set unmute mode function.

Parameters
ctxClick object.

@description Function set unmute mode by sets INPUT_2 and INPUT_1 bits to MODE CONTROL register of LM48100Q-Q1 chip.