BUILDROM

BUILDROM is the Symbian platform ROM configuration tool. It is +a unified ROM building front end to prepare the configurations. It +then invokes the ROMBUILD to generate the ROM image or ROFSBUILD to +generate the ROFS image.

BUILDROM +command syntax

If the OBY files are encoded in UTF-8 with +non-ASCII character support, use the following the BUILDROM command +syntax:

BUILDROM [options] <–oby-charset=utf-8 obyfile > [<obeyfile2> [obeyfile3 [...

If the OBY files are encoded in local character set +with non-ASCII character support, use the following the BUILDROM command +syntax:

BUILDROM [options] <obeyfile1> [<obeyfile2> [obeyfile3 [...

options can be one or more of the following:

+ + + +

–argfile=<parameter file>

Accepts a parameter file, which contains a list of command-line +parameters specific to the ROM tools, as input.

+ + +

-Dxxx

C++ preprocessor arguments. A common, but not exhaustive +set is:

+ + + +

-D_DEBUG

Selects debug versions of some files.

+ + +

-D_FULL_DEBUG

Selects debug versions of all files.

+ + +

-D_ARM4T

Specifies the target platform.

+ + +

-D_KABI=xxxx

Specifies the target platform for the kernel (for example, +ARMv5).

+ + +

-D_EABI=xxxx

Specifies the target for all files (for example, ARMv5).

+ + +

-DFEATUREVARIANT=xxxx

Specifies the name of feature-based variant (for example, +myvar).

BUILDROM automatically looks for the binary names +and properties of the selected variant, using the data generated by +build system.

+ + +

-D_NAND2

Specifies to generate the image for NAND flash.

+ + +

-D_ONENAND

Specifies to generate the image for ONENAND flash.

+ + + +

+ + +

-lowmem

Reduces the physical memory consumption during image generation.

+ + +

-loglevel<level>

Level of information to log file. The following valid log +levels are available:

+ + + +
0
+
Default level of information to log file.
+ + +
1
+
Logs the host or the ROM filenames, the file size, and the +hidden attribute in addition to the loglevel 0 information.
+ + +
2
+
Logs the E32 file header attributes such as UIDs, data size, +heap size, stack size, VID, SID, and priority in addition to the loglevel 1 information.
+ + + +

+ + +

-nospi

Instructs BUILDROM not to produce any static +plug-in information (.spi) files. See the __ECOM_PLUGIN keyword for details of these files. The default +is to produce .spi files.

+ + +

-noimage

Instructs BUILDROM to suppress only the +generation of any ROM or ROFS images, while allowing generation of +all other relevant files.

+ + +

-o<image name>

The name of the ROM image. This overrides any name specified +using the romname keyword in an Obey file.

+ + +

-s

The strict option. Specifying this means that any missing +files will stop BUILDROM without generating a ROM +image.

If this option is not specified, then it is possible +to generate a ROM image with missing files.

+ + +

-p

Preserves the intermediate files and folders (data drive +and Z drive) generated by BUILDROM.

+ + +

-e

Specifies the external tools that need to be invoked. These +are the names of the Perl modules (without the .pm extension). Multiple +modules names must be separated by commas. This is an optional parameter.

Alternatively, external tools can be invoked by using IBY file +keyword externaltool.

+ + +

-fm =<feature_manager_database_file >.xml

Parses the specified feature manager database XML files +and generates the features data file(s) (features.dat) in the present working directory. The number of features.dat files generated depends on the total number of ROM image partitions +specified in the OBEY file that is used to create the ROM image.

Notes

You can provide +multiple feature manager database XML files delimited by commas.
If a feature +manager option (-fm or -nofm) is +not passed to BUILDROM explicitly, the -fm option is used internally to generate a feature data file using +the default featuredatabase.xml file in \epoc32\rom\include. For more information, refer to Enabling feature +data file generation.

+ + +

-nofm =<Existing_features_data_file_name >.dat

Includes the specified features data file in the ROM image.

Note: This option is ignored by BUILDROM if used with the -fm option.

+ + +

-z=xxx or -zdrivepath=xxx

Specifies the location to create the Z drive directory.

By default, a Z drive directory is created in the location from +where BUILDROM was invoked.

+ + +

-d=xxx or -datadrivepath=xxx

Specifies the location to create data drive directory.

By default, the data drive directory is created in the location +from where BUILDROM was invoked.

+ + +

-k or -keepgoing

Enables BUILDROM to continue to create the data drive image +even if the SIS file(s), non-SIS file(s), or the Z drive image file(s) +are missing or corrupted.

+ + +

-zdriveimage="<image_1.img>,[...,<image_n.img>]" +

Specifies the Z drive image (ROM, ROFS, and CORE image).

+ + +

–r or -retainfolder

Instructs BUILDROM not to delete any pre-existing data drive +folder.

+ + +

-pfile=xxx

Specifies a parameter file for INTERPRETSIS to take additional +parameters.

+ + +

-l=<logfile.txt> or -logimageentry=<logfile.txt>

Logs all stub-sis and SWI certificate file(s) that are part +of the Z drive image onto a log file.

+ + +

-argforinterpretsis

Specifies the command-line argument for the InterpretSIS +tool. These command-line arguments take precedence over the arguments +in the parameter file.

+ + +

-i=<optional path>

Specifies an optional path in which the IBY files are stored. +This option is case-sensitive.

Notes:

If the IBY files +are found both in the default path (\epoc32\rom\include), and the <optional path>, BUILDROM uses the +IBY files in the <optional path>.
If the IBY files +are not found in the default path, BUILDROM uses +the IBY files in the <optional path>.

+ + +

-j<NUM_OF_WORKING_THREADS>

Specifies the number of working threads that can run concurrently +to create a ROM image. The <NUM_OF_WORKING_THREADS> must be an integer in the range 1-128.

If the -j option is not specified or an invalid value is specified, BUILDROM +automatically takes the number of working threads in the following +ways:

If the NUMBER_OF_PROCESSORS environment variable is set properly, +BUILDROM uses the number of processors as the number of working threads.
If the NUMBER_OF_PROCESSORS environment variable is not set or +is invalid, the default value 8 is used as the number +of working threads.

+ + +

-compress

Compresses the ROM image. It supports three types of compression:

-compress: Compresses the entire ROM image.
-compress=paged: Compresses the paged section +in the ROM image.
-compress=unpaged: Compresses the unpaged +section in the ROM image.

+ + +

—w

Warns if an incorrect input file is selected. For example, +a warning is displayed, if an incorrect binary file is selected when +binary variant is enabled.

+ + +

-nosymbols

Suppresses the generation of any ROM or ROFS symbol file. +This option generates all the relevant files except symbol files.

+ + +

-geninc

Generates an INC file of ROM image. The INC file contains +size information of the paged and the unpaged section within the ROM +image. The name of the output file is the same as that of the output +ROM image, with .inc as extension.

+ + +

-spi

Creates an SPI file.

+ + +

-spiplacement

Enables positioning of the SPI file.

+ + +

-compressionmethod [none | inflate | bytepair]

Specifies the compression algorithm to use. The following +options are available with the -compressionmethod keyword:

+ + + +
none
+
No compression is used.
+ + +
inflate
+
Compresses executable files using the default (Deflate, +Huffman+LZ77) algorithm.
+ + +
bytepair
+
Compresses executable files using the bytepair algorithm. +Bytepair compression allows faster decompression than the default +Deflate, Huffman+LZ77 algorithm. It also supports demand paging by +performing compression and decompression of code in independent 4 +KB pages.
+ + + +

+ + +

-cache

Enables cache mechanism. It ensures that BUILDROM uses cached +executable files while creating a ROFS image. This allows BUILDROM +to reuse or generate cached files.

Notes:

The cache mechanism +is disabled by default.
The cached files +are stored on the hard disk.
The cache command +line options (-cache, -nocache, +and -cleancache) are mutually exclusive. This means +that you can use only one cache option at a time.

+ + +

-nocache

Disallows BUILDROM from using cached files while creating +a ROFS image.

+ + +

-cleancache

Deletes all cached files from the hard disk.

+ + +

-gendep

Generates dependencies file describing a internal dependencies +among executables or dlls in a ROM image.

Note: You can +only generate dependence information in the paged section of a ROM +image.

+ + +

-checkcase

Checks the character case of the path or name in OBY or +IBY files. By default, this option is disabled.

Note: + This option is only valid on Windows.

+ + + +

-workdir <output-location>

Generates the output files at the specified location.

+ + + +

-prependepocroot

Prepends EPOCROOT to the file location, if the specified +location starts from \epoc32 without EPOCROOT.

+ + + +

Note: <obeyfile1> and <obeyfile2> and are standard text files containing statements +that are used to control the building of ROM images.

See the OBEY files reference for the full syntax.