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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37
53#define HEADPHONEAMP3_ENABLE 0x01
54#define HEADPHONEAMP3_DISABLE 0x00
55 // headphoneamp3_set
57
72#define HEADPHONEAMP3_MAP_MIKROBUS( cfg, mikrobus ) \
73 cfg.enp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
74 cfg.ena = MIKROBUS( mikrobus, MIKROBUS_PWM )
75 // headphoneamp3_map // headphoneamp3
78
83typedef struct
84{
85 digital_out_t enp;
86 digital_out_t ena;
89
94typedef struct
95{
96 pin_name_t enp;
97 pin_name_t ena;
100
105typedef enum
106{
109
111
128
143
155
166void headphoneamp3_enable_power ( headphoneamp3_t *ctx, uint8_t state );
167
178void headphoneamp3_enable_amp ( headphoneamp3_t *ctx, uint8_t state );
179
180#ifdef __cplusplus
181}
182#endif
183#endif // HEADPHONEAMP3_H
184 // headphoneamp3
186
187// ------------------------------------------------------------------------ END
err_t headphoneamp3_init(headphoneamp3_t *ctx, headphoneamp3_cfg_t *cfg)
Headphone AMP 3 initialization function.
void headphoneamp3_enable_amp(headphoneamp3_t *ctx, uint8_t state)
Headphone AMP 3 amp pin setting function.
void headphoneamp3_cfg_setup(headphoneamp3_cfg_t *cfg)
Headphone AMP 3 configuration object setup function.
void headphoneamp3_default_cfg(headphoneamp3_t *ctx)
Headphone AMP 3 default configuration function.
void headphoneamp3_enable_power(headphoneamp3_t *ctx, uint8_t state)
Headphone AMP 3 power pin setting function.
headphoneamp3_return_value_t
Headphone AMP 3 Click return value data.
Definition: headphoneamp3.h:106
@ HEADPHONEAMP3_ERROR
Definition: headphoneamp3.h:108
@ HEADPHONEAMP3_OK
Definition: headphoneamp3.h:107
Headphone AMP 3 Click configuration object.
Definition: headphoneamp3.h:95
pin_name_t ena
Definition: headphoneamp3.h:97
pin_name_t enp
Definition: headphoneamp3.h:96
Headphone AMP 3 Click context object.
Definition: headphoneamp3.h:84
digital_out_t enp
Definition: headphoneamp3.h:85
digital_out_t ena
Definition: headphoneamp3.h:86