ble_config.h

Go to the documentation of this file.

 
#ifndef _BLE_CONFIG_H_
#define _BLE_CONFIG_H_
 
#include <stdint.h>
#include "ble_stack_config.h"
 
/* --------------------------------- BLE configuration options ---------------------------------- */
 
#ifndef dg_configBLE_CONNECTIONS_MAX
#define dg_configBLE_CONNECTIONS_MAX         (2)
#elif ( ( dg_configBLE_CONNECTIONS_MAX > CFG_CON ) || ( dg_configBLE_CONNECTIONS_MAX < 1 ) )
#error "dg_configBLE_CONNECTIONS_MAX must be between 1 and 8"
#endif
 
#ifndef dg_configBLE_OBSERVER
#define dg_configBLE_OBSERVER                (1)
#endif
 
#ifndef dg_configBLE_BROADCASTER
#define dg_configBLE_BROADCASTER             (1)
#endif
 
#ifndef dg_configBLE_CENTRAL
#define dg_configBLE_CENTRAL                 (1)
#endif
 
#ifndef dg_configBLE_PERIPHERAL
#define dg_configBLE_PERIPHERAL              (1)
#endif
 
#ifndef dg_configBLE_GATT_CLIENT
#define dg_configBLE_GATT_CLIENT             (1)
#endif
 
#ifndef dg_configBLE_GATT_SERVER
#define dg_configBLE_GATT_SERVER             (1)
#endif
 
#ifndef dg_configBLE_L2CAP_COC
#define dg_configBLE_L2CAP_COC               (1)
#endif
 
/*
 * Disable Connection Parameter Request procedure
 *
 * This option is deprecated. Using ble_gap_conn_param_update() with a peer that does
 * not support the 4.1 Connection Parameter Request feature will result in making a
 * connection update request over L2CAP to ensure interoperability.
 */
#ifdef dg_configBLE_CONN_PARAM_REQ_DISABLE
#pragma message "dg_configBLE_CONN_PARAM_REQ_DISABLE macro is deprecated: Defining it will have no effect!"
#endif
 
 
#ifndef dg_configBLE_EVENT_COUNTER_ENABLE
#define dg_configBLE_EVENT_COUNTER_ENABLE    (0)
#endif
 
#ifndef dg_configBLE_ADV_STOP_DELAY_ENABLE
#define dg_configBLE_ADV_STOP_DELAY_ENABLE   (0)
#endif
 
#ifndef dg_configBLE_SKIP_LATENCY_API
#define dg_configBLE_SKIP_LATENCY_API        (0)
#endif
 
#ifndef dg_configBLE_PRIVACY_1_2
#define dg_configBLE_PRIVACY_1_2             (0)
#endif
 
#ifndef dg_configBLE_DATA_LENGTH_RX_MAX
#define dg_configBLE_DATA_LENGTH_RX_MAX      (251)
#else
#if ((dg_configBLE_DATA_LENGTH_RX_MAX > 251) || (dg_configBLE_DATA_LENGTH_RX_MAX < 27))
#error "dg_configBLE_DATA_LENGTH_RX_MAX value must be between 27 and 251!"
#endif
#endif
 
#ifndef dg_configBLE_DATA_LENGTH_TX_MAX
#define dg_configBLE_DATA_LENGTH_TX_MAX      (251)
#else
#if ((dg_configBLE_DATA_LENGTH_TX_MAX > 251) || (dg_configBLE_DATA_LENGTH_TX_MAX < 27))
#error "dg_configBLE_DATA_LENGTH_TX_MAX value must be between 27 and 251!"
#endif
#endif
 
/*
 * \brief Initiate a data length request upon a new connection as slave
 *
 * Id defined to 1, the device will send an LL_LENGTH_REQ PDU upon a new connection as slave.
 */
#ifndef dg_configBLE_DATA_LENGTH_REQ_UPON_CONN
#define dg_configBLE_DATA_LENGTH_REQ_UPON_CONN  (0)
#endif
 
