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 
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 
67 #define AUDIOAMP12_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.stb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
69  cfg.gs = MIKROBUS( mikrobus, MIKROBUS_PWM )
70  // audioamp12_map // audioamp12
73 
78 typedef struct
79 {
80  digital_out_t stb;
81  digital_out_t gs;
83 } audioamp12_t;
84 
89 typedef struct
90 {
91  pin_name_t stb;
92  pin_name_t gs;
95 
100 typedef enum
101 {
103  AUDIOAMP12_ERROR = -1
104 
106 
111 typedef enum
112 {
115 
117 
134 
149 
161 
173 
185 
199 
211 
212 #ifdef __cplusplus
213 }
214 #endif
215 #endif // AUDIOAMP12_H
216  // audioamp12
218 
219 // ------------------------------------------------------------------------ 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:91
AUDIOAMP12_ERROR
@ AUDIOAMP12_ERROR
Definition: audioamp12.h:103
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:114
audioamp12_cfg_t::gs
pin_name_t gs
Definition: audioamp12.h:92
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:79
audioamp12_t::gs
digital_out_t gs
Definition: audioamp12.h:81
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:101
audioamp12_cfg_t
AudioAMP 12 Click configuration object.
Definition: audioamp12.h:90
AUDIOAMP12_GAIN_6_DB
@ AUDIOAMP12_GAIN_6_DB
Definition: audioamp12.h:113
audioamp12_gain_select_t
audioamp12_gain_select_t
AudioAMP 12 Click gain selection value data.
Definition: audioamp12.h:112
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:102
audioamp12_t::stb
digital_out_t stb
Definition: audioamp12.h:80