Adaptation/GUID-BF86E9F9-531A-51A1-90B4-23B51604F5B4.dita
changeset 15 307f4279f433
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Adaptation/GUID-BF86E9F9-531A-51A1-90B4-23B51604F5B4.dita	Fri Oct 15 14:32:18 2010 +0100
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
+<!-- This component and the accompanying materials are made available under the terms of the License 
+"Eclipse Public License v1.0" which accompanies this distribution, 
+and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
+<!-- Initial Contributors:
+    Nokia Corporation - initial contribution.
+Contributors: 
+-->
+<!DOCTYPE concept
+  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
+<concept id="GUID-BF86E9F9-531A-51A1-90B4-23B51604F5B4" xml:lang="en"><title>Reference</title><prolog><metadata><keywords/></metadata></prolog><conbody>
+<p>This topic provides a summary of related documentation for the USB Client
+Driver to which you can refer. </p>
+<section id="GUID-40972A82-4DE0-5A24-A00D-9F8DDA872B68"><title>API Reference</title> <p><b>Kernel Architecture </b> </p> <table id="GUID-1F30412D-631A-53C7-811C-9A9BE462D9BC">
+<tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>
+<tbody>
+<row>
+<entry><p> <b>Item</b>  </p> </entry>
+<entry><p> <b>Header</b>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-B1E32178-3B7C-3B00-A0AF-62ECE40E8598.dita"><apiname>RDevUsbcClient</apiname></xref>  </p> </entry>
+<entry><p> <filepath>d32usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-BD848FB9-532D-34E1-876C-66064D50B761.dita"><apiname>TCapsDevUsbc</apiname></xref>  </p> </entry>
+<entry><p> <filepath>d32usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-4BA5287B-69D8-3714-BA3A-D4DBA4DD6AE8.dita"><apiname>TUsbcClassInfo</apiname></xref>  </p> </entry>
+<entry><p> <filepath>d32usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-4ADDF113-0392-39EE-82C7-F070A7D0BA35.dita"><apiname>TUsbcEndpointCaps</apiname></xref>  </p> </entry>
+<entry><p> <filepath>d32usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-6FBACF89-444D-325B-B56D-59FDBEA0BFC3.dita"><apiname>TUsbcEndpointData</apiname></xref>  </p> </entry>
+<entry><p> <filepath>d32usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-468AF207-365F-33DB-A42F-847FEF0652BF.dita"><apiname>TUsbcEndpointInfo</apiname></xref>  </p> </entry>
+<entry><p> <filepath>d32usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita"><apiname>DUsbClientController</apiname></xref>  </p> </entry>
+<entry><p> <filepath>usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-D395BF82-65B3-3A98-800B-E6EF43150E8F.dita"><apiname>TUsbcRequestCallback</apiname></xref>  </p> </entry>
+<entry><p> <filepath>usbc.h</filepath>  </p> </entry>
+</row>
+<row>
+<entry><p> <xref href="GUID-0E2BBD18-FD98-3010-9B3D-6719FC47EBF3.dita"><apiname>TUsbcSetup</apiname></xref>  </p> </entry>
+<entry><p> <filepath>usbc.h</filepath>  </p> </entry>
+</row>
+</tbody>
+</tgroup>
+</table> <p>Note: <codeph>DUsbClientController</codeph> is mostly internal.
+There are 39 pure virtual functions that need to be implemented in your platform-specific
+layer: </p> <ul>
+<li id="GUID-0272220C-9E61-516C-B9CC-A60DC2C87945"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-03A4F9CC-B666-3110-A997-719C7E661495"><apiname>DUsbClientController::SignalRemoteWakeup()</apiname></xref>  </p> </li>
+<li id="GUID-6769C4EF-F9DB-5296-9BC8-CB992F2ABAA9"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-43A1A895-02D0-3210-B29D-DCBEC711BD66"><apiname>DUsbClientController::DumpRegisters()</apiname></xref>  </p> </li>
+<li id="GUID-9ADC21F2-F16F-592C-B870-CF6C5C19FDDE"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-7A581253-0727-3FA4-880C-AE519305DCFC"><apiname>DUsbClientController::DfcQ()</apiname></xref>  </p> </li>
+<li id="GUID-8B0B24EA-B15C-50EB-8268-32EBCF461337"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-41B9C6B0-4F99-3145-9165-FC23B91F9E4D"><apiname>DUsbClientController::SetDeviceAddress()</apiname></xref>  </p> </li>
+<li id="GUID-6E9BE22A-89EB-557C-9002-46D3C60301EF"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-0A97EDCD-386F-3AB6-9617-174070FCBB64"><apiname>DUsbClientController::ConfigureEndpoint()</apiname></xref>  </p> </li>
+<li id="GUID-5448449F-C54B-5F6A-BE8F-1AA34D3F7AA6"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-515AC24A-C52B-3F83-A7FA-80C9B77646C2"><apiname>DUsbClientController::DeConfigureEndpoint()</apiname></xref> <xref href="GUID-6BD89347-671F-3518-9777-55801A090C79.dita"><apiname/></xref>  </p> </li>
+<li id="GUID-10B2CA22-5DA3-5902-BE32-163C4234611E"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-D8C18443-2FF8-37FF-ADE1-4995D49C4A94"><apiname>DUsbClientController::AllocateEndpointResource()</apiname></xref> </p> </li>
+<li id="GUID-A42A3373-9C49-5F71-8E4E-C725EEAF3DED"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-B5AA7790-27C5-3BB0-973E-A3361F492B8B"><apiname>DUsbClientController::DeAllocateEndpointResource()</apiname></xref> </p> </li>
+<li id="GUID-C613DDF5-E4D5-50D5-B103-E8B698D62746"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-6857A47B-D80C-3DA6-9F0C-EB12E4481718"><apiname>DUsbClientController::QueryEndpointResource()</apiname></xref>  </p> </li>
+<li id="GUID-7B355024-49BF-5B9C-ADF0-C4E8BAF6CCDC"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-907F6988-4336-3160-BD41-7FBECE9C6E88"><apiname>DUsbClientController::SetupEndpointRead()</apiname></xref>  </p> </li>
+<li id="GUID-23F90152-951B-5D43-8555-4D5D51F6408B"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-F7880D1C-7E7D-3214-BF84-8811DA935B0C"><apiname>DUsbClientController::SetupEndpointWrite()</apiname></xref>  </p> </li>
+<li id="GUID-78DBF8CC-EE87-5408-8D1D-56231CD1643D"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-0ED52450-A396-3658-9839-9491DAB2E3C1"><apiname>DUsbClientController::CancelEndpointRead()</apiname></xref>  </p> </li>
+<li id="GUID-9F0DDAD1-AF75-5AB6-BDDB-3369A1406F43"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-F97633DE-6FFA-3E2D-8C6D-31597DE30572"><apiname>DUsbClientController::CancelEndpointWrite()</apiname></xref>  </p> </li>
+<li id="GUID-76AE42E7-7BB4-5EA0-89D8-0F047194C37A"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-B3B4793E-7B75-3C40-A6FA-CD17B460CC73"><apiname>DUsbClientController::SetupEndpointZeroRead()</apiname></xref>  </p> </li>
+<li id="GUID-46A1A126-F889-5181-A017-EC3996C8CA72"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-DBE7AC29-8B85-3D98-BAF9-8EF059B33331"><apiname>DUsbClientController::SetupEndpointZeroWrite()</apiname></xref> </p> </li>
+<li id="GUID-291FFD18-611B-5285-A957-23305ABAFDCA"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-95CCCE69-C8AA-39B1-8152-37AA0A7B9CEB"><apiname>DUsbClientController::SendEp0ZeroByteStatusPacket()</apiname></xref> </p> </li>
+<li id="GUID-B648B3AA-6FBF-5503-8C68-A5D7ED5B5A3D"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-B45BBE54-463B-3B54-9025-7CACB947995E"><apiname>DUsbClientController::StallEndpoint()</apiname></xref>  </p> </li>
+<li id="GUID-66B3E4EB-939E-5B66-8B5E-8B9F46F0AB9C"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-D6AF3F08-3CFC-3EEE-BF5F-8DA8A6C189DD"><apiname>DUsbClientController::ClearStallEndpoint()</apiname></xref>  </p> </li>
+<li id="GUID-8B3C1645-1319-524F-AC76-87C98CA1AC70"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-63169150-EEAC-34CE-909D-D985739B555D"><apiname>DUsbClientController::EndpointStallStatus()</apiname></xref>  </p> </li>
+<li id="GUID-BC1E6F3A-ED0D-52A4-AE9A-CA5F36BC0D48"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-F94B97E0-07DB-3468-8E97-EB2C0ED3C899"><apiname>DUsbClientController::EndpointErrorStatus()</apiname></xref>  </p> </li>
+<li id="GUID-ECCF863F-E650-5A30-BEAB-279ADAFF6DFA"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-514602A1-880E-36C7-B3A4-73B91AD12C14"><apiname>DUsbClientController::ResetDataToggle()</apiname></xref>  </p> </li>
+<li id="GUID-51E53D00-0681-5793-89EB-17DA5DE4D805"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-E6B2CF9C-B385-3398-AFAC-95508084371A"><apiname>DUsbClientController::SynchFrameNumber()</apiname></xref>  </p> </li>
+<li id="GUID-9663CBFA-CCE1-5444-B08B-D253A35FEC00"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-2D73F325-E968-350F-B1BB-C8B9B693CF5B"><apiname>DUsbClientController::SetSynchFrameNumber()</apiname></xref>  </p> </li>
+<li id="GUID-E63FBA1A-3B07-549C-824A-8A5F7C4C166D"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-E70BC002-5DC7-3985-B493-379C612B8392"><apiname>DUsbClientController::StartUdc()</apiname></xref>  </p> </li>
+<li id="GUID-948CAB64-C914-509D-91A2-532284E87E1F"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-D3939179-8129-33D1-BD53-9D3D551FB43E"><apiname>DUsbClientController::StopUdc()</apiname></xref>  </p> </li>
+<li id="GUID-54FA4620-BC5C-53FE-9AC5-3EC40CFF85ED"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-837EAD41-64E9-326D-BCAE-434A2E4D9B16"><apiname>DUsbClientController::UdcConnect()</apiname></xref>  </p> </li>
+<li id="GUID-C76D184E-15F7-5028-AA2D-E998031768D8"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-4C703AAE-454A-397F-8F00-71CC9FB6BAFE"><apiname>DUsbClientController::UdcDisconnect()</apiname></xref>  </p> </li>
+<li id="GUID-A91F46EC-55AB-51E1-928A-CBE5DEE8F8F8"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-A2719A78-DAB2-386C-9F65-DE7C1AAEF35F"><apiname>DUsbClientController::UsbConnectionStatus()</apiname></xref>  </p> </li>
+<li id="GUID-F37C1850-D743-5FCF-AF8A-0250B1CBA2BD"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-ECC83E6D-AD55-381B-BC20-F1F5EAF5F93C"><apiname>DUsbClientController::UsbPowerStatus()</apiname></xref>  </p> </li>
+<li id="GUID-3C9C295D-4F26-5FD6-A19E-B4A4095A44FD"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-040A2266-23DB-3261-94A4-40E8905A6C47"><apiname>DUsbClientController::DeviceSelfPowered()</apiname></xref>  </p> </li>
+<li id="GUID-E93E1006-824C-5B49-BA24-5CFED068A654"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-5B09B251-44E8-3DFB-8C03-B25CC6EEE515"><apiname>DUsbClientController::DeviceEndpointCaps()</apiname></xref>  </p> </li>
+<li id="GUID-99813D6D-5F8A-5E72-9CD3-10754893FC75"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-38F1A77F-E8EE-3426-865A-B369BB54DE30"><apiname>DUsbClientController::DeviceTotalEndpoints()</apiname></xref>  </p> </li>
+<li id="GUID-CCDD65CC-3B82-57E0-8577-021AFA43691B"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-CF2E5992-CA28-3D66-BE87-EB040CFE423D"><apiname>DUsbClientController::SoftConnectCaps()</apiname></xref>  </p> </li>
+<li id="GUID-5CB10AED-CDBB-51F6-926D-D1E340F6B10A"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-83DFAE51-6ADB-3B67-8620-9C5A9088DB48"><apiname>DUsbClientController::DeviceStateChangeCaps()</apiname></xref>  </p> </li>
+<li id="GUID-43891A8B-3ECA-5396-8358-D9FEE2CA52F7"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-8C625079-9E35-3DAA-A735-E76F0CCD3310"><apiname>DUsbClientController::Suspend()</apiname></xref>  </p> </li>
+<li id="GUID-0C69380C-EB69-5D93-B216-C8782D90C023"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-4E6F1260-1701-3572-962F-61FC0D5A7D01"><apiname>DUsbClientController::Resume()</apiname></xref>  </p> </li>
+<li id="GUID-49B914A8-3B60-5438-8458-809E457C4B90"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-DD4D0541-6FA5-37EB-A04B-5FE7DBEA89C6"><apiname>DUsbClientController::Reset()</apiname></xref>  </p> </li>
+<li id="GUID-4945A0DC-1252-5A5C-B5BC-846C58B1D409"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-CE068BED-F7BF-3EE6-BDE0-6E6D7CC367A7"><apiname>DUsbClientController::Ep0ReadSetupPktProceed()</apiname></xref> </p> </li>
+<li id="GUID-7E46EC76-83E5-50BC-A5E8-47898F759D59"><p> <xref href="GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941.dita#GUID-82FA9C04-0B7E-3FAD-9AAD-3A68E1E6A941/GUID-07830DF4-23D1-38BA-B95B-EF8D480EE773"><apiname>DUsbClientController::Ep0ReceiveProceed()</apiname></xref>  </p> </li>
+</ul> </section>
+</conbody></concept>
\ No newline at end of file