bt  2.0.0.0
bt.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 BT_H
29 #define BT_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 #include "drv_uart.h"
52 
73 #define BT_MSG_TYPE_COMMAND 0x20
74 #define BT_MSG_TYPE_RESPONSE 0x20
75 #define BT_MSG_TYPE_EVENT 0xA0
76 
81 #define BT_MSG_CLASS_DFU 0x00
82 #define BT_MSG_CLASS_SYSTEM 0x01
83 #define BT_MSG_CLASS_GAP 0x02
84 #define BT_MSG_CLASS_LE_GAP 0x03
85 #define BT_MSG_CLASS_RFCOMM 0x04
86 #define BT_MSG_CLASS_IDENTITY 0x05
87 #define BT_MSG_CLASS_SDP 0x06
88 #define BT_MSG_CLASS_CONNECTION 0x07
89 #define BT_MSG_CLASS_LE_CONNECTION 0x08
90 #define BT_MSG_CLASS_GATT 0x09
91 #define BT_MSG_CLASS_GATT_SERVER 0x0A
92 #define BT_MSG_CLASS_ENDPOINT 0x0B
93 #define BT_MSG_CLASS_HARDWARE 0x0C
94 #define BT_MSG_CLASS_FLASH_PS 0x0D
95 #define BT_MSG_CLASS_TEST 0x0E
96 #define BT_MSG_CLASS_SM 0x0F
97 #define BT_MSG_CLASS_UTIL 0x11
98 #define BT_MSG_CLASS_HID 0x13
99 #define BT_MSG_CLASS_LE_SERIAL 0x14
100 
106 #define BT_MSG_ID_SYSTEM_RESET 0x01
107 #define BT_MSG_ID_SYSTEM_GET_BT_ADDRESS 0x03
108 #define BT_MSG_ID_SYSTEM_GET_CLASS_OF_DEV 0x05
109 #define BT_MSG_ID_SYSTEM_SET_CLASS_OF_DEV 0x06
110 #define BT_MSG_ID_SYSTEM_FACTORY_RESET 0x07
111 #define BT_MSG_ID_SYSTEM_SET_LOCAL_NAME 0x08
112 #define BT_MSG_ID_SYSTEM_GET_LOCAL_NAME 0x09
113 #define BT_MSG_ID_SM_SET_BONDABLE_MODE 0x00
114 #define BT_MSG_ID_SM_DELETE_BONDINGS 0x07
115 #define BT_MSG_ID_GAP_SET_MODE 0x03
116 #define BT_MSG_ID_HARDWARE_CONFIG_GPIO 0x01
117 #define BT_MSG_ID_HARDWARE_WRITE_GPIO 0x02
118 #define BT_MSG_ID_HARDWARE_READ_GPIO 0x03
119 #define BT_MSG_ID_ENDPOINT_SEND_DATA 0x00
120 #define BT_MSG_ID_RFCOMM_START_SERVER 0x01
121 #define BT_MSG_ID_RFCOMM_STOP_SERVER 0x03
122 #define BT_MSG_ID_EVT_ENDPOINT_DATA 0x01
123 #define BT_MSG_ID_EVT_CONNECTION_OPENED 0x00
124 #define BT_MSG_ID_EVT_CONNECTION_CLOSED 0x01
125 #define BT_MSG_ID_EVT_SM_BONDED 0x03
126 #define BT_MSG_ID_EVT_RFCOMM_OPENED 0x00
127 #define BT_MSG_ID_EVT_RFCOMM_MODEM_STATUS 0x01
128 
133 #define BT_SYSTEM_RESET_NORMAL 0x00
134 #define BT_SYSTEM_RESET_BOOT_TO_DFU 0x01
135 
140 #define BT_SM_SET_BONDABLE_NOT_ACCEPTED 0x00
141 #define BT_SM_SET_BONDABLE_ALLOWED 0x01
142 
147 #define BT_GAP_MODE_NOT_CONNECTABLE 0x00
148 #define BT_GAP_MODE_CONNECTABLE 0x01
149 #define BT_GAP_MODE_NOT_DISCOVERABLE 0x00
150 #define BT_GAP_MODE_DISCOVERABLE 0x01
151 #define BT_GAP_MODE_NOT_LIMITED 0x00
152 #define BT_GAP_MODE_LIMITED 0x01
153 
158 #define BT_RFCOMM_SERVER_DEF_SDP_ID 0x02
159 #define BT_RFCOMM_SERVER_DEF_STREAM_DEST 0x00
160 
165 #define BT_HARDWARE_CONFIG_PORT_A 0x00
166 #define BT_HARDWARE_CONFIG_PORT_B 0x01
167 #define BT_HARDWARE_CONFIG_GPIO_FLOAT 0x00
168 #define BT_HARDWARE_CONFIG_GPIO_PULLUP 0x01
169 #define BT_HARDWARE_CONFIG_GPIO_PULLDOWN 0x02
170 #define BT_HARDWARE_CONFIG_GPIO_INPUT 0x00
171 #define BT_HARDWARE_CONFIG_GPIO_OUTPUT 0x01
172 #define BT_HARDWARE_CONFIG_GPIO_FUNCTION 0x02
173 #define BT_HARDWARE_CONFIG_GPIO_ANALOG 0x03
174 #define BT_HARDWARE_BUTTON1_PIN_INDEX 0x08
175 #define BT_HARDWARE_BUTTON2_PIN_INDEX 0x09
176 #define BT_HARDWARE_BUTTON3_PIN_INDEX 0x0A
177 #define BT_HARDWARE_BUTTON4_PIN_INDEX 0x0C
178 #define BT_HARDWARE_BUTTON5_PIN_INDEX 0x0D
179 #define BT_HARDWARE_LED1_PIN_INDEX 0x0E
180 #define BT_HARDWARE_LED2_PIN_INDEX 0x0F
181 #define BT_HARDWARE_BUTTON1_PIN_MASK 0x0100
182 #define BT_HARDWARE_BUTTON2_PIN_MASK 0x0200
183 #define BT_HARDWARE_BUTTON3_PIN_MASK 0x0400
184 #define BT_HARDWARE_BUTTON4_PIN_MASK 0x1000
185 #define BT_HARDWARE_BUTTON5_PIN_MASK 0x2000
186 #define BT_HARDWARE_ALL_BUTTONS_PIN_MASK 0x3700
187 #define BT_HARDWARE_LED1_PIN_MASK 0x4000
188 #define BT_HARDWARE_LED2_PIN_MASK 0x8000
189 #define BT_HARDWARE_ALL_LEDS_PIN_MASK 0xC000
190 
195 #define BT_MAX_PAYLOAD_LEN 0x40
196 
202 #define DRV_BUFFER_SIZE 200
203  // bt_set
205 
220 #define BT_MAP_MIKROBUS( cfg, mikrobus ) \
221  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
222  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
223  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
224  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
225  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
226  cfg.bt0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
227  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
228  // bt_map // bt
231 
236 typedef struct
237 {
238  digital_out_t an;
239  digital_out_t rst;
240  digital_out_t cts;
241  digital_out_t bt0;
243  digital_in_t rts;
245  // Modules
246  uart_t uart;
248  // Buffers
249  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
250  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
252 } bt_t;
253 
258 typedef struct
259 {
260  // Communication gpio pins
261  pin_name_t rx_pin;
262  pin_name_t tx_pin;
264  // Additional gpio pins
265  pin_name_t an;
266  pin_name_t rst;
267  pin_name_t cts;
268  pin_name_t bt0;
269  pin_name_t rts;
271  // Static variable
272  uint32_t baud_rate;
274  uart_data_bits_t data_bit;
275  uart_parity_t parity_bit;
276  uart_stop_bits_t stop_bit;
278 } bt_cfg_t;
279 
284 typedef enum
285 {
286  BT_OK = 0,
287  BT_ERROR = -1
288 
290 
295 typedef struct
296 {
297  uint8_t msg_type;
298  uint8_t payload_len;
299  uint8_t msg_class;
300  uint8_t msg_id;
301  uint8_t payload[ BT_MAX_PAYLOAD_LEN ];
302 
303 } bt_package_t;
304 
320 void bt_cfg_setup ( bt_cfg_t *cfg );
321 
336 err_t bt_init ( bt_t *ctx, bt_cfg_t *cfg );
337 
351 err_t bt_default_cfg ( bt_t *ctx );
352 
366 err_t bt_generic_write ( bt_t *ctx, char *data_buf, uint16_t len );
367 
381 err_t bt_generic_read ( bt_t *ctx, char *data_buf, uint16_t max_len );
382 
392 void bt_set_an_pin ( bt_t *ctx, uint8_t state );
393 
403 void bt_set_rst_pin ( bt_t *ctx, uint8_t state );
404 
414 void bt_set_cts_pin ( bt_t *ctx, uint8_t state );
415 
425 void bt_set_bt0_pin ( bt_t *ctx, uint8_t state );
426 
435 uint8_t bt_get_rts_pin ( bt_t *ctx );
436 
450 err_t bt_send_package ( bt_t *ctx, bt_package_t pkg );
451 
466 err_t bt_read_package ( bt_t *ctx, bt_package_t *pkg );
467 
480 err_t bt_set_local_name ( bt_t *ctx, char *name );
481 
495 err_t bt_set_bondable_mode ( bt_t *ctx, uint8_t mode );
496 
508 err_t bt_delete_bondings ( bt_t *ctx );
509 
522 err_t bt_set_class_of_device ( bt_t *ctx, uint32_t cod );
523 
541 err_t bt_set_gap_mode ( bt_t *ctx, uint8_t connectable, uint8_t discoverable, uint8_t limited );
542 
556 err_t bt_rfcomm_start_server ( bt_t *ctx, uint8_t sdp_id, uint8_t stream_dest );
557 
570 err_t bt_rfcomm_stop_server ( bt_t *ctx, uint8_t sdp_id );
571 
583 err_t bt_factory_reset ( bt_t *ctx );
584 
598 err_t bt_system_reset ( bt_t *ctx, uint8_t mode );
599 
621 err_t bt_hardware_config_gpio ( bt_t *ctx, uint8_t port, uint16_t pin_index, uint8_t mode, uint8_t pullup );
622 
638 err_t bt_hardware_read_gpio ( bt_t *ctx, uint8_t port, uint16_t mask, uint16_t *port_data );
639 
655 err_t bt_hardware_write_gpio ( bt_t *ctx, uint8_t port, uint16_t mask, uint16_t port_data );
656 
671 err_t bt_endpoint_send_data ( bt_t *ctx, uint8_t *endpoint, char *msg );
672 
673 #ifdef __cplusplus
674 }
675 #endif
676 #endif // BT_H
677  // bt
679 
680 // ------------------------------------------------------------------------ END
bt_t::uart
uart_t uart
Definition: bt.h:246
bt_init
err_t bt_init(bt_t *ctx, bt_cfg_t *cfg)
BT initialization function.
bt_set_cts_pin
void bt_set_cts_pin(bt_t *ctx, uint8_t state)
BT set CTS pin function.
bt_hardware_read_gpio
err_t bt_hardware_read_gpio(bt_t *ctx, uint8_t port, uint16_t mask, uint16_t *port_data)
BT hardware read gpio function.
bt_t::cts
digital_out_t cts
Definition: bt.h:240
bt_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: bt.h:276
bt_rfcomm_stop_server
err_t bt_rfcomm_stop_server(bt_t *ctx, uint8_t sdp_id)
BT rfcomm stop server function.
bt_factory_reset
err_t bt_factory_reset(bt_t *ctx)
BT factory reset function.
bt_package_t::msg_id
uint8_t msg_id
Definition: bt.h:300
bt_t::rts
digital_in_t rts
Definition: bt.h:243
bt_read_package
err_t bt_read_package(bt_t *ctx, bt_package_t *pkg)
BT read package function.
BT_ERROR
@ BT_ERROR
Definition: bt.h:287
bt_set_gap_mode
err_t bt_set_gap_mode(bt_t *ctx, uint8_t connectable, uint8_t discoverable, uint8_t limited)
BT set gap mode function.
bt_set_local_name
err_t bt_set_local_name(bt_t *ctx, char *name)
BT set local name function.
bt_set_an_pin
void bt_set_an_pin(bt_t *ctx, uint8_t state)
BT set AN pin function.
bt_delete_bondings
err_t bt_delete_bondings(bt_t *ctx)
BT delete bondings function.
bt_set_rst_pin
void bt_set_rst_pin(bt_t *ctx, uint8_t state)
BT set RST pin function.
bt_system_reset
err_t bt_system_reset(bt_t *ctx, uint8_t mode)
BT system reset function.
bt_cfg_t::rst
pin_name_t rst
Definition: bt.h:266
bt_t::rst
digital_out_t rst
Definition: bt.h:239
bt_cfg_t::cts
pin_name_t cts
Definition: bt.h:267
bt_cfg_t::rx_pin
pin_name_t rx_pin
Definition: bt.h:261
bt_t::bt0
digital_out_t bt0
Definition: bt.h:241
bt_generic_write
err_t bt_generic_write(bt_t *ctx, char *data_buf, uint16_t len)
BT data writing function.
bt_rfcomm_start_server
err_t bt_rfcomm_start_server(bt_t *ctx, uint8_t sdp_id, uint8_t stream_dest)
BT rfcomm start server function.
bt_cfg_t::rts
pin_name_t rts
Definition: bt.h:269
bt_set_bt0_pin
void bt_set_bt0_pin(bt_t *ctx, uint8_t state)
BT set BT0 pin function.
bt_hardware_config_gpio
err_t bt_hardware_config_gpio(bt_t *ctx, uint8_t port, uint16_t pin_index, uint8_t mode, uint8_t pullup)
BT hardware config gpio function.
bt_hardware_write_gpio
err_t bt_hardware_write_gpio(bt_t *ctx, uint8_t port, uint16_t mask, uint16_t port_data)
BT hardware write gpio function.
bt_cfg_t::baud_rate
uint32_t baud_rate
Definition: bt.h:272
bt_default_cfg
err_t bt_default_cfg(bt_t *ctx)
BT default configuration function.
bt_package_t
BT Click packet structure object.
Definition: bt.h:296
BT_OK
@ BT_OK
Definition: bt.h:286
bt_cfg_t::uart_blocking
bool uart_blocking
Definition: bt.h:273
bt_set_bondable_mode
err_t bt_set_bondable_mode(bt_t *ctx, uint8_t mode)
BT set bondable mode function.
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
BT driver buffer size.
Definition: bt.h:202
bt_send_package
err_t bt_send_package(bt_t *ctx, bt_package_t pkg)
BT send package function.
bt_get_rts_pin
uint8_t bt_get_rts_pin(bt_t *ctx)
BT get RTS pin function.
bt_return_value_t
bt_return_value_t
BT Click return value data.
Definition: bt.h:285
bt_cfg_t::an
pin_name_t an
Definition: bt.h:265
bt_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: bt.h:275
bt_package_t::msg_type
uint8_t msg_type
Definition: bt.h:297
bt_package_t::msg_class
uint8_t msg_class
Definition: bt.h:299
bt_cfg_t::bt0
pin_name_t bt0
Definition: bt.h:268
bt_cfg_setup
void bt_cfg_setup(bt_cfg_t *cfg)
BT configuration object setup function.
bt_package_t::payload_len
uint8_t payload_len
Definition: bt.h:298
bt_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: bt.h:274
bt_t
BT Click context object.
Definition: bt.h:237
bt_set_class_of_device
err_t bt_set_class_of_device(bt_t *ctx, uint32_t cod)
BT set class of device function.
BT_MAX_PAYLOAD_LEN
#define BT_MAX_PAYLOAD_LEN
BT payload setting.
Definition: bt.h:195
bt_cfg_t::tx_pin
pin_name_t tx_pin
Definition: bt.h:262
bt_cfg_t
BT Click configuration object.
Definition: bt.h:259
bt_generic_read
err_t bt_generic_read(bt_t *ctx, char *data_buf, uint16_t max_len)
BT data reading function.
bt_t::an
digital_out_t an
Definition: bt.h:238
bt_endpoint_send_data
err_t bt_endpoint_send_data(bt_t *ctx, uint8_t *endpoint, char *msg)
BT endpoint send data function.