c2x20wamp 2.0.0.0

Functions

void c2x20wamp_cfg_setup (c2x20wamp_cfg_t *cfg)
 Config Object Initialization function.
 
C2X20WAMP_RETVAL c2x20wamp_init (c2x20wamp_t *ctx, c2x20wamp_cfg_t *cfg)
 Initialization function.
 
void c2x20wamp_generic_write (c2x20wamp_t *ctx, uint8_t data_buf)
 Generic write function.
 
void c2x20wamp_mode_play (c2x20wamp_t *ctx)
 Set Play mode of the amplifier function.
 
void c2x20wamp_mode_mute (c2x20wamp_t *ctx)
 Set Mute mode of the amplifier function.
 
void c2x20wamp_disable (c2x20wamp_t *ctx)
 Disable the amplifier function.
 
void c2x20wamp_enable (c2x20wamp_t *ctx)
 Enable the amplifier function.
 
void c2x20wamp_set_volume (c2x20wamp_t *ctx, uint8_t volume)
 Set volume of the amplifier function.
 
void c2x20wamp_volume_up (c2x20wamp_t *ctx)
 Increase the volume by one level function.
 
void c2x20wamp_volume_down (c2x20wamp_t *ctx)
 Decrease the volume by one level function.
 
void c2x20wamp_filterless_modulation (c2x20wamp_t *ctx)
 Set filterless output modulation function.
 
void c2x20wamp_classic_pwm_modulation (c2x20wamp_t *ctx)
 Set classic PWM output modulation function.
 

Detailed Description

Function Documentation

◆ c2x20wamp_cfg_setup()

void c2x20wamp_cfg_setup ( c2x20wamp_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.

◆ c2x20wamp_classic_pwm_modulation()

void c2x20wamp_classic_pwm_modulation ( c2x20wamp_t * ctx)

Set classic PWM output modulation function.

Parameters
ctxClick object.

Function set classic PWM output modulation by write classic PWM command ( 0x41 ) to the MAX9744ETH+T chip on 2x20W Amp Click.

◆ c2x20wamp_disable()

void c2x20wamp_disable ( c2x20wamp_t * ctx)

Disable the amplifier function.

Parameters
ctxClick object.

Function disable the amplifier by clear SHDN pin of 2x20W Amp Click.

◆ c2x20wamp_enable()

void c2x20wamp_enable ( c2x20wamp_t * ctx)

Enable the amplifier function.

Parameters
ctxClick object.

Function enable the amplifier by set SHDN pin of 2x20W Amp Click.

◆ c2x20wamp_filterless_modulation()

void c2x20wamp_filterless_modulation ( c2x20wamp_t * ctx)

Set filterless output modulation function.

Parameters
ctxClick object.

Function set filterless output modulation by write filterless command ( 0x40 ) to the MAX9744ETH+T chip on 2x20W Amp Click.

◆ c2x20wamp_generic_write()

void c2x20wamp_generic_write ( c2x20wamp_t * ctx,
uint8_t data_buf )

Generic write function.

Parameters
ctxClick object.
data_bufData buf to be written.

@description This function writes data to the desired register.

◆ c2x20wamp_init()

C2X20WAMP_RETVAL c2x20wamp_init ( c2x20wamp_t * ctx,
c2x20wamp_cfg_t * cfg )

Initialization function.

Parameters
c2x20wampClick object.
cfgClick configuration structure.

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

◆ c2x20wamp_mode_mute()

void c2x20wamp_mode_mute ( c2x20wamp_t * ctx)

Set Mute mode of the amplifier function.

Parameters
ctxClick object.

Function set Mute operating mode of the amplifier by set MUTE pin of 2x20W Amp Click.

◆ c2x20wamp_mode_play()

void c2x20wamp_mode_play ( c2x20wamp_t * ctx)

Set Play mode of the amplifier function.

Parameters
ctxClick object.

Function set Play operating mode of the amplifier by clear MUTE pin of 2x20W Amp Click.

◆ c2x20wamp_set_volume()

void c2x20wamp_set_volume ( c2x20wamp_t * ctx,
uint8_t volume )

Set volume of the amplifier function.

Parameters
ctxClick object.
[in]volume
  • minimum volume : 0
  • maximum volume : 63

Function set volume of the amplifier by write volume value to the MAX9744ETH+T chip on 2x20W Amp Click.

◆ c2x20wamp_volume_down()

void c2x20wamp_volume_down ( c2x20wamp_t * ctx)

Decrease the volume by one level function.

Parameters
ctxClick object.

Function decrease the volume by one level by write decreases command( 0xC5 ) to the MAX9744ETH+T chip on 2x20W Amp Click.

◆ c2x20wamp_volume_up()

void c2x20wamp_volume_up ( c2x20wamp_t * ctx)

Increase the volume by one level function.

Function increase the volume by one level by write increases command ( 0xC4 ) to the MAX9744ETH+T chip on 2x20W Amp Click.