audioamp3 2.0.0.0
audioamp3.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
33// ----------------------------------------------------------------------------
34
35#ifndef AUDIOAMP3_H
36#define AUDIOAMP3_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define AUDIOAMP3_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.stb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56 cfg.clp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
57 cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
64#define AUDIOAMP3_RETVAL uint8_t
65#define AUDIOAMP3_STATUS_T uint8_t
66
67#define AUDIOAMP3_OK 0x00
68#define AUDIOAMP3_INIT_ERROR 0xFF
75#define AUDIOAMP3_I2C_SLAVE_ADDRESS 0x6C
82#define AUDIOAMP3_DIAG_LATCHED_FAULT_REG_1 0x00
83#define AUDIOAMP3_DIAG_LATCHED_FAULT_REG_2 0x01
84#define AUDIOAMP3_DIAG_LATCHED_REG_1 0x02
85#define AUDIOAMP3_DIAG_LATCHED_REG_2 0x03
92#define AUDIOAMP3_EXT_STATUS_REG_1 0x04
93#define AUDIOAMP3_EXT_STATUS_REG_2 0x05
94#define AUDIOAMP3_EXT_STATUS_REG_3 0x06
95#define AUDIOAMP3_EXT_STATUS_REG_4 0x07
96#define AUDIOAMP3_EXT_STATUS_REG_5 0x11
103#define AUDIOAMP3_EXT_CTRL_REG_1 0x08
104#define AUDIOAMP3_EXT_CTRL_REG_2 0x09
105#define AUDIOAMP3_EXT_CTRL_REG_3 0x0A
106#define AUDIOAMP3_EXT_CTRL_REG_4 0x0B
107#define AUDIOAMP3_EXT_CTRL_REG_5 0x0C
108#define AUDIOAMP3_EXT_CTRL_REG_6 0x0D
109#define AUDIOAMP3_EXT_CTRL_REG_7 0x10
116#define AUDIOAMP3_SEL_CH_1_GAIN_12dB 0x00
117#define AUDIOAMP3_SEL_CH_1_GAIN_20dB 0x01
118#define AUDIOAMP3_SEL_CH_1_GAIN_32dB 0x03
119#define AUDIOAMP3_SEL_CH_2_GAIN_12dB 0x00
120#define AUDIOAMP3_SEL_CH_2_GAIN_20dB 0x04
121#define AUDIOAMP3_SEL_CH_2_GAIN_32dB 0x0C
122#define AUDIOAMP3_SEL_CH_3_GAIN_12dB 0x00
123#define AUDIOAMP3_SEL_CH_3_GAIN_20dB 0x10
124#define AUDIOAMP3_SEL_CH_3_GAIN_32dB 0x30
125#define AUDIOAMP3_SEL_CH_4_GAIN_12dB 0x00
126#define AUDIOAMP3_SEL_CH_4_GAIN_20dB 0x40
127#define AUDIOAMP3_SEL_CH_4_GAIN_32dB 0xC0
128#define AUDIOAMP3_SEL_ALL_CH_GAIN_26dB 0xAA
135#define AUDIOAMP3_OVERCURR_CH_1_LIMIT_LVL_1 0x00
136#define AUDIOAMP3_OVERCURR_CH_1_LIMIT_LVL_2 0x10
137#define AUDIOAMP3_OVERCURR_CH_2_LIMIT_LVL_1 0x00
138#define AUDIOAMP3_OVERCURR_CH_2_LIMIT_LVL_2 0x20
139#define AUDIOAMP3_OVERCURR_CH_3_LIMIT_LVL_1 0x00
140#define AUDIOAMP3_OVERCURR_CH_3_LIMIT_LVL_2 0x40
141#define AUDIOAMP3_OVERCURR_CH_4_LIMIT_LVL_1 0x00
142#define AUDIOAMP3_OVERCURR_CH_4_LIMIT_LVL_2 0x80
143#define AUDIOAMP3_CURRENT_LIMIT_LVL_2_ALL_CH 0xF0
144#define AUDIOAMP3_DIS_THERMAL_FOLDBACK 0x01
151#define AUDIOAMP3_FREQ_SEL_417_kHZ_45_PHASE_CLIP_OTWT 0x0D
152#define AUDIOAMP3_FREQ_SEL_500_kHZ 0x00
153#define AUDIOAMP3_FREQ_SEL_357_kHZ 0x02
154#define AUDIOAMP3_CONFIG_CLIP_OTW_TWEETER_DETECT 0x00
155#define AUDIOAMP3_CONFIG_CLIP_OTW_CLIP_DETECT 0x04
156#define AUDIOAMP3_CONFIG_CLIP_OTW_OVERTEMP_WARNING 0x08
157#define AUDIOAMP3_ENABLE_HARD_STOP_MODE 0x10
158#define AUDIOAMP3_SET_FS_357_kHZ_180_PHASE_CLIP_OTWT 0x20
159#define AUDIOAMP3_SEND_SYNC_PULSE_OSC_SYNC 0x40
160#define AUDIOAMP3_CONFIG_CLIP_OTW_THERMAL_FOLDBACK 0x80
167#define AUDIOAMP3_LOAD_DIAG_RUN_CH_1 0x01
168#define AUDIOAMP3_LOAD_DIAG_RUN_CH_2 0x02
169#define AUDIOAMP3_LOAD_DIAG_RUN_CH_3 0x04
170#define AUDIOAMP3_LOAD_DIAG_RUN_CH_4 0x08
171#define AUDIOAMP3_SET_CLOCK_OUTPUT_DISABLED 0x50
172#define AUDIOAMP3_DIS_DC_DETECTION_ALL_CH 0x00
173#define AUDIOAMP3_EN_TWEETER_DETECT_MODE 0x20
174#define AUDIOAMP3_EN_CLOCK_OUTPUT_OSC_SYNC 0x80
181#define AUDIOAMP3_OUT_CTRL_ALL_CH_HI_Z_MUTE_RST_DIS_DC_EN 0x1F
182#define AUDIOAMP3_OUT_CTRL_SET_CH_1_2_3_4_MUTE 0x00
183#define AUDIOAMP3_OUT_CTRL_SET_PLAY_MODE 0x20
184#define AUDIOAMP3_OUT_CTRL_DC_DET_SHUTDOWN_DIS 0x40
185#define AUDIOAMP3_OUT_CTRL_RST_DEVICE 0x80
186#define AUDIOAMP3_OUT_CTRL_L_LOW_STATE_DIS_ALL_CH 0x00
187#define AUDIOAMP3_OUT_CTRL_SET_CH_1_L_LOW_STATE 0xC1
188#define AUDIOAMP3_OUT_CTRL_SET_CH_2_L_LOW_STATE 0xC2
189#define AUDIOAMP3_OUT_CTRL_SET_CH_3_L_LOW_STATE 0xC4
190#define AUDIOAMP3_OUT_CTRL_SET_CH_4_L_LOW_STATE 0xC8
191#define AUDIOAMP3_OUT_CTRL_CONN_CH_1_2_BTL_MODE 0xD0
192#define AUDIOAMP3_OUT_CTRL_CONN_CH_3_4_BTL_MODE 0xE0
199#define AUDIOAMP3_MISCELL_NORMAL_SPEED_S2P_S2G_TIMING 0x01
200#define AUDIOAMP3_MISCELL_MIN_DC_DET_VAL_0_8_V 0x00
201#define AUDIOAMP3_MISCELL_MIN_DC_DET_VAL_2_4_V 0x02
202#define AUDIOAMP3_MISCELL_EN_CROSSTALK_ENHANCEMENT 0x04
203#define AUDIOAMP3_MISCELL_N_LOAD_DIAG_PHASES 0x08
204#define AUDIOAMP3_MISCELL_S2P_S2G_LOAD_DIAG 0x10
205#define AUDIOAMP3_MISCELL_SLOW_COMMON_MODE_RAMP 0x20
206#define AUDIOAMP3_MISCELL_SLOWER_CM_RAMP_DOWN_MUTE_MODE 0x80
213#define AUDIOAMP3_MASK_BIT_SEL_NO_CH 0x00
214#define AUDIOAMP3_MASK_BIT_SEL_CH_1 0x01
215#define AUDIOAMP3_MASK_BIT_SEL_CH_2 0x02
216#define AUDIOAMP3_MASK_BIT_SEL_ALL_CH 0x03
217#define AUDIOAMP3_MASK_BIT_SEL_GAIN_12dB 0x0C
218#define AUDIOAMP3_MASK_BIT_SEL_GAIN_20dB 0x14
219#define AUDIOAMP3_MASK_BIT_SEL_GAIN_26dB 0x1A
220#define AUDIOAMP3_MASK_BIT_SEL_GAIN_32dB 0x20
221#define AUDIOAMP3_MASK_BIT_CH_1 0xFC
222#define AUDIOAMP3_MASK_BIT_MUTE_NO_CH 0x10
223#define AUDIOAMP3_MASK_BIT_MUTE_CH_1 0xFE
224#define AUDIOAMP3_MASK_BIT_MUTE_CH_2 0xFD
231#define AUDIOAMP3_GAIN_VAL_MAX 0x04
232#define AUDIOAMP3_GAIN_VAL_MEDIUM 0x03
233#define AUDIOAMP3_GAIN_VAL_MIN 0x01
234#define AUDIOAMP3_GAIN_VAL_0 0x00
235#define AUDIOAMP3_GAIN_VAL_5 0x05
236#define AUDIOAMP3_GAIN_VAL_LVL_1_12dB 0x01
237#define AUDIOAMP3_GAIN_VAL_LVL_2_20dB 0x02
238#define AUDIOAMP3_GAIN_VAL_LVL_3_26dB 0x03
239#define AUDIOAMP3_GAIN_VAL_LVL_4_32dB 0x04
246#define AUDIOAMP3_STATUS_ERR 0x00
247#define AUDIOAMP3_STATUS_OK 0x01 // End group macro
251
252// --------------------------------------------------------------- PUBLIC TYPES
261typedef struct
262{
263 // Output pins
264
265 digital_out_t stb;
266
267 // Input pins
268
269 digital_in_t clp;
270 digital_in_t flt;
271
272 // Modules
273
274 i2c_master_t i2c;
275
276 // ctx variable
277
279
281
285typedef struct
286{
287 // Communication gpio pins
288
289 pin_name_t scl;
290 pin_name_t sda;
291
292 // Additional gpio pins
293
294 pin_name_t stb;
295 pin_name_t clp;
296 pin_name_t flt;
297
298 // static variable
299
300 uint32_t i2c_speed;
301 uint8_t i2c_address;
302
304 // End types group
306
307// ------------------------------------------------------------------ CONSTANTS // End constants group
315
316// ------------------------------------------------------------------ VARIABLES // End variable group
324
325// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
326
332#ifdef __cplusplus
333extern "C"{
334#endif
335
345
355
366void audioamp3_generic_write ( audioamp3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
367
379void audioamp3_generic_read ( audioamp3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
380
390
402
413void audioamp3_read_all_diagnostics ( audioamp3_t *ctx, uint8_t *p_all_diagnostics );
414
441
470
491
511
541
542#ifdef __cplusplus
543}
544#endif
545#endif // _AUDIOAMP3_H_
546 // End public_function group
549
550// ------------------------------------------------------------------------- END
#define AUDIOAMP3_STATUS_T
Definition: audioamp3.h:65
#define AUDIOAMP3_RETVAL
Definition: audioamp3.h:64
AUDIOAMP3_STATUS_T audioamp3_set_gain_lvl(audioamp3_t *ctx, uint8_t gain_lvl)
Set the gain lvl function.
void audioamp3_read_all_diagnostics(audioamp3_t *ctx, uint8_t *p_all_diagnostics)
Read all diagnostics function.
void audioamp3_power_up(audioamp3_t *ctx)
Power Up function.
void audioamp3_generic_write(audioamp3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void audioamp3_generic_read(audioamp3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void audioamp3_cfg_setup(audioamp3_cfg_t *cfg)
Config Object Initialization function.
AUDIOAMP3_STATUS_T audioamp3_set_channel_low_to_low(audioamp3_t *ctx, uint8_t s_channel)
Set the channel to low-low state function.
AUDIOAMP3_STATUS_T audioamp3_set_channel_mute_mode(audioamp3_t *ctx, uint8_t s_channel)
Set the mute mode of channel function.
AUDIOAMP3_RETVAL audioamp3_init(audioamp3_t *ctx, audioamp3_cfg_t *cfg)
Initialization function.
AUDIOAMP3_STATUS_T audioamp3_set_play_mode(audioamp3_t *ctx)
Set the play mode for all channels function.
AUDIOAMP3_STATUS_T audioamp3_run_channel_diagnostics(audioamp3_t *ctx, uint8_t rc_channel)
Run channel diagnostics function.
void audioamp3_hw_reset(audioamp3_t *ctx)
Hardware reset function.
Click configuration structure definition.
Definition: audioamp3.h:286
uint32_t i2c_speed
Definition: audioamp3.h:300
pin_name_t clp
Definition: audioamp3.h:295
pin_name_t flt
Definition: audioamp3.h:296
pin_name_t scl
Definition: audioamp3.h:289
pin_name_t sda
Definition: audioamp3.h:290
pin_name_t stb
Definition: audioamp3.h:294
uint8_t i2c_address
Definition: audioamp3.h:301
Click ctx object definition.
Definition: audioamp3.h:262
digital_in_t flt
Definition: audioamp3.h:270
digital_out_t stb
Definition: audioamp3.h:265
i2c_master_t i2c
Definition: audioamp3.h:274
digital_in_t clp
Definition: audioamp3.h:269
uint8_t slave_address
Definition: audioamp3.h:278