audiomux  2.0.0.0
audiomux.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 AUDIOMUX_H
36 #define AUDIOMUX_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define AUDIOMUX_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
66 
74 #define AUDIOMUX_RETVAL uint8_t
75 
76 #define AUDIOMUX_OK 0x00
77 #define AUDIOMUX_INIT_ERROR 0xFF
78 
84 #define AUDIOMUX_DEVICE_ADDR 0x44
85 
91 #define AUDIOMUX_AUTO_INCR 0x10
92 
98 #define AUDIOMUX_INPUT_SEL_ADDR 0x00
99 #define AUDIOMUX_INPUT_GAIN_ADDR 0x01
100 #define AUDIOMUX_SURROUND_ADDR 0x02
101 #define AUDIOMUX_VOLUME_LEFT_ADDR 0x03
102 #define AUDIOMUX_VOLUME_RIGHT_ADDR 0x04
103 #define AUDIOMUX_TREBLE_BASS_ADDR 0x05
104 #define AUDIOMUX_OUTPUT_ADDR 0x06
105 #define AUDIOMUX_BASS_ALC_ADDR 0x07
106 
112 #define AUDIOMUX_IN1_EN 0x00
113 #define AUDIOMUX_IN2_EN 0x01
114 #define AUDIOMUX_IN3_EN 0x02
115 #define AUDIOMUX_IN4_EN 0x03
116 #define AUDIOMUX_MIC_GAIN_14DB 0x00
117 #define AUDIOMUX_MIC_GAIN_10DB 0x01
118 #define AUDIOMUX_MIC_GAIN_6DB 0x02
119 #define AUDIOMUX_MIC_GAIN_0DB 0x03
120 #define AUDIOMUX_MIC_OFF 0x01
121 #define AUDIOMUX_MIC_ON 0x00
122 
128 #define AUDIOMUX_MUTE_INPUT_ON 0x01
129 #define AUDIOMUX_MUTE_INPUT_OFF 0x00
130 
136 #define AUDIOMUX_IN_GAIN_0DB 0x00
137 #define AUDIOMUX_IN_GAIN_2DB 0x01
138 #define AUDIOMUX_IN_GAIN_4DB 0x02
139 #define AUDIOMUX_IN_GAIN_6DB 0x03
140 #define AUDIOMUX_IN_GAIN_8DB 0x04
141 #define AUDIOMUX_IN_GAIN_10DB 0x05
142 #define AUDIOMUX_IN_GAIN_12DB 0x06
143 #define AUDIOMUX_IN_GAIN_14DB 0x07
144 
150 #define AUDIOMUX_SURROUND_MODE_ON 0x01
151 #define AUDIOMUX_SURROUND_MODE_OFF 0x00
152 #define AUDIOMUX_SURROUND_GAIN_0DB 0x00
153 #define AUDIOMUX_SURROUND_GAIN_6DB 0x02
154 #define AUDIOMUX_SURROUND_GAIN_9DB 0x04
155 #define AUDIOMUX_SURROUND_GAIN_12DB 0x06
156 #define AUDIOMUX_MIX_INV_100 0x00
157 #define AUDIOMUX_MIX_INV_50 0x08
158 #define AUDIOMUX_MIX_INV_25 0x10
159 #define AUDIOMUX_MIX_0 0x18
160 #define AUDIOMUX_MIX_NONINV_100 0x20
161 #define AUDIOMUX_MIX_NONINV_75 0x28
162 #define AUDIOMUX_MIX_NONINV_50 0x30
163 #define AUDIOMUX_MIX_MUTE 0x38
164 #define AUDIOMUX_BUFF_GAIN_0 0x40
165 #define AUDIOMUX_BUFF_GAIN_6DB 0x00
166 
172 #define AUDIOMUX_VOL1_0DB 0x00
173 #define AUDIOMUX_VOL1_1DB_NEG 0x01
174 #define AUDIOMUX_VOL1_2DB_NEG 0x02
175 #define AUDIOMUX_VOL1_3DB_NEG 0x03
176 #define AUDIOMUX_VOL1_4DB_NEG 0x04
177 #define AUDIOMUX_VOL1_5DB_NEG 0x05
178 #define AUDIOMUX_VOL1_6DB_NEG 0x06
179 #define AUDIOMUX_VOL1_7DB_NEG 0x07
180 #define AUDIOMUX_VOL1_8DB_NEG 0x08
181 #define AUDIOMUX_VOL1_16DB_NEG 0x10
182 #define AUDIOMUX_VOL1_24DB_NEG 0x18
183 #define AUDIOMUX_VOL1_32DB_NEG 0x20
184 #define AUDIOMUX_VOL1_40DB_NEG 0x28
185 #define AUDIOMUX_VOL1_48DB_NEG 0x30
186 #define AUDIOMUX_VOL1_56DB_NEG 0x38
187 #define AUDIOMUX_VOL2_0DB 0x00
188 #define AUDIOMUX_VOL2_8DB_NEG 0x01
189 #define AUDIOMUX_VOL2_16DB_NEG 0x02
190 #define AUDIOMUX_VOL2_24DB_NEG 0x03
191 
197 #define AUDIOMUX_TRE_BASS_14DB_NEG 0x00
198 #define AUDIOMUX_TRE_BASS_12DB_NEG 0x01
199 #define AUDIOMUX_TRE_BASS_10DB_NEG 0x02
200 #define AUDIOMUX_TRE_BASS_8DB_NEG 0x03
201 #define AUDIOMUX_TRE_BASS_6DB_NEG 0x04
202 #define AUDIOMUX_TRE_BASS_4DB_NEG 0x05
203 #define AUDIOMUX_TRE_BASS_2DB_NEG 0x06
204 #define AUDIOMUX_TRE_BASS_0DB 0x07
205 #define AUDIOMUX_TRE_BASS_14DB 0x08
206 #define AUDIOMUX_TRE_BASS_12DB 0x09
207 #define AUDIOMUX_TRE_BASS_10DB 0x0A
208 #define AUDIOMUX_TRE_BASS_8DB 0x0B
209 #define AUDIOMUX_TRE_BASS_6DB 0x0C
210 #define AUDIOMUX_TRE_BASS_4DB 0x0D
211 #define AUDIOMUX_TRE_BASS_2DB 0x0E
212 
218 #define AUDIOMUX_MUTE_OUTPUT_ON 0x00
219 #define AUDIOMUX_MUTE_OUTPUT_OFF 0x01
220 
226 #define AUDIOMUX_ALC_MODE_ON 0x01
227 #define AUDIOMUX_DETECTOR_ON 0x02
228 #define AUDIOMUX_RELEASE_CURR 0x04
229 #define AUDIOMUX_TIME_RES_12K5 0x00
230 #define AUDIOMUX_TIME_RES_25K 0x08
231 #define AUDIOMUX_TIME_RES_50K 0x10
232 #define AUDIOMUX_TIME_RES_100K 0x18
233 #define AUDIOMUX_THRSH_700MVRMS 0x00
234 #define AUDIOMUX_THRSH_485MVRMS 0x20
235 #define AUDIOMUX_THRSH_320MVRMS 0x40
236 #define AUDIOMUX_THRSH_170MVRMS 0x60
237 #define AUDIOMUX_MODE1_FIXED_RES 0x00
238 #define AUDIOMUX_MODE2_ADAPTIVE 0x80
239 
245 #define AUDIOMUX_OK 0x00
246 #define AUDIOMUX_ADDR_ERR 0x01
247 #define AUDIOMUX_NBYTES_ERR 0x02
248 #define AUDIOMUX_IN_SEL_ERR 0x03
249 #define AUDIOMUX_GAIN_ERR 0x04
250 #define AUDIOMUX_STATE_ERR 0x05
251 #define AUDIOMUX_VOL_ERR 0x06
252 #define AUDIOMUX_TRE_BASS_ERR 0x07
253 
259 #define T_AUDIOMUX_P const uint8_t*
260 #define T_AUDIOMUX_RETVAL uint8_t
261  // End group macro
265 // --------------------------------------------------------------- PUBLIC TYPES
274 typedef struct
275 {
276  // Modules
277 
278  i2c_master_t i2c;
279 
280  // ctx variable
281 
282  uint8_t slave_address;
283 
284 } audiomux_t;
285 
289 typedef struct
290 {
291  // Communication gpio pins
292 
293  pin_name_t scl;
294  pin_name_t sda;
295 
296  // static variable
297 
298  uint32_t i2c_speed;
299  uint8_t i2c_address;
300 
302  // End types group
304 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
305 
311 #ifdef __cplusplus
312 extern "C"{
313 #endif
314 
324 
333 
346 
357 void audiomux_generic_write ( audiomux_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
358 
370 void audiomux_generic_read ( audiomux_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
371 
384  uint8_t data_in );
385 
399  uint8_t *data_in, uint8_t n_bytes );
400 
413  uint8_t *data_out );
414 
428  uint8_t *data_out, uint8_t n_bytes );
429 
443 T_AUDIOMUX_RETVAL audiomux_select_input ( audiomux_t *ctx, uint8_t input_sel, uint8_t mute_in,
444  uint8_t mic_gain, uint8_t mic_state );
445 
457 
470 T_AUDIOMUX_RETVAL audiomux_set_volume ( audiomux_t *ctx, uint8_t volume1, uint8_t volume2,
471  uint8_t side_sel );
472 
484 T_AUDIOMUX_RETVAL audiomux_set_treble_bass ( audiomux_t *ctx, uint8_t treble, uint8_t bass );
485 
497 
498 
499 #ifdef __cplusplus
500 }
501 #endif
502 #endif // _AUDIOMUX_H_
503  // End public_function group
506 
507 // ------------------------------------------------------------------------- END
audiomux_cfg_t
Click configuration structure definition.
Definition: audiomux.h:290
audiomux_select_input
T_AUDIOMUX_RETVAL audiomux_select_input(audiomux_t *ctx, uint8_t input_sel, uint8_t mute_in, uint8_t mic_gain, uint8_t mic_state)
Input Selection function.
audiomux_read_single_byte
T_AUDIOMUX_RETVAL audiomux_read_single_byte(audiomux_t *ctx, uint8_t reg_addr, uint8_t *data_out)
Single Read function.
T_AUDIOMUX_RETVAL
#define T_AUDIOMUX_RETVAL
Definition: audiomux.h:260
audiomux_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: audiomux.h:298
audiomux_default_cfg
void audiomux_default_cfg(audiomux_t *ctx)
Click Default Configuration function.
audiomux_set_input_gain
T_AUDIOMUX_RETVAL audiomux_set_input_gain(audiomux_t *ctx, uint8_t input_gain)
Input Gain Control function.
audiomux_set_treble_bass
T_AUDIOMUX_RETVAL audiomux_set_treble_bass(audiomux_t *ctx, uint8_t treble, uint8_t bass)
Treble and Bass Control function.
audiomux_write_bytes
T_AUDIOMUX_RETVAL audiomux_write_bytes(audiomux_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t n_bytes)
Multiple Write function.
audiomux_cfg_t::scl
pin_name_t scl
Definition: audiomux.h:293
audiomux_set_volume
T_AUDIOMUX_RETVAL audiomux_set_volume(audiomux_t *ctx, uint8_t volume1, uint8_t volume2, uint8_t side_sel)
Volume Control function.
audiomux_init
AUDIOMUX_RETVAL audiomux_init(audiomux_t *ctx, audiomux_cfg_t *cfg)
Initialization function.
audiomux_mute_ouput
T_AUDIOMUX_RETVAL audiomux_mute_ouput(audiomux_t *ctx, uint8_t state)
Output Mute function.
audiomux_t::i2c
i2c_master_t i2c
Definition: audiomux.h:278
audiomux_read_bytes
T_AUDIOMUX_RETVAL audiomux_read_bytes(audiomux_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t n_bytes)
Multiple Read function.
audiomux_cfg_setup
void audiomux_cfg_setup(audiomux_cfg_t *cfg)
Config Object Initialization function.
audiomux_generic_read
void audiomux_generic_read(audiomux_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
audiomux_t::slave_address
uint8_t slave_address
Definition: audiomux.h:282
audiomux_cfg_t::sda
pin_name_t sda
Definition: audiomux.h:294
AUDIOMUX_RETVAL
#define AUDIOMUX_RETVAL
Definition: audiomux.h:74
audiomux_cfg_t::i2c_address
uint8_t i2c_address
Definition: audiomux.h:299
audiomux_write_single_byte
T_AUDIOMUX_RETVAL audiomux_write_single_byte(audiomux_t *ctx, uint8_t reg_addr, uint8_t data_in)
Single Write function.
audiomux_t
Click ctx object definition.
Definition: audiomux.h:275
audiomux_generic_write
void audiomux_generic_write(audiomux_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.