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-535C66C9-8B45-4DF3-8404-8ED03ABB4799-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1" xml:lang="en"><title>TSDIOInterrupt

    13 Class Tutorial</title><shortdesc>Describes the TSDIOInterrupt API class.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <section id="GUID-26C82435-8FB9-422E-B6D0-302CB1E4B5F5-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-1"><title>Description</title><p>The <xref href="GUID-5A5218D4-E8AD-322F-BE5B-597137623B3F.dita"><apiname>TSDIOInterrupt</apiname></xref> class

    15 provides the client with the ability to enable, disable, bind and unbind to

    16 an SDIO interrupt. There is no Clear() method provided as it is the responsibility

    17 of the client device driver to clear the appropriate interrupt through its <xref href="GUID-CC5352E2-DB21-393F-A7A4-108AA3684460.dita"><apiname>DSDIORegInterface</apiname></xref> class

    18 documented <xref href="GUID-2607CCFA-3D24-4716-A447-74304F861C44.dita">here</xref>.</p><table id="GUID-8047BB14-2519-4421-B6BD-41B078CAC404-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-1-3">

    19 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>

    20 <tbody>

    21 <row>

    22 <entry><p>Header file</p></entry>

    23 <entry><p><filepath>interrupt.h</filepath></p></entry>

    24 </row>

    25 <row>

    26 <entry><p>Source code file</p></entry>

    27 <entry><p><filepath>interrupt.cpp</filepath></p></entry>

    28 </row>

    29 <row>

    30 <entry><p>Required libraries</p></entry>

    31 <entry><p>epbussdio.lib</p></entry>

    32 </row>

    33 <row>

    34 <entry><p>Class declaration</p></entry>

    35 <entry><p><codeph>class TSDIOInterrupt</codeph></p></entry>

    36 </row>

    37 </tbody>

    38 </tgroup>

    39 </table></section>

    40 <section id="GUID-ACEDEF93-FD3F-4F19-9641-36F4FAC8FE66-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-2"><title>Bind()</title><p>The

    41 function declaration for the <xref href="GUID-8DAB6465-BCDE-35FE-8C31-861C13A34526.dita"><apiname>Bind()</apiname></xref> method is:</p><codeblock xml:space="preserve">IMPORT_C TInt Bind(TSDIOIsr aIsr, TAny* aPtr);</codeblock><p><b>Description</b></p><p>Binds the <xref href="GUID-5E00A59F-9316-3522-B152-EA8F8BC429B3.dita"><apiname>TSDIOIsr</apiname></xref> callback to the function's interrupt.

    42 Once bound, the interrupt should be enabled for the function by a call to

    43 Enable().</p><p><b>Parameters</b></p><p><table id="GUID-8F76FE85-D8EF-4FBF-974F-CB5CD7FF76FB-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-2-7-1">

    44 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>

    45 <tbody>

    46 <row>

    47 <entry><p><codeph>TSDIOIsr aIsr</codeph></p></entry>

    48 <entry>The ISR used to handle the function's interrupt.</entry>

    49 </row>

    50 <row>

    51 <entry><p><codeph>TAny* aPtr</codeph></p></entry>

    52 <entry>User defined data for use within the ISR.</entry>

    53 </row>

    54 </tbody>

    55 </tgroup>

    56 </table></p><p><b>Return value</b></p><p><codeph>KErrNone</codeph> if successful, <codeph>KErrAlreadyExists</codeph> if

    57 an ISR already bound to the function's interrupt, or a standard Symbian platform

    58 error code.</p></section>

    59 <section id="GUID-ACEDEF93-FD3F-4F19-9641-36F4FAC8FE66-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-3"><title>Unbind()</title><p>The

    60 function declaration for the <xref href="GUID-EAED145E-E4BE-3A0F-BC25-78E1FC13FB55.dita"><apiname>Unbind()</apiname></xref> method is:</p><codeblock xml:space="preserve">IMPORT_C TInt Unbind();</codeblock><p><b>Description</b></p><p>Unbinds

    61 the callback from the interrupt controller, replacing the callback with a

    62 dummy handler.</p><p><b>Parameters</b></p><p>None.</p><p><b>Return value</b></p><p><codeph>KErrNone</codeph> if

    63 successful, otherwise a standard Symbian platform error code.</p></section>

    64 <section id="GUID-ACEDEF93-FD3F-4F19-9641-36F4FAC8FE66-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-4"><title>Enable()</title><p>The

    65 function declaration for the <xref href="GUID-1B8F9258-D611-39DC-B0A7-8BB634915752.dita"><apiname>Enable()</apiname></xref> method is:</p><codeblock xml:space="preserve">IMPORT_C TInt Enable();</codeblock><p><b>Description</b></p><p>Enables

    66 the function's interrupt by setting the appropriate IEN bit in the CCCR. Note

    67 that this only unmasks the global function interrupt. It is the responsibility

    68  of the client to perform any function-specific interrupt enabling that may

    69 be required.</p><p><b>Parameters</b></p><p>None.</p><p><b>Return value</b></p><p><codeph>KErrNone</codeph> if

    70 successful, otherwise a standard Symbian platform error code.</p></section>

    71 <section id="GUID-ACEDEF93-FD3F-4F19-9641-36F4FAC8FE66-GENID-1-2-1-10-1-5-1-9-1-1-7-1-4-1-4-1-3-5"><title>Disable()</title><p>The

    72 function declaration for the <xref href="GUID-229B7E6B-EF06-3C54-8D92-F1075B04D585.dita"><apiname>Disable()</apiname></xref> method is:</p><codeblock xml:space="preserve">IMPORT_C TInt Disable();</codeblock><p><b>Description</b></p><p>Disables the function's interrupt by clearing the appropriate IEN bit in

    73 the CCCR.  Note that this only masks the global function interrupt. It is

    74 the responsibility  of the client to perform any function-specific interrupt

    75 disabling that may be required.</p><p><b>Parameters</b></p><p>None.</p><p><b>return

    76 value</b></p><p><codeph>KErrNone</codeph> if successful, otherwise a standard

    77 Symbian platform error code.</p></section>

    78 </conbody></concept>