c2x20wamp  2.0.0.0
c2x20wamp.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 C2X20WAMP_H
36 #define C2X20WAMP_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_i2c_master.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define C2X20WAMP_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
67  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
68  cfg.shdn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.mute = MIKROBUS( mikrobus, MIKROBUS_CS ); \
70  cfg.addr1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
71  cfg.addr2 = MIKROBUS( mikrobus, MIKROBUS_INT );
72 
78 #define C2X20WAMP_RETVAL int8_t
79 
80 #define C2X20WAMP_OK 0
81 #define C2X20WAMP_INIT_ERROR (-1)
82 
88 #define C2X20WAMP_I2C_ADDRESS 0x48
89 
95 #define C2X20WAMP_ADDRESS_1 0x01
96 #define C2X20WAMP_ADDRESS_2 0x02
97 
103 #define C2X20WAMP_6_BIT_VALUE 0x3F
104 #define C2X20WAMP_CMD_VOLUME_UP 0xC4
105 #define C2X20WAMP_CMD_VOLUME_DOWN 0xC5
106 #define C2X20WAMP_CMD_FILTERLESS_MODULATION 0x40
107 #define C2X20WAMP_CMD_CLASSIC_PWM_MODULATION 0x41
108 
114 #define C2X20WAMP_6_BIT_VALUE 0x3F
115  // End group macro
118 // --------------------------------------------------------------- PUBLIC TYPES
127 typedef struct
128 {
129  // Output pins
130 
131  digital_out_t shdn;
132  digital_out_t mute;
133 
134  // Input pins
135 
136  digital_out_t addr1;
137  digital_out_t addr2;
138 
139  // Modules
140 
141  i2c_master_t i2c;
142 
143  // ctx variable
144 
145  uint8_t slave_address;
146 
147 } c2x20wamp_t;
148 
152 typedef struct
153 {
154  // Communication gpio pins
155 
156  pin_name_t scl;
157  pin_name_t sda;
158 
159  // Additional gpio pins
160 
161  pin_name_t shdn;
162  pin_name_t mute;
163  pin_name_t addr1;
164  pin_name_t addr2;
165 
166  // static variable
167 
168  uint32_t i2c_speed;
169  uint8_t i2c_address;
170 
172  // End types group
174 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
175 
181 #ifdef __cplusplus
182 extern "C"{
183 #endif
184 
194 
203 
212 void c2x20wamp_generic_write ( c2x20wamp_t *ctx, uint8_t data_buf );
213 
214 
224 
234 
244 
254 
268 void c2x20wamp_set_volume( c2x20wamp_t *ctx, uint8_t volume );
269 
278 
289 
300 
311 
312 #ifdef __cplusplus
313 }
314 #endif
315 #endif // C2X20WAMP_H
316  // End public_function group // End Click Driver group
319 
320 // ------------------------------------------------------------------------ END
c2x20wamp_classic_pwm_modulation
void c2x20wamp_classic_pwm_modulation(c2x20wamp_t *ctx)
Set classic PWM output modulation function.
c2x20wamp_set_volume
void c2x20wamp_set_volume(c2x20wamp_t *ctx, uint8_t volume)
Set volume of the amplifier function.
c2x20wamp_generic_write
void c2x20wamp_generic_write(c2x20wamp_t *ctx, uint8_t data_buf)
Generic write function.
c2x20wamp_volume_up
void c2x20wamp_volume_up(c2x20wamp_t *ctx)
Increase the volume by one level function.
c2x20wamp_init
C2X20WAMP_RETVAL c2x20wamp_init(c2x20wamp_t *ctx, c2x20wamp_cfg_t *cfg)
Initialization function.
c2x20wamp_mode_mute
void c2x20wamp_mode_mute(c2x20wamp_t *ctx)
Set Mute mode of the amplifier function.
c2x20wamp_cfg_t
Click configuration structure definition.
Definition: c2x20wamp.h:153
c2x20wamp_t
Click ctx object definition.
Definition: c2x20wamp.h:128
c2x20wamp_cfg_t::shdn
pin_name_t shdn
Definition: c2x20wamp.h:161
c2x20wamp_enable
void c2x20wamp_enable(c2x20wamp_t *ctx)
Enable the amplifier function.
c2x20wamp_cfg_t::scl
pin_name_t scl
Definition: c2x20wamp.h:156
c2x20wamp_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: c2x20wamp.h:168
c2x20wamp_cfg_t::i2c_address
uint8_t i2c_address
Definition: c2x20wamp.h:169
c2x20wamp_t::slave_address
uint8_t slave_address
Definition: c2x20wamp.h:145
C2X20WAMP_RETVAL
#define C2X20WAMP_RETVAL
Definition: c2x20wamp.h:78
c2x20wamp_cfg_t::mute
pin_name_t mute
Definition: c2x20wamp.h:162
c2x20wamp_t::i2c
i2c_master_t i2c
Definition: c2x20wamp.h:141
c2x20wamp_cfg_t::sda
pin_name_t sda
Definition: c2x20wamp.h:157
c2x20wamp_filterless_modulation
void c2x20wamp_filterless_modulation(c2x20wamp_t *ctx)
Set filterless output modulation function.
c2x20wamp_volume_down
void c2x20wamp_volume_down(c2x20wamp_t *ctx)
Decrease the volume by one level function.
c2x20wamp_t::addr1
digital_out_t addr1
Definition: c2x20wamp.h:136
c2x20wamp_t::shdn
digital_out_t shdn
Definition: c2x20wamp.h:131
c2x20wamp_t::addr2
digital_out_t addr2
Definition: c2x20wamp.h:137
c2x20wamp_mode_play
void c2x20wamp_mode_play(c2x20wamp_t *ctx)
Set Play mode of the amplifier function.
c2x20wamp_disable
void c2x20wamp_disable(c2x20wamp_t *ctx)
Disable the amplifier function.
c2x20wamp_t::mute
digital_out_t mute
Definition: c2x20wamp.h:132
c2x20wamp_cfg_t::addr1
pin_name_t addr1
Definition: c2x20wamp.h:163
c2x20wamp_cfg_t::addr2
pin_name_t addr2
Definition: c2x20wamp.h:164
c2x20wamp_cfg_setup
void c2x20wamp_cfg_setup(c2x20wamp_cfg_t *cfg)
Config Object Initialization function.