audioamp12  2.1.0.0
audioamp12.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 AUDIOAMP12_H
29 #define AUDIOAMP12_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 
71 #define AUDIOAMP12_MAP_MIKROBUS( cfg, mikrobus ) \
72  cfg.stb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
73  cfg.gs = MIKROBUS( mikrobus, MIKROBUS_PWM )
74  // audioamp12_map // audioamp12
77 
82 typedef struct
83 {
84  digital_out_t stb;
85  digital_out_t gs;
87 } audioamp12_t;
88 
93 typedef struct
94 {
95  pin_name_t stb;
96  pin_name_t gs;
99 
104 typedef enum
105 {
107  AUDIOAMP12_ERROR = -1
108 
110 
115 typedef enum
116 {
119 
121 
138 
153 
165 
177 
189 
203 
215 
216 #ifdef __cplusplus
217 }
218 #endif
219 #endif // AUDIOAMP12_H
220  // audioamp12
222 
223 // ------------------------------------------------------------------------ END
audioamp12_init
err_t audioamp12_init(audioamp12_t *ctx, audioamp12_cfg_t *cfg)
AudioAMP 12 initialization function.
audioamp12_cfg_t::stb
pin_name_t stb
Definition: audioamp12.h:95
AUDIOAMP12_ERROR
@ AUDIOAMP12_ERROR
Definition: audioamp12.h:107
audioamp12_default_cfg
void audioamp12_default_cfg(audioamp12_t *ctx)
AudioAMP 12 default configuration function.
AUDIOAMP12_GAIN_12_DB
@ AUDIOAMP12_GAIN_12_DB
Definition: audioamp12.h:118
audioamp12_cfg_t::gs
pin_name_t gs
Definition: audioamp12.h:96
audioamp12_change_gain
void audioamp12_change_gain(audioamp12_t *ctx)
AudioAMP 12 changes the gain function.
audioamp12_t
AudioAMP 12 Click context object.
Definition: audioamp12.h:83
audioamp12_t::gs
digital_out_t gs
Definition: audioamp12.h:85
audioamp12_cfg_setup
void audioamp12_cfg_setup(audioamp12_cfg_t *cfg)
AudioAMP 12 configuration object setup function.
audioamp12_gain_select
void audioamp12_gain_select(audioamp12_t *ctx, audioamp12_gain_select_t sel_gain)
AudioAMP 12 select gain level function.
audioamp12_set_mode_operation
void audioamp12_set_mode_operation(audioamp12_t *ctx)
AudioAMP 12 set operation mode function.
audioamp12_return_value_t
audioamp12_return_value_t
AudioAMP 12 Click return value data.
Definition: audioamp12.h:105
audioamp12_cfg_t
AudioAMP 12 Click configuration object.
Definition: audioamp12.h:94
AUDIOAMP12_GAIN_6_DB
@ AUDIOAMP12_GAIN_6_DB
Definition: audioamp12.h:117
audioamp12_gain_select_t
audioamp12_gain_select_t
AudioAMP 12 Click gain selection value data.
Definition: audioamp12.h:116
audioamp12_set_mode_standby
void audioamp12_set_mode_standby(audioamp12_t *ctx)
AudioAMP 12 set standby mode function.
AUDIOAMP12_OK
@ AUDIOAMP12_OK
Definition: audioamp12.h:106
audioamp12_t::stb
digital_out_t stb
Definition: audioamp12.h:84