* @since_tizen 3.0
* @remarks @a ctx should be destroyed by calling usb_host_destroy() when no longer needed.
* @param[out] ctx Context pointer
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_OUT_OF_MEMORY Out of memory
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* the memory used by library.
* @since_tizen 3.0
* @param[in] ctx Context to deinitialize
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @retval #USB_HOST_ERROR_NONE Success
* @param[in] ctx Context handle
* @param[out] devs An array of devices
* @param[out] length Number of devices
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_OUT_OF_MEMORY Out of memory
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Operation not supported
* @param[in] devs List of devices
* @param[in] unref_devices Set to @c true to unreference devices,
* set to @c false to not unref
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @retval #USB_HOST_ERROR_NONE Successful
* @details Increment ref count of device.
* @since_tizen 3.0
* @param[in] dev Device to reference
- * @return @c 0 on success,
+ * @return @c 0 on success,
* error code otherwise
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @retval #USB_HOST_ERROR_NONE Successful
* @details Decrements ref count of device. If ref count reaches zero, device will be destroyed.
* @since_tizen 3.0
* @param[in] dev Device to unreference
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* (including transfer operations and strings introspection).
* @since_tizen 3.0
* @param[in] dev Device to open
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_OUT_OF_MEMORY Memory allocation failure
* It destroys reference that was added by usb_host_device_open().
* @since_tizen 3.0
* @param[in] dev Device that should be closed
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_DEVICE_NOT_OPENED If device is not opened
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @param[in] vendor_id idVendor of connected device
* @param[in] product_id idProduct of connected device
* @param[out] device_handle Opened device handle
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_OUT_OF_MEMORY Insufficient memory
* @since_tizen 3.0
* @param[in] dev Device handle
* @param[out] bus_number Device bus number
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @since_tizen 3.0
* @param[in] dev Device
* @param[out] device_address Device address
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @param[out] port_numbers Array to be filled with port numbers
* @param[in] port_numbers_len Max length of array
* @param[out] ports_count Number of all ports obtained from device
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @param[in] dev Device
* @param[in] config_index Index of configuration to retrieve (counting from 0)
* @param[out] config Output location for USB configuration
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_FOUND The configuration does not exist
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] config Handle to active configuration
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NO_SUCH_DEVICE the dev has been disconnected
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @details Set active configuration for a device.
* @since_tizen 3.0
* @param[in] configuration Handle to configuration to be activated
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_FOUND Requested configuration does not exist
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] bcd_usb Bcd release number of USB
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] device_class Device class
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] subclass Device subclass
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] protocol Device protocol
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] max_packet_size Maximum size of single packet, in bytes
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] vendor_id Vendor ID of @a dev
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] product_id Product ID of @a dev
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] device_bcd Device release number
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] dev A device
* @param[out] num_configurations Number of configurations for given device
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @param[in] dev A device
* @param[out] is_opened @c true if device is opened,
* @c false otherwise
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @param[in] dev A handle to opened device
* @param[in, out] length Data buffer size/how much was actually used
* @param[out] data Buffer to store string
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_OVERFLOW There was no space in buffer
* @param[in] dev A handle to opened device
* @param[in, out] length Data buffer size/how much was actually used
* @param[out] data Buffer to store string
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_OVERFLOW There was no space in buffer
* @param[in] dev A handle to opened device
* @param[in, out] length Data buffer size/how much was actually used
* @param[out] data Buffer to store string
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_OVERFLOW There was no space in buffer
* @since_tizen 3.0
* @param[in] config A configuration
* @param[out] num_interfaces Number of interfaces
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @param[in] config A configuration
* @param[out] self_powered @c true if device is self-powered in given configuration,
* @c false otherwise
- * @return @c 0 on success,
+ * @return @c 0 on success,
* negative error code otherwise
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @param[in] config A configuration
* @param[out] remote_wakeup @c true if device supports remote wakeup in given configuration,
* @c false otherwise
- * @return @c 0 on success,
+ * @return @c 0 on success,
* negative error code otherwise
* @retval #USB_HOST_ERROR_NONE Successful
* @retval @USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @since_tizen 3.0
* @param[in] config A configuration
* @param[out] max_power Maximum power, in mA
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @param[in] config A configuration
* @param[in, out] length Data buffer size/how much was actually used
* @param[out] data Buffer to store string
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @param[in] config Configuration handle
* @param[in] interface_index Index of interface to retrieve (counting from 0)
* @param[out] interface Interface handle
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_FOUND Configuration does not exist
* @details Frees configuration obtained from usb_host_device_get_config().
* @since_tizen 3.0
* @param[in] config Configuration to free
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @param[in] interface The bInterfaceNumber of interface to claim
* @param[in] force Set to @c true to auto detach kernel driver,
* set to @c false to not detach it
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_FOUND Requested interface does not exist
* This is a blocking function.
* @since_tizen 3.0
* @param[in] interface The bInterfaceNumber of interface to release
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_FOUND Interface was not claimed
* @since_tizen 3.0
* @param[in] interface An interface
* @param[out] number Number of given interface
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] interface An interface
* @param[out] num_endpoints Number of endpoints in @a interface
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @param[in] interface Interface handle
* @param[in] ep_index Index of endpoint to retrieve (counting from 0)
* @param[out] ep Endpoint handle
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @since_tizen 3.0
* @param[in] interface Interface handle
* @param[in] altsetting Index of new alternative setting for given interface
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @param[in] interface An interface
* @param[in, out] length Data buffer size/how much was actually used
* @param[out] data Buffer to store string
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] number Number of given endpoint
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] direction Direction of endpoint (a value from enum #usb_host_endpoint_direction_e)
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] transfer_type Transfer type (a value from enum #usb_host_transfer_type_e)
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @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)
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] usage_type Usage type (a value from enum #usb_host_usage_type_e)
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_NOT_SUPPORTED Not supported
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] max_packet_size Max packet size, in bytes
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* @since_tizen 3.0
* @param[in] ep An endpoint
* @param[out] interval Interval for polling, in frame counts (refer to USB protocol specification)
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_INVALID_PARAMETER Invalid parameter was passed
* before giving up due to no response being received. For an unlimited
* @param[out] transferred Number of transferred bytes
* timeout, 0 value should be used
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_TIMED_OUT Transfer timed out
* @param[in] timeout Timeout (in milliseconds) that this function should wait
* before giving up due to no response being received (for an unlimited
* timeout 0 value should be used)
- * @return @c 0 on success (and populates @a transferred),
+ * @return @c 0 on success (and populates @a transferred),
* negative error code on error
* @retval #USB_HOST_ERROR_NONE Successful
* @retval #USB_HOST_ERROR_TIMED_OUT Transfer timed out