Allocates the use of aResource to aEndpoint. it will be used from when the current bus transfer has been completed.

TUsbcEndpointInfo

Register for notification when a change of the Interface alternate setting or the USB Controller's current state occurs. When the alternate setting or the Controller state changes, then the asynchronous function completes and the current alternate setting number or Controller state is written back to aValue. If the KUsbAlternateSetting bit is set then the remaining bits are the alternate setting number. Otherwise aValue is interpreted as a TUsbcDeviceState.

TUsbcDeviceState

Completes an AlternateDeviceStatusNotify request. If a request has previously been made then the status variable is updated with the current device state.

Clears the stall condition on endpoint aEndpoint. This is inluded for symmetry and test purposes.

Enquires about the current operating speed of the UDC.

Deallocates the use of aResource aEndpoint or ends a specified endpoint behaviour.

TUsbcEndpointInfo

Retrieves the capabilities of the USB device.

TUsbDeviceCaps

Simulates a physical insertion of the USB cable by enabling the D+/- pull-ups.The iConnect member of TUsbDeviceCapsV01 , returned by RDevUsbcClient::DeviceCaps() , indicates whether this functionality is supported.

Simulates a physical removal of the USB cable by disabling the D+/- pull-ups.The iConnect member of TUsbDeviceCapsV01 , returned by RDevUsbcClient::DeviceCaps() , indicates whether this functionality is supported.

Copies the current device status into aDeviceStatus.

Retrieves the capabilities of all the endpoints on the device.

Suggested use is as follows:

         TUsbcEndpointData data[KUsbcMaxEndpoints];
		TPtr8 dataPtr(reinterpret_cast<TUint8*>(data), sizeof(data), sizeof(data));
		ret = usbPort.EndpointCaps(dataPtr);
        

Copies the current endpoint status into aEndpointStatus.

Register for notification when a change in stall status of any of the interface's endpoints occurs, but not ep0. When a change in stall status occurs, then the asynchronous function completes and the current stall state is written back to 'aEndpointStatus' as a bit map: Only stall state changes caused by SET_FEATURE and CLEAR_FEATURE standard commands on ep0 will be notified when this function completes. After this request completes the request should be re-issued to obtain future notifications.

Completes an endpoint status notify request.

Cancels any transfer on any endpoint specified in aEndpointMask.

         // Cancel transfer requests on endpoints 1, 2 & 3
		usbPort.EndpointTransferCancel(KUsbcEndpoint1Bit | KUsbcEndpoint2Bit | KUsbcEndpoint3Bit);
        

Returns a bitmap of available ep0 maximum packet sizes.

Stalls ep0 to signal command fault to the host.

Copies the current alternate setting for this interface into aInterfaceNumber For USB Interfaces whose main interface is active, this will be 0 (zero).

Copies the class specific endpoint descriptor for logical endpoint number aEndpointNumber into aEndpointDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface.

Copies the size of the class specific endpoint descriptor block for logical endpoint number aEndpointNumber for the interface with alternate setting aSettingNumber, 0 for the main interface, into aSize.

Copies the class specific interface descriptor block into aInterfaceDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface.

Copies the size of the class specific interface descriptor block for the interface with alternate setting aSettingNumber, 0 for the main interface, into aSize.

Copies the current configuration descriptor into aConfigurationDescriptor.

Gets the size of the current configuration descriptor.

Retrieves the string descriptor identified by the iConfiguration index field of the (first) Standard Configuration Descriptor into the aString argument.

Copies the current device descriptor into aDeviceDescriptor.

Gets the size of the current device descriptor. This is unlikely to be anything other than 9.

Copies the current device_qualifier descriptor into aDescriptor.

Copies the endpoint descriptor for logical endpoint number aEndpointNumber into aEndpointDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface.

Copies the size of the endpoint descriptor for logical endpoint number aEndpointNumber for the interface with alternate setting aSettingNumber, 0 for the main interface, into aSize.

Queries the current maximum packet size on ep0.

Copies the interface descriptor into aInterfaceDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface.

Copies the size of the interface descriptor for the interface with alternate setting aSettingNumber, 0 for the main interface, into aSize.

Copies the string descriptor identified by the iManufacturer index field of the Standard Device Descriptor into the aString argument.

