bt-oal/include/oal-manager.h

   1 /*
   2 * Open Adaptation Layer (OAL)
   3 *
   4 * Copyright (c) 2014-2015 Samsung Electronics Co., Ltd.
   5 *
   6 * Licensed under the Apache License, Version 2.0 (the "License");
   7 * you may not use this file except in compliance with the License.
   8 * You may obtain a copy of the License at
   9 *
  10 *                          http://www.apache.org/licenses/LICENSE-2.0
  11 *
  12 * Unless required by applicable law or agreed to in writing, software
  13 * distributed under the License is distributed on an "AS IS" BASIS,
  14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 * See the License for the specific language governing permissions and
  16 * limitations under the License.
  17 *
  18 */
  19
  20 #ifndef _OAL_MANAGER_H_
  21 #define _OAL_MANAGER_H_
  22
  23 #include <glib.h>
  24 #include <stdint.h>
  25 #include <sys/types.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #define BT_VERSION_STR_LEN_MAX       30 /**< This specifies maximum adapter version string length */
  32
  33 #define BT_DEVICE_NAME_LENGTH_MAX       248 /**< This specifies maximum device name length */
  34
  35 #define BT_ADDRESS_BYTES_NUM            6 /**< This specifies bluetooth device address length */
  36
  37 #define OAL_UUID_MAX_LENGTH                             16/**< This specifies ble service UUID Length */
  38
  39 #define BLE_ADV_DATA_LENGTH            31 /**< This specifies Advertising Data Length */
  40
  41 #define BT_ADDRESS_STR_LEN                              18 /**< BT address String length> */
  42
  43 #define BT_MAX_SERVICES_FOR_DEVICE  60 /**< This specifies the Maximum UUID Id mentioned in bta_api.h>*/
  44
  45 #define BLUETOOTH_UUID_STRING_MAX       50
  46
  47 #define BT_DEVICE_MANUFACTURER_DATA_LEN_MAX 31 /**<This specifies the Maximum manufacturer data Length>*/
  48
  49 typedef void (*oal_event_callback)(int event, gpointer event_data, gsize size);
  50
  51 typedef struct {
  52         unsigned char addr[BT_ADDRESS_BYTES_NUM];
  53 } bt_address_t;
  54
  55 typedef struct {
  56         char name[BT_DEVICE_NAME_LENGTH_MAX + 1];
  57 } bt_name_t;
  58
  59 typedef struct {
  60         int data_len;           /**< manafacturer specific data length */
  61         char data[BT_DEVICE_MANUFACTURER_DATA_LEN_MAX];
  62 } oal_manufacturer_data_t;
  63
  64 typedef enum {
  65         OAL_STATUS_SUCCESS,
  66         /* Generic */
  67         OAL_STATUS_INTERNAL_ERROR,
  68         OAL_STATUS_NOT_READY,
  69         OAL_STATUS_BUSY,
  70         OAL_STATUS_INVALID_PARAM,
  71         OAL_STATUS_RMT_DEVICE_DOWN,
  72         OAL_STATUS_AUTH_FAILED,
  73         OAL_STATUS_NOT_SUPPORT, //For APIs not supported
  74         OAL_STATUS_NOT_PAIRED,
  75         OAL_STATUS_ALREADY_DONE,
  76         OAL_STATUS_PENDING,
  77         OAL_STATUS_CONN_TIMEOUT,
  78         /* HID */
  79         OAL_STATUS_HID_FAILED_MOUSE,
  80 #ifndef TIZEN_BT_HAL
  81         OAL_STATUS_LINK_LOSS
  82 #else
  83         OAL_STATUS_LINK_LOSS,
  84         OAL_STATUS_CONN_TERM_LOCAL_HOST,
  85         OAL_STATUS_CONN_TERM_RMT_HOST
  86 #endif
  87 } oal_status_t;
  88
  89
  90
  91 /* NOTE: If anything changes in bt_service_id_t enum definition of Bluedroid header, change here too */
  92 typedef enum {
  93         A2DP_SRC_SERVICE_ID = 3,
  94         HSP_SERVICE_ID = 5,
  95         HFP_SERVICE_ID = 6,
  96         OPP_SERVICE_ID = 7,
  97         AVRCP_CT_SERVICE_ID = 9,
  98         SAP_SERVICE_ID = 17,
  99         A2DP_SERVICE_ID = 18,
 100         AVRCP_SERVICE_ID = 19,
 101         HID_SERVICE_ID = 20,
 102         HSP_HS_SERVICE_ID = 23,
 103         HFP_HS_SERVICE_ID = 24,
 104 #ifdef TIZEN_BT_HAL
 105         IOTIVITY_SERVICE_ID = 29,
 106 #endif
 107 } oal_service_t;
 108
 109 /** Bluetooth 128-bit UUID */
 110 typedef struct {
 111         uint8_t uuid[16];
 112 } oal_uuid_t;
 113
 114 typedef oal_uuid_t service_uuid_t;
 115
 116 typedef enum {
 117         DEV_TYPE_BREDR,
 118         DEV_TYPE_BLE_ONLY,
 119         DEV_TYPE_DUAL
 120 } device_type_t;
 121
 122 typedef enum {
 123         BT_DISC_TYPE_BREDR = 0x01,
 124         BT_DISC_TYPE_LE,
 125         BT_DISC_TYPE_DUAL
 126 } discovery_type_t;
 127
 128 typedef struct {
 129         char name[BT_DEVICE_NAME_LENGTH_MAX + 1];
 130         char alias[BT_DEVICE_NAME_LENGTH_MAX + 1];
 131         bt_address_t address;
 132         int cod;
 133         int rssi;
 134         int vid;
 135         int pid;
 136         int is_bonded;
 137         int is_connected;
 138         device_type_t type;
 139         int uuid_count;
 140         oal_uuid_t uuid[BT_MAX_SERVICES_FOR_DEVICE];
 141         int is_trusted;
 142         int is_alias_set;
 143 } remote_device_t;
 144
 145 /** GATT ID adding instance id tracking to the UUID */
 146 typedef struct {
 147         oal_uuid_t          uuid;
 148         uint8_t             inst_id;
 149 } oal_gatt_id_t;
 150
 151 /** GATT Service ID also identifies the service type (primary/secondary) */
 152 typedef struct {
 153         oal_gatt_id_t    id;
 154         uint8_t              is_prmry;
 155 } oal_gatt_srvc_id_t;
 156
 157 /**
 158  * @brief Initializes OAL layer
 159  *
 160  * @remarks Other API can only be used after successful return. \n
 161  *
 162  * @details EVENT: N/A
 163  *
 164  * @return OAL_STATUS_SUCCESS on success, otherwise a non-zero error value.
 165  * @retval #OAL_STATUS_SUCCESS  Successful
 166  *
 167  * @pre N/A
 168  *
 169  * @see  oal_bt_deinit()
 170  */
 171 oal_status_t oal_bt_init(oal_event_callback cb);
 172
 173 /**
 174  * @brief Deinitializes OAL Layer
 175  *
 176  * @remarks Other API can only be used after oal_bt_init done again. \n
 177  *
 178  * @details EVENT: N/A
 179  *
 180  * @return void.
 181  * @retval void
 182  *
 183  * @pre N/A
 184  *
 185  * @see  oal_bt_init()
 186  */
 187 void oal_bt_deinit(void);
 188
 189 /**
 190  * @brief Initialize Stack lib based on chip
 191  *
 192  * @remarks Other API can only be used after oal_lib_init done. \n
 193  *
 194  * @details EVENT: OAL_EVENT_OAL_INITIALISED_SUCCESS, OAL_EVENT_OAL_INITIALISED_FAILED
 195  *
 196  * @return bool.
 197  * @retval bool
 198  *
 199  * @pre N/A
 200  *
 201  * @see  N/A
 202  */
 203 gboolean oal_lib_init(gpointer data);
 204
 205 /**
 206  * @brief Set Debug Mode Flag to TRUE
 207  *
 208  * @remarks OAL will run in exclusive mode, no processing of api-call and no event sending. \n
 209  *
 210  * @details EVENT: N/A
 211  *
 212  * @return void
 213  * @retval void
 214  *
 215  * @pre N/A
 216  *
 217  * @see  oal_get_debug_mode()
 218  */
 219 void oal_set_debug_mode(gboolean mode);
 220
 221 /**
 222  * @brief Set Debug Mode Flag
 223  *
 224  * @remarks To check whether Debug mode is running. \n
 225  *
 226  * @details EVENT: N/A
 227  *
 228  * @return TRUE if debug mode is on, otherwise FALSE
 229  * @retval #TRUE  Successful
 230  *
 231  * @pre N/A
 232  *
 233  * @see  oal_set_debug_mode()
 234  */
 235 gboolean oal_get_debug_mode(void);
 236
 237 #ifdef OAL_DEBUG
 238 /**
 239  * @brief Register the debug mode event catcher
 240  *
 241  * @remarks handles the incoming events and passes to debug handler. \n
 242  *
 243  * @details EVENT: N/A
 244  *
 245  * @return void
 246  * @retval void
 247  *
 248  * @pre N/A
 249  *
 250  * @see  N/A
 251  */
 252 void server_event_catch_register(oal_event_callback dbg_cb);
 253 #endif
 254
 255 /**
 256  * @brief Get stack name
 257  *
 258  * @return stack name
 259  *
 260  * @pre OAL API must be initialized with oal_bt_init().
 261  */
 262 const char *oal_get_stack_name(void);
 263
 264 #ifdef __cplusplus
 265 }
 266 #endif /* __cplusplus */
 267 #endif /*_OAL_HARDWARE_H_*/
 268
 269 /**
 270  * @brief calls function to set the is_activating variable in HAL to true
 271  *
 272  * @remarks It is required to let adapter switched on event propagate upwards
 273  *
 274  * @details EVENT: N/A
 275  *
 276  * @return sucess if variable set in HAL
 277  * @retval BT_STATUS_SUCCESS
 278  *
 279  * @pre N/A
 280  *
 281  * @see  N/A
 282 */
 283 int oal_set_adapter_request_state(int enable);
 284
 285 /*
 286 * @brief calls function to set the is_activating variable in HAL to true
 287  *
 288  * @remarks It is required to let le adapter switched on event propagate upwards
 289  *
 290  * @details EVENT: N/A
 291  *
 292  * @return sucess if variable set in HAL
 293  * @retval BT_STATUS_SUCCESS
 294  *
 295  * @pre N/A
 296  *
 297  * @see  N/A
 298 */
 299 int oal_set_le_request_state(int enable);