audioamp6  2.0.0.0
audioamp6.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 AUDIOAMP6_H
36 #define AUDIOAMP6_H
37 
38 #include "drv_digital_out.h"
39 
40 // -------------------------------------------------------------- PUBLIC MACROS
50 #define AUDIOAMP6_MAP_MIKROBUS( cfg, mikrobus ) \
51  cfg.mds= MIKROBUS( mikrobus, MIKROBUS_RST ); \
52  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
53  cfg.gs= MIKROBUS( mikrobus, MIKROBUS_PWM );
54 
60 #define AUDIOAMP6_RETVAL uint8_t
61 
62 #define AUDIOAMP6_OK 0x00
63 #define AUDIOAMP6_INIT_ERROR 0xFF
64 
70 #define AUDIOAMP6_GAIN_20dB 0x00
71 #define AUDIOAMP6_GAIN_26dB 0x01
72 
78 #define AUDIOAMP6_OUTPUT_ENABLE 0x01
79 #define AUDIOAMP6_OUTPUT_DISABLE 0x00
80 
86 #define AUDIOAMP6_MODE_BD 0x00
87 #define AUDIOAMP6_MODE_1SPW 0x01
88  // End group macro
91 // --------------------------------------------------------------- PUBLIC TYPES
100 typedef struct
101 {
102  // Output pins
103 
104  digital_out_t mds;
105  digital_out_t en;
106  digital_out_t gs;
107 
108 } audioamp6_t;
109 
113 typedef struct
114 {
115  // Additional gpio pins
116 
117  pin_name_t mds;
118  pin_name_t en;
119  pin_name_t gs;
120 
122  // End types group
124 
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
145 
154 
165 void audioamp6_set_mode( audioamp6_t *ctx, uint8_t mode );
166 
173 void audioamp6_set_output( audioamp6_t *ctx, uint8_t out );
174 
181 void audioamp6_set_gain( audioamp6_t *ctx, uint8_t gain );
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 #endif // _AUDIOAMP6_H_
187  // End public_function group
190 
191 // ------------------------------------------------------------------------- END
audioamp6_cfg_setup
void audioamp6_cfg_setup(audioamp6_cfg_t *cfg)
Config Object Initialization function.
audioamp6_cfg_t::en
pin_name_t en
Definition: audioamp6.h:118
audioamp6_cfg_t::mds
pin_name_t mds
Definition: audioamp6.h:117
audioamp6_set_mode
void audioamp6_set_mode(audioamp6_t *ctx, uint8_t mode)
Sets mode.
audioamp6_t::en
digital_out_t en
Definition: audioamp6.h:105
audioamp6_set_output
void audioamp6_set_output(audioamp6_t *ctx, uint8_t out)
Enable or Disable output.
audioamp6_t::gs
digital_out_t gs
Definition: audioamp6.h:106
audioamp6_t::mds
digital_out_t mds
Definition: audioamp6.h:104
audioamp6_cfg_t
Click configuration structure definition.
Definition: audioamp6.h:114
audioamp6_cfg_t::gs
pin_name_t gs
Definition: audioamp6.h:119
audioamp6_t
Click ctx object definition.
Definition: audioamp6.h:101
audioamp6_set_gain
void audioamp6_set_gain(audioamp6_t *ctx, uint8_t gain)
Sets Gain.
AUDIOAMP6_RETVAL
#define AUDIOAMP6_RETVAL
Definition: audioamp6.h:60
audioamp6_init
AUDIOAMP6_RETVAL audioamp6_init(audioamp6_t *ctx, audioamp6_cfg_t *cfg)
Initialization function.