bluetooth.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/bluetooth/bluetooth.h
 *
 *   Copyright 2018 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_BLUETOOTH_H
#define __MODULES_INCLUDE_BLUETOOTH_BLUETOOTH_H
 
#define BLUETOOTH_DEBUG
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <sdk/config.h>
 
#include <debug.h>
#include <errno.h>
#include <stdbool.h>
#include <stdint.h>
#ifdef BLUETOOTH_DEBUG
#include <stdio.h>
#endif
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#ifdef BLUETOOTH_DEBUG
#undef _err
#define _err(format, ...)   printf(format, ##__VA_ARGS__)
#undef _info
#define _info(format, ...)  printf(format, ##__VA_ARGS__)
#endif
 
#define BT_SUCCESS 0
#define BT_FAIL    -1
#define BT_ADDR_LEN 6
#define BT_NAME_LEN 28
#define BT_UUID128_LEN 16
#define BLE_ADV_FLAGS_LIMITED_DISC_MODE      (0x01)
 
#define BLE_ADV_FLAGS_GENERAL_DISC_MODE      (0x02)
 
#define BLE_ADV_FLAGS_BR_EDR_NOT_SUPPORTED   (0x04)
 
#define BLE_ADV_FLAGS_LE_BR_EDR_CONTROLLER   (0x08)
 
#define BLE_ADV_FLAGS_LE_BR_EDR_HOST         (0x10)
 
#define BLE_UUID_128BIT_STRING_LENGTH  (36)
 
#define BLE_UUID_16BIT_STRING_LENGTH   (4)
 
#define BLE_UUID_128BIT_STRING_BUFSIZE (BLE_UUID_128BIT_STRING_LENGTH + 1)
 
#define BLE_UUID_16BIT_STRING_BUFSIZE  (BLE_UUID_16BIT_STRING_LENGTH + 1)
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef struct
{
    uint8_t address[BT_ADDR_LEN]; 
} BT_ADDR;
 
typedef struct
{
    uint8_t uuid128[BT_UUID128_LEN]; 
} BT_UUID;
 
typedef enum
{
    BT_COMMAND_STATUS_SUCCESS = 0,            
    BT_COMMAND_STATUS_IN_PROGRESS,            
    BT_COMMAND_STATUS_ALREADY_CONNECTED,      
    BT_COMMAND_STATUS_NOT_CONNECTED,          
    BT_COMMAND_STATUS_BAD_HANDLE,             
    BT_COMMAND_STATUS_WRONG_STATE,            
    BT_COMMAND_STATUS_INVALID_ARGS,           
    BT_COMMAND_STATUS_FAILED,                 
    BT_COMMAND_STATUS_UNKNOWN_GROUP,          
    BT_COMMAND_STATUS_UNKNOWN_COMMAND,        
    BT_COMMAND_STATUS_CLIENT_NOT_REGISTERED,  
    BT_COMMAND_STATUS_OUT_OF_MEMORY,          
    BT_COMMAND_STATUS_DISALLOWED              
} BT_CMD_STATUS;
 
typedef enum
{
    BT_PAIR_SUCCESS,                        
    BT_PAIR_PASSKEY_ENTRY_FAILURE,          
    BT_PAIR_OOB_FAILURE,                    
    BT_PAIR_PAIRING_AUTHENTICATION_FAILURE, 
    BT_PAIR_CONFIRM_VALUE_FAILURE,          
    BT_PAIR_PAIRING_NOT_SUPPORTED,          
    BT_PAIR_ENCRYPTION_KEY_SIZE_FAILURE,    
    BT_PAIR_INVALID_COMMAND,                
    BT_PAIR_PAIRING_FAILURE_UNKNOWN,        
    BT_PAIR_REPEATED_ATTEMPTS,              
    BT_PAIR_INTERNAL_PAIRING_ERROR,         
    BT_PAIR_UNKNOWN_IO_CAPABILITIES,        
    BT_PAIR_SMP_INITIALIZATION_FAILURE,     
    BT_PAIR_CONFIRMATION_FAILRUE,           
    BT_PAIR_SMP_BUSY,                       
    BT_PAIR_ENCRYPTION_FAILURE,             
    BT_PAIR_BONDING_STARTED,                
    BT_PAIR_RESPONSE_TIMEOUT,               
    BT_PAIR_GENERIC_FAILURE,                
    BT_PAIR_CONNECTION_TIMEOUT,             
} BT_PAIR_STATUS;
 
