c2x5wamp  2.0.0.0
c2x5wamp.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef C2X5WAMP_H
36 #define C2X5WAMP_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_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define C2X5WAMP_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.gn0= MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.gn1= MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.stb= MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.mute= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
70  cfg.dia= MIKROBUS( mikrobus, MIKROBUS_INT );
71 
77 #define C2X5WAMP_RETVAL uint8_t
78 
79 #define C2X5WAMP_OK 0x00
80 #define C2X5WAMP_INIT_ERROR 0xFF
81 
87 #define C2X5WAMP_MODE_STANDBY 0x00
88 #define C2X5WAMP_MODE_MUTE 0x01
89 #define C2X5WAMP_MODE_PLAY 0x02
90 
96 #define C2X5WAMP_GAIN_20DB 0x00
97 #define C2X5WAMP_GAIN_26DB 0x01
98 #define C2X5WAMP_GAIN_30DB 0x02
99 #define C2X5WAMP_GAIN_32DB 0x03
100 
106 #define C2X5WAMP_RESULT_ERROR 0x00
107 #define C2X5WAMP_RESULT_OK 0x01
108  // End group macro
111 // --------------------------------------------------------------- PUBLIC TYPES
120 typedef struct
121 {
122  // Output pins
123 
124  digital_out_t gn0;
125  digital_out_t gn1;
126  digital_out_t stb;
127  digital_out_t mute;
128 
129  // Input pins
130 
131  digital_in_t dia;
132 
133 } c2x5wamp_t;
134 
138 typedef struct
139 {
140  // Additional gpio pins
141 
142  pin_name_t gn0;
143  pin_name_t gn1;
144  pin_name_t stb;
145  pin_name_t mute;
146  pin_name_t dia;
147 
149  // End types group
151 // ------------------------------------------------------------------ CONSTANTS // End constants group
160 // ------------------------------------------------------------------ VARIABLES // End variable group
168 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
169 
175 #ifdef __cplusplus
176 extern "C"{
177 #endif
178 
188 
197 
209 
227 uint8_t c2x5wamp_set_mode ( c2x5wamp_t *ctx, uint8_t select_mode );
228 
246 uint8_t c2x5wamp_set_gain ( c2x5wamp_t *ctx, uint8_t select_gain );
247 
262 
263 #ifdef __cplusplus
264 }
265 #endif
266 #endif // _C2X5WAMP_H_
267  // End public_function group
270 
271 // ------------------------------------------------------------------------- END
c2x5wamp_cfg_setup
void c2x5wamp_cfg_setup(c2x5wamp_cfg_t *cfg)
Config Object Initialization function.
c2x5wamp_cfg_t::mute
pin_name_t mute
Definition: c2x5wamp.h:145
c2x5wamp_t
Click ctx object definition.
Definition: c2x5wamp.h:121
c2x5wamp_t::mute
digital_out_t mute
Definition: c2x5wamp.h:127
c2x5wamp_t::gn0
digital_out_t gn0
Definition: c2x5wamp.h:124
c2x5wamp_set_gain
uint8_t c2x5wamp_set_gain(c2x5wamp_t *ctx, uint8_t select_gain)
Set gain resistors of the amplifier function.
c2x5wamp_check_input
uint8_t c2x5wamp_check_input(c2x5wamp_t *ctx)
Check input impedance function.
c2x5wamp_cfg_t::gn1
pin_name_t gn1
Definition: c2x5wamp.h:143
c2x5wamp_t::gn1
digital_out_t gn1
Definition: c2x5wamp.h:125
c2x5wamp_t::dia
digital_in_t dia
Definition: c2x5wamp.h:131
c2x5wamp_cfg_t::dia
pin_name_t dia
Definition: c2x5wamp.h:146
c2x5wamp_init
C2X5WAMP_RETVAL c2x5wamp_init(c2x5wamp_t *ctx, c2x5wamp_cfg_t *cfg)
Initialization function.
c2x5wamp_cfg_t
Click configuration structure definition.
Definition: c2x5wamp.h:139
C2X5WAMP_RETVAL
#define C2X5WAMP_RETVAL
Definition: c2x5wamp.h:77
c2x5wamp_default_cfg
void c2x5wamp_default_cfg(c2x5wamp_t *ctx)
Click Default Configuration function.
c2x5wamp_t::stb
digital_out_t stb
Definition: c2x5wamp.h:126
c2x5wamp_set_mode
uint8_t c2x5wamp_set_mode(c2x5wamp_t *ctx, uint8_t select_mode)
Set mode selection of the amplifier function.
c2x5wamp_cfg_t::stb
pin_name_t stb
Definition: c2x5wamp.h:144
c2x5wamp_cfg_t::gn0
pin_name_t gn0
Definition: c2x5wamp.h:142