adapter 2.0.0.0
adapter.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 ADAPTER_H
36#define ADAPTER_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41#include "drv_spi_master.h"
42
43// -------------------------------------------------------------- PUBLIC MACROS
54#define ADAPTER_MAP_MIKROBUS( cfg, mikrobus ) \
55 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
56 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
57 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
58 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
59 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
60 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
61 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
62 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); \
63 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
64 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX )
71#define ADAPTER_MASTER_I2C 0
72#define ADAPTER_MASTER_SPI 1
79#define ADAPTER_RETVAL uint8_t
80
81#define ADAPTER_OK 0x00
82#define ADAPTER_INIT_ERROR 0xFF
89#define I2C_SLAVE_ADDR_DEMO 0x4C // End group macro
93// --------------------------------------------------------------- PUBLIC TYPES
102typedef uint8_t adapter_select_t;
103
107typedef void ( *adapter_master_io_t )( struct adapter_s*, uint8_t, uint8_t*, uint8_t );
108
112typedef struct adapter_s
113{
114 // Output pins
115
116 digital_out_t cs;
117 digital_out_t pwm;
118 digital_out_t tx_pin;
119 digital_out_t rx_pin;
120
121 // Input pins
122
123 digital_in_t int_pin;
124
125 // Modules
126
127 i2c_master_t i2c;
128 spi_master_t spi;
129
130 // ctx variable
131
132
134 pin_name_t chip_select;
138
140
144typedef struct
145{
146 // Communication gpio pins
147
148 pin_name_t scl;
149 pin_name_t sda;
150 pin_name_t miso;
151 pin_name_t mosi;
152 pin_name_t sck;
153 pin_name_t cs;
154 pin_name_t rx_pin;
155 pin_name_t tx_pin;
156
157 // Additional gpio pins
158
159 pin_name_t pwm;
160 pin_name_t int_pin;
161
162 // static variable
163
164 uint32_t i2c_speed;
165 uint8_t i2c_address;
166
167 uint32_t spi_speed;
168 spi_master_mode_t spi_mode;
169 spi_master_chip_select_polarity_t cs_polarity;
170
172
174 // End types group
176// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
182#ifdef __cplusplus
183extern "C"{
184#endif
185
195
205
216void adapter_generic_write ( adapter_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
217
228void adapter_generic_read ( adapter_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
229
241void adapter_generic_transfer( adapter_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
242
251
260
269
278
287
296
307
308#ifdef __cplusplus
309}
310#endif
311#endif // _ADAPTER_H_
312 // End public_function group
315
316// ------------------------------------------------------------------------- END
#define ADAPTER_RETVAL
Definition: adapter.h:79
uint8_t adapter_check_int(adapter_t *ctx)
Check INT function.
void adapter_cfg_setup(adapter_cfg_t *cfg)
Config Object Initialization function.
void adapter_turn_rx_on(adapter_t *ctx)
Turn RX on function.
void adapter_turn_pwm_off(adapter_t *ctx)
Turn PWM off function.
void adapter_generic_write(adapter_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void adapter_turn_tx_on(adapter_t *ctx)
Turn TX on function.
void adapter_turn_pwm_on(adapter_t *ctx)
Turn PWM on function.
void adapter_generic_transfer(adapter_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
void adapter_turn_tx_off(adapter_t *ctx)
Turn TX off function.
void adapter_generic_read(adapter_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void adapter_turn_rx_off(adapter_t *ctx)
Turn RX off function.
ADAPTER_RETVAL adapter_init(adapter_t *ctx, adapter_cfg_t *cfg)
Initialization function.
struct adapter_s adapter_t
Click ctx object definition.
uint8_t adapter_select_t
Communication type.
Definition: adapter.h:102
void(* adapter_master_io_t)(struct adapter_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: adapter.h:107
Click configuration structure definition.
Definition: adapter.h:145
uint32_t i2c_speed
Definition: adapter.h:164
spi_master_chip_select_polarity_t cs_polarity
Definition: adapter.h:169
pin_name_t sck
Definition: adapter.h:152
spi_master_mode_t spi_mode
Definition: adapter.h:168
pin_name_t tx_pin
Definition: adapter.h:155
pin_name_t mosi
Definition: adapter.h:151
adapter_select_t sel
Definition: adapter.h:171
uint32_t spi_speed
Definition: adapter.h:167
pin_name_t rx_pin
Definition: adapter.h:154
pin_name_t scl
Definition: adapter.h:148
pin_name_t int_pin
Definition: adapter.h:160
pin_name_t pwm
Definition: adapter.h:159
pin_name_t miso
Definition: adapter.h:150
pin_name_t sda
Definition: adapter.h:149
pin_name_t cs
Definition: adapter.h:153
uint8_t i2c_address
Definition: adapter.h:165
Click ctx object definition.
Definition: adapter.h:113
digital_out_t cs
Definition: adapter.h:116
adapter_select_t master_sel
Definition: adapter.h:137
spi_master_t spi
Definition: adapter.h:128
adapter_master_io_t read_f
Definition: adapter.h:136
adapter_master_io_t write_f
Definition: adapter.h:135
digital_out_t pwm
Definition: adapter.h:117
digital_in_t int_pin
Definition: adapter.h:123
i2c_master_t i2c
Definition: adapter.h:127
digital_out_t rx_pin
Definition: adapter.h:119
uint8_t slave_address
Definition: adapter.h:133
digital_out_t tx_pin
Definition: adapter.h:118
pin_name_t chip_select
Definition: adapter.h:134