Adaptation/GUID-10FD1B94-EC0C-458F-839F-B60A8E47BAD6.dita
changeset 15 307f4279f433
equal deleted inserted replaced
14:578be2adaf3e 15:307f4279f433
       
     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-10FD1B94-EC0C-458F-839F-B60A8E47BAD6" xml:lang="en"><title>Baseport Template Configuration Guide</title><shortdesc>Describes the configuration of the Baseport Template platform
       
    13 service.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    14 <p>The <filepath>config.inc</filepath> file provided at <filepath>os/kernelhwsrv/bsptemplate/asspandvariant/template_variant/config.inc</filepath> is used to set up the platform specific values in the Baseport.
       
    15 The comments in the <filepath>config.inc</filepath> file explains
       
    16 the various options that can be used to configure the baseport. </p>
       
    17 <section id="GUID-67DA5F25-67FB-440D-8473-1261922AFC73"><title>Template
       
    18 configuration</title><p>A sample configuration file is available in
       
    19 the template. The configuration file looks like the one below:</p><codeblock xml:space="preserve">
       
    20 ; template\config.inc
       
    21 ;
       
    22 ;Include to enable tracing
       
    23 ;	GBLL	CFG_DebugBootRom
       
    24 
       
    25 ; 
       
    26 ; Include one of these to select the CPU
       
    27 ;	GBLL	CFG_CPU_GENERIC_ARM4
       
    28 ;	GBLL	CFG_CPU_ARM710T
       
    29 ;	GBLL	CFG_CPU_ARM720T
       
    30 ;	GBLL	CFG_CPU_SA1
       
    31 ;	GBLL	CFG_CPU_ARM925T
       
    32 ;	GBLL	CFG_CPU_ARM926J
       
    33 ;	GBLL	CFG_CPU_XSCALE
       
    34 ;	GBLL	CFG_CPU_ARM1136
       
    35 ;	GBLL	CFG_CPU_ARM1176
       
    36 ;	GBLL	CFG_CORTEX_A8
       
    37 
       
    38 ; Include the following line if this is a bootloader bootstrap
       
    39 ;	GBLL	CFG_BootLoader
       
    40 
       
    41 ; TO DO:
       
    42 ; The following line needs to be removed for target hardware
       
    43 GBLL	CFG_Template
       
    44 
       
    45 ; If you want to supply a custom set of initial vectors (including reset vector) include the following line
       
    46 ;	GBLL	CFG_CustomVectors
       
    47 ;
       
    48 ; and provide a custom_vectors.inc file
       
    49 
       
    50 ; Variant Number, just an example:
       
    51 	INIT_NUMERIC_CONSTANT	CFG_HWVD, 0x09080001
       
    52 
       
    53 ; On ARM architecture 6 processors, include the following line to override the threshold
       
    54 ; on total physical RAM size at which the multiple memory model switches into large address space mode
       
    55 ; i.e. size&gt;threshold -&gt; 2Gb per process, size&lt;=threshold -&gt; 1Gb per process
       
    56 ; Defaults to 32Mb.
       
    57 ;	INIT_NUMERIC_CONSTANT	CFG_ARMV6_LARGE_CONFIG_THRESHOLD, ;&lt;value &amp;rt;   
       
    58 ; For the direct memory model only, include the following line if you wish the exception vectors at the 
       
    59 ; start of the bootstrap to be used at all times. This is only relevant if an MMU is present - this option 
       
    60 ; is mandatory if not.
       
    61 ;	GBLL	CFG_UseBootstrapVectors 
       
    62 ;
       
    63 ; If the above option is in use (including if no MMU is present) the following symbol should be defined 
       
    64 ; to specify the offset from the bootstrap to the kernel image. 	INIT_NUMERIC_CONSTANT	KernelCodeOffset, 0x4000  
       
    65 ; Include the following line if you wish to include the ROM autodetection code based on data bus 
       
    66 ; capacitance and image repeats. 
       
    67 ;	GBLL	CFG_AutoDetectROM  
       
    68 ; Include the following line to minimise the initial kernel heap size 
       
    69 ; On the direct memory model the size of the kernel data area (super page to end of kernel heap)  
       
    70 ; is rounded up to the next 1Mb if this is not included, 4K if it is. 
       
    71 ; On the moving and multiple models, the size of the initial kernel heap area is rounded up to 
       
    72 ; the next 64K if this is not included, 4K if it is. 
       
    73 ;	GBLL	CFG_MinimiseKernelHeap  
       
    74 ; Include the following line if default memory mapping should use shared memory. 
       
    75 ; Should be defined on multicore (SMP) devices. 
       
    76 ;	GBLL	CFG_USE_SHARED_MEMORY  
       
    77 ; On the moving or multiple memory models, include either or both of the following lines to 
       
    78 ; specify the size of the initial kernel heap 
       
    79 ;	INIT_NUMERIC_CONSTANT	CFG_KernelHeapMultiplier, &lt;multiplier&gt; 
       
    80 ;	INIT_NUMERIC_CONSTANT	CFG_KernelHeapBaseSize, &lt;base&gt; 
       
    81 ; 
       
    82 ; The initial kernel heap size is MAX( &lt;base&gt; + &lt;multiplier&gt; * N / 16, value specified in ROMBUILD ) 
       
    83 ; where N is the total physical RAM size in pages. 
       
    84 ; &lt;base&gt; defaults to 24K and &lt;multiplier&gt; defaults to 9*16 (ie 9 bytes per page).  
       
    85 ; Uncomment if using ARM1136 processor and ARM1136 Erratum 353494 
       
    86 ; "Rare conditions can cause corruption of the Instruction Cache"  
       
    87 ; is fixed on this hardware. 
       
    88 ; NOTE: The boot table should use this macro to determine whether RONO or RORO permissions 
       
    89 ; are used for the exception vectors. If the erratum is not fixed, RORO must be used. 
       
    90 ;
       
    91 ;	GBLL	CFG_CPU_ARM1136_ERRATUM_353494_FIXED  
       
    92 ; Uncomment if using ARM1136 processor and ARM1136 Erratum 364296 
       
    93 ; "Possible Cache Data Corruption with Hit-Under-Miss" 
       
    94 ; is fixed on this hardware. 
       
    95 ; 
       
    96 ;	GBLL	CFG_CPU_ARM1136_ERRATUM_364296_FIXED  
       
    97 ; Uncomment if using ARM1136 processor and ARM1136 Erratum 399234 
       
    98 ; "Write back data cache entry evicted by write through entry causes data corruption" 
       
    99 ; is fixed on this hardware. 
       
   100 ;
       
   101 ; Workaround 
       
   102 ; The erratum may be avoided by marking all cacheable memory as one of write through or write back. 
       
   103 ; This requires the memory attributes described in the translation tables to be modified by software 
       
   104 ; appropriately, or the use of the remapping capability to remap write through regions to non cacheable. 
       
   105 ; 
       
   106 ; If this macro is enabled, it should be accompanied by: 
       
   107 ; 		"macro __CPU_ARM1136_ERRATUM_399234_FIXED" in variant.mmh 
       
   108 ;	GBLL	CFG_CPU_ARM1136_ERRATUM_399234_FIXED   
       
   109 ;
       
   110 ; Uncomment if: 
       
   111 ;	1)	using ARM1136 processor and ARM1136 Erratum 411920: "Invalidate Entire Instruction Cache 
       
   112 ;	  	operation might fail to invalidate some lines if coincident with linefill" 
       
   113 ;  	  	is fixed on this hardware, or 
       
   114 ;	2)	using ARM1176 processor and ARM1176 Erratum 415045: "Invalidate Entire Instruction Cache 
       
   115 ; 	  	operation might fail to invalidate some lines if coincident with linefill 
       
   116 ;	  	is fixed on this hardware. 
       
   117 ; Workaround: 
       
   118 ;	1)	Disables the use of of prefetch range cache operations by setting RV bit in Auxiliary Ctrl Reg. 
       
   119 ;	2)	Replaces Invalidate ICache operation with the sequence defined in the errata document. 
       
   120 ;
       
   121 ; If this macro is enabled, it should be accompanied by: 
       
   122 ; 	"macro __CPU_ARM1136_ERRATUM_411920_FIXED" in variant.mmh 
       
   123 ; 
       
   124 ;	GBLL	CFG_CPU_ARM1136_ERRATUM_411920_FIXED   
       
   125 ;
       
   126 ; Uncomment if using ARM1136 processor and ARM1136 Erratum 415662: "Invalidate Instruction Cache by 
       
   127 ; Index might corrupt cache when used with background prefetch range" is fixed on this hardware. 
       
   128 ; Workaround: 
       
   129 ; 	Disables the use of of prefetch range cache operations by setting RV bit in Auxiliary Ctrl Reg. 
       
   130 ; 
       
   131 ;	GBLL	CFG_CPU_ARM1136_ERRATUM_415662_FIXED   
       
   132 ;
       
   133 ; These are deduced from the supplied configuration 
       
   134 ;	CFG_ARMV6 ;	CFG_MMUPresent 
       
   135 ;	CFG_CachePresent ;	CFG_WriteBufferPresent 
       
   136 ;	CFG_SplitCache 
       
   137 ;	CFG_SplitTLB 
       
   138 ;	CFG_AltDCachePresent 
       
   139 ;	CFG_WriteBackCache 
       
   140 ;	CFG_CacheWriteAllocate 
       
   141 ;	CFG_CachePhysicalTag 
       
   142 ;	CFG_CacheFlushByDataRead 
       
   143 ;	CFG_CacheFlushByWaySetIndex 
       
   144 ;	CFG_CacheFlushByLineAlloc 
       
   145 ;	CFG_CachePolicyInPTE 
       
   146 ;	CFG_TEX 
       
   147 ;	CFG_SingleEntryDCacheFlush 
       
   148 ;	CFG_SingleEntryICacheFlush 
       
   149 ;	CFG_SingleEntryITLBFlush 
       
   150 ;	CFG_SingleEntryTLBFlush 
       
   151 ;	CFG_CacheTypeReg 
       
   152 ;	CFG_BTBPresent 
       
   153 ;	CFG_CARPresent 
       
   154 ;	CFG_PrefetchBuffer 
       
   155 ;	CFG_FCSE_Present 
       
   156 ;	CFG_ASID_Present 
       
   157 ;	CFG_IncludeRAMAllocator
       
   158  	END 
       
   159 	</codeblock><note> Ensure that you have made the line <codeph>GBLL	CFG_Template </codeph> a comment and have selected the lines for the required configuration.</note></section>
       
   160 </conbody><related-links>
       
   161 <link href="GUID-AE486C82-8854-463F-8CB9-B7353D6B2804.dita"><linktext>Baseport
       
   162 Template Build Guide</linktext></link>
       
   163 </related-links></concept>