typedef enum
{
    BT_CONNECT_NO_SERVICE = 0,  
    BT_CONNECT_NO_DEVICE,       
    BT_CONNECT_TIMEOUT,         
    BT_CONNECT_OTHER,           
} BT_CONNECT_FAIL_REASON_ID;
 
typedef enum
{
  BT_VIS_NO_DISCOVERY_NO_CONNECTABLE = 0, 
  BT_VIS_DISCOVERY_NO_CONNECTABLE    = 1, 
  BT_VIS_NO_DISCOVERY_CONNECTABLE    = 2, 
  BT_VIS_DISCOVERY_CONNECTABLE       = 3  
} BT_VISIBILITY;
 
#ifdef EXTERNALS_NRF52
#include "ble_types.h"
typedef int BLE_APPEARANCE
#else
typedef enum
{
  BLE_APPEARANCE_GENERIC_PHONE                    = 64,
  BLE_APPEARANCE_GENERIC_COMPUTER                 = 128,
  BLE_APPEARANCE_GENERIC_WATCH                    = 192,
  BLE_APPEARANCE_WATCH_SPORTS                     = 193,
  BLE_APPEARANCE_GENERIC_CLOCK                    = 256,
  BLE_APPEARANCE_GENERIC_DISPLAY                  = 320,
  BLE_APPEARANCE_GENERIC_REMOTE_CONTROL           = 384,
  BLE_APPEARANCE_GENERIC_EYE_GLASSES              = 448,
  BLE_APPEARANCE_GENERIC_TAG                      = 512,
  BLE_APPEARANCE_GENERIC_KEYRING                  = 576,
  BLE_APPEARANCE_GENERIC_MEDIA_PLAYER             = 640,
  BLE_APPEARANCE_GENERIC_BARCODE_SCANNER          = 704,
  BLE_APPEARANCE_GENERIC_THERMOMETER              = 768,
  BLE_APPEARANCE_THERMOMETER_EAR                  = 769,
  BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR        = 832,
  BLE_APPEARANCE_HEART_RATE_BELT                  = 833,
  BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE           = 896,
  BLE_APPEARANCE_BLOOD_PRESSURE_ARM               = 897,
  BLE_APPEARANCE_BLOOD_PRESSURE_WRIST             = 898,
  BLE_APPEARANCE_GENERIC_HID_DEVICE               = 960,
  BLE_APPEARANCE_HID_KEYBOARD                     = 961,
  BLE_APPEARANCE_HID_MOUSE                        = 962,
  BLE_APPEARANCE_HID_JOYSTICK                     = 963,
  BLE_APPEARANCE_HID_GAMEPAD                      = 964,
  BLE_APPEARANCE_HID_DIGITIZER_TABLET             = 965,
  BLE_APPEARANCE_HID_CARD_READER                  = 966,
  BLE_APPEARANCE_HID_DIGITAL_PEN                  = 967,
  BLE_APPEARANCE_HID_BARCODE_SCANNER              = 968,
  BLE_APPEARANCE_GENERIC_GLUCOSE_METER            = 1024,
  BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR   = 1088,
  BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE   = 1089,
  BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE   = 1090,
  BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP    = 1091,
  BLE_APPEARANCE_GENERIC_CYCLING                  = 1152,
  BLE_APPEARANCE_CYCLING_COMPUTER                 = 1153,
  BLE_APPEARANCE_CYCLING_SPEED_SENSOR             = 1154,
  BLE_APPEARANCE_CYCLING_CADENCE_SENSOR           = 1155,
  BLE_APPEARANCE_CYCLING_POWER_SENSOR             = 1156,
  BLE_APPEARANCE_CYCLING_SPEED_AND_CADENCE_SENSOR = 1157,
} BLE_APPEARANCE;
#endif
 
typedef enum {
    BLE_GAP_IO_CAP_DISPLAY_ONLY = 0,   
    BLE_GAP_IO_CAP_DISPLAY_YESNO,      
    BLE_GAP_IO_CAP_KEYBOARD_ONLY,      
    BLE_GAP_IO_CAP_NO_INPUT_NO_OUTPUT, 
    BLE_GAP_IO_CAP_KEYBOARD_DISPLAY,   
} BLE_GAP_IO_CAP;
 
