|
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-D0F5D40A-28D2-4A2E-9B40-180537E60F56" xml:lang="en"><title>Interrupt Client Interface Guide</title><shortdesc>Provides information to handle and control interrupts in |
|
13 the system.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p>The purpose of this document is to describe interrupt specific |
|
15 functions for the kernel side device drivers. </p> |
|
16 <section id="GUID-FBAD05E8-650D-4B1A-B0EF-A300436D890A"> |
|
17 <title>Interface classes</title> <table id="GUID-BEFE92DD-C363-4D72-A1A2-63BD8DE6B91B"> |
|
18 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
19 <thead> |
|
20 <row> |
|
21 <entry valign="top">API</entry> |
|
22 <entry valign="top">Description</entry> |
|
23 </row> |
|
24 </thead> |
|
25 <tbody> |
|
26 <row> |
|
27 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita"><apiname>Interrupt</apiname></xref></p></entry> |
|
28 <entry><p>Exports interrupt functionality to device |
|
29 drivers and other kernel-side code</p></entry> |
|
30 </row> |
|
31 </tbody> |
|
32 </tgroup> |
|
33 </table> </section> |
|
34 <section id="GUID-3395229E-189B-4182-A18E-67DB99B65DDD"><title>Interrupt |
|
35 class</title><p>The <xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita"><apiname>Interrupt</apiname></xref> class provides functions |
|
36 for using interrupts. The Symbian platform defines this class and |
|
37 the implementation for each of the functions is defined by at the |
|
38 hardware level.</p><p>The Interrupt class provides the following functions.</p><table id="GUID-7E7372AA-2D00-4D74-ABB4-E1AC0116AA86"> |
|
39 <tgroup cols="3"><colspec colname="COLSPEC0" colwidth="1.00*"/><colspec colname="col1"/><colspec colname="col2"/> |
|
40 <thead> |
|
41 <row> |
|
42 <entry valign="top">Function </entry> |
|
43 <entry valign="top">Return Type</entry> |
|
44 <entry valign="top">Description</entry> |
|
45 </row> |
|
46 </thead> |
|
47 <tbody> |
|
48 <row> |
|
49 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita#GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3/GUID-118AE209-BBFA-367D-89EE-A79722207532"><apiname>Interrupt:: Bind(TInt anId, TIsr anIsr, TAny* aPtr)</apiname></xref></p></entry> |
|
50 <entry><p><codeph>TInt</codeph></p></entry> |
|
51 <entry><p>Associates the specified Interrupt Service Routine (ISR) |
|
52 function with the specified interrupt Id.</p></entry> |
|
53 </row> |
|
54 <row> |
|
55 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita#GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3/GUID-AE029812-8220-3970-80F6-6322B9D933BC"><apiname>Interrupt::Unbind(TInt anId)</apiname></xref></p></entry> |
|
56 <entry><p><codeph>TInt</codeph></p></entry> |
|
57 <entry><p>Unbinds the ISR function from the specified interrupt Id.</p></entry> |
|
58 </row> |
|
59 <row> |
|
60 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita#GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3/GUID-A0D94710-E832-36F9-B324-823BFA537C2E"><apiname>Interrupt::Enable(TInt anId)</apiname></xref></p></entry> |
|
61 <entry><p><codeph>TInt</codeph></p></entry> |
|
62 <entry><p>Enables the specified interrupt.</p></entry> |
|
63 </row> |
|
64 <row> |
|
65 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita#GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3/GUID-410A0ED1-CA83-396C-921B-766C4D0BEFF6"><apiname>Interrupt::Disable(TInt anId)</apiname></xref></p></entry> |
|
66 <entry><p><codeph>TInt</codeph></p></entry> |
|
67 <entry><p>Disables the specified interrupt.</p></entry> |
|
68 </row> |
|
69 <row> |
|
70 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita#GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3/GUID-63C93F0D-F236-35D0-8E21-9FF1F96074B3"><apiname>Interrupt::Clear(TInt anId)</apiname></xref></p></entry> |
|
71 <entry><p><codeph>TInt</codeph></p></entry> |
|
72 <entry><p>Clears the interrupt pending signal at the interrupt controller |
|
73 hardware level.</p></entry> |
|
74 </row> |
|
75 <row> |
|
76 <entry><p><xref href="GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3.dita#GUID-E7A7083C-97B9-39B9-A147-4A6E314EE3A3/GUID-CD40CF24-7732-34FB-8FA1-34E0DCB9B474"><apiname>Interrupt::SetPriority(TInt anId, TInt aPriority)</apiname></xref></p></entry> |
|
77 <entry><p><codeph>TInt</codeph></p></entry> |
|
78 <entry><p>Changes the priority of the specified interrupt to the new |
|
79 specified value.</p></entry> |
|
80 </row> |
|
81 </tbody> |
|
82 </tgroup> |
|
83 </table></section> |
|
84 </conbody><related-links> |
|
85 <link href="GUID-654A788A-526A-4C3F-838C-05B09F0D5445.dita"><linktext>Interrupt |
|
86 Technology Guide</linktext></link> |
|
87 </related-links></concept> |