First public contribution.
1 // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of the License "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // e32/include/d32usbc.inl
15 // User side class definitions for USB Device support (inline header).
25 #ifndef __D32USBC_INL__
26 #define __D32USBC_INL__
29 /** @internalTechnology
33 TUsbcInterfaceInfoBuf* iInterfaceData;
35 TUint32 iBandwidthPriority;
39 /** @internalTechnology
41 struct TEndpointTransferInfo
44 TTransferType iTransferType;
49 inline TUsbcInterfaceInfo::TUsbcInterfaceInfo(TInt aClass, TInt aSubClass,
50 TInt aProtocol, TDesC16* aString,
51 TUint aTotalEndpoints)
52 : iClass(aClass, aSubClass, aProtocol), iString(aString),
53 iTotalEndpointsUsed(aTotalEndpoints), iEndpointData(), iFeatureWord(0)
57 #ifndef __KERNEL_MODE__
59 /** @capability CommDD
61 inline TInt RDevUsbcClient::Open(TInt aUnit)
63 _LIT(KUsbDevName, "Usbc");
64 return (DoCreate(KUsbDevName, VersionRequired(), aUnit, NULL, NULL, EOwnerThread));
68 inline TVersion RDevUsbcClient::VersionRequired() const
70 return (TVersion(EMajorVersionNumber, EMinorVersionNumber, EBuildVersionNumber));
74 inline TInt RDevUsbcClient::EndpointZeroRequestError()
76 return DoControl(EControlEndpointZeroRequestError);
80 inline TInt RDevUsbcClient::EndpointCaps(TDes8& aCapsBuf)
82 return DoControl(EControlEndpointCaps, &aCapsBuf);
86 inline TInt RDevUsbcClient::DeviceCaps(TUsbDeviceCaps& aCapsBuf)
88 return DoControl(EControlDeviceCaps, &aCapsBuf);
92 inline TInt RDevUsbcClient::GetAlternateSetting(TInt &aInterfaceNumber)
94 return DoControl(EControlGetAlternateSetting, &aInterfaceNumber);
98 inline TInt RDevUsbcClient::DeviceStatus(TUsbcDeviceState &aDeviceStatus)
100 return DoControl(EControlDeviceStatus, &aDeviceStatus);
104 inline TInt RDevUsbcClient::EndpointStatus(TEndpointNumber aEndpoint,TEndpointState &aEndpointStatus)
106 return DoControl(EControlEndpointStatus,(TAny*) aEndpoint, &aEndpointStatus);
110 inline TInt RDevUsbcClient::QueryReceiveBuffer(TEndpointNumber aEndpoint,TInt& aNumberOfBytes)
112 return DoControl(EControlQueryReceiveBuffer, (TAny*) aEndpoint, &aNumberOfBytes);
116 inline TInt RDevUsbcClient::SendEp0StatusPacket()
118 return DoControl(EControlSendEp0StatusPacket);
122 inline TInt RDevUsbcClient::HaltEndpoint(TEndpointNumber aEndpoint)
124 return DoControl(EControlHaltEndpoint, (TAny*) aEndpoint);
128 inline TInt RDevUsbcClient::ClearHaltEndpoint(TEndpointNumber aEndpoint)
130 return DoControl(EControlClearHaltEndpoint, (TAny*) aEndpoint);
134 inline TUint RDevUsbcClient::EndpointZeroMaxPacketSizes()
136 return DoControl(EControlEndpointZeroMaxPacketSizes);
140 inline TInt RDevUsbcClient::SetEndpointZeroMaxPacketSize(TInt aMaxPacketSize)
142 return DoControl(EControlSetEndpointZeroMaxPacketSize, (TAny*) aMaxPacketSize);
146 inline TInt RDevUsbcClient::GetEndpointZeroMaxPacketSize()
148 return DoControl(EControlGetEndpointZeroMaxPacketSize);
152 inline TInt RDevUsbcClient::GetDeviceDescriptor(TDes8& aDeviceDescriptor)
154 return DoControl(EControlGetDeviceDescriptor, &aDeviceDescriptor);
158 inline TInt RDevUsbcClient::SetDeviceDescriptor(const TDesC8& aDeviceDescriptor)
160 return DoControl(EControlSetDeviceDescriptor, const_cast<TDesC8*>(&aDeviceDescriptor));
164 inline TInt RDevUsbcClient::GetDeviceDescriptorSize(TInt& aSize)
167 TInt r = DoControl(EControlGetDeviceDescriptorSize, &p);
174 inline TInt RDevUsbcClient::GetConfigurationDescriptor(TDes8& aConfigurationDescriptor)
176 return DoControl(EControlGetConfigurationDescriptor, &aConfigurationDescriptor);
180 inline TInt RDevUsbcClient::SetConfigurationDescriptor(const TDesC8& aConfigurationDescriptor)
182 return DoControl(EControlSetConfigurationDescriptor, const_cast<TDesC8*> (&aConfigurationDescriptor));
186 inline TInt RDevUsbcClient::GetConfigurationDescriptorSize(TInt& aSize)
189 TInt r=DoControl(EControlGetConfigurationDescriptorSize, &p);
196 inline TInt RDevUsbcClient::GetInterfaceDescriptor(TInt aSettingNumber, TDes8& aInterfaceDescriptor)
198 return DoControl(EControlGetInterfaceDescriptor,(TAny*) aSettingNumber, &aInterfaceDescriptor);
202 inline TInt RDevUsbcClient::SetInterfaceDescriptor(TInt aSettingNumber, const TDesC8& aInterfaceDescriptor)
204 return DoControl(EControlSetInterfaceDescriptor,(TAny*) aSettingNumber,
205 const_cast<TDesC8*>(&aInterfaceDescriptor));
209 inline TInt RDevUsbcClient::GetInterfaceDescriptorSize(TInt aSettingNumber, TInt& aSize)
212 TInt r = DoControl(EControlGetInterfaceDescriptorSize,(TAny*) aSettingNumber, &p);
219 inline TInt RDevUsbcClient::GetEndpointDescriptor(TInt aSettingNumber, TInt aEndpointNumber,
220 TDes8& aEndpointDescriptor)
222 TEndpointDescriptorInfo info = {aSettingNumber, aEndpointNumber, &aEndpointDescriptor};
223 return DoControl(EControlGetEndpointDescriptor, &info, NULL);
227 inline TInt RDevUsbcClient::SetEndpointDescriptor(TInt aSettingNumber, TInt aEndpointNumber,
228 const TDesC8& aEndpointDescriptor)
230 TEndpointDescriptorInfo info = {aSettingNumber, aEndpointNumber, const_cast<TDesC8*>(&aEndpointDescriptor)};
231 return DoControl(EControlSetEndpointDescriptor, &info, NULL);
235 inline TInt RDevUsbcClient::GetEndpointDescriptorSize(TInt aSettingNumber, TInt aEndpointNumber, TInt& aSize)
238 TEndpointDescriptorInfo info = {aSettingNumber, aEndpointNumber, &p};
239 TInt r = DoControl(EControlGetEndpointDescriptorSize, &info, NULL);
246 inline void RDevUsbcClient::GetOtgDescriptorSize(TInt& aSize)
248 aSize = KUsbDescSize_Otg;
252 inline TInt RDevUsbcClient::GetOtgDescriptor(TDes8& aOtgDesc)
254 return DoControl(EControlGetOtgDescriptor, (TAny*)&aOtgDesc);
258 inline TInt RDevUsbcClient::SetOtgDescriptor(const TDesC8& aOtgDesc)
260 return DoControl(EControlSetOtgDescriptor, (TAny*)&aOtgDesc);
264 inline TInt RDevUsbcClient::GetDeviceQualifierDescriptor(TDes8& aDescriptor)
266 return DoControl(EControlGetDeviceQualifierDescriptor, &aDescriptor);
270 inline TInt RDevUsbcClient::SetDeviceQualifierDescriptor(const TDesC8& aDescriptor)
272 return DoControl(EControlSetDeviceQualifierDescriptor, const_cast<TDesC8*>(&aDescriptor));
276 inline TInt RDevUsbcClient::GetOtherSpeedConfigurationDescriptor(TDes8& aDescriptor)
278 return DoControl(EControlGetOtherSpeedConfigurationDescriptor, &aDescriptor);
282 inline TInt RDevUsbcClient::SetOtherSpeedConfigurationDescriptor(const TDesC8& aDescriptor)
284 return DoControl(EControlSetOtherSpeedConfigurationDescriptor, const_cast<TDesC8*> (&aDescriptor));
288 inline TInt RDevUsbcClient::GetCSInterfaceDescriptorBlock(TInt aSettingNumber, TDes8& aInterfaceDescriptor)
290 return DoControl(EControlGetCSInterfaceDescriptor,(TAny*) aSettingNumber, &aInterfaceDescriptor);
294 inline TInt RDevUsbcClient::GetCSInterfaceDescriptorBlockSize(TInt aSettingNumber, TInt& aSize)
297 TInt r = DoControl(EControlGetCSInterfaceDescriptorSize,(TAny*) aSettingNumber, &p);
304 inline TInt RDevUsbcClient::GetCSEndpointDescriptorBlock(TInt aSettingNumber, TInt aEndpointNumber,
305 TDes8& aEndpointDescriptor)
307 TEndpointDescriptorInfo info={aSettingNumber, aEndpointNumber, &aEndpointDescriptor};
308 return DoControl(EControlGetCSEndpointDescriptor,&info,NULL);
312 inline TInt RDevUsbcClient::GetCSEndpointDescriptorBlockSize(TInt aSettingNumber, TInt aEndpointNumber,
316 TEndpointDescriptorInfo info = {aSettingNumber, aEndpointNumber, &p};
317 TInt r = DoControl(EControlGetCSEndpointDescriptorSize, &info, NULL);
324 inline TInt RDevUsbcClient::SignalRemoteWakeup()
326 return DoControl(EControlSignalRemoteWakeup);
330 inline TInt RDevUsbcClient::DeviceDisconnectFromHost()
332 return DoControl(EControlDeviceDisconnectFromHost);
336 inline TInt RDevUsbcClient::DeviceConnectToHost()
338 return DoControl(EControlDeviceConnectToHost);
342 inline TInt RDevUsbcClient::PowerUpUdc()
344 return DoControl(EControlDevicePowerUpUdc);
348 inline TBool RDevUsbcClient::CurrentlyUsingHighSpeed()
350 return DoControl(EControlCurrentlyUsingHighSpeed);
354 inline TInt RDevUsbcClient::SetInterface(TInt aInterfaceNumber, TUsbcInterfaceInfoBuf& aInterfaceData,
355 TUint32 aBandwidthPriority)
357 TPtr8 name_8(NULL,0);
358 TUsbcIfcInfo ifcinfo;
359 ifcinfo.iInterfaceData = const_cast<TUsbcInterfaceInfoBuf*>(&aInterfaceData);
360 if (!aInterfaceData().iString)
362 ifcinfo.iString = NULL;
366 name_8.Set(const_cast<TUint8*>(reinterpret_cast<const TUint8*>(aInterfaceData().iString->Ptr())),
367 aInterfaceData().iString->Size(), aInterfaceData().iString->Size());
368 ifcinfo.iString = &name_8;
370 ifcinfo.iBandwidthPriority = aBandwidthPriority;
371 return DoControl(EControlSetInterface, (TAny*)aInterfaceNumber, &ifcinfo);
375 inline TInt RDevUsbcClient::ReleaseInterface(TInt aInterfaceNumber)
377 return DoControl(EControlReleaseInterface, (TAny*)aInterfaceNumber);
381 inline TInt RDevUsbcClient::SetCSInterfaceDescriptorBlock(TInt aSettingNumber, const TDesC8& aInterfaceDescriptor)
383 TCSDescriptorInfo info = {aSettingNumber, 0, const_cast<TDesC8*>(&aInterfaceDescriptor),
384 aInterfaceDescriptor.Size()};
385 return DoControl(EControlSetCSInterfaceDescriptor, &info, NULL);
389 inline TInt RDevUsbcClient::SetCSEndpointDescriptorBlock(TInt aSettingNumber, TInt aEndpointNumber,
390 const TDesC8& aEndpointDescriptor)
392 TCSDescriptorInfo info = {aSettingNumber, aEndpointNumber, const_cast<TDesC8*>(&aEndpointDescriptor),
393 aEndpointDescriptor.Size()};
394 return DoControl(EControlSetCSEndpointDescriptor, &info, NULL);
398 inline TInt RDevUsbcClient::SetDeviceControl()
400 return DoControl(EControlSetDeviceControl);
404 inline TInt RDevUsbcClient::ReleaseDeviceControl()
406 return DoControl(EControlReleaseDeviceControl);
410 inline TInt RDevUsbcClient::GetStringDescriptorLangId(TUint16& aLangId)
413 const TInt r = DoControl(EControlGetStringDescriptorLangId, &p);
420 inline TInt RDevUsbcClient::SetStringDescriptorLangId(TUint16 aLangId)
422 return DoControl(EControlSetStringDescriptorLangId, (TAny*)(TUint)aLangId);
426 inline TInt RDevUsbcClient::GetManufacturerStringDescriptor(TDes16& aString)
428 TPtr8 name_8(const_cast<TUint8*>(reinterpret_cast<const TUint8*>(aString.Ptr())), aString.MaxSize());
429 const TInt r = DoControl(EControlGetManufacturerStringDescriptor, &name_8);
430 aString.SetLength(name_8.Size()/2);
435 inline TInt RDevUsbcClient::SetManufacturerStringDescriptor(const TDesC16& aString)
437 TPtrC8 name_8(reinterpret_cast<const TUint8*>(aString.Ptr()), aString.Size());
438 return DoControl(EControlSetManufacturerStringDescriptor, &name_8);
442 inline TInt RDevUsbcClient::RemoveManufacturerStringDescriptor()
444 return DoControl(EControlRemoveManufacturerStringDescriptor);
448 inline TInt RDevUsbcClient::GetProductStringDescriptor(TDes16& aString)
450 TPtr8 name_8(const_cast<TUint8*>(reinterpret_cast<const TUint8*>(aString.Ptr())), aString.MaxSize());
451 const TInt r = DoControl(EControlGetProductStringDescriptor, &name_8);
452 aString.SetLength(name_8.Size()/2);
457 inline TInt RDevUsbcClient::SetProductStringDescriptor(const TDesC16& aString)
459 TPtrC8 name_8(reinterpret_cast<const TUint8*>(aString.Ptr()), aString.Size());
460 return DoControl(EControlSetProductStringDescriptor, &name_8);
464 inline TInt RDevUsbcClient::RemoveProductStringDescriptor()
466 return DoControl(EControlRemoveProductStringDescriptor);
470 inline TInt RDevUsbcClient::GetSerialNumberStringDescriptor(TDes16& aString)
472 TPtr8 name_8(const_cast<TUint8*>(reinterpret_cast<const TUint8*>(aString.Ptr())), aString.MaxSize());
473 const TInt r = DoControl(EControlGetSerialNumberStringDescriptor, &name_8);
474 aString.SetLength(name_8.Size()/2);
479 inline TInt RDevUsbcClient::SetSerialNumberStringDescriptor(const TDesC16& aString)
481 TPtrC8 name_8(reinterpret_cast<const TUint8*>(aString.Ptr()), aString.Size());
482 return DoControl(EControlSetSerialNumberStringDescriptor, &name_8);
486 inline TInt RDevUsbcClient::RemoveSerialNumberStringDescriptor()
488 return DoControl(EControlRemoveSerialNumberStringDescriptor);
492 inline TInt RDevUsbcClient::GetConfigurationStringDescriptor(TDes16& aString)
494 TPtr8 name_8(const_cast<TUint8*>(reinterpret_cast<const TUint8*>(aString.Ptr())), aString.MaxSize());
495 const TInt r = DoControl(EControlGetConfigurationStringDescriptor, &name_8);
496 aString.SetLength(name_8.Size() / 2);
501 inline TInt RDevUsbcClient::SetConfigurationStringDescriptor(const TDesC16& aString)
503 TPtrC8 name_8(reinterpret_cast<const TUint8*>(aString.Ptr()), aString.Size());
504 return DoControl(EControlSetConfigurationStringDescriptor, &name_8);
508 inline TInt RDevUsbcClient::RemoveConfigurationStringDescriptor()
510 return DoControl(EControlRemoveConfigurationStringDescriptor);
514 inline TInt RDevUsbcClient::GetStringDescriptor(TUint8 aIndex, TDes16& aString)
516 TPtr8 name_8(const_cast<TUint8*>(reinterpret_cast<const TUint8*>(aString.Ptr())), aString.MaxSize());
517 const TInt r = DoControl(EControlGetStringDescriptor, (TAny*)(TUint)aIndex, &name_8);
518 aString.SetLength(name_8.Size() / 2);
523 inline TInt RDevUsbcClient::SetStringDescriptor(TUint8 aIndex, const TDesC16& aString)
525 TPtrC8 name_8(reinterpret_cast<const TUint8*>(aString.Ptr()), aString.Size());
526 return DoControl(EControlSetStringDescriptor, (TAny*)(TUint)aIndex, &name_8);
530 inline TInt RDevUsbcClient::RemoveStringDescriptor(TUint8 aIndex)
532 return DoControl(EControlRemoveStringDescriptor, (TAny*)(TUint)aIndex);
536 inline TInt RDevUsbcClient::AllocateEndpointResource(TInt aEndpoint, TUsbcEndpointResource aResource)
538 return DoControl(EControlAllocateEndpointResource, (TAny*)aEndpoint, (TAny*)aResource);
542 inline TInt RDevUsbcClient::DeAllocateEndpointResource(TInt aEndpoint, TUsbcEndpointResource aResource)
544 return DoControl(EControlDeAllocateEndpointResource, (TAny*)aEndpoint, (TAny*)aResource);
548 inline TBool RDevUsbcClient::QueryEndpointResourceUse(TInt aEndpoint, TUsbcEndpointResource aResource)
550 return DoControl(EControlQueryEndpointResourceUse, (TAny*)aEndpoint, (TAny*)aResource);
554 inline void RDevUsbcClient::ReadUntilShort(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes)
556 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
557 TEndpointTransferInfo info = {&aDes, ETransferTypeReadUntilShort, aDes.MaxLength()};
558 DoRequest(ep, aStatus, &info, NULL);
562 inline void RDevUsbcClient::ReadUntilShort(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes,
565 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
566 TEndpointTransferInfo info = {&aDes, ETransferTypeReadUntilShort, aLen};
567 DoRequest(ep, aStatus, &info, NULL);
571 inline void RDevUsbcClient::ReadOneOrMore(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes)
573 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
574 TEndpointTransferInfo info = {&aDes, ETransferTypeReadOneOrMore, aDes.MaxLength()};
575 DoRequest(ep, aStatus, &info, NULL);
579 inline void RDevUsbcClient::ReadOneOrMore(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes,
582 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
583 TEndpointTransferInfo info = {&aDes, ETransferTypeReadOneOrMore, aLen};
584 DoRequest(ep, aStatus, &info, NULL);
588 inline void RDevUsbcClient::Read(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes)
590 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
591 TEndpointTransferInfo info = {&aDes, ETransferTypeReadData, aDes.MaxLength()};
592 DoRequest(ep, aStatus, &info, NULL);
596 inline void RDevUsbcClient::Read(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes, TInt aLen)
598 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
599 TEndpointTransferInfo info = {&aDes, ETransferTypeReadData, aLen};
600 DoRequest(ep, aStatus, &info, NULL);
604 inline void RDevUsbcClient::ReadPacket(TRequestStatus &aStatus, TEndpointNumber aEndpoint, TDes8 &aDes,
607 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
608 TEndpointTransferInfo info = {&aDes, ETransferTypeReadPacket, aMaxLen};
609 DoRequest(ep, aStatus, &info, NULL);
613 inline void RDevUsbcClient::Write(TRequestStatus &aStatus, TEndpointNumber aEndpoint, const TDesC8& aDes,
614 TInt aLen, TBool aZlpRequired)
616 TInt ep = (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient) ? KInvalidEndpointNumber : aEndpoint;
617 TEndpointTransferInfo info = {const_cast<TDesC8*>(&aDes), ETransferTypeWrite, aLen, aZlpRequired};
618 DoRequest(ep, aStatus, &info, NULL);
622 inline void RDevUsbcClient::AlternateDeviceStatusNotify(TRequestStatus& aStatus, TUint& aValue)
624 DoRequest(ERequestAlternateDeviceStatusNotify, aStatus, &aValue);
628 inline void RDevUsbcClient::ReEnumerate(TRequestStatus& aStatus)
630 DoRequest(ERequestReEnumerate, aStatus);
634 inline void RDevUsbcClient::EndpointStatusNotify(TRequestStatus& aStatus, TUint& aEndpointMask)
636 DoRequest(ERequestEndpointStatusNotify, aStatus, &aEndpointMask);
640 inline void RDevUsbcClient::ReadCancel(TEndpointNumber aEndpoint)
642 if (aEndpoint < 0 || aEndpoint > KMaxEndpointsPerClient)
644 DoCancel(1 << aEndpoint);
648 inline void RDevUsbcClient::WriteCancel(TEndpointNumber aEndpoint)
650 ReadCancel(aEndpoint);
654 inline void RDevUsbcClient::EndpointTransferCancel(TUint aEndpointMask)
656 /* Mask off non-endpoint cancels */
657 DoCancel(aEndpointMask & ERequestAllCancel);
661 inline void RDevUsbcClient::AlternateDeviceStatusNotifyCancel()
663 DoCancel(ERequestAlternateDeviceStatusNotifyCancel);
667 inline void RDevUsbcClient::ReEnumerateCancel()
669 DoCancel(ERequestReEnumerateCancel);
673 inline void RDevUsbcClient::EndpointStatusNotifyCancel()
675 DoCancel(ERequestEndpointStatusNotifyCancel);
678 inline TInt RDevUsbcClient::GetOtgFeatures(TUint8& aFeatures)
681 TInt r = DoControl(EControlGetOtgFeatures, &p);
688 inline void RDevUsbcClient::OtgFeaturesNotify(TRequestStatus& aStatus, TUint8& aValue)
690 DoRequest(ERequestOtgFeaturesNotify, aStatus, &aValue);
694 inline void RDevUsbcClient::OtgFeaturesNotifyCancel()
696 DoCancel(ERequestOtgFeaturesNotifyCancel);
700 #endif // #ifndef __KERNEL_MODE__
702 #endif // #ifndef __D32USBC_INL__