audioxover 2.0.0.0
audioxover.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 AUDIOXOVER_H
36#define AUDIOXOVER_H
37
38#include "drv_digital_out.h"
39
40// -------------------------------------------------------------- PUBLIC MACROS
50#define AUDIOXOVER_MAP_MIKROBUS( cfg, mikrobus ) \
51 cfg.sdn = MIKROBUS( mikrobus, MIKROBUS_CS )
58#define AUDIOXOVER_RETVAL uint8_t
59
60#define AUDIOXOVER_OK 0x00
61#define AUDIOXOVER_INIT_ERROR 0xFF
68#define AUDIOXOVER_ENABLE 0
69#define AUDIOXOVER_DISABLE 1 // End group macro
73// --------------------------------------------------------------- PUBLIC TYPES
82typedef struct
83{
84 // Output pins
85
86 digital_out_t sdn;
87
89
93typedef struct
94{
95 // Additional gpio pins
96
97 pin_name_t sdn;
98
100 // End types group
102// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
103
109#ifdef __cplusplus
110extern "C"{
111#endif
112
122
131
140
149
150#ifdef __cplusplus
151}
152#endif
153#endif // _AUDIOXOVER_H_
154 // End public_function group
157
158// ------------------------------------------------------------------------- END
#define AUDIOXOVER_RETVAL
Definition: audioxover.h:58
void audioxover_cfg_setup(audioxover_cfg_t *cfg)
Config Object Initialization function.
void audioxover_power_on(audioxover_t *ctx)
Device power on function.
void audioxover_shut_down(audioxover_t *ctx)
Device shut down function.
AUDIOXOVER_RETVAL audioxover_init(audioxover_t *ctx, audioxover_cfg_t *cfg)
Initialization function.
Click configuration structure definition.
Definition: audioxover.h:94
pin_name_t sdn
Definition: audioxover.h:97
Click ctx object definition.
Definition: audioxover.h:83
digital_out_t sdn
Definition: audioxover.h:86