#define BLE_DATA_LENGTH_TO_TIME(OCTETS)  ( ( (OCTETS) + 11 + 3 ) * 8 )
 
#ifndef dg_configBLE_CONN_EVENT_LENGTH_MIN
#define dg_configBLE_CONN_EVENT_LENGTH_MIN \
        ( (BLE_DATA_LENGTH_TO_TIME(dg_configBLE_DATA_LENGTH_RX_MAX) \
         + BLE_DATA_LENGTH_TO_TIME(dg_configBLE_DATA_LENGTH_TX_MAX) + 150 + 624) / 625)
 
#if (dg_configBLE_CONN_EVENT_LENGTH_MIN > 8)
        #undef dg_configBLE_CONN_EVENT_LENGTH_MIN
        #define dg_configBLE_CONN_EVENT_LENGTH_MIN (8)
#endif
#elif defined(dg_configBLE_CONN_EVENT_LENGTH_MAX) \
        && (dg_configBLE_CONN_EVENT_LENGTH_MIN > dg_configBLE_CONN_EVENT_LENGTH_MAX)
#error "dg_configBLE_CONN_EVENT_LENGTH_MIN must be lower or equal to dg_configBLE_CONN_EVENT_LENGTH_MAX."
#endif
 
#ifndef dg_configBLE_CONN_EVENT_LENGTH_MAX
#define dg_configBLE_CONN_EVENT_LENGTH_MAX   (0xFFFF)
#endif
 
#ifndef dg_configBLE_DUPLICATE_FILTER_MAX
#define dg_configBLE_DUPLICATE_FILTER_MAX    (10)
#elif ((dg_configBLE_DUPLICATE_FILTER_MAX < 10) || (dg_configBLE_DUPLICATE_FILTER_MAX > 255))
#error "dg_configBLE_DUPLICATE_FILTER_MAX value must be between 10 and 255."
#endif
 
#ifndef dg_configBLE_PAIR_INIT_KEY_DIST
#define dg_configBLE_PAIR_INIT_KEY_DIST      (GAP_KDIST_ENCKEY | GAP_KDIST_IDKEY | GAP_KDIST_SIGNKEY)
#endif
 
#ifndef dg_configBLE_PAIR_RESP_KEY_DIST
#define dg_configBLE_PAIR_RESP_KEY_DIST      (GAP_KDIST_ENCKEY | GAP_KDIST_IDKEY | GAP_KDIST_SIGNKEY)
#endif
 
#ifndef dg_configBLE_SECURE_CONNECTIONS
#define dg_configBLE_SECURE_CONNECTIONS      (1)
#endif
 
#ifdef dg_configBLE_PUB_KEY_SUCCESS_THR
#pragma message "This configuration macro is deprecated. The P-256 Public/Private Key Pair is automatically renewed by the stack prior to every pairing procedure."
#endif
 
#ifdef dg_configBLE_PUB_KEY_FAILURE_THR
#pragma message "This configuration macro is deprecated. The P-256 Public/Private Key Pair is automatically renewed by the stack prior to every pairing procedure."
#endif
 
#ifndef dg_configBLE_INITIAL_TX_POWER
#define dg_configBLE_INITIAL_TX_POWER        (GAP_TX_POWER_0_dBm)
#else
        #if   ( (dg_configBLE_INITIAL_TX_POWER < GAP_TX_POWER_MIN) || \
                (dg_configBLE_INITIAL_TX_POWER > GAP_TX_POWER_MAX) )
        #error "The TX power level value must be one of @gap_tx_power_t values."
        #endif
#endif
 
#ifndef dg_configDEFAULT_RADIO_OP_MODE
#define dg_configDEFAULT_RADIO_OP_MODE          (LOW_POWER_ALL_PHYS)
#endif
 
/* ------------------------------- RF calibration configuration --------------------------------- */
 
#ifndef dg_configRF_CALIB_TEMP_DIFF
#define dg_configRF_CALIB_TEMP_DIFF          (8)
#endif
 
