ble9.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 *
 * 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 _BLE9_H_
#define _BLE9_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_uart.h"
 
// -------------------------------------------------------------- PUBLIC MACROS
#define BLE9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX );
#define BLE9_OK                                                 0
#define BLE9_ERROR                                             -1
#define BLE9_RSP_READY                                          1
#define BLE9_RSP_NOT_READY                                      0
#define BLE9_CMD_SYSTEM_HELLO_ID                                0x00010020ul
#define BLE9_CMD_SYSTEM_DATA_BUFFER_CLEAR_ID                    0x14010020ul
#define BLE9_CMD_SYSTEM_RESET_ID                                0x01010020ul
#define BLE9_CMD_SYSTEM_HALT_ID                                 0x2001010Cul
#define BLE9_CMD_SYSTEM_SET_TX_POWER_ID                         0x17010020ul
#define BLE9_CMD_SYSTEM_GET_VERSION_ID                          0x1B010020ul
#define BLE9_CMD_SYSTEM_SET_SOFT_TIMER_ID                       0x19010020ul
#define BLE9_CMD_SYSTEM_SET_LAZY_SOFT_TIMER_ID                  0x1A010020ul
#define BLE9_CMD_SYSTEM_SET_IDENTITY_ADDRESS_ID                 0x13010020ul
#define BLE9_CMD_SYSTEM_GET_IDENTITY_ADDRESS_ID                 0x15010020ul
#define BLE9_CMD_SYSTEM_DATA_BUFFER_WRITE_ID                    0x12010020ul
 
#define BLE9_CMD_GAP_SET_PRIVACY_MODE_ID                        0x01020020ul
#define BLE9_CMD_GAP_ENABLE_WHITELISTING_ID                     0x03020020ul
 
#define BLE9_CMD_ADVERTISER_CREATE_ID                           0x01040020ul
#define BLE9_CMD_ADVERTISER_DELETE_SET_ID                       0x02040020ul
#define BLE9_CMD_ADVERTISER_START_ID                            0x09040320ul
#define BLE9_CMD_ADVERTISER_STOP_ID                             0x0A040020ul
#define BLE9_CMD_ADVERTISER_SET_TIMING_ID                       0x03040020ul
#define BLE9_CMD_ADVERTISER_SET_PHY_ID                          0x06040020ul
#define BLE9_CMD_ADVERTISER_SET_CHANNEL_MAP_ID                  0x04040020ul
#define BLE9_CMD_ADVERTISER_SET_TX_POWER_ID                     0x0B040020ul
#define BLE9_CMD_ADVERTISER_SET_REPORT_SCAN_REQUEST_ID          0x05040020ul
#define BLE9_CMD_ADVERTISER_SET_CONFIGURATION_ID                0x07040020ul
#define BLE9_CMD_ADVERTISER_CLEAR_CONFIGURATION_ID              0x08040020ul
#define BLE9_CMD_ADVERTISER_SET_DATA_ID                         0x0F040020ul
#define BLE9_CMD_ADVERTISER_SET_LONG_DATA_ID                    0x0E040020ul
#define BLE9_CMD_ADVERTISER_START_PERIODIC_ADVERTISING_ID       0x0C040020ul
#define BLE9_CMD_ADVERTISER_STOP_PERIODIC_ADVERTISING_ID        0x0D040020ul
 
#define BLE9_CMD_NULL                                           0
#define BLE9_SYSTEM_RESUME                                      0
#define BLE9_SYSTEM_HALT                                        1
 
#define DRV_RX_BUFFER_SIZE                                      100
#define DRV_TX_BUFFER_SIZE                                      100
 // End group macro
// --------------------------------------------------------------- PUBLIC TYPES
typedef enum
{
    BLE9_DFU_RESET_MODE_NORMAL = 0,
    BLE9_DFU_RESET_MODE_UART,
    BLE9_DFU_RESET_MODE_OTA
    
} ble9_dfu_reset_mode_t;
 
typedef enum
{
    BLE9_CHANNEL_37 = 0,
    BLE9_CHANNEL_38,
    BLE9_CHANNEL_37_38,
    BLE9_CHANNEL_39,
    BLE9_CHANNEL_37_39,
    BLE9_CHANNEL_38_39,
    BLE9_CHANNEL_ALL
    
} ble9_channel_t;
 
typedef enum
{
    BLE9_PHY_TYPE_1M = 1,
    BLE9_PHY_TYPE_2M,
    BLE9_PHY_TYPE_CODED,
    BLE9_PHY_TYPE_ANY = 0xFF
    
} ble9_phy_type_t;
 
typedef enum
{
    BLE9_PACKAGE_TYPE_ADVERTISING = 0,
    BLE9_PACKAGE_TYPE_SCAN_RESPONSE,
    BLE9_PACKAGE_TYPE_PERIODIC_ADVERTISING = 8
    
} ble9_package_type_t;
 
typedef enum
{
    BLE9_ADVERTISER_MODE_DISCOVERABLE_NONE = 0,
    BLE9_ADVERTISER_MODE_DISCOVERABLE_LIMITED,
    BLE9_ADVERTISER_MODE_DISCOVERABLE_GENERAL,
    BLE9_ADVERTISER_MODE_DISCOVERABLE_BROADCAST,
    BLE9_ADVERTISER_MODE_DISCOVERABLE_USER_DATA
    
} ble9_adv_mode_discoverable_t;
 
