audioamp8  2.0.0.0
audioamp8.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef AUDIOAMP8_H
29 #define AUDIOAMP8_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define AUDIOAMP8_REG_PWR_MODE_CTRL 0x00
60 #define AUDIOAMP8_REG_THSH_PWR_MODE_PM12 0x01
61 #define AUDIOAMP8_REG_THSH_PWR_MODE_PM21 0x02
62 #define AUDIOAMP8_REG_THSH_PWR_MODE_PM23 0x03
63 #define AUDIOAMP8_REG_THSH_PWR_MODE_PM32 0x04
64 #define AUDIOAMP8_REG_SOFT_CLP_OVC_PROT_LAT 0x0A
65 #define AUDIOAMP8_REG_SEL_PWR_MODE_PROFILE 0x1D
66 #define AUDIOAMP8_REG_PWR_MODE_PROFILE_CFG 0x1E
67 #define AUDIOAMP8_REG_OVC_PROT_LAT_CLR 0x20
68 #define AUDIOAMP8_REG_AUDIO_IN_MODE 0x25
69 #define AUDIOAMP8_REG_DC_PROTECTION 0x26
70 #define AUDIOAMP8_REG_AUDIO_IN_MODE_OVERWRITE 0x27
71 #define AUDIOAMP8_REG_ERROR_HANDLER_CLEAR 0x2D
72 
73 #define AUDIOAMP8_REG_MON_CH_0_FREQ_PWR_MODE 0x60
74 #define AUDIOAMP8_REG_MON_CH_0 0x61
75 #define AUDIOAMP8_REG_MON_CH_0_MODUL_INDEX 0x62
76 #define AUDIOAMP8_REG_MON_CH_1_FREQ_PWR_MODE 0x64
77 #define AUDIOAMP8_REG_MON_CH_1 0x65
78 #define AUDIOAMP8_REG_MON_CH_1_MODUL_INDEX 0x66
79 #define AUDIOAMP8_REG_ERROR_ACCUMULATED 0x6D
80 #define AUDIOAMP8_REG_MONITOR_MSEL 0x75
81 #define AUDIOAMP8_REG_ERROR 0x7C
82  // audioamp8_reg
84 
99 #define AUDIOAMP8_SET_MON_CH_0 0x00
100 #define AUDIOAMP8_SET_MON_CH_1 0x01
101 #define AUDIOAMP8_SET_AUTO_PWR_MODE 0x00
102 #define AUDIOAMP8_SET_MANUAL_PWR_MODE 0x01
103 #define AUDIOAMP8_SET_MTHR_1TO2_DEFAULT 0x3C
104 #define AUDIOAMP8_SET_MTHR_2TO1_DEFAULT 0x32
105 #define AUDIOAMP8_SET_MTHR_2TO3_DEFAULT 0x5A
106 #define AUDIOAMP8_SET_MTHR_3TO2_DEFAULT 0x50
107 #define AUDIOAMP8_SET_DISABLE 0x00
108 #define AUDIOAMP8_SET_ENABLE 0x01
109 
110 
116 #define AUDIOAMP8_SET_DEV_ADDR_0 0x20
117 #define AUDIOAMP8_SET_DEV_ADDR_1 0x21
118 #define AUDIOAMP8_SET_DEV_ADDR_2 0x22
119 #define AUDIOAMP8_SET_DEV_ADDR_3 0x23
120  // audioamp8_set
122 
137 #define AUDIOAMP8_MAP_MIKROBUS( cfg, mikrobus ) \
138  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
140  cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141  cfg.mut = MIKROBUS( mikrobus, MIKROBUS_RST ); \
142  cfg.ms0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
143  cfg.ms1 = MIKROBUS( mikrobus, MIKROBUS_INT )
144  // audioamp8_map // audioamp8
147 
152 typedef struct
153 {
154  // Output pins
155  digital_out_t en;
156  digital_out_t mut;
157  digital_out_t ms0;
158  digital_out_t ms1;
160  // Modules
161  i2c_master_t i2c;
163  // I2C slave address
164  uint8_t slave_address;
166 } audioamp8_t;
167 
172 typedef struct
173 {
174  pin_name_t scl;
175  pin_name_t sda;
177  pin_name_t en;
178  pin_name_t mut;
179  pin_name_t ms0;
180  pin_name_t ms1;
182  uint32_t i2c_speed;
183  uint8_t i2c_address;
186 
191 typedef struct
192 {
193  uint8_t manual_pm;
194  uint8_t pm_man;
195  uint8_t mthr_1to2;
196  uint8_t mthr_2to1;
197  uint8_t mthr_2to3;
198  uint8_t mthr_3to2;
199 
201 
206 typedef struct
207 {
208  uint8_t pm_profile;
209  uint8_t pm3_man_sh;
210  uint8_t pm2_man_sh;
211  uint8_t pm1_man_sh;
212 
214 
219 typedef struct
220 {
221  uint8_t freq_mode;
222  uint8_t pwr_mode;
223  uint8_t mute_mon;
224  uint8_t vdd_mon;
225  uint8_t pvdd_mon;
226  uint8_t cfly2_mon;
227  uint8_t cfly1_mon;
228  uint8_t ovc_prot;
230 
232 
237 typedef struct
238 {
239  uint8_t fly_cap_ov_vtg;
240  uint8_t ov_curr_prot;
241  uint8_t pll_err;
243  uint8_t ov_temp_wrg;
244  uint8_t ov_temp_err;
245  uint8_t imped_prot;
246  uint8_t dc_prot;
247 
249 
254 typedef enum
255 {
257  AUDIOAMP8_ERROR = -1
258 
260 
265 typedef enum
266 {
270 
272 
277 typedef enum
278 {
284 
286 
291 typedef enum
292 {
297 
299 
304 typedef enum
305 {
308 
310 
315 typedef enum
316 {
319 
321 
338 
354 
369 
385 err_t audioamp8_generic_write ( audioamp8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
386 
402 err_t audioamp8_generic_read ( audioamp8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
403 
417 
431 
444 err_t audioamp8_set_mute ( audioamp8_t *ctx, uint8_t en_mute );
445 
458 err_t audioamp8_set_enable ( audioamp8_t *ctx, uint8_t dev_en );
459 
474 
490 
506 
526 err_t audioamp8_set_soft_clp_ovc_prot_lat ( audioamp8_t *ctx, uint8_t lf_clamp_en, uint8_t ocp_latch_en );
527 
543 
559 
574 
591 err_t audioamp8_set_audio_in_mode ( audioamp8_t *ctx, uint8_t audio_in_mode );
592 
609 err_t audioamp8_set_dc_protection ( audioamp8_t *ctx, uint8_t eh_dcshdn );
610 
627 err_t audioamp8_set_audio_in_mode_overwrite ( audioamp8_t *ctx, uint8_t audio_in_mode_ext );
628 
643 
662 
681 err_t audioamp8_monitor_msel ( audioamp8_t *ctx, uint8_t *msel );
682 
698 
699 #ifdef __cplusplus
700 }
701 #endif
702 #endif // AUDIOAMP8_H
703  // audioamp8
705 
706 // ------------------------------------------------------------------------ END
audioamp8_pwr_mon_cfg_t::mthr_3to2
uint8_t mthr_3to2
Definition: audioamp8.h:198
AUDIOAMP8_AUDIO_IN_MODE_0_20dB
@ AUDIOAMP8_AUDIO_IN_MODE_0_20dB
Definition: audioamp8.h:306
audioamp8_audio_in_mode_value_t
audioamp8_audio_in_mode_value_t
AudioAmp 8 Click audio input mode value data.
Definition: audioamp8.h:305
audioamp8_error_status_t::imped_prot
uint8_t imped_prot
Definition: audioamp8.h:245
audioamp8_set_soft_clp_ovc_prot_lat
err_t audioamp8_set_soft_clp_ovc_prot_lat(audioamp8_t *ctx, uint8_t lf_clamp_en, uint8_t ocp_latch_en)
AudioAmp 8 set soft-clipping and overcurrent protection latching function.
audioamp8_monitor_msel
err_t audioamp8_monitor_msel(audioamp8_t *ctx, uint8_t *msel)
AudioAmp 8 monitor msel function.
AUDIOAMP8_SCHEME_D
@ AUDIOAMP8_SCHEME_D
Definition: audioamp8.h:296
audioamp8_t::i2c
i2c_master_t i2c
Definition: audioamp8.h:161
audioamp8_t::ms1
digital_out_t ms1
Definition: audioamp8.h:158
audioamp8_return_value_t
audioamp8_return_value_t
AudioAmp 8 Click return value data.
Definition: audioamp8.h:255
AUDIOAMP8_ERROR
@ AUDIOAMP8_ERROR
Definition: audioamp8.h:257
audioamp8_t::ms0
digital_out_t ms0
Definition: audioamp8.h:157
AUDIOAMP8_PM_MAN_3
@ AUDIOAMP8_PM_MAN_3
Definition: audioamp8.h:269
audioamp8_monitor_channel_t::freq_mode
uint8_t freq_mode
Definition: audioamp8.h:221
audioamp8_pwr_mod_profile_cfg_t::pm2_man_sh
uint8_t pm2_man_sh
Definition: audioamp8.h:210
audioamp8_monitor_channel_t
AudioAmp 8 Click monitor channel object.
Definition: audioamp8.h:220
AUDIOAMP8_SCHEME_A
@ AUDIOAMP8_SCHEME_A
Definition: audioamp8.h:293
audioamp8_error_status_t::ov_temp_err
uint8_t ov_temp_err
Definition: audioamp8.h:244
audioamp8_pm_profile_value_t
audioamp8_pm_profile_value_t
AudioAmp 8 Click select power mode profile value data.
Definition: audioamp8.h:278
audioamp8_monitor_channel_t::pvdd_mon
uint8_t pvdd_mon
Definition: audioamp8.h:225
audioamp8_channel_monitoring
err_t audioamp8_channel_monitoring(audioamp8_t *ctx, uint8_t mon_ch, audioamp8_monitor_channel_t *ch_mon)
AudioAmp 8 monitors the status of the channel's function.
audioamp8_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: audioamp8.h:182
audioamp8_cfg_t::mut
pin_name_t mut
Definition: audioamp8.h:178
audioamp8_cfg_t::ms0
pin_name_t ms0
Definition: audioamp8.h:179
audioamp8_monitor_channel_t::ovc_prot
uint8_t ovc_prot
Definition: audioamp8.h:228
audioamp8_t::en
digital_out_t en
Definition: audioamp8.h:155
audioamp8_manual_pm_value_t
audioamp8_manual_pm_value_t
AudioAmp 8 Click manual selected power mode value data.
Definition: audioamp8.h:266
audioamp8_pwr_mon_cfg_t::mthr_1to2
uint8_t mthr_1to2
Definition: audioamp8.h:195
audioamp8_monitor_channel_t::modul_index_mon
uint8_t modul_index_mon
Definition: audioamp8.h:229
AUDIOAMP8_PM_PROFILE_0
@ AUDIOAMP8_PM_PROFILE_0
Definition: audioamp8.h:279
AUDIOAMP8_PM_MAN_2
@ AUDIOAMP8_PM_MAN_2
Definition: audioamp8.h:268
AUDIOAMP8_AUDIO_IN_MODE_0_26dB
@ AUDIOAMP8_AUDIO_IN_MODE_0_26dB
Definition: audioamp8.h:307
audioamp8_monitor_channel_t::cfly2_mon
uint8_t cfly2_mon
Definition: audioamp8.h:226
audioamp8_cfg_t
AudioAmp 8 Click configuration object.
Definition: audioamp8.h:173
audioamp8_get_config_power_mode_profile
err_t audioamp8_get_config_power_mode_profile(audioamp8_t *ctx, audioamp8_pwr_mod_profile_cfg_t *pm_profile)
AudioAmp 8 get power mode configuration function.
audioamp8_cfg_t::i2c_address
uint8_t i2c_address
Definition: audioamp8.h:183
AUDIOAMP8_PM_PROFILE_1
@ AUDIOAMP8_PM_PROFILE_1
Definition: audioamp8.h:280
audioamp8_pwr_mod_profile_cfg_t::pm1_man_sh
uint8_t pm1_man_sh
Definition: audioamp8.h:211
audioamp8_cfg_t::sda
pin_name_t sda
Definition: audioamp8.h:175
audioamp8_monitor_channel_t::vdd_mon
uint8_t vdd_mon
Definition: audioamp8.h:224
audioamp8_cfg_t::scl
pin_name_t scl
Definition: audioamp8.h:174
audioamp8_pwr_mod_profile_cfg_t::pm3_man_sh
uint8_t pm3_man_sh
Definition: audioamp8.h:209
audioamp8_error_status_t::fly_cap_ov_vtg
uint8_t fly_cap_ov_vtg
Definition: audioamp8.h:239
AUDIOAMP8_SCHEME_B
@ AUDIOAMP8_SCHEME_B
Definition: audioamp8.h:294
AUDIOAMP8_PM_PROFILE_3
@ AUDIOAMP8_PM_PROFILE_3
Definition: audioamp8.h:282
AUDIOAMP8_OK
@ AUDIOAMP8_OK
Definition: audioamp8.h:256
audioamp8_set_config_power_mode_profile
err_t audioamp8_set_config_power_mode_profile(audioamp8_t *ctx, audioamp8_pwr_mod_profile_cfg_t pm_profile)
AudioAmp 8 set power mode profile configuration function.
audioamp8_shut_down
err_t audioamp8_shut_down(audioamp8_t *ctx)
AudioAmp 8 shut-down procedure function.
audioamp8_generic_read
err_t audioamp8_generic_read(audioamp8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
AudioAmp 8 I2C reading function.
audioamp8_error_status_t::ov_temp_wrg
uint8_t ov_temp_wrg
Definition: audioamp8.h:243
audioamp8_clear_ovc_prot_latch
err_t audioamp8_clear_ovc_prot_latch(audioamp8_t *ctx)
AudioAmp 8 over-current protection latch clear function.
audioamp8_set_enable
err_t audioamp8_set_enable(audioamp8_t *ctx, uint8_t dev_en)
AudioAmp 8 enable function.
audioamp8_t::mut
digital_out_t mut
Definition: audioamp8.h:156
audioamp8_err_status
err_t audioamp8_err_status(audioamp8_t *ctx, audioamp8_error_status_t *error_status)
AudioAmp 8 get error status function.
audioamp8_monitor_channel_t::pwr_mode
uint8_t pwr_mode
Definition: audioamp8.h:222
audioamp8_pwr_mod_profile_cfg_t
AudioAmp 8 Click power mode profile configuration object.
Definition: audioamp8.h:207
audioamp8_get_config_power_mode
err_t audioamp8_get_config_power_mode(audioamp8_t *ctx, audioamp8_pwr_mon_cfg_t *pwr_mode)
AudioAmp 8 get power mode configuration function.
audioamp8_set_config_power_mode
err_t audioamp8_set_config_power_mode(audioamp8_t *ctx, audioamp8_pwr_mon_cfg_t pwr_mode)
AudioAmp 8 set power mode configuration function.
audioamp8_set_audio_in_mode
err_t audioamp8_set_audio_in_mode(audioamp8_t *ctx, uint8_t audio_in_mode)
AudioAmp 8 set audio IN mode function.
audioamp8_audio_in_mode_ext_value_t
audioamp8_audio_in_mode_ext_value_t
AudioAmp 8 Click audio input mode value data.
Definition: audioamp8.h:316
AUDIOAMP8_AUDIO_IN_MODE_EXT_ENABLE
@ AUDIOAMP8_AUDIO_IN_MODE_EXT_ENABLE
Definition: audioamp8.h:318
audioamp8_pwr_mod_profile_cfg_t::pm_profile
uint8_t pm_profile
Definition: audioamp8.h:208
AUDIOAMP8_SCHEME_C
@ AUDIOAMP8_SCHEME_C
Definition: audioamp8.h:295
audioamp8_pwr_mon_cfg_t::mthr_2to3
uint8_t mthr_2to3
Definition: audioamp8.h:197
audioamp8_btl_config
err_t audioamp8_btl_config(audioamp8_t *ctx)
AudioAmp 8 BTL configuration function.
audioamp8_generic_write
err_t audioamp8_generic_write(audioamp8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
AudioAmp 8 I2C writing function.
audioamp8_cfg_t::en
pin_name_t en
Definition: audioamp8.h:177
audioamp8_clear_error_handler
err_t audioamp8_clear_error_handler(audioamp8_t *ctx)
AudioAmp 8 error handler clear function.
audioamp8_error_status_t::pvdd_un_vtg_prot
uint8_t pvdd_un_vtg_prot
Definition: audioamp8.h:242
audioamp8_monitor_channel_t::mute_mon
uint8_t mute_mon
Definition: audioamp8.h:223
audioamp8_t::slave_address
uint8_t slave_address
Definition: audioamp8.h:164
audioamp8_pm_man_sh_value_t
audioamp8_pm_man_sh_value_t
AudioAmp 8 Click profile assign scheme value data.
Definition: audioamp8.h:292
audioamp8_t
AudioAmp 8 Click context object.
Definition: audioamp8.h:153
audioamp8_monitor_channel_t::cfly1_mon
uint8_t cfly1_mon
Definition: audioamp8.h:227
audioamp8_set_dc_protection
err_t audioamp8_set_dc_protection(audioamp8_t *ctx, uint8_t eh_dcshdn)
AudioAmp 8 set DC protection function.
audioamp8_pwr_mon_cfg_t::manual_pm
uint8_t manual_pm
Definition: audioamp8.h:193
AUDIOAMP8_PM_PROFILE_4
@ AUDIOAMP8_PM_PROFILE_4
Definition: audioamp8.h:283
AUDIOAMP8_AUDIO_IN_MODE_EXT_DISABLE
@ AUDIOAMP8_AUDIO_IN_MODE_EXT_DISABLE
Definition: audioamp8.h:317
audioamp8_set_mute
err_t audioamp8_set_mute(audioamp8_t *ctx, uint8_t en_mute)
AudioAmp 8 mute function.
audioamp8_cfg_setup
void audioamp8_cfg_setup(audioamp8_cfg_t *cfg)
AudioAmp 8 configuration object setup function.
audioamp8_start_up
err_t audioamp8_start_up(audioamp8_t *ctx)
AudioAmp 8 start-up procedure function.
AUDIOAMP8_PM_MAN_1
@ AUDIOAMP8_PM_MAN_1
Definition: audioamp8.h:267
AUDIOAMP8_PM_PROFILE_2
@ AUDIOAMP8_PM_PROFILE_2
Definition: audioamp8.h:281
audioamp8_pwr_mon_cfg_t::mthr_2to1
uint8_t mthr_2to1
Definition: audioamp8.h:196
audioamp8_cfg_t::ms1
pin_name_t ms1
Definition: audioamp8.h:180
audioamp8_pwr_mon_cfg_t
AudioAmp 8 Click power mode configuration object.
Definition: audioamp8.h:192
audioamp8_set_audio_in_mode_overwrite
err_t audioamp8_set_audio_in_mode_overwrite(audioamp8_t *ctx, uint8_t audio_in_mode_ext)
AudioAmp 8 set audio IN mode overwrite function.
audioamp8_init
err_t audioamp8_init(audioamp8_t *ctx, audioamp8_cfg_t *cfg)
AudioAmp 8 initialization function.
audioamp8_error_status_t
AudioAmp 8 Click monitor channel object.
Definition: audioamp8.h:238
audioamp8_default_cfg
err_t audioamp8_default_cfg(audioamp8_t *ctx)
AudioAmp 8 default configuration function.
audioamp8_error_status_t::ov_curr_prot
uint8_t ov_curr_prot
Definition: audioamp8.h:240
audioamp8_error_status_t::dc_prot
uint8_t dc_prot
Definition: audioamp8.h:246
audioamp8_error_status_t::pll_err
uint8_t pll_err
Definition: audioamp8.h:241
audioamp8_pwr_mon_cfg_t::pm_man
uint8_t pm_man
Definition: audioamp8.h:194