Get OTG descriptor of USB on-the-go feature

Get OTG descriptor size

Get current on-the-go features relating to the ability of device/host pair to perform OTG role swap.

Copies the current other_speed_configuration descriptor into aDescriptor.

Retrieves the string descriptor identified by the iProduct index field of the Standard Device Descriptor into the aString argument.

Retrieves the string descriptor identified by the iSerialNumber index field of the Standard Device Descriptor into the aString argument.

Copies the string of the USB string descriptor at the specified index in the string descriptor array into the aString argument.

Although this function can also be used for it, for querying most standard string descriptors there exists a set of dedicated access functions.

RDevUsbcClient::GetStringDescriptorLangId RDevUsbcClient::GetManufacturerStringDescriptor RDevUsbcClient::GetProductStringDescriptor RDevUsbcClient::GetSerialNumberStringDescriptor RDevUsbcClient::GetConfigurationStringDescriptor

Copies the current string descriptor language ID (LANGID) code into the aLangId argument. Even though the USB spec allows for the existence of a whole array of LANGID codes, we only support one.

Stalls endpoint aEndpoint, usually to indicate an error condition with a previous command. The host will normally send a SET_FEATURE command on ep0 to acknowledge and clear the stall.

Opens a channel.

Register for notification on USB on-the-go features' change. If any OTG feature is changed, request completes and current feature value is filled in aValue.

Cancel pending OTG feature request.

Powers up the UDC and connects it to the bus if one or more interfaces exist.

Queries endpoint resource use.

Copies the number of bytes available in the aEndpoint read buffer into aNumberOfBytes.

If the channel has changed the grouping of endpoints between interfaces or changed the interface class type from the defaults then it is necessary to force a re-enumeration. This will typically involve the Symbian OS device initiating a disconnection and re-connection. This is an asynchronous operation which will complete when the Controller is successfully configured by the host, i.e. has achieved EUsbcDeviceStateConfigured. Since it is not known if the operation has failed, at the same time that a ReEnumerate request is made, a timer should be set up to complete after approximately 5 seconds. It can be assumed that if the operation has not completed after this time interval then it will not complete.

Cancels an outstanding ReEnumerate() request.

Asynchronously read data from endpoint 'aEndpoint' into the descriptor 'aDes'. Request completes when the specified number of bytes is received, length taken from max. length of descriptor.

Asynchronously read data from endpoint 'aEndpoint' into the descriptor 'aDes'. Request completes when the specified number of bytes is received.

Cancels an outstanding read request. The request will complete with whatever data is available.

Asynchronously read data from endpoint 'aEndpoint' into the descriptor 'aDes'. The request completes when the specified number of bytes is received, length taken from max. length of descriptor or a packet whose size is smaller than the endpoint's maximum packet size is received.

Asynchronously read data from endpoint 'aEndpoint' into the descriptor 'aDes'. The request completes when the specified number of bytes is received, or a packet whose size is smaller than the endpoint's maximum packet size is received.

Asynchronously read an entire packet of data from endpoint 'aEndpoint' into the descriptor 'aDes'. If a packet has previously been partly read. then only the remainder of the packet will be returned. The request should be for the maximum packet size of the endpoint. If less data is requested, then after this read completes the remainder of the data in the packet will be discarded and the next read will start from the next available packet. Request completes when either a complete packet is received or the length of the packet currently being received exceeds 'aMaxLen'.

Asynchronously read data from endpoint 'aEndpoint' into the descriptor 'aDes'. Request completes when the specified number of bytes is received (in first version, length taken from max. length of descriptor).

Asynchronously read data from endpoint 'aEndpoint' into the descriptor 'aDes'. Request completes when the specified number of bytes is received (in first version, length taken from max. length of descriptor).

Relinquishes device control previously allocated to this channel.

Release an interface previously claimed by this channel. Alternate interfaces need to be released in strict descending order, starting with the last (i.e. highest numbered) one. It is not necessary to release an interface that wasn't successfully requested.

Removes (deletes) the string descriptor identified by the iConfiguration index field of the Standard Configuration Descriptor and sets that field to zero.

Removes (deletes) the string descriptor identified by the iManufacturer index field of the Standard Device Descriptor and sets that field to zero.