typedef enum {
  BLE_AD_TYPE_ADDRESS_TYPE                   = 0x00,
 
  BLE_AD_TYPE_FLAGS                          = 0x01,
 
  BLE_AD_TYPE_16BIT_SERVICE_UUID_INCOMPLETE  = 0x02,
 
  BLE_AD_TYPE_16BIT_SERVICE_UUID_COMPLETE    = 0x03,
 
  BLE_AD_TYPE_32BIT_SERVICE_UUID_INCOMPLETE  = 0x04,
 
  BLE_AD_TYPE_32BIT_SERVICE_UUID_COMPLETE    = 0x05,
 
  BLE_AD_TYPE_128BIT_SERVICE_UUID_INCOMPLETE = 0x06,
 
  BLE_AD_TYPE_128BIT_SERVICE_UUID_COMPLETE   = 0x07,
 
  BLE_AD_TYPE_SHORT_LOCAL_NAME               = 0x08,
 
  BLE_AD_TYPE_COMPLETE_LOCAL_NAME            = 0x09,
 
  BLE_AD_TYPE_TX_POWER_LEVEL                 = 0x0A,
 
  BLE_AD_TYPE_CLASS_OF_DEVICE                = 0x0D,
 
  BLE_AD_TYPE_SIMPLE_PAIRING_HASH_C          = 0x0E,
 
  BLE_AD_TYPE_SIMPLE_PAIRING_RANDOMIZER_R    = 0x0F,
 
  BLE_AD_TYPE_SECURITY_MANAGER_TK_VALUE      = 0x10,
 
  BLE_AD_TYPE_SECURITY_MANAGER_OOB_FLAGS     = 0x11,
 
  BLE_AD_TYPE_CONNECTION_INTERVAL_RANGE      = 0x12,
 
  BLE_AD_TYPE_SOLICITED_SERVICE_UUIDS_16BIT  = 0x14,
 
  BLE_AD_TYPE_SOLICITED_SERVICE_UUIDS_128BIT = 0x15,
 
  BLE_AD_TYPE_SERVICE_DATA                   = 0x16,
 
  BLE_AD_TYPE_PUBLIC_TARGET_ADDRESS          = 0x17,
 
  BLE_AD_TYPE_RANDOM_TARGET_ADDRESS          = 0x18,
 
  BLE_AD_TYPE_APPEARANCE                     = 0x19,
 
  BLE_AD_TYPE_ADVERTISING_INTERVAL           = 0x1A,
 
  BLE_AD_TYPE_LE_BLUETOOTH_DEVICE_ADDRESS    = 0x1B,
 
  BLE_AD_TYPE_LE_ROLE                        = 0x1C,
 
  BLE_AD_TYPE_SIMPLE_PAIRING_HASH_C256       = 0x1D,
 
  BLE_AD_TYPE_SIMPLE_PAIRING_RANDOMIZER_R256 = 0x1E,
 
  BLE_AD_TYPE_SERVICE_DATA_32BIT_UUID        = 0x20,
 
  BLE_AD_TYPE_SERVICE_DATA_128BIT_UUID       = 0x21,
 
  BLE_AD_TYPE_LESC_CONFIRMATION_VALUE        = 0x22,
 
  BLE_AD_TYPE_LESC_RANDOM_VALUE              = 0x23,
 
  BLE_AD_TYPE_URI                            = 0x24,
 
  BLE_AD_TYPE_3D_INFORMATION_DATA            = 0x3D,
 
  BLE_AD_TYPE_MANUFACTURER_SPECIFIC_DATA     = 0xFF,
} BLE_AD_TYPE;
 
typedef enum
{
  BLE_ADDRTYPE_PUBLIC = 0x00,
 
  BLE_ADDRTYPE_RAND_STATIC,
 
  BLE_ADDRTYPE_RAND_PRIV_RESOLVABLE,
 
  BLE_ADDRTYPE_RAND_PRIV_NONRESOLVABLE,
} BLE_ADDRESS_TYPE;
 
/****************************************************************************
 * Private Data
 ****************************************************************************/
 
/****************************************************************************
 * Public Function Prototypes
 ****************************************************************************/
 
#endif /* __MODULES_INCLUDE_BLUETOOTH_BLUETOOTH_H */