headphoneamp3  2.1.0.0
headphoneamp3.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 HEADPHONEAMP3_H
29 #define HEADPHONEAMP3_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 #include "drv_digital_in.h"
51 
67 #define HEADPHONEAMP3_ENABLE 0x01
68 #define HEADPHONEAMP3_DISABLE 0x00
69  // headphoneamp3_set
71 
86 #define HEADPHONEAMP3_MAP_MIKROBUS( cfg, mikrobus ) \
87  cfg.enp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
88  cfg.ena = MIKROBUS( mikrobus, MIKROBUS_PWM )
89  // headphoneamp3_map // headphoneamp3
92 
97 typedef struct
98 {
99  digital_out_t enp;
100  digital_out_t ena;
103 
108 typedef struct
109 {
110  pin_name_t enp;
111  pin_name_t ena;
114 
119 typedef enum
120 {
123 
125 
142 
157 
169 
180 void headphoneamp3_enable_power ( headphoneamp3_t *ctx, uint8_t state );
181 
192 void headphoneamp3_enable_amp ( headphoneamp3_t *ctx, uint8_t state );
193 
194 #ifdef __cplusplus
195 }
196 #endif
197 #endif // HEADPHONEAMP3_H
198  // headphoneamp3
200 
201 // ------------------------------------------------------------------------ END
HEADPHONEAMP3_OK
@ HEADPHONEAMP3_OK
Definition: headphoneamp3.h:121
headphoneamp3_t::ena
digital_out_t ena
Definition: headphoneamp3.h:100
headphoneamp3_cfg_t::ena
pin_name_t ena
Definition: headphoneamp3.h:111
headphoneamp3_return_value_t
headphoneamp3_return_value_t
Headphone AMP 3 Click return value data.
Definition: headphoneamp3.h:120
headphoneamp3_cfg_t
Headphone AMP 3 Click configuration object.
Definition: headphoneamp3.h:109
headphoneamp3_enable_amp
void headphoneamp3_enable_amp(headphoneamp3_t *ctx, uint8_t state)
Headphone AMP 3 amp pin setting function.
headphoneamp3_enable_power
void headphoneamp3_enable_power(headphoneamp3_t *ctx, uint8_t state)
Headphone AMP 3 power pin setting function.
headphoneamp3_t
Headphone AMP 3 Click context object.
Definition: headphoneamp3.h:98
HEADPHONEAMP3_ERROR
@ HEADPHONEAMP3_ERROR
Definition: headphoneamp3.h:122
headphoneamp3_init
err_t headphoneamp3_init(headphoneamp3_t *ctx, headphoneamp3_cfg_t *cfg)
Headphone AMP 3 initialization function.
headphoneamp3_t::enp
digital_out_t enp
Definition: headphoneamp3.h:99
headphoneamp3_cfg_setup
void headphoneamp3_cfg_setup(headphoneamp3_cfg_t *cfg)
Headphone AMP 3 configuration object setup function.
headphoneamp3_cfg_t::enp
pin_name_t enp
Definition: headphoneamp3.h:110
headphoneamp3_default_cfg
void headphoneamp3_default_cfg(headphoneamp3_t *ctx)
Headphone AMP 3 default configuration function.