Removes (deletes) the string descriptor identified by the iProduct index field of the Standard Device Descriptor and sets that field to zero.

Removes (deletes) the string descriptor identified by the iSerialNumber index field of the Standard Device Descriptor and sets that field to zero.

Removes (deletes) the USB string descriptor at the specified index in the string descriptor array. The position in the array of other string descriptors is not affected.

Care should be taken, when choosing aIndex, not to inadvertently delete a standard string descriptor (also because index references from non-string descriptors would be invalidated). For the deletion of most standard string descriptors there exists a set of dedicated functions.

RDevUsbcClient::RemoveManufacturerStringDescriptor RDevUsbcClient::RemoveProductStringDescriptor RDevUsbcClient::RemoveSerialNumberStringDescriptor RDevUsbcClient::RemoveConfigurationStringDescriptor

Requests that a zero length status packet be sent to the host in response to a class or vendor specific ep0 SETUP packet.

Sets the class specific endpoint descriptor for logical endpoint number aEndpointNumber contained in aEndpointDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface, for transmission to the host during enumeration.

aSettingNumber is the alternate interface setting, 0 for the main interface, that the descriptor block aDes should be attached to. aDes is a block of data containing at least one class specific descriptor for transmission during enumeration after the class interface descriptor (or alternate interface descriptor) has been sent, but before the endpoint descriptors belonging to this interface are sent. aDes may contain as many descriptors as are necessary or only 1. SetCSInterfaceDescriptorBlock() should be called at any time after SetInterface() has been called to establish a main interface or an alternate interface. More than one call may be made - the data blocks will be concatenated prior to sending. No checking or validation of the contents of aDes will be made and it is the caller's responsibility to ensure that the data supplied is correct and appropriate to the interface identified by aSettingNumber.

Sets the contents of aConfigurationDescriptor to be the current configuration descriptor.

Sets the string descriptor identified by the iConfiguration index field of the Standard Configuration Descriptor to the aString argument.

Requests that device control be allocated to this channel.

Sets the contents of aDeviceDescriptor to be the current device descriptor.

Sets the device_qualifier descriptor to the contents of aDescriptor.

Sets the endpoint descriptor for logical endpoint number aEndpointNumber contained in aEndpointDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface, for transmission to the host during enumeration.

Requests that a maximum packet size of aMaxPacketSize be set on ep0.

Request (i.e. claim for this channel) up to five endpoints and set the class type for this USB interface. 'aInterfaceData' is a package buffer which describes the interface and all the endpoints being requested by the driver for this interface.

Sets the interface descriptor contained in aInterfaceDescriptor for the interface with alternate setting aSettingNumber, 0 for the main interface, for transmission to the host during enumeration.

Sets the string descriptor identified by the iManufacturer index field of the Standard Device Descriptor to the aString argument.

Set OTG descriptor by user to enable/disable USB on-the-go feature

Sets the other_speed_configuration descriptor to the contents of aDescriptor.

Sets the string descriptor identified by the iProduct index field of the Standard Device Descriptor to the aString argument.

Sets the string descriptor identified by the iSerialNumber index field of the Standard Device Descriptor to the aString argument.

Sets the aString argument to be the string of a USB string descriptor at the specified index in the string descriptor array. If a string descriptor already exists at that position then its string will be replaced.

Care should be taken, when choosing aIndex, not to inadvertently overwrite one of the standard string descriptors. For their manipulation there exists a set of dedicated access functions.

RDevUsbcClient::SetStringDescriptorLangId RDevUsbcClient::SetManufacturerStringDescriptor RDevUsbcClient::SetProductStringDescriptor RDevUsbcClient::SetSerialNumberStringDescriptor RDevUsbcClient::SetConfigurationStringDescriptor

Sets the string descriptor language ID (LANGID). Even though the USB spec allows for the existence of a whole array of LANGID codes, we only support one.

Generates a Remote Wakeup bus condition The capability of the device to generate Remote Wakeup signalling is enquired in RDevUsbcClient::DeviceCaps .

Asynchronously write 'aLen' bytes of data to endpoint 'aEndpoint' from descriptor 'aDes'. 'aZlpRequired' (optional) signals that ZLP termination may be required.

Cancels an outstanding write request on endpoint aEndpoint.