#ifndef dg_configRF_CALIB_TEMP_POLL_INTV
#define dg_configRF_CALIB_TEMP_POLL_INTV     (1000)
#endif
 
/* ---------------------------------- BLE default parameters ------------------------------------ */
 
#ifndef defaultBLE_DEVICE_NAME
#define defaultBLE_DEVICE_NAME               "Dialog BLE"
#endif
 
#ifndef defaultBLE_APPEARANCE
#define defaultBLE_APPEARANCE                (0)
#endif
 
#ifndef defaultBLE_MAX_CONNECTIONS
#define defaultBLE_MAX_CONNECTIONS           (CFG_CON)
#endif
#if (defaultBLE_MAX_CONNECTIONS != CFG_CON)
# error "Values different than the BLE stack library default (CFG_CON) are not currently supported."
#endif
 
 
#ifndef defaultBLE_MAX_BONDED
#define defaultBLE_MAX_BONDED                (8)
#endif
 
#ifndef defaultBLE_GAP_ROLE
#define defaultBLE_GAP_ROLE                  GAP_NO_ROLE
#endif
 
#ifndef defaultBLE_ADDRESS_RENEW_DURATION
#define defaultBLE_ADDRESS_RENEW_DURATION    (900)    // 900 seconds (15 minutes)
#endif
 
#ifndef defaultBLE_STATIC_ADDRESS
#define defaultBLE_STATIC_ADDRESS            { 0x06, 0x00, 0xF4, 0x35, 0x23, 0x48 }
#endif
 
#ifndef defaultBLE_ADDRESS_TYPE
#define defaultBLE_ADDRESS_TYPE              PUBLIC_ADDRESS
#endif
 
#ifndef defaultBLE_IRK
#define defaultBLE_IRK                       { 0xEF, 0xCD, 0xAB, 0x89, 0x67, 0x45, 0x23, 0x01, \
                                               0xEF, 0xCD, 0xAB, 0x89, 0x67, 0x45, 0x23, 0x01 }
#endif
 
#ifndef defaultBLE_ATT_DB_CONFIGURATION
#define defaultBLE_ATT_DB_CONFIGURATION      (0x10)     // Peripheral Pref. Conn. Parameters present
#endif
 
#ifndef defaultBLE_MAX_MTU_SIZE
#define defaultBLE_MAX_MTU_SIZE              (512)
#endif
 
#ifndef defaultBLE_MIN_MTU_SIZE
#if (dg_configBLE_SECURE_CONNECTIONS == 1)
#define defaultBLE_MIN_MTU_SIZE              (65)
#else
#define defaultBLE_MIN_MTU_SIZE              (23)
#endif
#elif (((dg_configBLE_SECURE_CONNECTIONS == 1) \
                && (defaultBLE_MIN_MTU_SIZE < 65)) \
        || ((dg_configBLE_SECURE_CONNECTIONS == 0) \
                && (defaultBLE_MIN_MTU_SIZE < 23)) \
        || (defaultBLE_MIN_MTU_SIZE > defaultBLE_MAX_MTU_SIZE))
#error "defaultBLE_MIN_MTU_SIZE set out of supported range!"
#endif
 
#ifndef defaultBLE_MTU_SIZE
#define defaultBLE_MTU_SIZE                  (defaultBLE_MIN_MTU_SIZE)
#elif ((defaultBLE_MTU_SIZE < defaultBLE_MIN_MTU_SIZE) \
        || (defaultBLE_MTU_SIZE > defaultBLE_MAX_MTU_SIZE))
#error "defaultBLE_MTU_SIZE set out of supported range!"
#endif
 
#ifndef defaultBLE_CHANNEL_MAP
#define defaultBLE_CHANNEL_MAP               {0xFF, 0xFF, 0xFF, 0xFF, 0x1F}  // All channels enabled
#endif
 
#ifndef defaultBLE_ADVERTISE_MODE
#define defaultBLE_ADVERTISE_MODE            GAP_DISC_MODE_GEN_DISCOVERABLE
#endif
 
