Deprecate HDP(Health Device Profile) APIs 32/185832/4 accepted/tizen/unified/20180816.134639 submit/tizen/20180814.011534
authorDoHyun Pyun <dh79.pyun@samsung.com>
Wed, 8 Aug 2018 05:16:40 +0000 (14:16 +0900)
committerPyun DoHyun <dh79.pyun@samsung.com>
Wed, 8 Aug 2018 06:14:02 +0000 (06:14 +0000)
In these days there is no vendor to make BT health device
(BT/EDR HDP profile). And the supported device also be
less. Because we can't get new BT health device, it is hard
to verify APIs for developers and testers. So we deprecate
HDP APIs

Change-Id: I1e4cb04d0144b4023a7a536e2bfba5458cccb0c9
Signed-off-by: DoHyun Pyun <dh79.pyun@samsung.com>
include/bluetooth.h
include/bluetooth_type.h

index 38ac6d0..4164c99 100644 (file)
@@ -3736,12 +3736,14 @@ int bt_avrcp_control_get_track_info(bt_avrcp_metadata_attributes_info_s **track)
 int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track);
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief Registers an application that acts as the Sink role of HDP (Health Device Profile).
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/bluetooth
- * @remarks The @a app_id must be released with free() by you.
+ * @remarks The @a app_id must be released with free() by you. \n
+ *          Deprecated, because of no usecase and supported devices.
  * @param[in] data_type  The data type of MDEP. This value is defined in ISO/IEEE 11073-20601 spec.
  * For example, pulse oximeter is 0x1004 and blood pressure monitor is 0x1007.
  * @param[out] app_id  The ID of application
@@ -3757,14 +3759,16 @@ int bt_avrcp_control_free_track_info(bt_avrcp_metadata_attributes_info_s *track)
  * @pre The state of local Bluetooth must be #BT_ADAPTER_ENABLED.
  * @see bt_hdp_unregister_sink_app()
  */
