ble6  2.0.0.0
ble6.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 BLE6_H
29 #define BLE6_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define BLE6_MODULE_POWER_OFF 0x00
60 #define BLE6_MODULE_POWER_ON 0x01
61 
67 #define BLE6_DRV_BUFFER_SIZE 256
68  // ble6_cmd
70 
85 #define BLE6_MAP_MIKROBUS( cfg, mikrobus ) \
86  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
87  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
88  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
89  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
90  cfg.bl = MIKROBUS( mikrobus, MIKROBUS_PWM )
91  // ble6_map // ble6
94 
99 typedef struct
100 {
101  // Output pins
102  digital_out_t rst;
103  digital_out_t bl;
105  // Input pins
106  digital_in_t an;
108  // Modules
109  uart_t uart;
111  // Buffers
112  uint8_t uart_rx_buffer[ BLE6_DRV_BUFFER_SIZE ];
113  uint8_t uart_tx_buffer[ BLE6_DRV_BUFFER_SIZE ];
115 } ble6_t;
116 
121 typedef struct
122 {
123  // Communication gpio pins
124  pin_name_t rx_pin;
125  pin_name_t tx_pin;
127  // Additional gpio pins
128  pin_name_t an;
129  pin_name_t rst;
130  pin_name_t bl;
132  // Static variable
133  uint32_t baud_rate;
135  uart_data_bits_t data_bit;
136  uart_parity_t parity_bit;
137  uart_stop_bits_t stop_bit;
139 } ble6_cfg_t;
140 
145 typedef struct
146 {
147  uint8_t event_code;
148  uint8_t length;
149  uint8_t num_hci_cmd;
150  uint16_t cmd_opcode;
151  uint8_t status;
152  uint8_t payload[ BLE6_DRV_BUFFER_SIZE ];
153 
154 } ble6_rsp_t;
155 
160 typedef struct
161 {
162  uint8_t le_event_code;
163  uint8_t le_length;
165  uint8_t le_status;
166  uint16_t le_conn_hdl;
167  uint8_t le_role;
169  uint8_t le_peer_addr[ 6 ];
171  uint16_t le_conn_latency;
172  uint16_t le_sup_timeout;
174 
176 
181 typedef struct
182 {
183  uint8_t event_code;
184  uint8_t length;
185  uint16_t e_code;
186  uint16_t conn_hdl;
187  uint16_t attr_hdl;
188  uint16_t offset;
189  uint16_t attr_data_len;
190  uint8_t attr_data[ 255 ];
191 
192 } ble6_rx_rsp_t;
193 
198 typedef enum
199 {
200  BLE6_OK = 0,
201  BLE6_ERROR = -1
202 
204 
215 typedef void ( *ble6_handler_t )( uint8_t *message_buf, uint32_t message_len );
216 
221 typedef void ( *ble6_hdl_t )( uint8_t* );
222 
233 
247 err_t ble6_init ( ble6_t *ctx, ble6_cfg_t *cfg );
248 
261 err_t ble6_generic_write ( ble6_t *ctx, char *data_buf, uint16_t len );
262 
275 err_t ble6_generic_read ( ble6_t *ctx, char *data_buf, uint16_t max_len );
276 
287 int8_t ble6_strncmp ( uint8_t *string1, uint8_t *string2, uint8_t len );
288 
296 uint8_t ble6_byte_ready ( ble6_t *ctx );
297 
309 void ble6_power_on ( ble6_t *ctx, uint8_t en_pwr );
310 
322 void ble6_send_command ( ble6_t *ctx, uint8_t *tx_data, uint8_t n_bytes );
323 
330 void ble6_set_response_handler ( void ( *handler )( uint8_t* ), ble6_hdl_t driver_hdl );
331 
339 void ble6_set_handlers ( ble6_handler_t event_handler, ble6_handler_t eve_hdlr );
340 
349 void ble6_parser_rsp ( ble6_t *ctx, ble6_rsp_t *response );
350 
351 #ifdef __cplusplus
352 }
353 #endif
354 #endif // BLE6_H
355  // ble6
357 
358 // ------------------------------------------------------------------------ END
ble6_le_meta_event_t::le_conn_latency
uint16_t le_conn_latency
Definition: ble6.h:171
ble6_byte_ready
uint8_t ble6_byte_ready(ble6_t *ctx)
Check for new byte received.
ble6_return_value_t
ble6_return_value_t
BLE 6 Click return value data.
Definition: ble6.h:199
ble6_le_meta_event_t::le_length
uint8_t le_length
Definition: ble6.h:163
ble6_cfg_t::uart_blocking
bool uart_blocking
Definition: ble6.h:134
ble6_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ble6.h:125
ble6_parser_rsp
void ble6_parser_rsp(ble6_t *ctx, ble6_rsp_t *response)
Response parser function.
ble6_cfg_t::an
pin_name_t an
Definition: ble6.h:128
ble6_rx_rsp_t::attr_hdl
uint16_t attr_hdl
Definition: ble6.h:187
ble6_set_response_handler
void ble6_set_response_handler(void(*handler)(uint8_t *), ble6_hdl_t driver_hdl)
Set response handlers function.
ble6_t::bl
digital_out_t bl
Definition: ble6.h:103
ble6_hdl_t
void(* ble6_hdl_t)(uint8_t *)
BLE 6 Click driver handler.
Definition: ble6.h:221
ble6_le_meta_event_t::le_peer_addr_type
uint8_t le_peer_addr_type
Definition: ble6.h:168
ble6_le_meta_event_t::le_status
uint8_t le_status
Definition: ble6.h:165
ble6_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ble6.h:124
ble6_handler_t
void(* ble6_handler_t)(uint8_t *message_buf, uint32_t message_len)
BLE 6 Click driver handler.
Definition: ble6.h:215
ble6_rx_rsp_t::offset
uint16_t offset
Definition: ble6.h:188
ble6_cfg_t::baud_rate
uint32_t baud_rate
Definition: ble6.h:133
ble6_cfg_t::bl
pin_name_t bl
Definition: ble6.h:130
ble6_le_meta_event_t::le_master_clk_accuracy
uint8_t le_master_clk_accuracy
Definition: ble6.h:173
ble6_rx_rsp_t::length
uint8_t length
Definition: ble6.h:184
ble6_le_meta_event_t::le_subevent_code
uint8_t le_subevent_code
Definition: ble6.h:164
ble6_cfg_t
BLE 6 Click configuration object.
Definition: ble6.h:122
ble6_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ble6.h:136
ble6_init
err_t ble6_init(ble6_t *ctx, ble6_cfg_t *cfg)
BLE 6 initialization function.
ble6_rx_rsp_t::event_code
uint8_t event_code
Definition: ble6.h:183
ble6_t
BLE 6 Click context object.
Definition: ble6.h:100
ble6_generic_write
err_t ble6_generic_write(ble6_t *ctx, char *data_buf, uint16_t len)
BLE 6 data writing function.
ble6_le_meta_event_t
Driver Response Le Meta Event.
Definition: ble6.h:161
ble6_power_on
void ble6_power_on(ble6_t *ctx, uint8_t en_pwr)
Set Power On function.
ble6_t::uart
uart_t uart
Definition: ble6.h:109
ble6_rx_rsp_t::e_code
uint16_t e_code
Definition: ble6.h:185
ble6_t::rst
digital_out_t rst
Definition: ble6.h:102
ble6_cfg_t::rst
pin_name_t rst
Definition: ble6.h:129
ble6_rsp_t::length
uint8_t length
Definition: ble6.h:148
ble6_strncmp
int8_t ble6_strncmp(uint8_t *string1, uint8_t *string2, uint8_t len)
Lexicographically compares function.
ble6_le_meta_event_t::le_event_code
uint8_t le_event_code
Definition: ble6.h:162
ble6_le_meta_event_t::le_sup_timeout
uint16_t le_sup_timeout
Definition: ble6.h:172
ble6_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ble6.h:135
ble6_rsp_t::status
uint8_t status
Definition: ble6.h:151
BLE6_DRV_BUFFER_SIZE
#define BLE6_DRV_BUFFER_SIZE
BLE 6 driver buffer size.
Definition: ble6.h:67
ble6_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ble6.h:137
ble6_le_meta_event_t::le_role
uint8_t le_role
Definition: ble6.h:167
ble6_cfg_setup
void ble6_cfg_setup(ble6_cfg_t *cfg)
BLE 6 configuration object setup function.
ble6_rsp_t
Driver Default Response type.
Definition: ble6.h:146
ble6_le_meta_event_t::le_conn_interval
uint16_t le_conn_interval
Definition: ble6.h:170
ble6_rx_rsp_t::attr_data_len
uint16_t attr_data_len
Definition: ble6.h:189
BLE6_ERROR
@ BLE6_ERROR
Definition: ble6.h:201
ble6_rx_rsp_t
Driver Response type.
Definition: ble6.h:182
ble6_t::an
digital_in_t an
Definition: ble6.h:106
ble6_send_command
void ble6_send_command(ble6_t *ctx, uint8_t *tx_data, uint8_t n_bytes)
Send command function.
ble6_rsp_t::num_hci_cmd
uint8_t num_hci_cmd
Definition: ble6.h:149
BLE6_OK
@ BLE6_OK
Definition: ble6.h:200
ble6_rsp_t::event_code
uint8_t event_code
Definition: ble6.h:147
ble6_generic_read
err_t ble6_generic_read(ble6_t *ctx, char *data_buf, uint16_t max_len)
BLE 6 data reading function.
ble6_rx_rsp_t::conn_hdl
uint16_t conn_hdl
Definition: ble6.h:186
ble6_rsp_t::cmd_opcode
uint16_t cmd_opcode
Definition: ble6.h:150
ble6_le_meta_event_t::le_conn_hdl
uint16_t le_conn_hdl
Definition: ble6.h:166
ble6_set_handlers
void ble6_set_handlers(ble6_handler_t event_handler, ble6_handler_t eve_hdlr)
Set handlers function.