#ifndef defaultBLE_ADVERTISE_CHANNEL_MAP
#define defaultBLE_ADVERTISE_CHANNEL_MAP     (GAP_ADV_CHANNEL_37 | GAP_ADV_CHANNEL_38 | GAP_ADV_CHANNEL_39)
#endif
 
#ifndef defaultBLE_ADVERTISE_INTERVAL_MIN
#define defaultBLE_ADVERTISE_INTERVAL_MIN    (BLE_ADV_INTERVAL_FROM_MS(687.5))  // 687.5ms
#endif
 
#ifndef defaultBLE_ADVERTISE_INTERVAL_MAX
#define defaultBLE_ADVERTISE_INTERVAL_MAX    (BLE_ADV_INTERVAL_FROM_MS(687.5))  // 687.5ms
#endif
 
#ifndef defaultBLE_ADVERTISE_FILTER_POLICY
#define defaultBLE_ADVERTISE_FILTER_POLICY   ADV_ALLOW_SCAN_ANY_CONN_ANY
#endif
 
#ifndef defaultBLE_ADVERTISE_DATA_LENGTH
#define defaultBLE_ADVERTISE_DATA_LENGTH     (28)
#endif
 
#ifndef defaultBLE_ADVERTISE_DATA
#define defaultBLE_ADVERTISE_DATA            { 0x0D, GAP_DATA_TYPE_LOCAL_NAME, \
                                               'R', 'e', 'n', 'e', 's', 'a', 's', ' ', 'B', 'L', 'E' }
#endif
 
#ifndef defaultBLE_SCAN_RESPONSE_DATA_LENGTH
#define defaultBLE_SCAN_RESPONSE_DATA_LENGTH (31)
#endif
 
#ifndef defaultBLE_SCAN_RESPONSE_DATA
#define defaultBLE_SCAN_RESPONSE_DATA        { }
#endif
 
#ifndef defaultBLE_SCAN_INTERVAL
#define defaultBLE_SCAN_INTERVAL             (BLE_SCAN_INTERVAL_FROM_MS(100))   // 100ms
#endif
 
#ifndef defaultBLE_SCAN_WINDOW
#define defaultBLE_SCAN_WINDOW               (BLE_SCAN_WINDOW_FROM_MS(50))      // 50ms
#endif
 
#ifndef defaultBLE_PPCP_INTERVAL_MIN
#define defaultBLE_PPCP_INTERVAL_MIN         (BLE_CONN_INTERVAL_FROM_MS(10))    // 10ms
#endif
 
#ifndef defaultBLE_PPCP_INTERVAL_MAX
#define defaultBLE_PPCP_INTERVAL_MAX         (BLE_CONN_INTERVAL_FROM_MS(20))    // 20ms
#endif
 
#ifndef defaultBLE_PPCP_SLAVE_LATENCY
#define defaultBLE_PPCP_SLAVE_LATENCY        (0)          // number of events
#endif
 
#ifndef defaultBLE_PPCP_SUP_TIMEOUT
#define defaultBLE_PPCP_SUP_TIMEOUT          (BLE_SUPERVISION_TMO_FROM_MS(1000)) // 1s
#endif
 
#ifndef defaultBLE_GAP_IO_CAP
#define defaultBLE_GAP_IO_CAP                GAP_IO_CAP_NO_INPUT_OUTPUT
#endif
 
#ifndef defaultBLE_DIS_MANUFACTURER
#define defaultBLE_DIS_MANUFACTURER          "Renesas Electronics Corporation"
#endif
 
#ifndef defaultBLE_DIS_MODEL_NUMBER
#define defaultBLE_DIS_MODEL_NUMBER          "Renesas BLE"
#endif
 
#ifndef defaultBLE_DIS_SERIAL_NUMBER
#define defaultBLE_DIS_SERIAL_NUMBER         "SN123456"
#endif
 
#ifndef defaultBLE_DIS_HW_REVISION
#define defaultBLE_DIS_HW_REVISION           "Rev.D"
#endif
 