typedef enum
{
    BLE9_ADVERTISER_MODE_CONNECTABLE_NONE = 0,
    BLE9_ADVERTISER_MODE_CONNECTABLE_DIRECTED,
    BLE9_ADVERTISER_MODE_CONNECTABLE_SCANNABLE,
    BLE9_ADVERTISER_MODE_CONNECTABLE_NONE_CONNECTABLE,
    BLE9_ADVERTISER_MODE_CONNECTABLE_NONE_SCANABLE
    
} ble9_adv_mode_connectable_t;
 
typedef struct
{
    uint16_t version_major;
    uint16_t version_minor;
    uint16_t version_patch;
    uint16_t version_build;
    uint32_t version_bootloader;
    uint32_t version_hash;
    
} ble9_version_t;
 
typedef struct
{
    uint8_t  ble9_timer_handle;
    uint8_t  ble9_timer_single_shot;
    uint32_t ble9_timer_time;
    uint32_t ble9_timer_slack;
    
} ble9_timer_t;
 
typedef struct
{
    uint8_t ble9_adv_handle;
    ble9_version_t ble9_version;
    // Modules
    uart_t uart;
 
    uint8_t uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    uint8_t uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
    
} ble9_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;
    pin_name_t tx_pin;
 
    // Static variables
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking; // Wait for data or not.
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.
    uart_stop_bits_t  stop_bit;      // Stop bits.
    
} ble9_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
void ble9_cfg_setup ( ble9_cfg_t *cfg );
 
err_t ble9_init ( ble9_t *ctx, ble9_cfg_t *cfg );
 
err_t ble9_sys_hello ( ble9_t *ctx );
 
err_t ble9_sys_get_version ( ble9_t *ctx );
 
void ble9_sys_set_id_addr ( ble9_t *ctx, uint8_t *address, uint8_t type );
 
err_t ble9_sys_get_id_address ( ble9_t *ctx, uint8_t *data_buf, uint8_t type );
 
void ble9_sys_reset ( ble9_t *ctx, ble9_dfu_reset_mode_t reset_mode );
 
err_t ble9_sys_halt ( ble9_t *ctx, uint8_t halt );
 
void ble9_sys_set_tx_power ( ble9_t *ctx, int16_t min_power, int16_t max_power );
 
err_t ble9_sys_data_buf_write ( ble9_t *ctx, uint16_t data_len, uint8_t *wr_data );
 
err_t ble9_sys_data_buf_clear ( ble9_t *ctx );
 
err_t ble9_sys_set_soft_timer ( ble9_t  *ctx, ble9_timer_t *ble9_timer );
 
err_t ble9_sys_set_lazy_soft_timer ( ble9_t *ctx, ble9_timer_t *ble9_timer );
 
err_t ble9_gap_set_privacy_mode ( ble9_t *ctx, uint8_t privacy, uint8_t interval_in_minutes );
 
err_t ble9_gap_en_wlist ( ble9_t *ctx, uint8_t enable );
 
err_t ble9_adv_create_id ( ble9_t *ctx );
 
err_t ble9_adv_delete_id ( ble9_t *ctx );
 
err_t ble9_adv_set_timing ( ble9_t *ctx, uint16_t interval_min, uint16_t interval_max, 
                            uint16_t duration, uint8_t maxevents );
 
err_t ble9_adv_set_phy ( ble9_t *ctx, ble9_phy_type_t primary_phy, ble9_phy_type_t secondary_phy );
 
err_t ble9_adv_set_channel_map ( ble9_t *ctx, ble9_channel_t channel_map );
 
err_t ble9_adv_set_tx_power ( ble9_t *ctx, int16_t power, int16_t *set_power );
 
err_t ble9_adv_set_report_scan_req ( ble9_t *ctx, uint8_t report_scan_req );
 
err_t ble9_adv_set_configuration ( ble9_t *ctx, uint8_t configurations );
 
err_t ble9_adv_clear_configuration ( ble9_t *ctx, uint8_t configurations );
 
err_t ble9_adv_set_data ( ble9_t *ctx, ble9_package_type_t packet_type, 
                          uint16_t adv_data_len, uint8_t *adv_data );
 
err_t ble9_adv_set_long_data ( ble9_t *ctx, ble9_package_type_t packet_type );
 
err_t ble9_adv_start ( ble9_t *ctx, ble9_adv_mode_discoverable_t discover, 
                       ble9_adv_mode_connectable_t connect );
 
err_t ble9_adv_stop ( ble9_t *ctx );
 
err_t ble9_adv_start_per_adv ( ble9_t *ctx, uint16_t interval_min, uint16_t interval_max, uint8_t flags );
 
err_t ble9_adv_stop_per_adv( ble9_t *ctx );
 
void ble9_generic_write ( ble9_t *ctx, uint8_t *data_buf, uint16_t len );
 
int32_t ble9_generic_read ( ble9_t *ctx, uint8_t *data_buf, uint16_t max_len );
 
void ble9_send_command ( ble9_t *ctx, uint32_t command );
 
#ifdef __cplusplus
}
#endif
#endif  // _BLE9_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END