Revert "Use Trusted Profiles instead of Restricted Profiles"
[platform/core/connectivity/bluetooth-frwk.git] / include / bluetooth-api.h
index c81f2b5..63b250c 100644 (file)
@@ -78,6 +78,9 @@ extern "C" {
 #define BLUETOOTH_MAX_DPM_LIST 20      /**< This specifies maximum number of devices/uuids
                                                        dpm shall store */
 
+#define BLUETOOTH_TDS_DATA_LENGTH_MAX  239 /**< This specifies maximum AD data length: 0xEF */
+#define BLUETOOTH_TDS_CONTROL_POINT_PARAM_LENGTH_MAX   500 /**< TDS Control Point parameter Max length */
+
 /**
  * This is Bluetooth error code
  */
@@ -188,6 +191,10 @@ extern "C" {
 #define BLUETOOTH_ERROR_LOCAL_HOST_TERM        0x16
 #define BLUETOOTH_ERROR_REPEATED_ATTEMPTS      0x17
 #define BLUETOOTH_ERROR_LMP_RESPONSE_TIMEOUT 0x22
+#define BLUETOOTH_ERROR_LMP_TRANSACTION_COLLISION 0x23
+#define BLUETOOTH_ERROR_INSTANT_PASSED 0x28
+#define BLUETOOTH_ERROR_INSUFFICIENT_SECURITY 0x2f
+#define BLUETOOTH_ERROR_CONNECTION_TERMINATED_DUE_TO_MIC_FAILURE 0x3d
 #define BLUETOOTH_ERROR_CONNECTION_FAILED_TO_BE_ESTABLISHED    0x3e
 
 
@@ -289,6 +296,7 @@ typedef enum {
 
 /**
  * Service type
+ * Service type matched to bt_profile_type_t of bt-service-common.h
  */
 typedef enum {
        BLUETOOTH_RFCOMM_SERVICE = 0x01,
@@ -414,6 +422,68 @@ typedef enum {
 } bluetooth_pxp_poperty_t;
 
 /**
+ * TDS transport Type
+ */
+typedef enum {
+               BLUETOOTH_TDS_TRANSPORT_BT = 0x01,      /* Transport type BR-EDR */
+               BLUETOOTH_TDS_TRANSPORT_CUSTOM, /* Transport type custom */
+               /* ... */
+               BLUETOOTH_TDS_TRANSPORT_INVALID
+} bluetooth_tds_transport_t;
+
+/**
+ * TDS transport state
+ */
+typedef enum {
+       BLUETOOTH_TDS_TRANSPORT_STATE_OFF = 0,
+       BLUETOOTH_TDS_TRANSPORT_STATE_ON,
+       BLUETOOTH_TDS_TRANSPORT_STATE_UNAVAILABLE,
+       BLUETOOTH_TDS_TRANSPORT_STATE_RESERVED
+} bluetooth_tds_transport_state_t;
+
+/**
+* TDS data
+*/
+typedef struct {
+       int length;
+       guint8 data[BLUETOOTH_TDS_DATA_LENGTH_MAX];
+} bluetooth_tds_data_t;
+
+/**
+* TDS activation request
+*/
+typedef struct {
+       bluetooth_device_address_t rem_addr;
+       bluetooth_tds_transport_t transport;
+       bluetooth_tds_data_t tds_data;
+} bluetooth_tds_activation_req_t;
+
+/**
+* TDS Control Point data
+*/
+typedef struct {
+       int length;                                                     /**< Control point data length */
+       guint8 data[BLUETOOTH_TDS_CONTROL_POINT_PARAM_LENGTH_MAX];      /**< Control pint param data */
+} bluetooth_control_point_data_t;
+
+/**
+* TDS Indication Response data
+*/
+typedef struct {
+       bluetooth_device_address_t rem_addr;         /**< Device address */
+       bluetooth_control_point_data_t tds_data;     /**< TDS Control Point Indication params */
+} bluetooth_tds_indication_res_t;
+
+/**
+* Structure to hold the TDS Complete data information which is read from remote TDS provider
+*/
+typedef struct {
+       bluetooth_device_address_t device_address;      /**< Device address */
+       int data_length;                        /**< Data length */
+       char *data;                             /**< Complete Transport Specific data */
+} bluetooth_tds_transport_data_info_t;
+
+/**
 * Advertising parameters
 */
 typedef struct {
@@ -613,6 +683,7 @@ typedef enum {
        BLUETOOTH_EVENT_MAP_GET_MESSAGE_COMPLETE,
        BLUETOOTH_EVENT_MAP_GET_MESSAGE_INVALID_ARGUMENTS,
        BLUETOOTH_EVENT_MAP_GET_MESSAGE_FAILED,
+       BLUETOOTH_EVENT_MAP_LIST_FILTER_FIELD_COMPLETE,
 
        BLUETOOTH_EVENT_OBEX_SERVER_TRANSFER_AUTHORIZE = BLUETOOTH_EVENT_OBEX_SERVER_BASE,
                                                                /* Obex server authorize event*/
@@ -722,6 +793,11 @@ typedef enum {
        BLUETOOTH_EVENT_IPSP_INTERFACE_INFO, /** IPSP BT Interface Info after connection */
        BLUETOOTH_EVENT_LE_DATA_LENGTH_CHANGED,  /** LE data length values changed */
        BLUETOOTH_EVENT_PXP_PROPERTY_CHANGED, /** Proximity property changed */
+       BLUETOOTH_EVENT_TDS_ACTIVATION_REQUESTED, /** TDS activation requested */
+       BLUETOOTH_EVENT_TDS_TRANSPORT_DATA_RECEIVED,  /** TDS Transport Data received */
+       BLUETOOTH_EVENT_TDS_ACTIVATION_RESULT,        /** TDS Activation Result */
+       BLUETOOTH_EVENT_TDS_CONTROL_POINT_ENABLED,    /** TDS CCCD enabled event */
+       BLUETOOTH_EVENT_TDS_ACTIVATION_INDICATION,    /** TDS Activation Indication from Provider */
 } bluetooth_event_type_t;
 
  /**
@@ -1156,7 +1232,9 @@ typedef enum {
        HTYPE_TRANS_GET_PROTOCOL,
        HTYPE_TRANS_SET_PROTOCOL,
        HTYPE_TRANS_DATA,
-       HTYPE_TRANS_UNKNOWN
+       HTYPE_TRANS_UNKNOWN,
+       HTYPE_TRANS_GET_IDLE = 0xF0,
+       HTYPE_TRANS_SET_IDLE = 0xF1,
 } bt_hid_header_type_t;
 
 /**
@@ -1276,6 +1354,13 @@ typedef struct {
 } bt_opc_transfer_info_t;
 
 /* TODO: MAP client structures, see above */
+/**
+ * Stucture to Map filter fields
+ */
+typedef struct {
+       char **fields;
+       int size;
+} bt_map_list_filter_fields_info_t;
 
 /* Obex Server transfer type */
 #define TRANSFER_PUT "PUT"
@@ -1471,6 +1556,15 @@ typedef struct {
 } bt_gatt_indicate_confirm_t;
 
 /**
+ * Structure for GATT response data
+ */
+typedef struct {
+       guint8 *value;
+       guint32 len;
+       gpointer user_data;
+} bt_gatt_resp_data_t;
+
+/**
  * Structure to RSSI Signal Strength Alert
  */
 
@@ -1796,11 +1890,87 @@ typedef struct {
        char* remote_address;
 } bt_map_client_session_info_s;
 
+typedef char* bt_map_client_message_object_t;
+
+typedef struct {
+       int16_t offset;
+       int16_t max_count;
+} bt_map_client_list_folders_filter_t;
+
+typedef struct {
+       int16_t offset;
+       int16_t max_count;
+       int8_t subject_length;
+       char *fields;
+       char *types;
+       char *period_begin;
+       char *period_end;
+       int is_read;
+       char *recipient;
+       char *sender;
+       int is_priority;
+} bt_map_client_list_messages_filter_t;
+
+typedef struct {
+       bt_map_client_message_object_t message_object;
+       char *folder;
+       char *subject;
+       char *timestamp;
+       char *sender;
+       char *sender_address;
+       char *reply_to;
+       char *recipient;
+       char *recipient_address;
+       char *type;
+       int64_t size;
+       int is_text;
+       char *status;
+       int64_t attachment_size;
+       int is_priority;
+       int is_read;
+       int is_sent;
+       int is_protected;
+} bt_map_client_message_item_t;
+
+typedef struct {
+       int is_transparent;
+       int is_retry;
+       char *charset;
+} bt_map_client_push_message_args_t;
+
+typedef struct {
+       char *folder;
+       char *subject;
+       char *timestamp;
+       char *sender;
+       char *sender_address;
+       char *reply_to;
+       char *recipient;
+       char *recipient_address;
+       char *type;
+       int64_t size;
+       char *status;
+       int is_priority;
+       int is_read;
+       int is_deleted;
+       int is_sent;
+       int is_protected;
+} bt_map_client_message_t;
+
 typedef struct {
        char **names; // holding %size null-terminated folder names
-       int size;
+       int64_t size;
 } bt_map_client_folders_s;
 
+typedef struct {
+       bt_map_client_message_item_t *message_items;
+       int64_t size;
+} bt_map_client_message_items_s;
+
+typedef struct {
+       const char* target_file;
+       void* user_data;
+} bt_get_message_callback_data;
 
 /**
  * Callback pointer type
@@ -4841,61 +5011,55 @@ int bluetooth_obex_server_is_receiving(gboolean *is_receiving);
  *              BLUETOOTH_ERROR_NO_RESOURCES - Not resource available \n
  *              BLUETOOTH_ERROR_ACCESS_DENIED -Memory allocation failed \n
  *
- * @exception   None
+ * @exception None
  *
- * @remark       None
- * @see          bluetooth_map_client_deinit
+ * @remark None
+ * @see bluetooth_map_client_deinit
  */
 int bluetooth_map_client_init(void);
 
 int bluetooth_map_client_deinit(void);
 
-int bluetooth_map_client_create_session(
-   bt_map_client_session_info_s *session
-);
+int bluetooth_map_client_create_session(bt_map_client_session_info_s *session);
 
-int bluetooth_map_client_destroy_session(
-    bt_map_client_session_info_s *session
-);
+int bluetooth_map_client_destroy_session(bt_map_client_session_info_s *session);
 
-int bluetooth_map_client_set_folder(
-    bt_map_client_session_info_s *session,
-    const char *name
-);
+int bluetooth_map_client_set_folder(bt_map_client_session_info_s *session, const char *name);
 
-int bluetooth_map_client_list_folders(
-    bt_map_client_session_info_s *session,
-    int offset,
-    int maxcount
-);
+int bluetooth_map_client_list_folders(bt_map_client_session_info_s *session,
+                       bt_map_client_list_folders_filter_t *filter);
 
-int bluetooth_map_client_list_filter_fields(
-    bt_map_client_session_info_s *session
-);
+/**
+ * @fn int bluetooth_map_client_list_filter_fields(bt_map_session_info_s* session)
+ * @brief Return all available fields that can be used in Fields filter.
+ *
+ * This function is a asynchronous call.
+ *
+ * @return   BLUETOOTH_ERROR_NONE  - Success \n
+ *              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Device is not enabled \n
+ *              BLUETOOTH_ERROR_INTERNAL - Update inbox failed \n
+ *
+ * @exception   None
+ * @param[in]  session   Information about session.
+ * @remark       None
+ */
+int bluetooth_map_client_list_filter_fields(bt_map_client_session_info_s *session);
 
-int bluetooth_map_client_list_messages(
-    bt_map_client_session_info_s *session,
-    const char *folder,
-    GVariant *filter
-);
+int bluetooth_map_client_list_messages(bt_map_client_session_info_s *session,
+                       const char *folder,
+                       bt_map_client_list_messages_filter_t *filter);
 
-int bluetooth_map_client_update_inbox(
-    bt_map_client_session_info_s *session
-);
+int bluetooth_map_client_update_inbox(bt_map_client_session_info_s *session);
 
-int bluetooth_map_client_push_message(
-    bt_map_client_session_info_s *session,
-    const char *source_file,
-    const char *folder,
-    GVariant *args
-);
+int bluetooth_map_client_push_message(bt_map_client_session_info_s *session,
+                       const char *source_file,
+                       const char *folder,
+                       bt_map_client_push_message_args_t *args);
 
-int bluetooth_map_client_get_message(
-    bt_map_client_session_info_s *session,
-    const char *message_object_name,
-    const char *target_file,
-    bool attachment
-);
+int bluetooth_map_client_get_message(bt_map_client_session_info_s *session,
+                       const bt_map_client_message_object_t message_object,
+                       const char *target_file,
+                       bool attachment);
 
 
 /**
@@ -5175,7 +5339,8 @@ int bluetooth_gatt_set_characteristics_value(const char *char_handle,
  * @see                None
  */
 int bluetooth_gatt_set_characteristics_value_by_type(const char *char_handle,
-                               const guint8 *value, int length, guint8 write_type);
+                                       const guint8 *value, int length,
+                                       guint8 write_type, gpointer app_data);
 
 
 /**
@@ -5220,7 +5385,7 @@ int bluetooth_gatt_set_characteristics_value_request(const char *char_handle,
  * @remark     None
  * @see        None
  */
-int bluetooth_gatt_read_characteristic_value(const char *char_handle);
+int bluetooth_gatt_read_characteristic_value(const char *char_handle, gpointer app_data);
 
 /**
  * @fn int bluetooth_gatt_get_service_from_uuid(bluetooth_device_address_t *address,
@@ -5387,7 +5552,7 @@ int bluetooth_gatt_discover_characteristic_descriptor(const char *characteristic
  * @remark     None
  * @see        None
  */
-int bluetooth_gatt_read_descriptor_value(const char *desc_handle);
+int bluetooth_gatt_read_descriptor_value(const char *desc_handle, gpointer app_data);
 
 /**
  * @fn int bluetooth_gatt_write_descriptor_value(const char *desc_handle,
@@ -5411,7 +5576,7 @@ int bluetooth_gatt_read_descriptor_value(const char *desc_handle);
  * @see        None
  */
 int bluetooth_gatt_write_descriptor_value(const char *desc_handle,
-                       const guint8 *value, int length);
+                       const guint8 *value, int length, gpointer app_data);
 
 /* @fn int bluetooth_gatt_init(void)
 *
@@ -7134,6 +7299,228 @@ int bluetooth_proximity_reporter_get_property(const bluetooth_device_address_t *
                                                        bluetooth_pxp_poperty_t property, int *value);
 
 /**
+ * @fn int bluetooth_tds_provider_register(void);
+ *
+ * @brief Register Transport Discovery Provider role.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_ALREADY_INITIALIZED - Already done \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Adapter not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Operation failed\n
+ *
+ * @exception  None
+ * @param[in] None
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_tds_provider_register(void);
+
+/**
+ * @fn int bluetooth_tds_provider_unregister(void);
+ *
+ * @brief Unregister Transport Discovery Provider role.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_NOT_INITIALIZED - Provider not registered \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Adapter not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Operation failed\n
+ *
+ * @exception  None
+ * @param[in] None
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_tds_provider_unregister(void);
+
+/**
+ * @fn int bluetooth_tds_provider_create(int transport, unsigned int handle);
+ *
+ * @brief Create Transport Discovery Provider for a transport.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *                              BLUETOOTH_ERROR_NOT_INITIALIZED - Provider not registered \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Operation failed\n
+ *
+ * @exception  None
+ * @param[in] Transport (BT, CUSTOM etc.)
+ * @param[in] Unique handle for TDS provider.
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_tds_provider_create(int transport, unsigned int handle);
+
+/**
+ * @fn int bluetooth_tds_provider_destroy(unsigned int handle);
+ *
+ * @brief Remove previously created Transport Discovery Provider.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *
+ * @exception  None
+ * @param[in] Unique handle for previously created provider.
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_tds_provider_destroy(unsigned int handle);
+
+/**
+ * @fn int bluetooth_set_tds_provider_manuf_data(unsigned char *buf, unsigned int length);
+ *
+ * @brief Set transport block for in advertisement and gatt db.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Adapter not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Operation failed\n
+ *
+ * @exception  None
+ * @param[in] Provider specific manufacturer data.
+ * @param[in] Provider specific manufacturer data length.
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_set_tds_provider_manuf_data(unsigned char *buf, unsigned int length);
+
+/**
+ * @fn int bluetooth_set_tds_provider_transport_data(unsigned int tds_handle,
+ *             bluetooth_tds_transport_state_t state, unsigned char *buf, unsigned int length);
+ *
+ * @brief Set transport block for in advertisement and gatt db.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Adapter not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Operation failed\n
+ *
+ * @exception  None
+ * @param[in] Unique handle for TDS provider.
+ * @param[in] Transport state (On/Off/Not Available).
+ * @param[in] Transport specific data block.
+ * @param[in] Transport specific data block length.
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_set_tds_provider_transport_data(unsigned int tds_handle,
+               bluetooth_tds_transport_state_t state, unsigned char *buf, unsigned int length);
+
+/**
+ * @fn int bluetooth_send_tds_activation_response(bluetooth_device_address_t *device_address,
+ *             unsigned int tds_handle, int response, unsigned char *buf, unsigned int length);
+ *
+ * @brief Send response to TDS activation request from remoted device.
+ *
+ * This function is a synchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *                              BLUETOOTH_ERROR_NOT_INITIALIZED - Provider not registered \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Operation failed\n
+ *
+ * @exception  None
+ * @param[in] Remote device BT address.
+ * @param[in] Unique handle for TDS provider.
+ * @param[in] Response for TDS activation request.
+ * @param[in] Transport specific data block to be sent in activation response.
+ * @param[in] Data block length.
+ * @param[out] None
+ *
+ * @remark     None
+ */
+int bluetooth_send_tds_activation_response(bluetooth_device_address_t *device_address,
+       unsigned int tds_handle, int response, unsigned char *buf, unsigned int length);
+
+/**
+ * @fn int bluetooth_tds_read_transport_data(bluetooth_device_address_t *device_address, const char *handle);
+ *
+ * @brief Reads the Complete TDS transport Blocks from Remote Provider's GATT database.
+ *
+ * This function is an asynchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Device is not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Internal Error \n
+ *                              BLUETOOTH_ERROR_IN_PROGRESS - Already Read Request is pending on same provider \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *
+ * @exception  None
+ * @param[in] device_address remote device address
+ * @param[in] handle attribute handle
+ *
+ * @remark     BLUETOOTH_EVENT_TDS_TRANSPORT_DATA_RECEIVED event is sent to pplication
+ * when TDS data is received from Remote provider
+ */
+int bluetooth_tds_read_transport_data(const bluetooth_device_address_t *device_address,
+                                               const char *handle);
+
+/**
+ * @fn int bluetooth_tds_enable_control_point(const bluetooth_device_address_t *device_address, const char *handle);
+ *
+ * @brief Enables CCCD on Remote Provider.
+ *
+ * This function is an asynchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Device is not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Internal Error \n
+ *                              BLUETOOTH_ERROR_IN_PROGRESS - Already Control Point activation is ongoing to Same Provider \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *
+ * @exception  None
+ * @param[in] device_address remote device address
+ * @param[in] handle attribute handle
+ *
+ * @remark     BLUETOOTH_EVENT_TDS_CONTROL_POINT_ENABLED event is sent to application
+ * when Indication is enabled on Remote provider
+ */
+int bluetooth_tds_enable_control_point(const bluetooth_device_address_t *device_address,
+                                               const char *handle);
+
+/**
+ * @fn int bluetooth_tds_activate_control_point(const bluetooth_device_address_t *device_address, const char *handle
+ *                                                     unsigned char *buf, int length);
+ * @brief Sends activation request for Alternate Transport enable on Remote Provider
+ *
+ * This function is an asynchronous call.
+ *
+ * @return      BLUETOOTH_ERROR_NONE - Success \n
+ *                              BLUETOOTH_ERROR_DEVICE_NOT_ENABLED - Device is not enabled \n
+ *                              BLUETOOTH_ERROR_INTERNAL - Internal Error \n
+ *                              BLUETOOTH_ERROR_IN_PROGRESS - Already Control Point activation is ongoing to Same Provider \n
+ *                              BLUETOOTH_ERROR_INVALID_PARAM - Invalid parameter \n
+ *
+ * @exception  None
+ * @param[in] device_address remote device address
+ * @param[in] handle attribute handle
+ * @param[in] buf Control point activation param
+ * @param[in] param length
+ *
+ * @remark     BLUETOOTH_EVENT_TDS_ACTIVATION_INDICATION event is sent to application when Indication response
+ * is received from remote Provider
+ */
+int bluetooth_tds_activate_control_point(const bluetooth_device_address_t *device_address, const char *handle,
+                                               unsigned char *buf, int length);
+
+/**
  * @}
  */