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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define BT_MSG_TYPE_COMMAND 0x20
60 #define BT_MSG_TYPE_RESPONSE 0x20
61 #define BT_MSG_TYPE_EVENT 0xA0
62 
67 #define BT_MSG_CLASS_DFU 0x00
68 #define BT_MSG_CLASS_SYSTEM 0x01
69 #define BT_MSG_CLASS_GAP 0x02
70 #define BT_MSG_CLASS_LE_GAP 0x03
71 #define BT_MSG_CLASS_RFCOMM 0x04
72 #define BT_MSG_CLASS_IDENTITY 0x05
73 #define BT_MSG_CLASS_SDP 0x06
74 #define BT_MSG_CLASS_CONNECTION 0x07
75 #define BT_MSG_CLASS_LE_CONNECTION 0x08
76 #define BT_MSG_CLASS_GATT 0x09
77 #define BT_MSG_CLASS_GATT_SERVER 0x0A
78 #define BT_MSG_CLASS_ENDPOINT 0x0B
79 #define BT_MSG_CLASS_HARDWARE 0x0C
80 #define BT_MSG_CLASS_FLASH_PS 0x0D
81 #define BT_MSG_CLASS_TEST 0x0E
82 #define BT_MSG_CLASS_SM 0x0F
83 #define BT_MSG_CLASS_UTIL 0x11
84 #define BT_MSG_CLASS_HID 0x13
85 #define BT_MSG_CLASS_LE_SERIAL 0x14
86 
92 #define BT_MSG_ID_SYSTEM_RESET 0x01
93 #define BT_MSG_ID_SYSTEM_GET_BT_ADDRESS 0x03
94 #define BT_MSG_ID_SYSTEM_GET_CLASS_OF_DEV 0x05
95 #define BT_MSG_ID_SYSTEM_SET_CLASS_OF_DEV 0x06
96 #define BT_MSG_ID_SYSTEM_FACTORY_RESET 0x07
97 #define BT_MSG_ID_SYSTEM_SET_LOCAL_NAME 0x08
98 #define BT_MSG_ID_SYSTEM_GET_LOCAL_NAME 0x09
99 #define BT_MSG_ID_SM_SET_BONDABLE_MODE 0x00
100 #define BT_MSG_ID_SM_DELETE_BONDINGS 0x07
101 #define BT_MSG_ID_GAP_SET_MODE 0x03
102 #define BT_MSG_ID_HARDWARE_CONFIG_GPIO 0x01
103 #define BT_MSG_ID_HARDWARE_WRITE_GPIO 0x02
104 #define BT_MSG_ID_HARDWARE_READ_GPIO 0x03
105 #define BT_MSG_ID_ENDPOINT_SEND_DATA 0x00
106 #define BT_MSG_ID_RFCOMM_START_SERVER 0x01
107 #define BT_MSG_ID_RFCOMM_STOP_SERVER 0x03
108 #define BT_MSG_ID_EVT_ENDPOINT_DATA 0x01
109 #define BT_MSG_ID_EVT_CONNECTION_OPENED 0x00
110 #define BT_MSG_ID_EVT_CONNECTION_CLOSED 0x01
111 #define BT_MSG_ID_EVT_SM_BONDED 0x03
112 #define BT_MSG_ID_EVT_RFCOMM_OPENED 0x00
113 #define BT_MSG_ID_EVT_RFCOMM_MODEM_STATUS 0x01
114 
119 #define BT_SYSTEM_RESET_NORMAL 0x00
120 #define BT_SYSTEM_RESET_BOOT_TO_DFU 0x01
121 
126 #define BT_SM_SET_BONDABLE_NOT_ACCEPTED 0x00
127 #define BT_SM_SET_BONDABLE_ALLOWED 0x01
128 
133 #define BT_GAP_MODE_NOT_CONNECTABLE 0x00
134 #define BT_GAP_MODE_CONNECTABLE 0x01
135 #define BT_GAP_MODE_NOT_DISCOVERABLE 0x00
136 #define BT_GAP_MODE_DISCOVERABLE 0x01
137 #define BT_GAP_MODE_NOT_LIMITED 0x00
138 #define BT_GAP_MODE_LIMITED 0x01
139 
144 #define BT_RFCOMM_SERVER_DEF_SDP_ID 0x02
145 #define BT_RFCOMM_SERVER_DEF_STREAM_DEST 0x00
146 
151 #define BT_HARDWARE_CONFIG_PORT_A 0x00
152 #define BT_HARDWARE_CONFIG_PORT_B 0x01
153 #define BT_HARDWARE_CONFIG_GPIO_FLOAT 0x00
154 #define BT_HARDWARE_CONFIG_GPIO_PULLUP 0x01
155 #define BT_HARDWARE_CONFIG_GPIO_PULLDOWN 0x02
156 #define BT_HARDWARE_CONFIG_GPIO_INPUT 0x00
157 #define BT_HARDWARE_CONFIG_GPIO_OUTPUT 0x01
158 #define BT_HARDWARE_CONFIG_GPIO_FUNCTION 0x02
159 #define BT_HARDWARE_CONFIG_GPIO_ANALOG 0x03
160 #define BT_HARDWARE_BUTTON1_PIN_INDEX 0x08
161 #define BT_HARDWARE_BUTTON2_PIN_INDEX 0x09
162 #define BT_HARDWARE_BUTTON3_PIN_INDEX 0x0A
163 #define BT_HARDWARE_BUTTON4_PIN_INDEX 0x0C
164 #define BT_HARDWARE_BUTTON5_PIN_INDEX 0x0D
165 #define BT_HARDWARE_LED1_PIN_INDEX 0x0E
166 #define BT_HARDWARE_LED2_PIN_INDEX 0x0F
167 #define BT_HARDWARE_BUTTON1_PIN_MASK 0x0100
168 #define BT_HARDWARE_BUTTON2_PIN_MASK 0x0200
169 #define BT_HARDWARE_BUTTON3_PIN_MASK 0x0400
170 #define BT_HARDWARE_BUTTON4_PIN_MASK 0x1000
171 #define BT_HARDWARE_BUTTON5_PIN_MASK 0x2000
172 #define BT_HARDWARE_ALL_BUTTONS_PIN_MASK 0x3700
173 #define BT_HARDWARE_LED1_PIN_MASK 0x4000
174 #define BT_HARDWARE_LED2_PIN_MASK 0x8000
175 #define BT_HARDWARE_ALL_LEDS_PIN_MASK 0xC000
176 
181 #define BT_MAX_PAYLOAD_LEN 0x40
182 
188 #define DRV_BUFFER_SIZE 200
189  // bt_set
191 
206 #define BT_MAP_MIKROBUS( cfg, mikrobus ) \
207  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
208  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
209  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
210  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
211  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
212  cfg.bt0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
213  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
214  // bt_map // bt
217 
222 typedef struct
223 {
224  digital_out_t an;
225  digital_out_t rst;
226  digital_out_t cts;
227  digital_out_t bt0;
229  digital_in_t rts;
231  // Modules
232  uart_t uart;
234  // Buffers
235  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
236  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
238 } bt_t;
239 
244 typedef struct
245 {
246  // Communication gpio pins
247  pin_name_t rx_pin;
248  pin_name_t tx_pin;
250  // Additional gpio pins
251  pin_name_t an;
252  pin_name_t rst;
253  pin_name_t cts;
254  pin_name_t bt0;
255  pin_name_t rts;
257  // Static variable
258  uint32_t baud_rate;
260  uart_data_bits_t data_bit;
261  uart_parity_t parity_bit;
262  uart_stop_bits_t stop_bit;
264 } bt_cfg_t;
265 
270 typedef enum
271 {
272  BT_OK = 0,
273  BT_ERROR = -1
274 
276 
281 typedef struct
282 {
283  uint8_t msg_type;
284  uint8_t payload_len;
285  uint8_t msg_class;
286  uint8_t msg_id;
287  uint8_t payload[ BT_MAX_PAYLOAD_LEN ];
288 
289 } bt_package_t;
290 
306 void bt_cfg_setup ( bt_cfg_t *cfg );
307 
322 err_t bt_init ( bt_t *ctx, bt_cfg_t *cfg );
323 
337 err_t bt_default_cfg ( bt_t *ctx );
338 
352 err_t bt_generic_write ( bt_t *ctx, char *data_buf, uint16_t len );
353 
367 err_t bt_generic_read ( bt_t *ctx, char *data_buf, uint16_t max_len );
368 
378 void bt_set_an_pin ( bt_t *ctx, uint8_t state );
379 
389 void bt_set_rst_pin ( bt_t *ctx, uint8_t state );
390 
400 void bt_set_cts_pin ( bt_t *ctx, uint8_t state );
401 
411 void bt_set_bt0_pin ( bt_t *ctx, uint8_t state );
412 
421 uint8_t bt_get_rts_pin ( bt_t *ctx );
422 
436 err_t bt_send_package ( bt_t *ctx, bt_package_t pkg );
437 
452 err_t bt_read_package ( bt_t *ctx, bt_package_t *pkg );
453 
466 err_t bt_set_local_name ( bt_t *ctx, char *name );
467 
481 err_t bt_set_bondable_mode ( bt_t *ctx, uint8_t mode );
482 
494 err_t bt_delete_bondings ( bt_t *ctx );
495 
508 err_t bt_set_class_of_device ( bt_t *ctx, uint32_t cod );
509 
527 err_t bt_set_gap_mode ( bt_t *ctx, uint8_t connectable, uint8_t discoverable, uint8_t limited );
528 
542 err_t bt_rfcomm_start_server ( bt_t *ctx, uint8_t sdp_id, uint8_t stream_dest );
543 
556 err_t bt_rfcomm_stop_server ( bt_t *ctx, uint8_t sdp_id );
557 
569 err_t bt_factory_reset ( bt_t *ctx );
570 
584 err_t bt_system_reset ( bt_t *ctx, uint8_t mode );
585 
607 err_t bt_hardware_config_gpio ( bt_t *ctx, uint8_t port, uint16_t pin_index, uint8_t mode, uint8_t pullup );
608 
624 err_t bt_hardware_read_gpio ( bt_t *ctx, uint8_t port, uint16_t mask, uint16_t *port_data );
625 
641 err_t bt_hardware_write_gpio ( bt_t *ctx, uint8_t port, uint16_t mask, uint16_t port_data );
642 
657 err_t bt_endpoint_send_data ( bt_t *ctx, uint8_t *endpoint, char *msg );
658 
659 #ifdef __cplusplus
660 }
661 #endif
662 #endif // BT_H
663  // bt
665 
666 // ------------------------------------------------------------------------ END
bt_t::uart
uart_t uart
Definition: bt.h:232
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:226
bt_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: bt.h:262
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:286
bt_t::rts
digital_in_t rts
Definition: bt.h:229
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:273
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:252
bt_t::rst
digital_out_t rst
Definition: bt.h:225
bt_cfg_t::cts
pin_name_t cts
Definition: bt.h:253
bt_cfg_t::rx_pin
pin_name_t rx_pin
Definition: bt.h:247
bt_t::bt0
digital_out_t bt0
Definition: bt.h:227
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:255
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:258
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:282
BT_OK
@ BT_OK
Definition: bt.h:272
bt_cfg_t::uart_blocking
bool uart_blocking
Definition: bt.h:259
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:188
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:271
bt_cfg_t::an
pin_name_t an
Definition: bt.h:251
bt_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: bt.h:261
bt_package_t::msg_type
uint8_t msg_type
Definition: bt.h:283
bt_package_t::msg_class
uint8_t msg_class
Definition: bt.h:285
bt_cfg_t::bt0
pin_name_t bt0
Definition: bt.h:254
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:284
bt_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: bt.h:260
bt_t
BT Click context object.
Definition: bt.h:223
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:181
bt_cfg_t::tx_pin
pin_name_t tx_pin
Definition: bt.h:248
bt_cfg_t
BT Click configuration object.
Definition: bt.h:245
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:224
bt_endpoint_send_data
err_t bt_endpoint_send_data(bt_t *ctx, uint8_t *endpoint, char *msg)
BT endpoint send data function.