ble_bms.h

/*
 * Copyright (c) 2012 - 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BLE_BMS_H__
#define BLE_BMS_H__
 
#include <stdint.h>
#include <stdbool.h>
#include <ble.h>
#include <bm/softdevice_handler/nrf_sdh_ble.h>
#include <bm/bluetooth/ble_qwr.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BLE_BMS_DEF(_name)                                                                         \
        static struct ble_bms _name;                                                               \
        NRF_SDH_BLE_OBSERVER(_name##_obs, ble_bms_on_ble_evt, &_name, HIGH)
 
#define BLE_BMS_CONFIG_SEC_MODE_DEFAULT                                                            \
        {                                                                                          \
                .feature_char.read = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                            \
                .ctrlpt_char.write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                            \
        }
 
#define BLE_BMS_CTRLPT_MAX_LEN 128
#define BLE_BMS_AUTH_CODE_MAX_LEN BLE_BMS_CTRLPT_MAX_LEN - 1
 
#define BLE_BMS_REQUESTING_DEVICE_BR_LE (0x01 << 0)
#define BLE_BMS_REQUESTING_DEVICE_BR_LE_AUTH_CODE (0x01 << 1)
#define BLE_BMS_REQUESTING_DEVICE_BR (0x01 << 2)
#define BLE_BMS_REQUESTING_DEVICE_BR_AUTH_CODE (0x01 << 3)
#define BLE_BMS_REQUESTING_DEVICE_LE (0x01 << 4)
#define BLE_BMS_REQUESTING_DEVICE_LE_AUTH_CODE (0x01 << 5)
#define BLE_BMS_ALL_BONDS_BR_LE (0x01 << 6)
#define BLE_BMS_ALL_BONDS_BR_LE_AUTH_CODE (0x01 << 7)
#define BLE_BMS_ALL_BONDS_BR (0x01 << 8)
#define BLE_BMS_ALL_BONDS_BR_AUTH_CODE (0x01 << 9)
#define BLE_BMS_ALL_BONDS_LE (0x01 << 10)
#define BLE_BMS_ALL_BONDS_LE_AUTH_CODE (0x01 << 11)
#define BLE_BMS_ALL_EXCEPT_REQUESTING_DEVICE_BR_LE (0x01 << 12)
#define BLE_BMS_ALL_EXCEPT_REQUESTING_DEVICE_BR_LE_AUTH_CODE (0x01 << 13)
#define BLE_BMS_ALL_EXCEPT_REQUESTING_DEVICE_BR (0x01 << 14)
#define BLE_BMS_ALL_EXCEPT_REQUESTING_DEVICE_BR_AUTH_CODE (0x01 << 15)
#define BLE_BMS_ALL_EXCEPT_REQUESTING_DEVICE_LE (0x01 << 16)
#define BLE_BMS_ALL_EXCEPT_REQUESTING_DEVICE_LE_AUTH_CODE (0x01 << 17)
#define BLE_BMS_OPCODE_NOT_SUPPORTED 0x80
#define BLE_BMS_OPERATION_FAILED 0x81
 
struct ble_bms_features {
        bool delete_all : 1;
        bool delete_all_auth : 1;
        bool delete_requesting : 1;
        bool delete_requesting_auth : 1;
        bool delete_all_but_requesting : 1;
        bool delete_all_but_requesting_auth : 1;
};
 
enum ble_bms_op {
        BLE_BMS_OP_DEL_BOND_REQ_DEVICE_BR_LE = 0x01,
        BLE_BMS_OP_DEL_BOND_REQ_DEVICE_BR_ONLY = 0x02,
        BLE_BMS_OP_DEL_BOND_REQ_DEVICE_LE_ONLY = 0x03,
        BLE_BMS_OP_DEL_ALL_BONDS_ON_SERVER_BR_LE = 0x04,
        BLE_BMS_OP_DEL_ALL_BONDS_ON_SERVER_BR_ONLY = 0x05,
        BLE_BMS_OP_DEL_ALL_BONDS_ON_SERVER_LE_ONLY = 0x06,
        BLE_BMS_OP_DEL_ALL_BUT_ACTIVE_BOND_BR_LE = 0x07,
        BLE_BMS_OP_DEL_ALL_BUT_ACTIVE_BOND_BR_ONLY = 0x08,
        BLE_BMS_OP_DEL_ALL_BUT_ACTIVE_BOND_LE_ONLY = 0x09,
        BLE_BMS_OP_NONE = 0xFF
};
 
enum ble_bms_auth_status {
        BLE_BMS_AUTH_STATUS_ALLOWED,
        BLE_BMS_AUTH_STATUS_DENIED,
        BLE_BMS_AUTH_STATUS_PENDING
};
 
struct ble_bms_auth_code {
        uint8_t code[BLE_BMS_AUTH_CODE_MAX_LEN];
        uint16_t len;
};
 
enum ble_bms_evt_type {
        BLE_BMS_EVT_ERROR,
        BLE_BMS_EVT_AUTH,
        BLE_BMS_EVT_BOND_DELETE_REQUESTING,
        BLE_BMS_EVT_BOND_DELETE_ALL,
        BLE_BMS_EVT_BOND_DELETE_ALL_EXCEPT_REQUESTING,
};
 
struct ble_bms_evt {
        enum ble_bms_evt_type evt_type;
        union {
                struct {
                        /* Error reason */
                        uint32_t reason;
                } error;
                struct {
                        struct ble_bms_auth_code auth_code;
                } auth;
        };
};
 
struct ble_bms_ctrlpt {
        enum ble_bms_op op_code;
        struct ble_bms_auth_code auth_code;
};
 
/* Forward declaration of the struct ble_bms. */
struct ble_bms;
 
typedef void (*ble_bms_evt_handler_t)(struct ble_bms *bms, struct ble_bms_evt *evt);
 
struct ble_bms_config {
        ble_bms_evt_handler_t evt_handler;
        struct ble_bms_features feature;
        struct ble_qwr *qwr;
        uint8_t qwr_count;
        struct {
                struct {
                        ble_gap_conn_sec_mode_t read;
                } feature_char;
                struct {
                        ble_gap_conn_sec_mode_t write;
                } ctrlpt_char;
        } sec_mode;
};
 
struct ble_bms {
        uint16_t service_handle;
        uint16_t conn_handle;
        ble_bms_evt_handler_t evt_handler;
        struct ble_bms_features feature;
        ble_gatts_char_handles_t feature_handles;
        ble_gatts_char_handles_t ctrlpt_handles;
        enum ble_bms_auth_status auth_status;
};
 
uint32_t ble_bms_auth_response(struct ble_bms *bms, bool authorize);
 
uint32_t ble_bms_init(struct ble_bms *bms, struct ble_bms_config *bms_config);
 
void ble_bms_on_ble_evt(const ble_evt_t *ble_evt, void *ble_bms);
 
uint16_t ble_bms_on_qwr_evt(struct ble_bms *bms, struct ble_qwr *qwr,
                            const struct ble_qwr_evt *evt);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BLE_BMS_H__ */