Features and few exceptions were documented here.
Change-Id: I41a644ebe22799079575a292a910a24fd433ee14
Signed-off-by: lokilee73 <changjoo.lee@samsung.com>
/// <summary>
/// USB Device
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public UsbDevice Device { get; }
/// <summary>
/// Event Type
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public HotplugEventType EventType { get; }
}
/// received(for an unlimited timeout 0 value should be used).
/// </param>
/// <returns>Number of bytes actually transferred.</returns>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Checks if device is self-powered in given configuration.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public bool IsSelfPowered
{
/// <summary>
/// Checks if device in given configuration supports remote wakeup.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public bool SupportRemoteWakeup
{
/// <summary>
/// Gets maximum power required in given configuration, in mA.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int MaximumPowerRequired
{
/// <summary>
/// Dictionary mapping interfaces Ids to interface instances for given configuration.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public IReadOnlyDictionary<int, UsbInterface> Interfaces
{
/// <summary>
/// Configuration string.
/// </summary>
- /// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">
+ /// Throws exception if device is disconnected or not opened for operation or busy as its interfaces are currently claimed.
+ /// </exception>
/// <since_tizen> 4 </since_tizen>
public string ConfigurationString
{
/// <summary>
/// Set this configuration as active configuration for the device.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
/// <since_tizen> 4 </since_tizen>
public void SetAsActive()
/// <summary>
/// Gets number of this endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public new int Id
{
/// <summary>
/// Gets direction of this endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public new EndpointDirection Direction
{
/// <summary>
/// Gets max packet size of given endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public new int MaxPacketSize
{
/// (for an unlimited timeout 0 value should be used).
/// </param>
/// <returns>Transferred Number of transferred bytes.</returns>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Number of the bus, this device is connected to.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
/// <since_tizen> 4 </since_tizen>
public int BusId {
/// <summary>
/// Address of device on the bus.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int Address
{
/// <summary>
/// List of available port numbers from a device.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public IEnumerable<int> Ports
{
/// <summary>
/// Checks if device is opened.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public bool IsOpened
{
/// <summary>
/// Control endpoint (endpoint 0).
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public UsbControlEndpoint ControlEndpoint
{
/// <summary>
/// Active configuration for the device.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation. </exception>
/// <since_tizen> 4 </since_tizen>
public UsbConfiguration ActiveConfiguration
/// <summary>
/// Dictionary mapping configuration Ids to configuration instances for this device.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public IReadOnlyDictionary<int, UsbConfiguration> Configurations
{
/// <summary>
/// Device information such as version, class, subclass etc.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public UsbDeviceInformation DeviceInformation
{
/// <summary>
/// String associated with device.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
/// <since_tizen> 4 </since_tizen>
public UsbDeviceStrings Strings
/// <summary>
/// Opens device, which allows performing operations on it.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
/// <summary>
/// Closes device for operations.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public void Close()
{
/// <summary>
/// USB specification release number as binary-coded decimal.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
/// <since_tizen> 4 </since_tizen>
public int UsbVersion
/// <summary>
/// Gets device class.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int Class
{
/// <summary>
/// Gets device sub class.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int Subclass
{
/// <summary>
/// Gets device protocol.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int Protocol
{
/// <summary>
/// Gets vendor id.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int VendorId
{
/// <summary>
/// Gets product id.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int ProductId
{
/// <summary>
/// Gets device release number in binary-coded decimal.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int DeviceVersion
{
/// <summary>
/// Gets string describing device manufacturer.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public string Manufacturer;
/// <summary>
/// Gets product string of device
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public string Product;
/// <summary>
/// Gets serial number of a device.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public string Serial;
}
/// <summary>
/// Gets number of this endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int Id
{
/// <summary>
/// Gets direction of this endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public EndpointDirection Direction
{
/// <summary>
/// Gets max packet size of given endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int MaxPacketSize
{
/// <summary>
/// Gets number of given interface.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int Id
{
/// <summary>
/// Sets alternative setting. Use index of new alternative setting for given interface.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int AlternateSetting
{
/// <summary>
/// Dictionary mapping endpoint Ids to endpoint instances for given interface.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public IReadOnlyDictionary<int, UsbEndpoint> Endpoints
{
/// <summary>
/// Gets string describing an interface.
/// </summary>
- /// <exception cref="InvalidOperationException"> Throws exception if device is disconnected or not opened for operation. </exception>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
+ /// <exception cref="InvalidOperationException">
+ /// Throws exception if device is disconnected or not opened for operation.
+ /// </exception>
/// <since_tizen> 4 </since_tizen>
public string InterfaceString
{
/// Claims interface on a device. Interface must be claimed first to perform I/O operations.
/// </summary>
/// <param name="force">Set to true to auto detach kernel driver, false otherwise.</param>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
/// Throws exception if device is disconnected or not opened for operation or another program or driver has claimed the interface.
/// </exception>
/// <summary>
/// Releases previously claimed interface.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Gets interval for polling endpoint for data transfers, in frame counts (refer to USB protocol specification).
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public int PollingInterval
{
/// received(for an unlimited timeout 0 value should be used).
/// </param>
/// <returns>Number of bytes actually transferred.</returns>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">Throws exception if device is disconnected or not opened for operation.</exception>
/// <exception cref="TimeoutException">Throws exception if transfer timed-out.</exception>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Gets synchronization type of this endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public SynchronizationType SynchronizationType
{
/// <summary>
/// Gets usage type of this endpoint.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public UsageType UsageType
{
/// <summary>
/// USB Manager Constructor.
/// </summary>
- /// <exception cref="NotSupportedException">Throws exception if USB host feature is not enabled.</exception>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public UsbManager()
{
/// <summary>
/// This function returns list of USB devices attached to system.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="OutOfMemoryException">Throws exception in case of insufficient memory.</exception>
/// <exception cref="UnauthorizedAccessException">Throws exception if user has insufficient permission on device.</exception>
/// <since_tizen> 4 </since_tizen>
/// <summary>
/// Event handler for events when a USB device is attached or detached.
/// </summary>
+ /// <feature>http://tizen.org/feature/usb.host</feature>
+ /// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public event EventHandler<HotPluggedEventArgs> DeviceHotPlugged;