ble6.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 BLE6_H
#define BLE6_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 BLE6_MODULE_POWER_OFF                   0x00
#define BLE6_MODULE_POWER_ON                    0x01
 
#define BLE6_DRV_BUFFER_SIZE                    256
 
 // ble6_cmd
 
#define BLE6_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.bl = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // ble6_map
 // ble6
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    digital_out_t bl;           
    // Input pins
    digital_in_t an;            
    // Modules
    uart_t uart;                
    // Buffers
    uint8_t uart_rx_buffer[ BLE6_DRV_BUFFER_SIZE ];     
    uint8_t uart_tx_buffer[ BLE6_DRV_BUFFER_SIZE ];     
} ble6_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 bl;              
    // 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;                         
} ble6_cfg_t;
 
typedef struct
{
    uint8_t event_code;
    uint8_t length;
    uint8_t num_hci_cmd;
    uint16_t cmd_opcode;
    uint8_t status;
    uint8_t payload[ BLE6_DRV_BUFFER_SIZE ];
    
} ble6_rsp_t;
 
typedef struct
{
    uint8_t le_event_code;
    uint8_t le_length;
    uint8_t le_subevent_code;
    uint8_t le_status;
    uint16_t le_conn_hdl;
    uint8_t le_role;
    uint8_t le_peer_addr_type;
    uint8_t le_peer_addr[ 6 ];
    uint16_t le_conn_interval;
    uint16_t le_conn_latency;
    uint16_t le_sup_timeout;
    uint8_t le_master_clk_accuracy;
    
} ble6_le_meta_event_t;
 
typedef struct
{
    uint8_t event_code;
    uint8_t length;
    uint16_t e_code;
    uint16_t conn_hdl;
    uint16_t attr_hdl;
    uint16_t offset;
    uint16_t attr_data_len;
    uint8_t attr_data[ 255 ];
    
} ble6_rx_rsp_t;
 
typedef enum
{
    BLE6_OK = 0,
    BLE6_ERROR = -1
 
} ble6_return_value_t;
 
typedef void ( *ble6_handler_t )( uint8_t *message_buf, uint32_t message_len );
 
typedef void ( *ble6_hdl_t )( uint8_t* );
 
void ble6_cfg_setup ( ble6_cfg_t *cfg );
 
err_t ble6_init ( ble6_t *ctx, ble6_cfg_t *cfg );
 
err_t ble6_generic_write ( ble6_t *ctx, char *data_buf, uint16_t len );
 
err_t ble6_generic_read ( ble6_t *ctx, char *data_buf, uint16_t max_len );
 
int8_t ble6_strncmp ( uint8_t *string1, uint8_t *string2, uint8_t len );
 
uint8_t ble6_byte_ready ( ble6_t *ctx );
 
void ble6_power_on ( ble6_t *ctx, uint8_t en_pwr );
 
void ble6_send_command ( ble6_t *ctx, uint8_t *tx_data, uint8_t n_bytes );
 
void ble6_set_response_handler ( void ( *handler )( uint8_t* ), ble6_hdl_t driver_hdl );
 
void ble6_set_handlers ( ble6_handler_t event_handler, ble6_handler_t eve_hdlr );
 
void ble6_parser_rsp ( ble6_t *ctx, ble6_rsp_t *response );
 
#ifdef __cplusplus
}
#endif
#endif // BLE6_H
 
 // ble6
 
// ------------------------------------------------------------------------ END