stereoamp  2.0.0.0
stereoamp.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  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef STEREOAMP_H
35 #define STEREOAMP_H
36 
37 #include "drv_digital_in.h"
38 #include "drv_i2c_master.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define STEREOAMP_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
52  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
53  cfg.fll = MIKROBUS( mikrobus, MIKROBUS_AN ); \
54  cfg.flr = MIKROBUS( mikrobus, MIKROBUS_INT )
55 
61 #define STEREOAMP_RETVAL uint8_t
62 
63 #define STEREOAMP_OK 0x00
64 #define STEREOAMP_INIT_ERROR 0xFF
65 
71 #define STEREOAMP_I2C_ADDRESS_0 0x7C
72 #define STEREOAMP_I2C_ADDRESS_1 0x7D
73 
79 #define STEREOAMP_CTRL_REG_MODE_CONTROL 0x00
80 #define STEREOAMP_CTRL_REG_DIAGNOSTIC_CONTROL 0x20
81 #define STEREOAMP_CTRL_REG_FAULT_DETECTION 0x40
82 #define STEREOAMP_CTRL_REG_VOLUME_CONTROL1 0x60
83 #define STEREOAMP_CTRL_REG_VOLUME_CONTROL2 0x80
84 
90 #define STEREOAMP_DIAG_REG_FIX_ILIMIT 0x00
91 #define STEREOAMP_DIAG_REG_ILIMIT 0x02
92 #define STEREOAMP_DIAG_REG_DG_RESET 0x04
93 #define STEREOAMP_DIAG_REG_DG_ONE_SHOT 0x00
94 #define STEREOAMP_DIAG_REG_DG_CONT 0x08
95 #define STEREOAMP_DIAG_REG_DG_DISABLE 0x00
96 #define STEREOAMP_DIAG_REG_DG_EN 0x10
97 
103 #define STEREOAMP_MODE_POWER_OFF 0x00
104 #define STEREOAMP_MODE_POWER_ON 0x10
105 #define STEREOAMP_MODE_INPUT1 0x04
106 #define STEREOAMP_MODE_INPUT1_OFF 0x00
107 #define STEREOAMP_MODE_INPUT2 0x08
108 #define STEREOAMP_MODE_INPUT2_OFF 0x00
109 #define STEREOAMP_MODE_BOTH_CHANNELS 0x0C
110 
116 #define STEREOAMP_FLT_DET_REG_OUTPUT_SHT 0x01
117 #define STEREOAMP_FLT_DET_REG_OUTPUT_OPEN 0x02
118 #define STEREOAMP_FLT_DET_REG_RAIL_SHT 0x04
119 #define STEREOAMP_FLT_DET_REG_OVF 0x08
120 #define STEREOAMP_FLT_DET_REG_TSD 0x10
121 
127 #define STEREOAMP_MASK_DATA 0x1F
128 #define STEREOAMP_MASK_ADDR 0xE0
129 #define STEREOAMP_MASK_CHANNEL 0x01
130 
136 #define STEREOAMP_OUTPUT_LEFT_SPEAKER 0x01
137 #define STEREOAMP_OUTPUT_RIGHT_SPEAKER 0x00
138 
144 #define STEREOAMP_GAIN_NEG_80dB 0x00
145 #define STEREOAMP_GAIN_NEG_54dB 0x01
146 #define STEREOAMP_GAIN_NEG_40_5dB 0x02
147 #define STEREOAMP_GAIN_NEG_34_5dB 0x03
148 #define STEREOAMP_GAIN_NEG_30dB 0x04
149 #define STEREOAMP_GAIN_NEG_27dB 0x05
150 #define STEREOAMP_GAIN_NEG_24dB 0x06
151 #define STEREOAMP_GAIN_NEG_21dB 0x07
152 #define STEREOAMP_GAIN_NEG_18dB 0x08
153 #define STEREOAMP_GAIN_NEG_15dB 0x09
154 #define STEREOAMP_GAIN_NEG_13_5dB 0x0A
155 #define STEREOAMP_GAIN_NEG_12dB 0x0B
156 #define STEREOAMP_GAIN_NEG_10_5dB 0x0C
157 #define STEREOAMP_GAIN_NEG_9dB 0x0D
158 #define STEREOAMP_GAIN_NEG_7_5dB 0x0E
159 #define STEREOAMP_GAIN_NEG_6dB 0x0F
160 #define STEREOAMP_GAIN_NEG_4_5dB 0x10
161 #define STEREOAMP_GAIN_NEG_3dB 0x11
162 #define STEREOAMP_GAIN_NEG_1_5dB 0x12
163 #define STEREOAMP_GAIN_NEG_0dB 0x13
164 #define STEREOAMP_GAIN_1_5dB 0x14
165 #define STEREOAMP_GAIN_3dB 0x15
166 #define STEREOAMP_GAIN_4_5dB 0x16
167 #define STEREOAMP_GAIN_6dB 0x17
168 #define STEREOAMP_GAIN_7_5dB 0x18
169 #define STEREOAMP_GAIN_9dB 0x19
170 #define STEREOAMP_GAIN_10_5dB 0x1A
171 #define STEREOAMP_GAIN_12dB 0x1B
172 #define STEREOAMP_GAIN_13_5dB 0x1C
173 #define STEREOAMP_GAIN_15dB 0x1D
174 #define STEREOAMP_GAIN_16_5dB 0x1E
175 #define STEREOAMP_GAIN_18dB 0x1F
176  // End group macro
179 
180 // --------------------------------------------------------------- PUBLIC TYPES
189 typedef struct
190 {
191 
192  // Input pins
193 
194  digital_in_t fll;
195  digital_in_t flr;
196 
197  // Modules
198 
199  i2c_master_t i2c;
200 
201  // ctx variable
202 
205 
206 } stereoamp_t;
207 
211 typedef struct
212 {
213  // Communication gpio pins
214 
215  pin_name_t scl;
216  pin_name_t sda;
217 
218  // Additional gpio pins
219 
220  pin_name_t fll;
221  pin_name_t flr;
222 
223  // static variable
224 
225  uint32_t i2c_speed;
226  uint8_t i2c_address_0;
227  uint8_t i2c_address_1;
228 
230  // End types group
232 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
233 
239 #ifdef __cplusplus
240 extern "C"{
241 #endif
242 
252 
262 
271 
288 void stereoamp_generic_write ( stereoamp_t *ctx, uint8_t ch_addr, uint8_t reg_addr, uint8_t tx_data );
289 
299 void stereoamp_set_volume ( stereoamp_t *ctx, uint8_t volume );
300 
310 
320 
330 
340 
350 
360 
370 
371 #ifdef __cplusplus
372 }
373 #endif
374 #endif // _STEREOAMP_H_
375  // End public_function group
378 
379 // ------------------------------------------------------------------------- END
stereoamp_cfg_t::sda
pin_name_t sda
Definition: stereoamp.h:216
stereoamp_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: stereoamp.h:225
STEREOAMP_RETVAL
#define STEREOAMP_RETVAL
Definition: stereoamp.h:61
stereoamp_init
STEREOAMP_RETVAL stereoamp_init(stereoamp_t *ctx, stereoamp_cfg_t *cfg)
Initialization function.
stereoamp_cfg_t::fll
pin_name_t fll
Definition: stereoamp.h:220
stereoamp_enable_diagnostic
void stereoamp_enable_diagnostic(stereoamp_t *ctx)
Enable the diagnostic function.
stereoamp_cfg_t::i2c_address_0
uint8_t i2c_address_0
Definition: stereoamp.h:226
stereoamp_set_power_on
void stereoamp_set_power_on(stereoamp_t *ctx)
Set the power On by channel function.
stereoamp_mute
void stereoamp_mute(stereoamp_t *ctx)
Set the mute mode function.
stereoamp_t::fll
digital_in_t fll
Definition: stereoamp.h:194
stereoamp_cfg_setup
void stereoamp_cfg_setup(stereoamp_cfg_t *cfg)
Config Object Initialization function.
stereoamp_soft_reset
void stereoamp_soft_reset(stereoamp_t *ctx)
Soft reset function.
stereoamp_cfg_t::i2c_address_1
uint8_t i2c_address_1
Definition: stereoamp.h:227
stereoamp_generic_write
void stereoamp_generic_write(stereoamp_t *ctx, uint8_t ch_addr, uint8_t reg_addr, uint8_t tx_data)
Generic write function.
stereoamp_enable_fault
void stereoamp_enable_fault(stereoamp_t *ctx)
Enable the fault function.
stereoamp_cfg_t
Click configuration structure definition.
Definition: stereoamp.h:212
stereoamp_check_fault_right
uint8_t stereoamp_check_fault_right(stereoamp_t *ctx)
Check the fault of the right speaker function.
stereoamp_check_fault_left
uint8_t stereoamp_check_fault_left(stereoamp_t *ctx)
Check the fault of the left speaker function.
stereoamp_default_cfg
void stereoamp_default_cfg(stereoamp_t *ctx)
Click Default Configuration function.
stereoamp_t::flr
digital_in_t flr
Definition: stereoamp.h:195
stereoamp_t::slave_address_0
uint8_t slave_address_0
Definition: stereoamp.h:203
stereoamp_t
Click ctx object definition.
Definition: stereoamp.h:190
stereoamp_cfg_t::flr
pin_name_t flr
Definition: stereoamp.h:221
stereoamp_set_volume
void stereoamp_set_volume(stereoamp_t *ctx, uint8_t volume)
Set the volume function.
stereoamp_t::slave_address_1
uint8_t slave_address_1
Definition: stereoamp.h:204
stereoamp_cfg_t::scl
pin_name_t scl
Definition: stereoamp.h:215
stereoamp_t::i2c
i2c_master_t i2c
Definition: stereoamp.h:199