#ifndef defaultBLE_DIS_FW_REVISION
#define defaultBLE_DIS_FW_REVISION           "1.0"
#endif
 
#ifndef defaultBLE_DIS_SW_REVISION
#define defaultBLE_DIS_SW_REVISION           "1.1"
#endif
 
#ifndef defaultBLE_DIS_PNP_VID_SOURCE
#define defaultBLE_DIS_PNP_VID_SOURCE        (0x01)
#endif
 
#ifndef defaultBLE_DIS_PNP_VID
#define defaultBLE_DIS_PNP_VID               (0x00D2)
#endif
 
#ifndef defaultBLE_DIS_PNP_PID
#define defaultBLE_DIS_PNP_PID               (0x0001)
#endif
 
#ifndef defaultBLE_DIS_PNP_VERSION
#define defaultBLE_DIS_PNP_VERSION           (0x0001)
#endif
 
/* IEEE 11073-20601 Regulatory Certification Data List Characteristic */
#ifndef defaultBLE_DIS_REGULATORY_CERT
#define defaultBLE_DIS_REGULATORY_CERT       { 0x00, 0x02, 0x00, 0x12, 0x02, 0x01, 0x00, 0x08, 0x01, \
                                               0x05, 0x00, 0x01, 0x00, 0x02, 0x80, 0x08, 0x02, 0x02, \
                                               0x00, 0x02, 0x00, 0x00 }
#endif
 
#ifndef defaultBLE_DIS_SYSTEM_ID_OUI
#define defaultBLE_DIS_SYSTEM_ID_OUI         { 0x80, 0xEA, 0xCA }
#endif
 
#ifndef defaultBLE_DIS_SYSTEM_ID_MANUFACTURER
#define defaultBLE_DIS_SYSTEM_ID_MANUFACTURER  { 0x0A, 0x0B, 0x0C, 0x0D, 0x0E }
#endif
 
#ifdef BLE_EXTERNAL_HOST
#define BLE_STACK_PASSTHROUGH_MODE
#define BLE_MGR_DIRECT_ACCESS   0
#endif
 
#ifndef USE_BLE_SLEEP
#               define USE_BLE_SLEEP           1
#endif
 
 
/* -----------------------------------BLE event notifications configuration --------------------- */
 
/*
 * BLE ISR event Notifications
 *
 * This facility enables the user app to receive notifications for BLE
 * ISR events. These events can be received either directly from inside
 * the BLE ISR, or as task notifications to the Application Task
 * registered to the BLE manager.
 *
 * To enable, define dg_configBLE_EVENT_NOTIF_TYPE to either
 * BLE_EVENT_NOTIF_USER_ISR or BLE_EVENT_NOTIF_USER_TASK.
 *
 * - When dg_configBLE_EVENT_NOTIF_TYPE == BLE_EVENT_NOTIF_USER_ISR, the user
 *   can define the following macros on his app configuration:
 *
 *   dg_configBLE_EVENT_NOTIF_HOOK_END_EVENT    : The BLE End Event
 *   dg_configBLE_EVENT_NOTIF_HOOK_CSCNT_EVENT  : The BLE CSCNT Event
 *   dg_configBLE_EVENT_NOTIF_HOOK_FINE_EVENT   : The BLE FINE Event
 *
 *   These macros must be actually set to the names of functions defined inside
 *   the user application, having a prototype of
 *
 *     void func(void);
 *
 *   (The user app does not need to explicitly define the prototype).
 *
 *   If one of these macros is not defined, the respective notification
 *   will be suppressed.
 *
 *   Note that these functions will be called in ISR context, directly from the
 *   BLE ISR. They should therefore be very fast and should NEVER block.
 *
 * - When dg_configBLE_EVENT_NOTIF_TYPE == BLE_EVENT_NOTIF_USER_TASK, the user
 *   app will receive task notifications on the task registered to the BLE
 *   manager.
 *
 *   Notifications will be received using the following bit masks:
 *
 *   - dg_configBLE_EVENT_NOTIF_MASK_END_EVENT: End Event Mask (Def: bit 24)
 *   - dg_configBLE_EVENT_NOTIF_MASK_CSCNT_EVENT: CSCNT Event Mask (Def: bit 25)
 *   - dg_configBLE_EVENT_NOTIF_MASK_FINE_EVENT: FINE Event Mask (Def: bit 26)
 *
 *   These macros, defining the task notification bit masks, can be redefined as
 *   needed.
 *
 *   If one of the macros for callback functions presented in the previous
 *   section (for direct ISR notifications) is defined, while in this mode,
 *   the function with the same name will be called directly from the isr
 *   instead of sending a task notification for this particular event to
 *   the app task.
 *
 *   Macro dg_configBLE_EVENT_NOTIF_RUNTIME_CONTROL (Default: 1) enables/disables
 *   runtime control/masking of notifications.
 *
 *   If dg_configBLE_EVENT_NOTIF_RUNTIME_CONTROL == 1, then task notifications
 *   must be enabled/disabled using the
 *   ble_event_notif_[enable|disable]_[end|cscnt|fine]_event() functions.
 *   By default all notifications are disabled.
 *
 *   If dg_configBLE_EVENT_NOTIF_RUNTIME_CONTROL == 0, all notifications will
 *   be sent unconditionally to the application task.
 *
 */