-int bt_hdp_register_sink_app(unsigned short data_type, char **app_id);
+int bt_hdp_register_sink_app(unsigned short data_type, char **app_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief Unregisters the given application that acts as the Sink role of HDP (Health Device Profile).
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/bluetooth
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @param[in] app_id  The ID of application
  * @return 0 on success, otherwise a negative error value.
  * @retval #BT_ERROR_NONE  Successful
@@ -3777,14 +3781,16 @@ int bt_hdp_register_sink_app(unsigned short data_type, char **app_id);
  *
  * @see bt_hdp_register_sink_app()
  */
-int bt_hdp_unregister_sink_app(const char *app_id);
+int bt_hdp_unregister_sink_app(const char *app_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief Connects the remote device which acts as Source role, asynchronously.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/bluetooth
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @param[in] remote_address  The remote address
  * @param[in] app_id  The ID of application
  * @return 0 on success, otherwise a negative error value.
@@ -3804,14 +3810,16 @@ int bt_hdp_unregister_sink_app(const char *app_id);
  * @see bt_hdp_set_connection_state_changed_cb()
  * @see bt_hdp_unset_connection_state_changed_cb()
  */
-int bt_hdp_connect_to_source(const char *remote_address, const char *app_id);
+int bt_hdp_connect_to_source(const char *remote_address, const char *app_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief Disconnects the remote device, asynchronously.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/bluetooth
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @param[in] remote_address  The remote address
  * @param[in] channel  The connected data channel
  * @return 0 on success, otherwise a negative error value.
@@ -3830,14 +3838,16 @@ int bt_hdp_connect_to_source(const char *remote_address, const char *app_id);
  * @see bt_hdp_set_connection_state_changed_cb()
  * @see bt_hdp_unset_connection_state_changed_cb()
  */
-int bt_hdp_disconnect(const char *remote_address, unsigned int channel);
+int bt_hdp_disconnect(const char *remote_address, unsigned int channel) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief Sends the data to the remote device.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/bluetooth
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @param[in] channel  The connected data channel
  * @param[in] data  The data to send
  * @param[in] size  The size of data to send (byte)
@@ -3855,12 +3865,14 @@ int bt_hdp_disconnect(const char *remote_address, unsigned int channel);
  * @see bt_hdp_set_data_received_cb()
  * @see bt_hdp_unset_data_received_cb()
  */
-int bt_hdp_send_data(unsigned int channel, const char *data, unsigned int size);
+int bt_hdp_send_data(unsigned int channel, const char *data, unsigned int size) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Registers a callback function that will be invoked when the connection state is changed.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @param[in] connected_cb The callback function called when a connection is established
  * @param[in] disconnected_cb The callback function called when a connection is disconnected
  * @param[in] user_data The user data to be passed to the callback function
@@ -3873,12 +3885,14 @@ int bt_hdp_send_data(unsigned int channel, const char *data, unsigned int size);
  * @pre The Bluetooth service must be initialized with bt_initialize().
  * @see bt_hdp_unset_connection_state_changed_cb()
  */
-int bt_hdp_set_connection_state_changed_cb(bt_hdp_connected_cb connected_cb, bt_hdp_disconnected_cb disconnected_cb, void *user_data);
+int bt_hdp_set_connection_state_changed_cb(bt_hdp_connected_cb connected_cb, bt_hdp_disconnected_cb disconnected_cb, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Unregisters a callback function that will be invoked when the connection state is changed.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @return   0 on success, otherwise a negative error value.
  * @retval #BT_ERROR_NONE  Successful
  * @retval #BT_ERROR_NOT_INITIALIZED  Not initialized
@@ -3887,12 +3901,14 @@ int bt_hdp_set_connection_state_changed_cb(bt_hdp_connected_cb connected_cb, bt_
  * @pre The Bluetooth service must be initialized with bt_initialize().
  * @see bt_hdp_set_connection_state_changed_cb()
  */
-int bt_hdp_unset_connection_state_changed_cb(void);
+int bt_hdp_unset_connection_state_changed_cb(void) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Registers a callback function that will be invoked when you receive the data.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @param[in] callback The callback function to register
  * @param[in] user_data The user data to be passed to the callback function
  * @return   0 on success, otherwise a negative error value.
@@ -3904,12 +3920,14 @@ int bt_hdp_unset_connection_state_changed_cb(void);
  * @pre The Bluetooth service must be initialized with bt_initialize().
  * @see bt_hdp_unset_data_received_cb()
  */
-int bt_hdp_set_data_received_cb(bt_hdp_data_received_cb callback, void *user_data);
+int bt_hdp_set_data_received_cb(bt_hdp_data_received_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Unregisters a callback function that will be invoked when you receive the data.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  * @return   0 on success, otherwise a negative error value.
  * @retval #BT_ERROR_NONE  Successful
  * @retval #BT_ERROR_NOT_INITIALIZED  Not initialized
@@ -3918,7 +3936,7 @@ int bt_hdp_set_data_received_cb(bt_hdp_data_received_cb callback, void *user_dat
  * @pre The Bluetooth service must be initialized with bt_initialize().
  * @see bt_hdp_set_data_received_cb()
  */
-int bt_hdp_unset_data_received_cb(void);
+int bt_hdp_unset_data_received_cb(void) TIZEN_DEPRECATED_API;
 
 /**
  * @ingroup CAPI_NETWORK_BLUETOOTH_GATT_MODULE
index bb3e936..d7abbd0 100644 (file)
@@ -638,9 +638,11 @@ typedef void (*bt_avrcp_track_info_changed_cb) (bt_avrcp_metadata_attributes_inf
 typedef void (*bt_avrcp_play_status_changed_cb) (bt_avrcp_player_state_e play_state, void *user_data);
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Enumerations for the data channel type.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  */
 typedef enum {
        BT_HDP_CHANNEL_TYPE_RELIABLE  = 0x01,  /**< Reliable Data Channel */
@@ -1573,9 +1575,11 @@ typedef void (*bt_avrcp_scan_mode_changed_cb) (bt_avrcp_scan_mode_e scan, void *
 typedef void (*bt_hid_host_connection_state_changed_cb) (int result, bool connected, const char *remote_address, void *user_data);
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Called when the connection is established.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  *
  * @param[in] result  The result of connecting to the remote device
  * @param[in] remote_address  The address of connected remote device
@@ -1590,9 +1594,11 @@ typedef void (*bt_hdp_connected_cb) (int result, const char *remote_address, con
        bt_hdp_channel_type_e type, unsigned int channel, void *user_data);
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Called when the connection is disconnected.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  *
  * @param[in] result  The result of disconnecting from the remote device
  * @param[in] remote_address  The address of disconnected remote device
@@ -1604,9 +1610,11 @@ typedef void (*bt_hdp_connected_cb) (int result, const char *remote_address, con
 typedef void (*bt_hdp_disconnected_cb) (int result, const char *remote_address, unsigned int channel, void *user_data);
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_NETWORK_BLUETOOTH_HDP_MODULE
  * @brief  Called when the you receive the data.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks Deprecated, because of no usecase and supported devices.
  *
  * @param[in] channel  The connected data channel
  * @param[in] data  The received data