|
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-003D2C5B-09DC-5BD1-AF45-A0FCB56F567B" xml:lang="en"><title>ROMBUILD</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
13 <p>ROMBUILD is the Symbian platform binary XIP (execute-in-place) |
|
14 ROM builder. It is normally invoked through <xref href="GUID-E4447BEF-33D2-5099-BCC1-C72FBB3B0463.dita">BUILDROM</xref>, |
|
15 the Symbian platform ROM configuration tool that acts as a front-end |
|
16 to ROMBUILD. </p> |
|
17 <section id="GUID-CFAB320B-5F0D-4E76-AD96-FE6EE8D3BE43"> </section> |
|
18 <section id="GUID-06C4A9F7-E8D4-5A53-97BA-F3C2973B661A"><title>ROMBUILD |
|
19 command syntax</title><p>If the OBY files are encoded in UTF-8 with |
|
20 non-ASCII character support, use the following the ROMBUILD command |
|
21 syntax:</p><codeblock id="GUID-379818BF-A17B-5CAF-A311-3EE4142EE51D-GENID-1-2-1-8-1-1-6-1-1-5-1-2-3-3" xml:space="preserve">ROMBUILD [options] [–oby-charset=utf-8 <obyfile>] [-datadrive=<fat.oby>]</codeblock><p>If the OBY files are encoded in local character set with non-ASCII |
|
22 characters support, use the following the ROMBUILD command syntax:</p><codeblock id="GUID-B3A01582-9631-57C6-A654-D5539DF1AE54-GENID-1-2-1-8-1-1-6-1-1-5-1-2-3-5" xml:space="preserve">ROMBUILD [options] <obeyfile> [-datadrive=<fat.oby>]</codeblock> <p>The following command line <codeph>options</codeph> are supported: </p> <table id="GUID-321B472A-D58B-5348-A701-EA7E33E3A0B5"> |
|
23 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
24 <tbody> |
|
25 <row> |
|
26 <entry><p> <codeph>–argfile=<parameter file></codeph> </p> </entry> |
|
27 <entry><p>Accepts a parameter file, which contains a list of command-line |
|
28 parameters specific to the ROM tools, as input. </p> </entry> |
|
29 </row> |
|
30 <row> |
|
31 <entry><p> <codeph> -? </codeph> </p> </entry> |
|
32 <entry><p>Displays more detailed help for the command. </p> </entry> |
|
33 </row> |
|
34 <row> |
|
35 <entry><p> <codeph>-coff-header</codeph> </p> </entry> |
|
36 <entry><p>Uses a PE-COFF header instead of a Symbian platform header. PE-COFF is a Portable Executable–Common Object File |
|
37 Format and is a Microsoft extension to the COFF standard. </p> </entry> |
|
38 </row> |
|
39 <row> |
|
40 <entry><p> <codeph> -compress</codeph> </p> </entry> |
|
41 <entry><p>Compresses executable files where possible using the inflate |
|
42 (Deflate, Huffman+LZ77) algorithm unless the <codeph>-compressionmethod</codeph> keyword is used to override the default (see below). </p> </entry> |
|
43 </row> |
|
44 <row> |
|
45 <entry><p> <codeph>-compressionmethod [none | inflate | bytepair]</codeph> </p> </entry> |
|
46 <entry><p>Specifies the compression algorithm to use. Can be used |
|
47 either with the <codeph>-compress</codeph> keyword or alone. </p> <p><table id="GUID-34E5FD4C-7B82-5342-85C3-C84A706C8C17-GENID-1-2-1-8-1-1-6-1-1-5-1-2-3-7-1-3-5-2-2-1"> |
|
48 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
49 <tbody> |
|
50 <row> |
|
51 <entry><p> <codeph>none </codeph> </p> </entry> |
|
52 <entry><p>No compression is used. </p> </entry> |
|
53 </row> |
|
54 <row> |
|
55 <entry><p> <codeph>inflate </codeph> </p> </entry> |
|
56 <entry><p>Compresses executable files using the default (Deflate, |
|
57 Huffman+LZ77) algorithm. </p> </entry> |
|
58 </row> |
|
59 <row> |
|
60 <entry><p> <codeph>bytepair </codeph> </p> </entry> |
|
61 <entry><p>Compresses executable files using the bytepair algorithm. |
|
62 Bytepair compression allows faster decompression than the default |
|
63 Deflate, Huffman+LZ77 algorithm and supports demand paging by performing |
|
64 compression and decompression of code in independent 4 KB pages. </p> </entry> |
|
65 </row> |
|
66 </tbody> |
|
67 </tgroup> |
|
68 </table> </p> </entry> |
|
69 </row> |
|
70 <row> |
|
71 <entry><p> <codeph>coreimage=<core ROM image file></codeph> </p> </entry> |
|
72 <entry><p>Uses the specified core image file as the basis for creating |
|
73 the ROM image extension. </p> <p>If the given core ROM image file |
|
74 is invalid or does not exist, an error message is displayed. </p> </entry> |
|
75 </row> |
|
76 <row> |
|
77 <entry><p> <codeph>-d<bitmask> </codeph> </p> </entry> |
|
78 <entry><p>Sets the trace bitmask; this only applies to debug builds. </p> <p>The simplest way of specifying this is to use a string of hexadecimal |
|
79 characters starting with 0x (for example, 0x01234567). However, any |
|
80 string that can be interpreted and translated into a valid TUint value |
|
81 may be used. See the standard C function <codeph>strtoul()</codeph>. </p> </entry> |
|
82 </row> |
|
83 <row> |
|
84 <entry><p> <codeph>-lowmem</codeph> </p> </entry> |
|
85 <entry><p>Reduces the physical memory consumption during image generation. </p> </entry> |
|
86 </row> |
|
87 <row> |
|
88 <entry><p> <codeph>-loglevel<level></codeph> </p> </entry> |
|
89 <entry><p>Level of information to log file. The following valid log |
|
90 levels are available: </p> <p><table id="GUID-6D12A1F6-70D6-5CAC-891F-CC0E98D21E70"> |
|
91 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
92 <tbody> |
|
93 <row> |
|
94 <entry><p> <codeph>0</codeph> </p> </entry> |
|
95 <entry><p>Default level of information to log file. </p> </entry> |
|
96 </row> |
|
97 <row> |
|
98 <entry><p> <codeph>1</codeph> </p> </entry> |
|
99 <entry><p>Logs the host or the ROM filenames, the file size, and the |
|
100 hidden attribute in addition to the <codeph>loglevel 0</codeph> information. </p> </entry> |
|
101 </row> |
|
102 <row> |
|
103 <entry><p> <codeph> 2</codeph> </p> </entry> |
|
104 <entry><p>Logs the E32 file header attributes such as UIDs, data size, |
|
105 heap size, stack size, VID, SID, and priority in addition to the <codeph>loglevel 1</codeph> information. </p> </entry> |
|
106 </row> |
|
107 </tbody> |
|
108 </tgroup> |
|
109 </table> </p> </entry> |
|
110 </row> |
|
111 <row> |
|
112 <entry><p> <codeph>-no-header </codeph> </p> </entry> |
|
113 <entry><p>Suppresses the image loader header. </p> </entry> |
|
114 </row> |
|
115 <row> |
|
116 <entry><p> <codeph>-no-sorted-romfs </codeph> </p> </entry> |
|
117 <entry><p>Does not add sorted entry arrays (6.1 compatible). It is |
|
118 a table of offsets for the subdirectories and files which are not |
|
119 in the sorted order. </p> </entry> |
|
120 </row> |
|
121 <row> |
|
122 <entry><p> <codeph>-r<fileName></codeph> </p> </entry> |
|
123 <entry><p>Compares the generated ROM image with the ROM image whose |
|
124 file name is specified. </p> </entry> |
|
125 </row> |
|
126 <row> |
|
127 <entry><p> <codeph>-s[log|screen|both] </codeph> </p> </entry> |
|
128 <entry><p>Displays a summary of the size to the specified destination, |
|
129 that is, to the log, to the screen or to both the log and the screen. </p> </entry> |
|
130 </row> |
|
131 <row> |
|
132 <entry><p> <codeph>-v </codeph> </p> </entry> |
|
133 <entry><p>Verbose mode. </p> </entry> |
|
134 </row> |
|
135 <row> |
|
136 <entry><p> <codeph>-wstdpath</codeph> </p> </entry> |
|
137 <entry><p>Displays a warning if a file is placed in a non-standard |
|
138 directory when <codeph>PlatSecEnforceSysBin</codeph> is set to <codeph>OFF</codeph>. </p><p> For example, the following instruction in |
|
139 OBY file leads to a warning when <codeph>-wstdpath</codeph> is used |
|
140 and <codeph>PlatSecEnforceSysBin</codeph> is <codeph>OFF</codeph>:</p><p><codeph>File=ABI_DIR/BUILD_DIR/hello.exe myfolder/bin/hello.exe</codeph></p> </entry> |
|
141 </row> |
|
142 <row> |
|
143 <entry><p> <codeph>-j<NUM_OF_WORKING_THREADS></codeph></p> </entry> |
|
144 <entry><p>Specifies the number of working threads that can run concurrently |
|
145 to create a ROM image. The <codeph><NUM_OF_WORKING_THREADS></codeph> must be an integer in the range 1-128. </p> <p>If the <codeph>-j</codeph> option is not specified or an invalid value is specified, ROMBUILD |
|
146 uses the following ways to determine the number of working threads: </p> <ul> |
|
147 <li id="GUID-7B81919D-9F6A-5945-A311-EFDE7B0985F5"><p>If the <codeph>NUMBER_OF_PROCESSORS</codeph> environment variable is set correctly, |
|
148 ROMBUILD uses the number of processors as the number of working threads. </p> </li> |
|
149 <li id="GUID-6C697962-2AE9-5AEC-950F-304ABE720501"><p>If the <codeph>NUMBER_OF_PROCESSORS</codeph> environment variable is not set or |
|
150 is invalid, the default value <codeph>8</codeph> is used as the number |
|
151 of working threads. </p> </li> |
|
152 </ul> </entry> |
|
153 </row> |
|
154 <row> |
|
155 <entry><p><codeph>-gendep</codeph></p></entry> |
|
156 <entry><p>Generates a dependencies file describing internal dependencies |
|
157 among executables or dlls in a ROM image.</p><p><b>Note</b>: You can |
|
158 only generate dependence information in the paged section of a ROM |
|
159 image.</p></entry> |
|
160 </row> |
|
161 <row> |
|
162 <entry><p><codeph>-symbols</codeph></p></entry> |
|
163 <entry><p>Generates symbols for each data or executable specified |
|
164 in the OBY file. </p><p><b>Note</b>: The symbols file is not generated |
|
165 by default.</p></entry> |
|
166 </row> |
|
167 </tbody> |
|
168 </tgroup> |
|
169 </table> <p> <codeph><obeyfile></codeph> is a standard text file |
|
170 containing statements that are used to control the operation of the |
|
171 tool. </p> <p>See the <xref href="GUID-9CF985F1-C100-5999-9410-58B7865A1E18.dita">OBEY files</xref> reference for the full syntax. </p> </section> |
|
172 </conbody></concept> |