#ifndef dg_configBLE_EVENT_NOTIF_TYPE
#define dg_configBLE_EVENT_NOTIF_TYPE BLE_EVENT_NOTIF_USER_ISR
#endif
 
#if dg_configBLE_EVENT_NOTIF_TYPE == BLE_EVENT_NOTIF_USER_TASK
 
/* Default implementation of BLE event task notifications. This
 * implementation allows a user task to register for notifications,
 * and to get task notifications for the available events
 */
 
/* Default task notification masks for the various events for which
 * the framework provides notifications
 */
#ifndef dg_configBLE_EVENT_NOTIF_MASK_END_EVENT
#define dg_configBLE_EVENT_NOTIF_MASK_END_EVENT         (1 << 24)
#endif
 
#ifndef dg_configBLE_EVENT_NOTIF_MASK_CSCNT_EVENT
#define dg_configBLE_EVENT_NOTIF_MASK_CSCNT_EVENT       (1 << 25)
#endif
 
#ifndef dg_configBLE_EVENT_NOTIF_MASK_FINE_EVENT
#define dg_configBLE_EVENT_NOTIF_MASK_FINE_EVENT        (1 << 26)
#endif
 
/* Implement event hook functions */
#ifndef dg_configBLE_EVENT_NOTIF_HOOK_END_EVENT
#define dg_configBLE_EVENT_NOTIF_HOOK_END_EVENT         ble_event_notif_app_task_end_event
#endif
 
#ifndef dg_configBLE_EVENT_NOTIF_HOOK_CSCNT_EVENT
#define dg_configBLE_EVENT_NOTIF_HOOK_CSCNT_EVENT       ble_event_notif_app_task_cscnt_event
#endif
 
#ifndef dg_configBLE_EVENT_NOTIF_HOOK_FINE_EVENT
#define dg_configBLE_EVENT_NOTIF_HOOK_FINE_EVENT        ble_event_notif_app_task_fine_event
#endif
 
/*
 * Allow runtime control of (un)masking notifications
 */
#ifndef dg_configBLE_EVENT_NOTIF_RUNTIME_CONTROL
#define dg_configBLE_EVENT_NOTIF_RUNTIME_CONTROL        1
#endif
 
#endif
/* ---------------------------------------------------------------------------------------------- */
 
#define dg_configBLE_2MBIT_PHY               (1)
 
#ifndef dg_configBLE_UUID_SUOTA_SERVICE
#define dg_configBLE_UUID_SUOTA_SERVICE    (0xFEF5)
#endif
 
#endif /* _BLE_CONFIG_H_ */