|
1 // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // template\template_variant\inc\iolines.h |
|
15 // Variant layer header for Template Platform |
|
16 // |
|
17 // |
|
18 |
|
19 |
|
20 |
|
21 #ifndef __V32TEMPLATEV1_H__ |
|
22 #define __V32TEMPLATEV1_H__ |
|
23 #include <e32cmn.h> |
|
24 #include <kpower.h> |
|
25 |
|
26 //---------------------------------------------------------------------------- |
|
27 // Variant-specific constants: use #define if constant dependencies are not |
|
28 // declared within this file (this breaks the dependency on other header files) |
|
29 //---------------------------------------------------------------------------- |
|
30 |
|
31 // Examples of what goes in here include: |
|
32 // |
|
33 // - General-purpose I/O allocation such as |
|
34 // #define KtVariantGpio32KHzClkOut KHtGpioPort1 |
|
35 // #define KtVariantGpioRClkOut KHtGpioPort0 |
|
36 // |
|
37 // #define KmVariantPinDirectionIn Sleep 0 |
|
38 // |
|
39 // - Memory constants (type, geometry, wait states, etc) such as: |
|
40 // #define KwVariantRom0Type TTemplate::ERomTypeBurst4Rom |
|
41 // #define KwVariantRom0Width TTemplate::ERomWidth32 |
|
42 // const TUint KwVariantRom0WaitNs = 150; |
|
43 // const TUint KwVariantRom0PageNs = 30; |
|
44 // const TUint KwVariantRom0RecoverNs = 55; |
|
45 // |
|
46 // - Specific Peripherals (Keyboard, LCD, CODECS, Serial Ports) such as |
|
47 // const TUint KwVariantKeyColLshift = 7; |
|
48 // #define KwVariantLcdBpp TTemplate::ELcd8BitsPerPixel |
|
49 // const TUint KwVariantLcdMaxColors = 4096; |
|
50 // const TUint KwVariantCodecMaxVolume = 0; |
|
51 // |
|
52 // - Off-chip hardware control blocks (addresses, register make-up) |
|
53 // |
|
54 // - Interrupts (second-level Interrupt controller base address, register make-up): |
|
55 // (EXAMPLE ONLY:) |
|
56 const TUint32 KHwVariantPhysBase = 0x40000000; |
|
57 const TUint32 KHoVariantRegSpacing = 0x200; |
|
58 |
|
59 const TUint32 KHoBaseIntCont = 0x0B*KHoVariantRegSpacing; |
|
60 |
|
61 const TUint32 KHoIntContEnable = 0x00; // offsets from KHwVariantPhysBase+KHoBaseIntCont |
|
62 const TUint32 KHoIntContPending = 0x04; |
|
63 // other Variant and external blocks Base adrress offsets to KHwVariantPhysBase |
|
64 |
|
65 |
|
66 // TO DO: (optional) |
|
67 // |
|
68 // Enumerate here all Variant (2nd level) interrupt sources. It could be a good idea to enumerate them in a way that |
|
69 // facilitates operating on the corresponding interrupt controller registers (e.g using their value as a shift count) |
|
70 // |
|
71 // (EXAMPLE ONLY:) |
|
72 enum TTemplateInterruptId |
|
73 { |
|
74 // the top-level bit is set to distinguish from first level (ASSP) Interrupts |
|
75 EXIntIdA=0x80000000, |
|
76 EXIntIdB=0x80000001, |
|
77 // ... |
|
78 EXIntIdZ=0x80000019, |
|
79 |
|
80 ENumXInts=0x1A |
|
81 }; |
|
82 |
|
83 // |
|
84 // TO DO: (optional) |
|
85 // |
|
86 // Define here some commonly used Variant (2nd level) interrupts |
|
87 // |
|
88 // (EXAMPLE ONLY:) |
|
89 const TInt KIntIdKeyboard=EXIntIdB; |
|
90 |
|
91 class Variant |
|
92 { |
|
93 // below is a selection of functions usually implemented at this level. This do not constitute a mandatory |
|
94 // set and it might not be relevant for your hardware... |
|
95 public: |
|
96 /** |
|
97 * initialisation |
|
98 */ |
|
99 static void Init3(); |
|
100 /** |
|
101 * Returns the Linear Base address of the Variant Hardware |
|
102 */ |
|
103 IMPORT_C static TUint BaseLinAddress(); |
|
104 /** |
|
105 * When invoked, turns off all power supplies |
|
106 */ |
|
107 IMPORT_C static void PowerReset(); |
|
108 /** |
|
109 * When invoked, it marks the Serial port used for outputting debug strings as requiring re-initialisation |
|
110 * As in, for example, the serial port was used by a device driver or the system is coming back from Standby |
|
111 */ |
|
112 IMPORT_C static void MarkDebugPortOff(); |
|
113 /** |
|
114 * When invoked, initialises the Serial Port hardware for the serial port used to output Debug strings |
|
115 * Called by Template::DebugInit() |
|
116 */ |
|
117 IMPORT_C static void UartInit(); |
|
118 /** |
|
119 * When invoked, read the state of on-board switches |
|
120 * @return A bitmask with the state of on-board switches |
|
121 */ |
|
122 IMPORT_C static TUint Switches(); |
|
123 // other functions to access hardware not covered by specific device-drivres, which may be called from drivers |
|
124 // or platform-specifc code |
|
125 // ... |
|
126 public: |
|
127 static TUint32 iBaseAddress; |
|
128 // (optional): May need to have a follower variable to store the value of a read only register initialised at boot time |
|
129 // static TUint aFollower; |
|
130 }; |
|
131 |
|
132 #endif |