bt_common.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/bluetooth/bt_common.h
 *
 *   Copyright 2018, 2024 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#ifndef __MODULES_INCLUDE_BLUETOOTH_BT_COMMON_H
#define __MODULES_INCLUDE_BLUETOOTH_BT_COMMON_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdint.h>
#include <bluetooth/bluetooth.h>
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define BT_ADV_DATA_MAX_LEN  (255)
#define BT_ADV_DATA_LEN_LEN  (1)
#define BT_ADV_DATA_TYPE_LEN (1)
#define BT_EIR_LEN  (BT_ADV_DATA_MAX_LEN \
                   - BT_ADV_DATA_LEN_LEN \
                   - BT_ADV_DATA_TYPE_LEN)
 
#define BLE_IRK_LEN  (16)
#define BLE_CSRK_LEN (16)
#define BLE_LTK_LEN  (16)
#define BLE_RAND_LEN (8)
 
/* Macro to convert time in msec for scan parameter */
 
#define BLE_SCAN_PARAM_INTERVAL_MSEC(t) ((t) * 1000 / 625)
#define BLE_SCAN_PARAM_WINDOW_MSEC(t)   ((t) * 1000 / 625)
#define BLE_SCAN_PARAM_TIMEOUT_MSEC(t)  ((t) * 1000 / 10000)
 
/* Macro to convert time in msec for connection parameter */
 
#define BLE_CONN_PARAM_INTERVAL_MSEC(t) ((t) * 1000 / 1250)
#define BLE_CONN_PARAM_TIMEOUT_MSEC(t)  ((t) * 1000 / 10000)
 
#define BLESTAT_SUCCESS           0x00
 
#define BLESTAT_MEMCAP_EXCD       0x07
 
#define BLESTAT_CONNECT_TIMEOUT   0x08
 
#define BLESTAT_PEER_TERMINATED   0x13
 
#define BLESTAT_PEER_TERM_LOWRES  0x14
 
#define BLESTAT_PEER_TERM_POFF    0x15
 
#define BLESTAT_TERMINATED        0x16
 
#define BLESTAT_UNSPEC_ERR        0x1F
 
#define BLESTAT_DEVICE_BUSY       0x3A
 
#define BLESTAT_PARAM_REJECTED    0x3B
 
#define BLESTAT_CONNECT_FAILED    0x3E
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef enum
{
    BT_DISCONNECTED  = 0, 
    BT_DISCONNECTING = 1, 
    BT_CONNECTING    = 2, 
    BT_CONNECTED     = 3  
} BT_CONNECT_STATUS;
 
struct bt_common_state_s
{
  struct bt_hal_common_ops_s  *bt_hal_common_ops;        
  struct ble_hal_common_ops_s *ble_hal_common_ops;       
  struct bt_common_ops_s      *bt_common_ops;            
  struct ble_common_ops_s      *ble_common_ops;          
  BT_ADDR                     bt_addr;                   
  BT_ADDR                     ble_addr;                  
  uint8_t                     ble_addr_type;             
  char                        bt_name[BT_NAME_LEN + 1];  
  char                        ble_name[BT_NAME_LEN + 1]; 
};
 
struct bt_acl_state_s
{
  BT_CONNECT_STATUS          bt_acl_connection;           
  struct bt_common_state_s   *bt_common_state;            
  BT_ADDR                    bt_target_addr;              
  char                       bt_target_name[BT_NAME_LEN]; 
};
 
struct ble_state_s
{
  BT_CONNECT_STATUS          ble_connection;              
  uint16_t                   ble_connect_handle;          
  struct bt_common_state_s   *bt_common_state;            
  uint8_t                    bt_target_addr_type;         
  BT_ADDR                    bt_target_addr;              
  char                       bt_target_name[BT_NAME_LEN]; 
};
 
struct ble_addr_s
{
  uint8_t type;
  uint8_t addr[BT_ADDR_LEN];
};
 
struct ble_idkey_s
{
  uint8_t  irk[BLE_IRK_LEN];
  uint8_t  csrk[BLE_CSRK_LEN];
  uint8_t  ltk[BLE_LTK_LEN];
  uint8_t  rand[BLE_RAND_LEN];
  uint16_t ediv;
};
 
struct ble_cccd_s
{
  uint16_t handle;
  uint16_t value;
};
 
