/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
- * @brief Enumeration of an endpoint's direction.
+ * @brief An enumeration representing USB endpoint direction.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
- * @brief Enumeration of transfer type.
+ * @brief An enumeration representing USB endpoint transfer type.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
- * @brief Enumeration of an endpoint's usage type.
+ * @brief An enumeration representing USB endpoint usage type.
* @since_tizen 3.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
- * @brief Enumeration of hotplug event types.
+ * @brief An enumeration representing USB hotplug event types.
* @since_tizen 4.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Enumeration of transfer status codes.
+ * @brief An enumeration representing USB async transfer status codes.
* @since_tizen 5.0
*/
typedef enum {
/**
* @ingroup CAPI_USB_HOST_MODULE
- * @brief Context handle to USB host.
+ * @brief An opaque handle representing the USB host context.
* @details This structure represents usb_host session.
* Using own session allows to use this API independently.
* For example calling usb_host_destroy() will not destroy resources
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Structure representing USB device.
+ * @brief An opaque handle representing a USB device on the bus.
* @details This structure represents USB device found on USB bus.
*
* This can be obtained by usb_host_get_device_list() or usb_host_device_open_with_vid_pid().
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
- * @brief USB config handle.
+ * @brief An opaque handle representing a USB device configuration.
* @details This type represents USB device configuration. Device can have multiple configurations,
* a configuration can have multiple interfaces. This handle can be obtained by
* usb_host_device_get_config().
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
- * @brief USB interface handle.
+ * @brief An opaque handle representing a USB configuration interface.
* @details This type represents USB interface. An interface is a part of configuration and
* can have multiple endpoints. This handle can be obtained by usb_host_config_get_interface().
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_ENDPOINT_MODULE
- * @brief USB endpoint handle.
+ * @brief An opaque handle representing a USB interface endpoint.
* @details This type represents USB endpoint. This handle can be obtained by
* usb_host_interface_get_endpoint().
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
- * @brief USB hotplug callback handle.
+ * @brief An opaque handle representing a USB hotplug callback manager.
* @details This handle is used for managing registered hotplug callbacks.
* @since_tizen 4.0
*/
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
- * @brief Device connected/disconnected event handler.
+ * @brief An type representing a USB hotplug callback handler.
* @details The device handle should be unreffed with usb_host_unref_device()
* when no longer needed.
* @since_tizen 4.0
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief USB asynchronous transfer handle.
+ * @brief An opaque handle representing an asynchronous USB transfer.
* @details This type represents an asynchronous USB transfer.
* @since_tizen 5.0
*/
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Called when asynchronous transfers finishes.
+ * @brief An type representing a USB transfer finish callback.
* @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_MODULE
- * @brief Initializes usb_host context.
+ * @brief Initializes a USB host context, providing a handle to it
* @details This function must be called before any other function from this module.
* @since_tizen 3.0
* @remarks @a ctx should be destroyed by calling usb_host_destroy() when no longer needed.
/**
* @ingroup CAPI_USB_HOST_MODULE
- * @brief Deinitializes usb_host context.
+ * @brief Deinitializes a USB host context, invalidating a handle
* @details This function must be called after closing all devices
* and before application close. It has to be called to clean
* the memory used by library.
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets USB device list.
+ * @brief Returns a list of USB devices attached to the system.
* @details This function returns list of USB devices attached to system.
* To free obtained device list usb_host_free_device_list() should be used, this
* function can also unref devices. Do not unref device and then open it.
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Frees devices list.
+ * @brief Frees devices list and optionally unrefs its contents
* @details This function needs to be called to free device list. This
* function can also unref devices if unref_devices is set to non-zero value.
* Do not unref device and then open it.
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Refs a device.
+ * @brief Increments the reference counter of given USB device
* @details Increment ref count of device.
* @since_tizen 3.0
* @param[in] dev Device to reference
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Unrefs a device.
+ * @brief Decrements the reference counter of given USB device
* @details Decrements ref count of device. If ref count reaches zero,
* device will be destroyed.
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Opens a device.
+ * @brief Opens a device obtained from the list of devices to allow operations.
* @details This function opens a device, which allows performing operations on it
* (including transfer operations and strings introspection).
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Closes device.
+ * @brief Closes an opened but not destroyed USB device handle.
* @details Function should be called before usb_host_destroy().
* It destroys reference that was added by usb_host_device_open().
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Opens device with valid idVendor and idProduct.
+ * @brief Opens device with valid, known idVendor and idProduct.
* @details This function can be used to open device with known idVendor and
* idProduct. If two or more devices have same vendor and product id only
* first will be opened.
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets bus number.
+ * @brief Gets the number of the bus the given device is connected to.
* @details Gets device bus number. This is number of the bus
* that device is connected to.
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets address.
+ * @brief Gets the address on the bus the given device is connected to.
* @details Gets device address. This is address of device on the bus
* that device is connected to.
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets list of port numbers.
+ * @brief Gets list of port numbers available from a device.
* @details Gets list of all port numbers from a device.
* @since_tizen 3.0
* @param[in] dev Device
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets a configuration.
+ * @brief Gets a USB configuration from a device given an index.
* @details Gets a USB configuration from a device.
* @since_tizen 3.0
* @remarks @a config must be freed with usb_host_config_destroy().
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets an active config.
+ * @brief Gets a handle to the configuration currently active on the device.
* @details Gets handle to active configuration.
* This function will return 0 value in config parameter :if device is unconfigured.
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Sets a configuration.
+ * @brief Sets a configuration as the currently active on a device.
* @details Set active configuration for a device.
* @since_tizen 3.0
* @param[in] configuration Handle to configuration to be activated
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Puts a device in unconfigured state.
+ * @brief 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 USB specification release number.
+ * @brief Gets USB specification release number supported by given device.
* @details Gets binary-coded decimal USB specification release number.
* This value is equal to bcdUSB field of device descriptor. See USB specification
* for more info.
/**
* @ingroup CAPI_USB_HOST_DEV_MODULE
- * @brief Gets device class.
+ * @brief 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 device sub class.
+ * @brief 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 device protocol.
+ * @brief 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 maximum packet size for endpoint 0.
+ * @brief 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 vendor id.
+ * @brief 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 product id.
+ * @brief 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 number of configurations for given device.
+ * @brief 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 if device is opened.
+ * @brief 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 device manufacturer, in ASCII.
+ * @brief 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 device, in ASCII.
+ * @brief 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 serial number of a device, in ASCII.
+ * @brief 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 maximum power in given configuration, in mA.
+ * @brief 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 string describing a configuration.
+ * @brief 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_CONFIG_MODULE
- * @brief Gets an interface from configuration.
+ * @brief Gets a USB interface from given USB configuration.
* @details Gets a USB interface from configuration by its index.
* @since_tizen 3.0
* @param[in] config Configuration handle
/**
* @ingroup CAPI_USB_HOST_CONFIG_MODULE
- * @brief Frees configuration.
+ * @brief Frees a configuration struct and its associated data.
* @details Frees configuration obtained from usb_host_device_get_config().
* @since_tizen 3.0
* @param[in] config Configuration to free
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
- * @brief Claims interface.
+ * @brief Claims a USB interface on a device for further I/O.
* @details Claims interface on a device.
* To perform I/O operations on interface user has to claim it.
* Remember to call usb_host_release_interface() when communication
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
- * @brief Releases interface.
+ * @brief Releases a previously claimed interface on a device.
* @details Releases interface previously claimed by usb_host_claim_interface().
* This is a blocking function.
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
- * @brief Gets number of given interface.
+ * @brief 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 number of endpoints in given interface.
+ * @brief 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 from interface.
+ * @brief Gets an endpoint via index from given USB interface.
* @details Get a USB endpoint from interface by its index.
* @since_tizen 3.0
* @param[in] interface Interface handle
/**
* @ingroup CAPI_USB_HOST_INTERFACE_MODULE
- * @brief Sets alternative setting for interface.
+ * @brief 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 string describing an interface.
+ * @brief 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 number of given endpoint.
+ * @brief 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 direction of an endpoint.
+ * @brief 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 given endpoint.
+ * @brief 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 endpoint.
+ * @brief 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 usage type of given endpoint.
+ * @brief 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 of given endpoint.
+ * @brief 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_SYNCIO_MODULE
- * @brief Performs USB control transfer.
+ * @brief Performs unidirectional USB control transfer on given device.
* @details For more explanation about the values please refer to USB protocol specification
* @since_tizen 3.0
* @remarks The wValue, wIndex and wLength fields values should be given in host-endian
/**
* @ingroup CAPI_USB_HOST_SYNCIO_MODULE
- * @brief Performs transfer on given endpoint.
+ * @brief Performs unidirectional transfer on given endpoint.
* @details Performs a USB transfer on given endpoint. Direction of transfer is
* determined by the endpoint.
* @since_tizen 3.0
/**
* @ingroup CAPI_USB_HOST_HOTPLUG_MODULE
- * @brief Unsets the hotplug callback function.
+ * @brief 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 Prepares an asynchronous USB transfer.
+ * @brief Prepares an asynchronous USB transfer and provides a handle to it.
* @details This function prepares transfer handle for asynchronous communication.
* Transfer handle can be used for multiple transfers after this initialization.
* @since_tizen 5.0
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Prepares an asynchronous USB isochronous transfer.
+ * @brief Prepares an asynchronous USB isochronous transfer and provides a handle to it.
* @details This function prepares transfer handle for asynchronous communication.
* Usage is similar to usb_host_create_transfer(), except this function is intended for
* isochronous endpoints. Transfer handle can be used for multiple transfers after this initialization.
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Prepares an asynchronous USB control transfer.
+ * @brief Prepares an asynchronous USB control transfer and provides a handle to it.
* @details This function prepares control transfer handle. Transfer handle can
* be used for multiple transfers after this initialization. Note, that first
* 8 bytes of data buffer are interpreted as control setup packet. You may use
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Sets an endpoint for asynchronous transfer.
+ * @brief Sets an endpoint for asynchronous transfer for a transfer handle.
* @details This function changes the endpoint on which given transfer is performed. Next submissions will be
* performed on this endpoint.
* @since_tizen 5.0
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Sets a callback for asynchronous transfer.
+ * @brief Sets a callback for asynchronous transfer for a transfer handle.
* @details This function changes the callback to be called on transfer completion.
* @since_tizen 5.0
* @param[in] transfer A transfer handle
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Sets data buffer for asynchronous transfer.
+ * @brief Sets data buffer for asynchronous transfer for a transfer handle.
* @details This function changes the data buffer used for this transfer.
* @since_tizen 5.0
* @param[in] transfer A transfer handle
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Sets timeout for asynchronous transfer.
+ * @brief Sets timeout for asynchronous transfer for a transfer handle.
* @details This function changes the timeout after which transfer will be stopped due to
* no response being received.
* @since_tizen 5.0
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Gets the transfer status.
+ * @brief 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 Gets the transfer data.
+ * @brief 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.
+ * @brief 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 length of data buffer.
+ * @brief Gets nominal length of data buffer from a transfer handle.
* @details This functions gets length that was set for data buffer, not the actual transferred data length.
* For length of transferred data see usb_host_transfer_get_data().
* @since_tizen 5.0
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Sets an isochronous packet length.
+ * @brief Sets an isochronous individual packet length for a transfer handle.
* @details This function sets length of individual packet.
* @since_tizen 5.0
* @param[in] transfer Transfer handle
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Gets an isochronous packet status.
+ * @brief 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.
+ * @brief 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.
+ * @brief 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.
+ * @brief 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 Destroys an asynchronous transfer structure.
+ * @brief Destroys a finished or cancelled asynchronous transfer structure.
* @details When no longer needed, transfer should be destroyed by this function.
* It frees memory allocated for the transfer. You cannot destroy unfinished transfer,
* wait for its completion or cancel it.
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Submits an asynchronous USB transfer.
+ * @brief Submits an initialized, asynchronous USB transfer.
* @details Calling this will start actual transfer.
* @since_tizen 5.0
* @param[in] transfer Transfer handle to be submitted
/**
* @ingroup CAPI_USB_HOST_ASYNC_MODULE
- * @brief Cancels an asynchronous USB transfer.
+ * @brief Attempts to cancel an ongoing asynchronous USB transfer.
* @details After calling this function the transfer will be cancelled, if only
* it was not finished already. The transfer callback will be called with #USB_HOST_TRANSFER_CANCELLED status.
* @since_tizen 5.0