|
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-6060F138-CEB6-482A-B0E9-BBBE261568B0" xml:lang="en"><title>Baseport Template Overview</title><shortdesc>This section provides a summary of the Baseport Template |
|
13 platform service.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <section id="GUID-55C84C61-0BD1-4E01-A454-9B10B305169C"><title>What |
|
15 is the Baseport Template</title><p>The Baseport Template is a reference |
|
16 board template, which provides a basic framework consisting of base |
|
17 parts of the Symbian platform. This framework can be modified to suit |
|
18 your hardware configurations.</p><p>The Baseport Template code is |
|
19 categorized into Application Specific Standard Product (ASSP) layer |
|
20 and variant layer. The ASSP layer provides the source code for hardware-specific |
|
21 functions (for example, GPIO, DMA, IIC, USB Client Controller) that |
|
22 are used by the kernel. This layer is implemented by the <xref href="GUID-E893165C-0E62-3AC6-98BA-227E104B672E.dita"><apiname>TemplateAssp</apiname></xref> class. The variant layer provides common peripheral |
|
23 control functions such as power, bootstrap, keymap, keyboard and sound |
|
24 that other extensions and device drivers can use. This layer is implemented |
|
25 by the <xref href="GUID-F041A785-0E01-3288-98EE-73627AC43B8B.dita"><apiname>Template</apiname></xref> class.</p><p>ASSP and variant layers |
|
26 provide control functions for hardware which is used by multiple devices. |
|
27 This is done by placing Baseport Template code in a single DLL, called |
|
28 the Variant DLL (<codeph>ecust.dll</codeph>). For hardware architectures |
|
29 based on an ASSP, you can allow multiple phone types that use the |
|
30 same ASSP to share the common code. To achieve this, implement the |
|
31 common ASSP code in a kernel extension, and <codeph>ecust.dll</codeph> implements the code that is specific to each variant. </p></section> |
|
32 <section id="GUID-94D4C137-A1C0-4A30-B115-A8C3ABB873DF"><title>Purpose |
|
33 of the Baseport Template</title><p>The Baseport Template is mostly |
|
34 useful in creating a baseport and testing the software. The following |
|
35 is a list of some of the key uses of the Baseport Template.</p><p>The Baseport Template is useful in handling:</p><ul> |
|
36 <li><p>data exchange between devices connected to the bus</p></li> |
|
37 <li><p>data copy between memory locations or between memory location |
|
38 and peripheral</p></li> |
|
39 <li><p>communication interface between the microprocessor components</p></li> |
|
40 <li><p>hardware events and registers</p></li> |
|
41 <li><p>USB functions of the device</p></li> |
|
42 <li><p>power resources</p></li> |
|
43 <li><p>phone restart after a hardware reset </p></li> |
|
44 <li><p>shared chunks of camera and sound physical device driver</p></li> |
|
45 <li><p>CPU idle operations</p></li> |
|
46 <li><p>HAL, interrupt and keyboard functions</p></li> |
|
47 <li><p>data storage based on NOR type flash memory</p></li> |
|
48 <li><p>variant specific initialization (not the same as ASSP specific |
|
49 initialization).</p></li> |
|
50 </ul></section> |
|
51 <section id="GUID-0E2FF597-880E-49B5-98EF-0228B9EE70F4"><title>Users |
|
52 of Baseport Template</title>The Baseport Template documentation cover |
|
53 users who: <ul> |
|
54 <li><p>manufacture devices and want to develop software and get an |
|
55 early debug output.</p></li> |
|
56 <li><p>develop baseport. See <xref href="GUID-0C84FD76-87B2-4AD1-B23A-2C5C8668BC4C.dita">Base Porting Guide</xref> for base porting details</p></li> |
|
57 </ul></section> |
|
58 <section id="GUID-575E1FDC-6BA8-4847-A7F3-ADDF0D74B929"><title>Baseport |
|
59 Template details</title><p>The following table lists the Baseport |
|
60 Template details:</p><table id="GUID-BCE51448-8AE7-4D00-BADC-68A630392145"> |
|
61 <tgroup cols="3"><colspec colname="col1" colwidth="0.66*"/><colspec colname="col2" colwidth="0.67*"/><colspec colname="col3" colwidth="2.31*"/> |
|
62 <thead> |
|
63 <row> |
|
64 <entry valign="top"><p>DLL</p></entry> |
|
65 <entry valign="top"><p>Library</p></entry> |
|
66 <entry valign="top"><p>Description</p></entry> |
|
67 </row> |
|
68 </thead> |
|
69 <tbody> |
|
70 <row> |
|
71 <entry><p><filepath>katemplate.dll</filepath></p></entry> |
|
72 <entry><p>None</p></entry> |
|
73 <entry><p> ASSP DLL. This DLL is made up of the following template |
|
74 files and can be found under <filepath>...template\asspandvariant\template_assp\</filepath> directory:<ul> |
|
75 <li><p><filepath>template_assp.cpp</filepath> </p></li> |
|
76 <li><p><filepath>interrupts.cpp</filepath></p></li> |
|
77 <li><p><filepath>assp.cpp</filepath></p></li> |
|
78 <li><p><filepath>register.cpp</filepath></p></li> |
|
79 <li><p><filepath>template_assp.cia</filepath></p></li> |
|
80 <li><p><filepath>interrupts.cia</filepath></p></li> |
|
81 <li><p><filepath>assp.cia</filepath></p></li> |
|
82 </ul></p></entry> |
|
83 </row> |
|
84 <row> |
|
85 <entry><p><filepath>ecust.dll</filepath></p></entry> |
|
86 <entry><p>None</p></entry> |
|
87 <entry><p>Variant DLL. This DLL is made up of the following template |
|
88 files and can be found in <filepath>...template\asspandvariant\template_variant\</filepath> directory:<ul> |
|
89 <li><p><filepath>variant.cpp</filepath> </p></li> |
|
90 <li><p><filepath>variant.cia</filepath> </p></li> |
|
91 </ul></p></entry> |
|
92 </row> |
|
93 </tbody> |
|
94 </tgroup> |
|
95 </table></section> |
|
96 </conbody><related-links> |
|
97 <link href="GUID-0C84FD76-87B2-4AD1-B23A-2C5C8668BC4C.dita"><linktext>Base |
|
98 Porting Guide</linktext></link> |
|
99 </related-links></concept> |