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            62 /**< 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_ALREADY_DONE,
  75         OAL_STATUS_PENDING,
  76         OAL_STATUS_CONN_TIMEOUT,
  77         /* HID */
  78         OAL_STATUS_HID_FAILED_MOUSE,
  79 #ifndef TIZEN_BT_HAL
  80         OAL_STATUS_LINK_LOSS
  81 #else
  82         OAL_STATUS_LINK_LOSS,
  83         OAL_STATUS_CONN_TERM_LOCAL_HOST,
  84         OAL_STATUS_CONN_TERM_RMT_HOST
  85 #endif
  86 } oal_status_t;
  87
  88
  89
  90 /* NOTE: If anything changes in bt_service_id_t enum definition of Bluedroid header, change here too */
  91 typedef enum {
  92         A2DP_SRC_SERVICE_ID = 3,
  93         HSP_SERVICE_ID = 5,
  94         HFP_SERVICE_ID = 6,
  95         OPP_SERVICE_ID = 7,
  96         AVRCP_CT_SERVICE_ID = 9,
  97         SAP_SERVICE_ID = 17,
  98         A2DP_SERVICE_ID = 18,
  99         AVRCP_SERVICE_ID = 19,
 100         HID_SERVICE_ID = 20,
 101         HSP_HS_SERVICE_ID = 23,
 102         HFP_HS_SERVICE_ID = 24,
 103 #ifdef TIZEN_BT_HAL
 104         IOTIVITY_SERVICE_ID = 29,
 105 #endif
 106 } oal_service_t;
 107
 108 /** Bluetooth 128-bit UUID */
 109 typedef struct {
 110         uint8_t uuid[16];
 111 } oal_uuid_t;
 112
 113 typedef oal_uuid_t service_uuid_t;
 114
 115 typedef enum {
 116         DEV_TYPE_BREDR,
 117         DEV_TYPE_BLE_ONLY,
 118         DEV_TYPE_DUAL
 119 } device_type_t;
 120
 121 typedef enum {
 122         BT_DISC_TYPE_BREDR = 0x01,
 123         BT_DISC_TYPE_LE,
 124         BT_DISC_TYPE_DUAL
 125 } discovery_type_t;
 126
 127 typedef struct {
 128         char name[BT_DEVICE_NAME_LENGTH_MAX + 1];
 129         char alias[BT_DEVICE_NAME_LENGTH_MAX + 1];
 130         bt_address_t address;
 131         int cod;
 132         int rssi;
 133         int vid;
 134         int pid;
 135         int is_bonded;
 136         int is_connected;
 137         device_type_t type;
 138         int uuid_count;
 139         oal_uuid_t uuid[BT_MAX_SERVICES_FOR_DEVICE];
 140         int is_trusted;
 141         int is_alias_set;
 142 } remote_device_t;
 143
 144 /** GATT ID adding instance id tracking to the UUID */
 145 typedef struct {
 146         oal_uuid_t          uuid;
 147         uint8_t             inst_id;
 148 } oal_gatt_id_t;
 149
 150 /** GATT Service ID also identifies the service type (primary/secondary) */
 151 typedef struct {
 152         oal_gatt_id_t    id;
 153         uint8_t              is_prmry;
 154 } oal_gatt_srvc_id_t;
 155
 156 /**
 157  * @brief Initializes OAL layer
 158  *
 159  * @remarks Other API can only be used after successful return. \n
 160  *
 161  * @details EVENT: N/A
 162  *
 163  * @return OAL_STATUS_SUCCESS on success, otherwise a non-zero error value.
 164  * @retval #OAL_STATUS_SUCCESS  Successful
 165  *
 166  * @pre N/A
 167  *
 168  * @see  oal_bt_deinit()
 169  */
 170 oal_status_t oal_bt_init(oal_event_callback cb);
 171
 172 /**
 173  * @brief Deinitializes OAL Layer
 174  *
 175  * @remarks Other API can only be used after oal_bt_init done again. \n
 176  *
 177  * @details EVENT: N/A
 178  *
 179  * @return void.
 180  * @retval void
 181  *
 182  * @pre N/A
 183  *
 184  * @see  oal_bt_init()
 185  */
 186 void oal_bt_deinit(void);
 187
 188 /**
 189  * @brief Initialize Stack lib based on chip
 190  *
 191  * @remarks Other API can only be used after oal_lib_init done. \n
 192  *
 193  * @details EVENT: OAL_EVENT_OAL_INITIALISED_SUCCESS, OAL_EVENT_OAL_INITIALISED_FAILED
 194  *
 195  * @return bool.
 196  * @retval bool
 197  *
 198  * @pre N/A
 199  *
 200  * @see  N/A
 201  */
 202 gboolean oal_lib_init(gpointer data);
 203
 204 /**
 205  * @brief Set Debug Mode Flag to TRUE
 206  *
 207  * @remarks OAL will run in exclusive mode, no processing of api-call and no event sending. \n
 208  *
 209  * @details EVENT: N/A
 210  *
 211  * @return void
 212  * @retval void
 213  *
 214  * @pre N/A
 215  *
 216  * @see  oal_get_debug_mode()
 217  */
 218 void oal_set_debug_mode(gboolean mode);
 219
 220 /**
 221  * @brief Set Debug Mode Flag
 222  *
 223  * @remarks To check whether Debug mode is running. \n
 224  *
 225  * @details EVENT: N/A
 226  *
 227  * @return TRUE if debug mode is on, otherwise FALSE
 228  * @retval #TRUE  Successful
 229  *
 230  * @pre N/A
 231  *
 232  * @see  oal_set_debug_mode()
 233  */
 234 gboolean oal_get_debug_mode(void);
 235
 236 #ifdef OAL_DEBUG
 237 /**
 238  * @brief Register the debug mode event catcher
 239  *
 240  * @remarks handles the incoming events and passes to debug handler. \n
 241  *
 242  * @details EVENT: N/A
 243  *
 244  * @return void
 245  * @retval void
 246  *
 247  * @pre N/A
 248  *
 249  * @see  N/A
 250  */
 251 void server_event_catch_register(oal_event_callback dbg_cb);
 252 #endif
 253
 254 /**
 255  * @brief Get stack name
 256  *
 257  * @return stack name
 258  *
 259  * @pre OAL API must be initialized with oal_bt_init().
 260  */
 261 const char *oal_get_stack_name(void);
 262
 263 #ifdef __cplusplus
 264 }
 265 #endif /* __cplusplus */
 266 #endif /*_OAL_HARDWARE_H_*/
 267
 268 /**
 269  * @brief calls function to set the is_activating variable in HAL to true
 270  *
 271  * @remarks It is required to let adapter switched on event propagate upwards
 272  *
 273  * @details EVENT: N/A
 274  *
 275  * @return sucess if variable set in HAL
 276  * @retval BT_STATUS_SUCCESS
 277  *
 278  * @pre N/A
 279  *
 280  * @see  N/A
 281 */
 282 int oal_set_adapter_request_state(int enable);
 283
 284 /*
 285 * @brief calls function to set the is_activating variable in HAL to true
 286  *
 287  * @remarks It is required to let le adapter switched on event propagate upwards
 288  *
 289  * @details EVENT: N/A
 290  *
 291  * @return sucess if variable set in HAL
 292  * @retval BT_STATUS_SUCCESS
 293  *
 294  * @pre N/A
 295  *
 296  * @see  N/A
 297 */
 298 int oal_set_le_request_state(int enable);