|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-BA3B42A2-141C-49D9-B513-1571C246C19B" xml:lang="en"><title>TSDIOCard |
|
13 Class Tutorial</title><shortdesc>Describes the <codeph>TSDIOCard</codeph> class.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <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 |
|
15 provides access to the individual IO functions available on the SDIO card. |
|
16 It also, provides various methods for reading the card capabilities and the |
|
17 Common Card Control Registers (CCCR) on the SDIO card.</p><table id="GUID-CE22150C-48E7-4764-A5D3-26FA0F241F1F"> |
|
18 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
19 <tbody> |
|
20 <row> |
|
21 <entry><p>Header file</p></entry> |
|
22 <entry><p><filepath>sdiocard.h</filepath></p></entry> |
|
23 </row> |
|
24 <row> |
|
25 <entry><p>Source code file</p></entry> |
|
26 <entry><p><filepath>sdiocard.cpp</filepath></p></entry> |
|
27 </row> |
|
28 <row> |
|
29 <entry><p>Required libraries</p></entry> |
|
30 <entry><p>EPBUSSDIO</p></entry> |
|
31 </row> |
|
32 <row> |
|
33 <entry><p>Class declaration</p></entry> |
|
34 <entry><p><codeph>class TSDIOCard : public TSDCard</codeph></p></entry> |
|
35 </row> |
|
36 </tbody> |
|
37 </tgroup> |
|
38 </table></section> |
|
39 <section id="GUID-6596C6D7-7912-4E8A-A317-1D7086EF36D7"><title>FunctionCount()</title><p>The |
|
40 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 |
|
41 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"> |
|
42 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
43 <tbody> |
|
44 <row> |
|
45 <entry><p><codeph>TUint8</codeph></p></entry> |
|
46 <entry><p>The number of IO functions present of the SDIO card.</p></entry> |
|
47 </row> |
|
48 </tbody> |
|
49 </tgroup> |
|
50 </table></section> |
|
51 <section id="GUID-6C999579-DE97-446B-9C7F-4C43B4A602B4"><title>IoFunction()</title><p>The |
|
52 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 |
|
53 out the required SDIO function.</p><p><b>Parameters</b></p><table id="GUID-C818B43D-BF71-4DAD-8AE4-5A8A3690D831"> |
|
54 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
55 <tbody> |
|
56 <row> |
|
57 <entry><p><codeph>TUint8 aFunctionNo</codeph></p></entry> |
|
58 <entry><p>The ID of the SDIO function.</p></entry> |
|
59 </row> |
|
60 </tbody> |
|
61 </tgroup> |
|
62 </table><p><b>Return value</b></p><table id="GUID-83EDD6EB-FB46-4F80-8F8F-DFE456795FDD"> |
|
63 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
64 <tbody> |
|
65 <row> |
|
66 <entry><p><codeph>TSDIOFunction*</codeph></p></entry> |
|
67 <entry><p>The pointer to the class that performs the SDIO function.</p></entry> |
|
68 </row> |
|
69 </tbody> |
|
70 </tgroup> |
|
71 </table></section> |
|
72 <section id="GUID-E17E970F-D020-4A38-A321-B25F11717ABE"><title>FindFunction()</title><p>The |
|
73 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& aCaps, TUint32 aMatchFlags, TSDIOFunction* aFunctionP = NULL) const;</codeblock><p><b>Description</b></p><p>This method provides support for the validation |
|
74 and the enumeration of the card functions.</p><p>This method finds the function |
|
75 that can carry out the required capabilities and either returns a function |
|
76 pointer to it (if it exists), or NULL, if it does not. See <xref href="GUID-12A4418A-9BC6-4BEB-993D-B55E61240A15.dita">Using |
|
77 the SDIO Interface in a Device Driver</xref> for example code which uses this |
|
78 function.</p><p><b>Parameters</b></p><table id="GUID-7A53C0AB-2AA0-4C80-801E-C3951451BC9F"> |
|
79 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
80 <tbody> |
|
81 <row> |
|
82 <entry><p><codeph>TSDIOFunctionCaps& aCaps</codeph></p></entry> |
|
83 <entry><p>The <xref href="GUID-103CBB8D-F965-3C71-B033-72423F95D2A8.dita"><apiname>TSDIOFunctionCaps</apiname></xref> class that contains the |
|
84 desired capabilities.</p></entry> |
|
85 </row> |
|
86 <row> |
|
87 <entry><p><codeph>TUint32 aMatchFlags</codeph></p></entry> |
|
88 <entry><p>A bitmask that specifies the capabilities that are to be matched.</p></entry> |
|
89 </row> |
|
90 <row> |
|
91 <entry><p><codeph>TSDIOFunction* aFunctionP</codeph></p></entry> |
|
92 <entry><p>A pointer to the currently matched function.</p></entry> |
|
93 </row> |
|
94 </tbody> |
|
95 </tgroup> |
|
96 </table><p><b>Return value</b></p><table id="GUID-31D8A918-2A00-4DC3-9020-A57C3127C0B8"> |
|
97 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
98 <tbody> |
|
99 <row> |
|
100 <entry><p><codeph>TSDIOFunction*</codeph></p></entry> |
|
101 <entry><p>A pointer to the next matching function. This value is NULL, if |
|
102 there are no more matching functions.</p></entry> |
|
103 </row> |
|
104 </tbody> |
|
105 </tgroup> |
|
106 </table></section> |
|
107 </conbody></concept> |