bt.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef BT_H
#define BT_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define BT_MSG_TYPE_COMMAND                 0x20
#define BT_MSG_TYPE_RESPONSE                0x20
#define BT_MSG_TYPE_EVENT                   0xA0
 
#define BT_MSG_CLASS_DFU                    0x00
#define BT_MSG_CLASS_SYSTEM                 0x01
#define BT_MSG_CLASS_GAP                    0x02
#define BT_MSG_CLASS_LE_GAP                 0x03
#define BT_MSG_CLASS_RFCOMM                 0x04
#define BT_MSG_CLASS_IDENTITY               0x05
#define BT_MSG_CLASS_SDP                    0x06
#define BT_MSG_CLASS_CONNECTION             0x07
#define BT_MSG_CLASS_LE_CONNECTION          0x08
#define BT_MSG_CLASS_GATT                   0x09
#define BT_MSG_CLASS_GATT_SERVER            0x0A
#define BT_MSG_CLASS_ENDPOINT               0x0B
#define BT_MSG_CLASS_HARDWARE               0x0C
#define BT_MSG_CLASS_FLASH_PS               0x0D
#define BT_MSG_CLASS_TEST                   0x0E
#define BT_MSG_CLASS_SM                     0x0F
#define BT_MSG_CLASS_UTIL                   0x11
#define BT_MSG_CLASS_HID                    0x13
#define BT_MSG_CLASS_LE_SERIAL              0x14
 
#define BT_MSG_ID_SYSTEM_RESET              0x01
#define BT_MSG_ID_SYSTEM_GET_BT_ADDRESS     0x03
#define BT_MSG_ID_SYSTEM_GET_CLASS_OF_DEV   0x05
#define BT_MSG_ID_SYSTEM_SET_CLASS_OF_DEV   0x06
#define BT_MSG_ID_SYSTEM_FACTORY_RESET      0x07
#define BT_MSG_ID_SYSTEM_SET_LOCAL_NAME     0x08
#define BT_MSG_ID_SYSTEM_GET_LOCAL_NAME     0x09
#define BT_MSG_ID_SM_SET_BONDABLE_MODE      0x00
#define BT_MSG_ID_SM_DELETE_BONDINGS        0x07
#define BT_MSG_ID_GAP_SET_MODE              0x03
#define BT_MSG_ID_HARDWARE_CONFIG_GPIO      0x01
#define BT_MSG_ID_HARDWARE_WRITE_GPIO       0x02
#define BT_MSG_ID_HARDWARE_READ_GPIO        0x03
#define BT_MSG_ID_ENDPOINT_SEND_DATA        0x00
#define BT_MSG_ID_RFCOMM_START_SERVER       0x01
#define BT_MSG_ID_RFCOMM_STOP_SERVER        0x03
#define BT_MSG_ID_EVT_ENDPOINT_DATA         0x01
#define BT_MSG_ID_EVT_CONNECTION_OPENED     0x00
#define BT_MSG_ID_EVT_CONNECTION_CLOSED     0x01
#define BT_MSG_ID_EVT_SM_BONDED             0x03
#define BT_MSG_ID_EVT_RFCOMM_OPENED         0x00
#define BT_MSG_ID_EVT_RFCOMM_MODEM_STATUS   0x01
 
#define BT_SYSTEM_RESET_NORMAL              0x00
#define BT_SYSTEM_RESET_BOOT_TO_DFU         0x01
 
#define BT_SM_SET_BONDABLE_NOT_ACCEPTED     0x00
#define BT_SM_SET_BONDABLE_ALLOWED          0x01
 
#define BT_GAP_MODE_NOT_CONNECTABLE         0x00
#define BT_GAP_MODE_CONNECTABLE             0x01
#define BT_GAP_MODE_NOT_DISCOVERABLE        0x00
#define BT_GAP_MODE_DISCOVERABLE            0x01
#define BT_GAP_MODE_NOT_LIMITED             0x00
#define BT_GAP_MODE_LIMITED                 0x01
 
#define BT_RFCOMM_SERVER_DEF_SDP_ID         0x02
#define BT_RFCOMM_SERVER_DEF_STREAM_DEST    0x00
 
