|
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-E1277A18-7201-4856-8712-067022F92123" xml:lang="en"><title>DSDIOStack |
|
13 Class Tutorial</title><shortdesc>Describes the DSDIOStack API class.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <section id="GUID-4BDF2833-2D45-4AAF-BB79-FC1215209C3B"><title>Description</title><p>The <xref href="GUID-908B4DA8-8E1C-3B38-90FF-14EC52277B91.dita"><apiname>DSDIOStack</apiname></xref> class |
|
15 provides the SDIO specific implementation of the initialization state machine |
|
16 and the support for asynchronous IO read and write operations.</p><table id="GUID-6247B2E9-C6A2-4EDD-9694-71514DEB44FD"> |
|
17 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
18 <tbody> |
|
19 <row> |
|
20 <entry><p>Header file</p></entry> |
|
21 <entry><p><filepath>sdio.h</filepath></p></entry> |
|
22 </row> |
|
23 <row> |
|
24 <entry><p>Source code file</p></entry> |
|
25 <entry><p><filepath>sdiostack.cpp</filepath></p></entry> |
|
26 </row> |
|
27 <row> |
|
28 <entry><p>Required libraries</p></entry> |
|
29 <entry><p>EPBUSSDIO</p></entry> |
|
30 </row> |
|
31 <row> |
|
32 <entry><p>Class declaration</p></entry> |
|
33 <entry><p><codeph>class DSDIOStack : public DStackBase</codeph></p></entry> |
|
34 </row> |
|
35 </tbody> |
|
36 </tgroup> |
|
37 </table></section> |
|
38 <section id="GUID-764AE495-9C67-4181-ACCF-F4705FC0CBCA"><title>AcquireStackSM()</title><p>The |
|
39 function declaration for the <xref href="GUID-A5562C23-91EC-38A4-A13E-1BF70C4920C5.dita"><apiname>AcquireStackSM()</apiname></xref>method is:</p><codeblock xml:space="preserve">IMPORT_C virtual TMMCErr AcquireStackSM();</codeblock><p><b>Description</b></p><p>This adds a new SDIO card to the SDIO card stack. |
|
40 This is an extension of the <codeph>DSDStack::AcquireStackSM</codeph> state |
|
41 machine function. It handles the SDIO initialization procedure as described |
|
42 in version 1.10f of the SDIO card specification.</p><p><b>Parameters</b></p><p>None</p><p><b>Return |
|
43 value</b></p><table id="GUID-9D79FCCD-516A-4A78-9F74-8E28B0E57E92"> |
|
44 <tgroup cols="2"><colspec colname="col1" colwidth="0.48*"/><colspec colname="col2" colwidth="1.52*"/> |
|
45 <tbody> |
|
46 <row> |
|
47 <entry><p><codeph>TMMCErr</codeph></p></entry> |
|
48 <entry><p>Return code of the operation. The return value is <codeph>KErrNone</codeph> if |
|
49 the operation was successful, otherwise an error code.</p></entry> |
|
50 </row> |
|
51 </tbody> |
|
52 </tgroup> |
|
53 </table></section> |
|
54 <section id="GUID-017EE801-8BBA-4D8D-9EAC-68534D510A3F"><title>CIMIoReadWriteDirectSM()</title><p>The |
|
55 function declaration for the <xref href="GUID-2F44539D-406E-3EFF-8F4A-035F1F040BC0.dita"><apiname>CIMIoReadWriteDirectSM()</apiname></xref> method |
|
56 is:</p><codeblock xml:space="preserve">IMPORT_C TMMCErr CIMIoReadWriteDirectSM();</codeblock><p><b>Description</b></p><p>Implements |
|
57 the state machine for the IO_RW_DIRECT command (CMD52).</p><p><b>Parameters</b></p><p>None</p><p><b>Return |
|
58 value</b></p><table id="GUID-695217EC-13A0-4AFF-A0CA-8BBB3AFEBB1A"> |
|
59 <tgroup cols="2"><colspec colname="col1" colwidth="0.48*"/><colspec colname="col2" colwidth="1.52*"/> |
|
60 <tbody> |
|
61 <row> |
|
62 <entry><p><codeph>TMMCErr</codeph></p></entry> |
|
63 <entry><p>Return code of the operation. The return value is <codeph>KErrNone</codeph> if |
|
64 the operation was successful, otherwise an error code.</p></entry> |
|
65 </row> |
|
66 </tbody> |
|
67 </tgroup> |
|
68 </table></section> |
|
69 <section id="GUID-9D061070-2B38-4A03-89F3-221F6F3BC28B"><title>CIMIoReadWriteExtendedSM()</title><p>The |
|
70 function declaration for the <xref href="GUID-2513922B-5796-3F96-A09E-FA2014C25A25.dita"><apiname>CIMIoReadWriteExtendedSM()</apiname></xref> method |
|
71 is:</p><codeblock xml:space="preserve">IMPORT_C TMMCErr CIMIoReadWriteExtendedSM();</codeblock><p><b>Description</b></p><p>Used |
|
72 to write an CMD53 command to the card.</p><p><b>Parameters</b></p><p>None</p><p><b>Return |
|
73 value</b></p><table id="GUID-A2C65FB6-DDAE-4EB1-A6D9-588D09735B9B"> |
|
74 <tgroup cols="2"><colspec colname="col1" colwidth="0.48*"/><colspec colname="col2" colwidth="1.52*"/> |
|
75 <tbody> |
|
76 <row> |
|
77 <entry><p><codeph>TMMCErr</codeph></p></entry> |
|
78 <entry><p>Return code of the operation. The return value is <codeph>KErrNone</codeph> if |
|
79 the operation was successful, otherwise an error code.</p></entry> |
|
80 </row> |
|
81 </tbody> |
|
82 </tgroup> |
|
83 </table></section> |
|
84 </conbody></concept> |