volume2  2.0.0.0
volume2.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 VOLUME2_H
29 #define VOLUME2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define VOLUME2_REG_VOLUME_1A_2A 0x00
70 
75 #define VOLUME2_REG_VOLUME_1B_ZERO1 0x01
76 
81 #define VOLUME2_REG_VOLUME_2B_ZERO2 0x02
82  // volume2_reg
84 
99 #define VOLUME2_GAIN_OPT_0_DB 0x00
100 
105 #define VOLUME2_GAIN_OPT_3_DB 0x01
106 
111 #define VOLUME2_GAIN_OPT_6_DB 0x02
112 
117 #define VOLUME2_GAIN_OPT_9_DB 0x03
118 
123 #define VOLUME2_ZERO_CROSS_DET_OPT_OFF 0x00
124 
129 #define VOLUME2_ZERO_CROSS_DET_OPT_ON 0x01
130 
136 #define VOLUME2_SET_DEV_ADDR 0x44
137  // volume2_set
139 
154 #define VOLUME2_DEVICE_MUTE_ON 0x00
155 
160 #define VOLUME2_DEVICE_MUTE_OFF 0x01
161  // mte_state
163 
178 #define VOLUME2_MAP_MIKROBUS( cfg, mikrobus ) \
179  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
180  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
181  cfg.mte = MIKROBUS( mikrobus, MIKROBUS_PWM )
182  // volume2_map // volume2
185 
190 typedef struct
191 {
192  // Output pins
193 
194  digital_out_t mte;
196  // Modules
197 
198  i2c_master_t i2c;
200  // I2C slave address
201 
202  uint8_t slave_address;
204 } volume2_t;
205 
210 typedef struct
211 {
212  pin_name_t scl;
213  pin_name_t sda;
215  pin_name_t mte;
217  uint32_t i2c_speed;
218  uint8_t i2c_address;
220 } volume2_cfg_t;
221 
226 typedef enum
227 {
229  VOLUME2_ERROR = -1
230 
232 
237 typedef struct
238 {
239  uint8_t gain_ch1;
240  uint8_t gain_ch2;
241  uint8_t attenuation_ch1;
242  uint8_t attenuation_ch2;
247 
266 
283 err_t volume2_init ( volume2_t *ctx, volume2_cfg_t *cfg );
284 
301 
319 err_t volume2_generic_write ( volume2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
320 
338 err_t volume2_generic_read ( volume2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
339 
354 err_t volume2_device_mute ( volume2_t *ctx, uint8_t mte_state );
355 
373 
374 #ifdef __cplusplus
375 }
376 #endif
377 #endif // VOLUME2_H
378  // volume2
380 
381 // ------------------------------------------------------------------------ END
volume2_generic_read
err_t volume2_generic_read(volume2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
Volume 2 I2C reading function.
volume2_t
Volume 2 Click context object.
Definition: volume2.h:191
volume2_cfg_t
Volume 2 Click configuration object.
Definition: volume2.h:211
volume2_init
err_t volume2_init(volume2_t *ctx, volume2_cfg_t *cfg)
Volume 2 initialization function.
volume2_vol_data_t::gain_ch1
uint8_t gain_ch1
Definition: volume2.h:239
volume2_cfg_t::scl
pin_name_t scl
Definition: volume2.h:212
volume2_vol_data_t::gain_ch2
uint8_t gain_ch2
Definition: volume2.h:240
volume2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: volume2.h:217
volume2_return_value_t
volume2_return_value_t
Volume 2 Click return value data.
Definition: volume2.h:227
volume2_t::mte
digital_out_t mte
Definition: volume2.h:194
volume2_vol_data_t::attenuation_ch2
uint8_t attenuation_ch2
Definition: volume2.h:242
volume2_vol_data_t::zero_cross_det_ch2
uint8_t zero_cross_det_ch2
Definition: volume2.h:244
volume2_vol_data_t
Volume 2 Vol data structure.
Definition: volume2.h:238
volume2_t::i2c
i2c_master_t i2c
Definition: volume2.h:198
volume2_generic_write
err_t volume2_generic_write(volume2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
Volume 2 I2C writing function.
volume2_device_mute
err_t volume2_device_mute(volume2_t *ctx, uint8_t mte_state)
Volume 2 device mute function.
volume2_vol_data_t::zero_cross_det_ch1
uint8_t zero_cross_det_ch1
Definition: volume2.h:243
VOLUME2_ERROR
@ VOLUME2_ERROR
Definition: volume2.h:229
volume2_update_vol_data
err_t volume2_update_vol_data(volume2_t *ctx, volume2_vol_data_t update_data)
Volume 2 update volume data function.
VOLUME2_OK
@ VOLUME2_OK
Definition: volume2.h:228
volume2_cfg_setup
void volume2_cfg_setup(volume2_cfg_t *cfg)
Volume 2 configuration object setup function.
volume2_vol_data_t::attenuation_ch1
uint8_t attenuation_ch1
Definition: volume2.h:241
volume2_cfg_t::mte
pin_name_t mte
Definition: volume2.h:215
volume2_cfg_t::i2c_address
uint8_t i2c_address
Definition: volume2.h:218
volume2_t::slave_address
uint8_t slave_address
Definition: volume2.h:202
volume2_default_cfg
err_t volume2_default_cfg(volume2_t *ctx)
Volume 2 default configuration function.
volume2_cfg_t::sda
pin_name_t sda
Definition: volume2.h:213