struct ble_bondinfo_s
{
  struct ble_addr_s   peer_addr;
  struct ble_idkey_s  peer;
  struct ble_idkey_s  own;
  uint8_t             cccd_num;
  struct ble_cccd_s   *cccd;
};
 
struct ble_scan_param_s
{
  uint8_t  active;   
  uint16_t interval; 
  uint16_t window;   
  uint16_t timeout;  
};
 
struct ble_conn_param_s
{
  uint16_t min_interval;  
  uint16_t max_interval;  
  uint16_t slave_latency; 
  uint16_t sup_timeout;   
};
 
struct bt_common_ops_s
{
  void (*command_status)(BT_CMD_STATUS status);                                                    
  void (*pairing_complete)(BT_ADDR addr, BT_PAIR_STATUS status);                                   
  void (*inquiry_result)(BT_ADDR addr, char *name);                                                
  void (*inquiry_complete)(void);                                                                  
  void (*connect_status_changed)(struct bt_acl_state_s *bt_acl_state, bool connected, int status); 
  void (*connected_device_name)(const char *name);                                                 
  void (*bond_info)(BT_ADDR addr);                                                                 
};
 
struct ble_common_ops_s
{
  void (*connect_status_changed)(struct ble_state_s *ble_state,
                                 bool connected,
                                 uint8_t status);
 
  void (*connected_device_name_resp)(const char *name);
 
  void (*scan_result)(BT_ADDR addr, uint8_t *data, uint8_t len);
 
  void (*mtusize)(uint16_t handle, uint16_t sz);
 
  void (*save_bondinfo)(int num, struct ble_bondinfo_s *bond);
 
  int  (*load_bondinfo)(int num, struct ble_bondinfo_s *bond);
 
  void (*encryption_result)(uint16_t conn_handle, bool result);
 
};
 
struct bt_eir_s
{
  uint8_t len;
  uint8_t type;
  uint8_t data[BT_EIR_LEN];
};
 
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
int bt_init(void);
 
int bt_finalize(void);
 
int bt_set_address(BT_ADDR *addr);
 
int bt_get_address(BT_ADDR *addr);
 
int bt_set_name(char *name);
 
int bt_get_name(char *name);
 
int bt_enable(void);
 
int bt_disable(void);
 
int bt_pairing_enable(void);
 
int bt_paring_disable(void);
 
int bt_get_bond_list(BT_ADDR *addr, int *num);
 
int bt_unbond(BT_ADDR *addr);
 
int bt_set_visibility(BT_VISIBILITY visibility);
 
int bt_start_inquiry(void);
 
int bt_cancel_inquiry(void);
 
int bt_register_common_cb(struct bt_common_ops_s *bt_common_ops);
 
int ble_set_address(BT_ADDR *addr);
 
int ble_get_address(BT_ADDR *addr);
 
int ble_set_public_address(BT_ADDR *addr);
 
uint8_t ble_get_address_type(void);
 
int ble_set_name(char *name);
 
int ble_get_name(char *name);
 
int ble_set_appearance(BLE_APPEARANCE appearance);
 
int ble_enable(void);
 
int ble_disable(void);
 
int ble_connect(struct ble_state_s *ble_state);
 
int ble_disconnect(struct ble_state_s *ble_state);
 
int ble_start_advertise(void);
 
int ble_cancel_advertise(void);
 
int ble_start_scan(bool duplicate_filter);
 
int ble_cancel_scan(void);
 
int ble_register_common_cb(struct ble_common_ops_s *ble_common_ops);
 
uint16_t ble_set_request_mtusize(uint16_t sz);
 
uint16_t ble_get_request_mtusize(void);
 
int ble_get_negotiated_mtusize(uint16_t handle);
 
int ble_set_tx_power(int8_t tx_power);
 
int ble_set_scan_param(struct ble_scan_param_s *param);
 
int ble_set_conn_param(struct ble_conn_param_s *param);
 
int ble_pairing(uint16_t handle);
 
int ble_parse_advertising_data(BLE_AD_TYPE target,
                               uint8_t *adv_data,
                               uint8_t adv_len,
                               struct bt_eir_s *eir);
 
#undef EXTERN
#ifdef __cplusplus
}
#endif
 
#endif /* __MODULES_INCLUDE_BLUETOOTH_BT_COMMON_H */