Adaptation/GUID-BA3B42A2-141C-49D9-B513-1571C246C19B.dita
author Graeme Price <GRAEME.PRICE@NOKIA.COM>
Fri, 15 Oct 2010 14:32:18 +0100
changeset 15 307f4279f433
permissions -rw-r--r--
Initial contribution of the Adaptation Documentation.

<?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-BA3B42A2-141C-49D9-B513-1571C246C19B" xml:lang="en"><title>TSDIOCard
Class Tutorial</title><shortdesc>Describes the <codeph>TSDIOCard</codeph> class.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
<section id="GUID-B373ECD1-7524-4498-838E-E5E0D5922BFB"><title>Description</title><p>The <xref href="GUID-731522ED-8259-3CBA-9AD3-09DDAE23257D.dita"><apiname>TSDIOCard</apiname></xref> class
provides access to the individual IO functions available on the SDIO card.
It also, provides various methods for reading the card capabilities and the
Common Card Control Registers (CCCR) on the SDIO card.</p><table id="GUID-CE22150C-48E7-4764-A5D3-26FA0F241F1F">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<tbody>
<row>
<entry><p>Header file</p></entry>
<entry><p><filepath>sdiocard.h</filepath></p></entry>
</row>
<row>
<entry><p>Source code file</p></entry>
<entry><p><filepath>sdiocard.cpp</filepath></p></entry>
</row>
<row>
<entry><p>Required libraries</p></entry>
<entry><p>EPBUSSDIO</p></entry>
</row>
<row>
<entry><p>Class declaration</p></entry>
<entry><p><codeph>class TSDIOCard : public TSDCard</codeph></p></entry>
</row>
</tbody>
</tgroup>
</table></section>
<section id="GUID-6596C6D7-7912-4E8A-A317-1D7086EF36D7"><title>FunctionCount()</title><p>The
function declaration for the <xref href="GUID-3A8CD17F-D6AB-3424-BB22-152E8D0CEA88.dita"><apiname>FunctionCount()</apiname></xref> method is:</p><codeblock xml:space="preserve">inline TUint8 FunctionCount() const;</codeblock><p><b>Description</b></p><p>This method returns the number of IO functions that are present on
the SDIO card.</p><p><b>Parameters</b></p><p>None</p><p><b>Return value</b></p><table id="GUID-47FB3FA5-729A-4361-BCA4-A8CDE1A4BEB1">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<tbody>
<row>
<entry><p><codeph>TUint8</codeph></p></entry>
<entry><p>The number of IO functions present of the SDIO card.</p></entry>
</row>
</tbody>
</tgroup>
</table></section>
<section id="GUID-6C999579-DE97-446B-9C7F-4C43B4A602B4"><title>IoFunction()</title><p>The
function declaration for the <xref href="GUID-EB683982-C6EC-38B3-84B5-B2514687EE0B.dita"><apiname>IoFunction()</apiname></xref> method is:</p><codeblock xml:space="preserve">inline TSDIOFunction* IoFunction(TUint8 aFunctionNo) const;</codeblock><p><b>Description</b></p><p>This returns a pointer to the class that carries
out the required SDIO function.</p><p><b>Parameters</b></p><table id="GUID-C818B43D-BF71-4DAD-8AE4-5A8A3690D831">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<tbody>
<row>
<entry><p><codeph>TUint8 aFunctionNo</codeph></p></entry>
<entry><p>The ID of the SDIO function.</p></entry>
</row>
</tbody>
</tgroup>
</table><p><b>Return value</b></p><table id="GUID-83EDD6EB-FB46-4F80-8F8F-DFE456795FDD">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<tbody>
<row>
<entry><p><codeph>TSDIOFunction*</codeph></p></entry>
<entry><p>The pointer to the class that performs the SDIO function.</p></entry>
</row>
</tbody>
</tgroup>
</table></section>
<section id="GUID-E17E970F-D020-4A38-A321-B25F11717ABE"><title>FindFunction()</title><p>The
function declaration for the <xref href="GUID-9B98BE63-FC7F-3CD9-9111-B88CDEAEDE89.dita"><apiname>FindFunction()</apiname></xref> method is:</p><codeblock xml:space="preserve">IMPORT_C TSDIOFunction* FindFunction(TSDIOFunctionCaps&amp; aCaps, TUint32 aMatchFlags, TSDIOFunction* aFunctionP = NULL) const;</codeblock><p><b>Description</b></p><p>This method provides support for the validation
and the enumeration of the card functions.</p><p>This method finds the function
that can carry out the required capabilities and either returns a function
pointer to it (if it exists), or NULL, if it does not. See <xref href="GUID-12A4418A-9BC6-4BEB-993D-B55E61240A15.dita">Using
the SDIO Interface in a Device Driver</xref> for example code which uses this
function.</p><p><b>Parameters</b></p><table id="GUID-7A53C0AB-2AA0-4C80-801E-C3951451BC9F">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<tbody>
<row>
<entry><p><codeph>TSDIOFunctionCaps&amp; aCaps</codeph></p></entry>
<entry><p>The <xref href="GUID-103CBB8D-F965-3C71-B033-72423F95D2A8.dita"><apiname>TSDIOFunctionCaps</apiname></xref> class that contains the
desired capabilities.</p></entry>
</row>
<row>
<entry><p><codeph>TUint32 aMatchFlags</codeph></p></entry>
<entry><p>A bitmask that specifies the capabilities that are to be matched.</p></entry>
</row>
<row>
<entry><p><codeph>TSDIOFunction* aFunctionP</codeph></p></entry>
<entry><p>A pointer to the currently matched function.</p></entry>
</row>
</tbody>
</tgroup>
</table><p><b>Return value</b></p><table id="GUID-31D8A918-2A00-4DC3-9020-A57C3127C0B8">
<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
<tbody>
<row>
<entry><p><codeph>TSDIOFunction*</codeph></p></entry>
<entry><p>A pointer to the next matching function. This value is NULL, if
there are no more matching functions.</p></entry>
</row>
</tbody>
</tgroup>
</table></section>
</conbody></concept>