/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief An enumeration representing USB endpoint direction.
+ * @details Used to control whether an endpoint writes or reads data.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief An enumeration representing USB endpoint transfer type.
+ * @details Used to control how a data transfer request is going to operate.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Enumeration of isochronous endpoint's synchronization type.
+ * @details Used to control how a data transfer request is going to be synchronized.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief An enumeration representing USB endpoint usage type.
+ * @details Used to control what sort of tasks an endpoint is up to.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_MODULE
* @brief Enumeration of error codes reported by USB host API.
+ * @details Most USB Host functions will return those errors to denote what happened.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
* @brief An enumeration representing USB hotplug event types.
+ * @details Says whether a hotplug event was about attachment or detachment.
* @since_tizen 4.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief An enumeration representing USB async transfer status codes.
+ * @details Used to give the current status of a USB transfer handle.
* @since_tizen 5.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief An type representing a USB transfer finish callback.
+ * @details Use to be notified for when a USB transfer is done.
* @since_tizen 5.0
* @param[in] transfer Transfer for which this callback was set
* @param[in] user_data User data pointer passed on callback registration
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Increments the reference counter of given USB device
- * @details Increment ref count of device.
+ * @details Increment ref count of device. If ref count reaches zero,
+ * device will be destroyed.
* @since_tizen 3.0
* @param[in] dev Device to reference
* @return 0 on success, error code otherwise
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets a USB configuration from a device given an index.
- * @details Gets a USB configuration from a device.
+ * @details Gets a USB configuration from a device given an index.
* @since_tizen 3.0
* @remarks @a config must be freed with usb_host_config_destroy().
* @param[in] dev Device
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Sets a configuration as the currently active on a device.
- * @details Set active configuration for a device.
+ * @details Sets a configuration as the currently active on a device.
* @since_tizen 3.0
* @param[in] configuration Handle to configuration to be activated
* @return 0 on success, otherwise a negative error value
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Returns a USB device back to the unconfigured state.
+ * @details Returns a USB device back to the unconfigured state.
* @since_tizen 4.0
* @param[in] dev Device to be unconfigured
* @return 0 on success, otherwise a negative error value
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the numerical device class of given USB device.
+ * @details Gets the numerical device class of given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] device_class Device class
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the numerical sub class of given USB device.
+ * @details Gets the numerical sub class of given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] subclass Device subclass
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the protocol being used by the given USB device.
+ * @details Gets the protocol being used by the given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] protocol Device protocol
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the maximum packet size for endpoint 0 on given USB device.
+ * @details Gets the maximum packet size for endpoint 0 on given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] max_packet_size Maximum size of single packet, in bytes
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the numerical vendor identifier of the given USB device.
+ * @details Gets the numerical vendor identifier of the given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] vendor_id Vendor id of @a dev
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the numerical product identifier of the given USB device.
+ * @details Gets the numerical product identifier of the given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] product_id Product id of @a dev
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets device release number in binary-coded decimal.
+ * @details Gets device release number in binary-coded decimal.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] device_bcd Device release number
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the number of configurations for given USB device.
+ * @details Gets the number of configurations for given USB device.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] num_configurations Number of configurations for given device
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Checks whether given USB device is currently opened.
+ * @details Checks whether given USB device is currently opened.
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] is_opened True if device is opened, false otherwise
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets string describing an open device's manufacturer, in ASCII.
+ * @details Gets string describing an open device's manufacturer, in ASCII.
* @since_tizen 3.0
* @param[in] dev A handle to opened device
* @param[in, out] length Data buffer size/how much was actually used
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets product string of an open USB device, in ASCII.
+ * @details Gets product string of an open USB device, in ASCII.
* @since_tizen 3.0
* @param[in] dev A handle to opened device
* @param[in, out] length Data buffer size/how much was actually used
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
* @brief Gets the serial number of an open USB device, in ASCII.
+ * @details Gets the serial number of an open USB device, in ASCII.
* @since_tizen 3.0
* @param[in] dev A handle to opened device
* @param[in, out] length Data buffer size/how much was actually used
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
* @brief Gets number of interfaces for given configuration.
+ * @details Gets number of interfaces for given configuration.
* @since_tizen 3.0
* @param[in] config A configuration
* @param[out] num_interfaces Number of interfaces
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
* @brief Checks if device is self-powered in given configuration.
+ * @details Checks if device is self-powered in given configuration.
* @since_tizen 3.0
* @param[in] config A configuration
* @param[out] self_powered True if device is self-powered in given configuration,
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
* @brief Checks if device in given configuration supports remote wakeup.
+ * @details Checks if device in given configuration supports remote wakeup.
* @since_tizen 3.0
* @param[in] config A configuration
* @param[out] remote_wakeup True if device supports remote wakeup in given configuration,
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
* @brief Gets maximum power in given USB configuration, in mA.
+ * @details Gets maximum power in given USB configuration, in mA.
* @since_tizen 3.0
* @param[in] config A configuration
* @param[out] max_power Maximum power, in mA
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
* @brief Gets a string describing a USB configuration into given buffer.
+ * @details Gets a string describing a USB configuration into given buffer.
* @since_tizen 3.0
* @param[in] config A configuration
* @param[in, out] length Data buffer size/how much was actually used
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
* @brief Gets the "number" of the given USB interface handle.
+ * @details Gets the "number" of the given USB interface handle.
* @since_tizen 3.0
* @param[in] interface An interface
* @param[out] number Number of given interface
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
* @brief Gets the number of endpoints in given USB interface.
+ * @details Gets the number of endpoints in given USB interface.
* @since_tizen 3.0
* @param[in] interface An interface
* @param[out] num_endpoints Number of endpoints in @a interface
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
* @brief Gets an endpoint via index from given USB interface.
- * @details Get a USB endpoint from interface by its index.
+ * @details Gets an endpoint via index from given USB interface.
* @since_tizen 3.0
* @param[in] interface Interface handle
* @param[in] ep_index index of endpoint to retrieve (counting from 0)
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
* @brief Sets an alternative setting for given USB interface.
+ * @details Sets an alternative setting for given USB interface.
* @since_tizen 3.0
* @param[in] interface Interface handle
* @param[in] altsetting Index of new alternative setting for given interface
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
* @brief Gets current alternative setting from an interface.
+ * @details Gets current alternative setting from an interface.
* @since_tizen 4.0
* @param[in] interface Interface handle
* @param[out] altsetting Index of alternative setting set for the given interface
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
* @brief Gets a string describing the given USB interface into a buffer.
+ * @details Gets a string describing the given USB interface into a buffer.
* @since_tizen 3.0
* @param[in] interface An interface
* @param[in, out] length Data buffer size/how much was actually used
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets the "number" of the given USB endpoint handle.
+ * @details Gets the "number" of the given USB endpoint handle.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] number Number of given endpoint
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets the direction of the given USB endpoint handle.
+ * @details Gets the direction of the given USB endpoint handle.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] direction Direction of endpoint (a value from enum #usb_host_endpoint_direction_e)
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets transfer type of the given USB endpoint handle.
+ * @details Gets transfer type of the given USB endpoint handle.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] transfer_type Transfer type (a value from enum #usb_host_transfer_type_e)
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets synchronization type of given USB endpoint handle.
+ * @details Gets synchronization type of given USB endpoint handle.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] synch_type Synch type (a value from enum #usb_host_iso_sync_type_e)
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets the usage type of the given USB endpoint handle.
+ * @details Gets the usage type of the given USB endpoint handle.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] usage_type Usage type (a value from enum #usb_host_usage_type_e)
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets max packet size from given USB endpoint handle.
+ * @details Gets max packet size from given USB endpoint handle.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] max_packet_size Max packet size, in bytes
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets interval for polling endpoint for data transfers.
+ * @details Gets interval for polling endpoint for data transfers.
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] interval Interval for polling, in frame counts (refer to USB protocol specification)
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
* @brief Sets a callback function to be invoked when a device is connected or disconnected.
+ * @details Sets a callback function to be invoked when a device is connected or disconnected.
* @since_tizen 4.0
* @param[in] ctx Context handle
* @param[in] cb The callback function to be registered
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
* @brief Unsets the (dis)connection hotplug callback function.
+ * @details Unsets the (dis)connection hotplug callback function.
* @since_tizen 4.0
* @param[in] handle Handle of the callback to be unregistered
* @return 0 on success, negative error code on error
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Sets request type for control transfer setup packet.
+ * @details Sets request type for control transfer setup packet.
* @since_tizen 5.0
* @param[in] transfer A transfer handle
* @param[in] bm_request_type bmRequestType type field for the setup packet
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Sets request field for control transfer setup packet.
+ * @details Sets request field for control transfer setup packet.
* @since_tizen 5.0
* @param[in] transfer A transfer handle
* @param[in] b_request Request field for the setup packet
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Sets w_value field for control transfer setup packet.
+ * @details Sets w_value field for control transfer setup packet.
* @since_tizen 5.0
* @param[in] transfer A transfer handle
* @param[in] w_value wValue field for the setup packet
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Sets w_index field for control transfer setup packet.
+ * @details Sets w_index field for control transfer setup packet.
* @since_tizen 5.0
* @param[in] transfer A transfer handle
* @param[in] w_index wIndex field for the setup packet
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Gets the status of a transfer from a transfer handle.
+ * @details Gets the status of a transfer from a transfer handle.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
* @param[out] status Status of this transfer
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Borrows a handle to the transfer data from a transfer handle.
+ * @details Borrows a handle to the transfer data from a transfer handle.
* @since_tizen 5.0
* @remarks @a data is part of the transfer object and should not be released
* separately. It should not be accessed after @a transfer is destroyed.
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Gets the *control* transfer data from a transfer handle.
+ * @details Gets the *control* transfer data from a transfer handle.
* @since_tizen 5.0
* @remarks @a data is part of the transfer object and should not be released
* separately. It should not be accessed after @a transfer is destroyed.
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Gets number of isochronous packets for this transfer.
+ * @details Gets number of isochronous packets for this transfer.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
* @param[out] num_iso_packets Number of isochronous packets
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Sets an isochronous individual packet length for a transfer handle.
- * @details This function sets length of individual packet.
+ * @details Sets an isochronous individual packet length for a transfer handle.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
* @param[in] packet_number Number of isochronous packet
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Gets an isochronous packet status from a transfer handle.
+ * @details Gets an isochronous packet status from a transfer handle.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
* @param[in] packet_number Number of isochronous packet
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Gets data buffer of isochronous packet from a transfer handle.
+ * @details Gets data buffer of isochronous packet from a transfer handle.
* @since_tizen 5.0
* @remarks @a data is part of the transfer object and should not be released
* separately. It should not be accessed after @a transfer is destroyed.
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Gets isochronous packet data buffer length from a transfer handle.
+ * @details Gets isochronous packet data buffer length from a transfer handle.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
* @param[in] packet_number Number of isochronous packet
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
* @brief Gets type of a transfer from a given transfer handle.
+ * @details Gets type of a transfer from a given transfer handle.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
* @param[out] transfer_type Transfer type (a value from enum #usb_host_transfer_type_e)
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
* @brief Submits an initialized, asynchronous USB transfer.
- * @details Calling this will start actual transfer.
+ * @details Submits an initialized, asynchronous USB transfer. Calling this will start actual transfer.
* @since_tizen 5.0
* @param[in] transfer Transfer handle to be submitted
* @return 0 on success, negative error code on error