#define BT_HARDWARE_CONFIG_PORT_A           0x00
#define BT_HARDWARE_CONFIG_PORT_B           0x01
#define BT_HARDWARE_CONFIG_GPIO_FLOAT       0x00
#define BT_HARDWARE_CONFIG_GPIO_PULLUP      0x01
#define BT_HARDWARE_CONFIG_GPIO_PULLDOWN    0x02
#define BT_HARDWARE_CONFIG_GPIO_INPUT       0x00
#define BT_HARDWARE_CONFIG_GPIO_OUTPUT      0x01
#define BT_HARDWARE_CONFIG_GPIO_FUNCTION    0x02
#define BT_HARDWARE_CONFIG_GPIO_ANALOG      0x03
#define BT_HARDWARE_BUTTON1_PIN_INDEX       0x08
#define BT_HARDWARE_BUTTON2_PIN_INDEX       0x09
#define BT_HARDWARE_BUTTON3_PIN_INDEX       0x0A
#define BT_HARDWARE_BUTTON4_PIN_INDEX       0x0C
#define BT_HARDWARE_BUTTON5_PIN_INDEX       0x0D
#define BT_HARDWARE_LED1_PIN_INDEX          0x0E
#define BT_HARDWARE_LED2_PIN_INDEX          0x0F
#define BT_HARDWARE_BUTTON1_PIN_MASK        0x0100
#define BT_HARDWARE_BUTTON2_PIN_MASK        0x0200
#define BT_HARDWARE_BUTTON3_PIN_MASK        0x0400
#define BT_HARDWARE_BUTTON4_PIN_MASK        0x1000
#define BT_HARDWARE_BUTTON5_PIN_MASK        0x2000
#define BT_HARDWARE_ALL_BUTTONS_PIN_MASK    0x3700
#define BT_HARDWARE_LED1_PIN_MASK           0x4000
#define BT_HARDWARE_LED2_PIN_MASK           0x8000
#define BT_HARDWARE_ALL_LEDS_PIN_MASK       0xC000
 
#define BT_MAX_PAYLOAD_LEN                  0x40
 
#define DRV_BUFFER_SIZE                     200
 
 // bt_set
 
#define BT_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.bt0 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // bt_map
 // bt
 
typedef struct
{
    digital_out_t an;                        
    digital_out_t rst;                       
    digital_out_t cts;                       
    digital_out_t bt0;                       
    digital_in_t rts;                        
    // Modules
    uart_t uart;                             
    // Buffers
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];  
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];  
} bt_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                       
    pin_name_t tx_pin;                       
    // Additional gpio pins
    pin_name_t an;                           
    pin_name_t rst;                          
    pin_name_t cts;                          
    pin_name_t bt0;                          
    pin_name_t rts;                          
    // Static variable
    uint32_t          baud_rate;             
    bool              uart_blocking;         
    uart_data_bits_t  data_bit;              
    uart_parity_t     parity_bit;            
    uart_stop_bits_t  stop_bit;              
} bt_cfg_t;
 
typedef enum
{
    BT_OK = 0,
    BT_ERROR = -1
 
} bt_return_value_t;
 
typedef struct
{
    uint8_t msg_type;
    uint8_t payload_len;
    uint8_t msg_class;
    uint8_t msg_id;
    uint8_t payload[ BT_MAX_PAYLOAD_LEN ];
 
} bt_package_t;
 
void bt_cfg_setup ( bt_cfg_t *cfg );
 
err_t bt_init ( bt_t *ctx, bt_cfg_t *cfg );
 
err_t bt_default_cfg ( bt_t *ctx );
 
err_t bt_generic_write ( bt_t *ctx, char *data_buf, uint16_t len );
 
err_t bt_generic_read ( bt_t *ctx, char *data_buf, uint16_t max_len );
 
void bt_set_an_pin ( bt_t *ctx, uint8_t state );
 
void bt_set_rst_pin ( bt_t *ctx, uint8_t state );
 
void bt_set_cts_pin ( bt_t *ctx, uint8_t state );
 
void bt_set_bt0_pin ( bt_t *ctx, uint8_t state );
 
uint8_t bt_get_rts_pin ( bt_t *ctx );
 
err_t bt_send_package ( bt_t *ctx, bt_package_t pkg );
 
err_t bt_read_package ( bt_t *ctx, bt_package_t *pkg );
 
err_t bt_set_local_name ( bt_t *ctx, char *name );
 
err_t bt_set_bondable_mode ( bt_t *ctx, uint8_t mode );
 
err_t bt_delete_bondings ( bt_t *ctx );
 
err_t bt_set_class_of_device ( bt_t *ctx, uint32_t cod );
 
err_t bt_set_gap_mode ( bt_t *ctx, uint8_t connectable, uint8_t discoverable, uint8_t limited );
 
err_t bt_rfcomm_start_server ( bt_t *ctx, uint8_t sdp_id, uint8_t stream_dest );
 
err_t bt_rfcomm_stop_server ( bt_t *ctx, uint8_t sdp_id );
 
err_t bt_factory_reset ( bt_t *ctx );
 
err_t bt_system_reset ( bt_t *ctx, uint8_t mode );
 
err_t bt_hardware_config_gpio ( bt_t *ctx, uint8_t port, uint16_t pin_index, uint8_t mode, uint8_t pullup );
 
err_t bt_hardware_read_gpio ( bt_t *ctx, uint8_t port, uint16_t mask, uint16_t *port_data );
 
err_t bt_hardware_write_gpio ( bt_t *ctx, uint8_t port, uint16_t mask, uint16_t port_data );
 
err_t bt_endpoint_send_data ( bt_t *ctx, uint8_t *endpoint, char *msg );
 
#ifdef __cplusplus
}
#endif
#endif // BT_H
 
 // bt
 
// ------------------------------------------------------------------------ END