diff -r 578be2adaf3e -r 307f4279f433 Adaptation/GUID-B9698943-0D4E-5B18-B7E4-448A0E21876A.dita
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Adaptation/GUID-B9698943-0D4E-5B18-B7E4-448A0E21876A.dita Fri Oct 15 14:32:18 2010 +0100
@@ -0,0 +1,238 @@
+
+
+
+
+
+ This page lists the keywords starting from A to C. BUILDROM only Performs textual substitution.
+All subsequent instances of the two characters ## are replaced with
+an empty string. Note that there is no UNDEFINE facility and
+substitutions are applied in an unspecified order. BUILDROM only Allows The use of this keyword is not appropriate
+for production devices, but is useful in the development environment
+as it increases the chances of producing a ROM in the presence of
+build problems. For example, This substitutes \ARMI\ for \THUMB\ if a specified source file
+cannot be found. Another example is in localisation support.
+Problem suppression allows rombuild and rofsbuild Creates an additional
+filesystem entry, which refers to an existing file. rombuild only Specifies the alignment boundary
+for the file that follows immediately after the rombuild only Defines the area in which the
+executable will be relocated. The specified name must have been previously
+defined in the rombuild only Defines a new relocation area.
+The area is identified by the specified name. Executable files placed
+in this area will be relocated so that they run in the address range The Bootstrap is required
+to copy the relevant subset of ROM to the run address at Boot time.
+The main purpose of this is to relocate time-critical executables
+to internal or tightly-coupled RAM. rombuild only Indicates that this is not a Unicode
+build. rombuild and rofsbuild Files may have the System,
+Hidden, read-only and writable attributes. File attributes
+are copied from the source file and are then overridden by the attributes
+specified by this keyword. Specifying As this is a ROM, the file cannot be physically modified even
+if the read-only attribute is cleared, but it is useful to mark files
+as writeable so that copies are made writeable, for example on a CF
+card or a RAM file system. Using the BUILDROM only Either selects a compressed MBM
+file if generating an XIP ROM image, or the original source file if
+generating a non-XIP ROM image This statement translates to rofsbuild only Reduces the size to a whole number
+of blocks where <block size> defines the granularity. For
+example if This causes the tools to check the given locations for files
+in the specified order: causes BUILDROM only Generates an uncompressed Symbian platform XIP ROM format MBM file from the <source> MBM
+file and copies it into the ROM at <dest>. rombuild only The file name of the ROM's bootstrap
+code, which on ARM CPUs appears at physical address 0x00000000 when
+the machine is booted. rombuild only A keyword for configuring the
+behaviour of the Symbian platform mechanism for generating and capturing
+trace information ( Each trace
+has a category which is an 8-bit value. The kernel implements a filter
+that enables traces in each category to be either discarded (disabled)
+or passed to the trace handler (enabled). This keyword sets the initial
+state of that filter, i.e. to indicate whether a trace category is
+enabled or disabled. A trace category is one of the The BTrace keyword
+takes up to eight 32-bit integers, representing a set of 256 bits.
+Each bit in the set is associated with a single category: If a bit
+is set it means that the corresponding category is enabled - if a
+bit is not set it means that the corresponding category is disabled. The rule for mapping the bits in these eight integers to the For example to turn on the trace category which turns on bit position 9 (counting from zero and starting
+at the right hand side of the integer). Note that there is no need
+to specify the remaining 7 integers if they all have zero values,
+as zero is assumed by default. See also rombuild only A keyword for configuring the
+behaviour of the Symbian platform trace handler. Use this
+keyword to set the initial size for any memory buffer used to store
+trace data. See also rombuild only A keyword for configuring the
+behaviour of the Symbian platform trace handler. Use this
+keyword to set the initial mode of the trace handler. This BTRaceBuffer
+keyword takes a single integer that specifies the mode. For the default
+trace handler supplied with Symbian platform, this will be one of
+the See also rombuild
+only This keyword overrides platform security capabilities
+of the executable specified in the OBY file. For information on the
+use of capabilities and current capability set, see This keyword
+specifies the cluster size for a FAT image generated by the ROM tools.
+The keyword must be specified in the The value of the cluster
+size must meet the following conditions: The cluster size must be between 512 bytes and 32KB (sector
+size). For a FAT16 image, the cluster size must be in the range 4101–
+65508 bytes. For a FAT32 image, the cluster size must be greater than 65541
+bytes. The cluster size must belong to the geometric progression series,
+512, 1024, 2048, 4096, and so on. A geometric progression series is
+a sequence of numbers where each term after the first is found by
+multiplying the previous one by a fixed number called common ratio.
+In this series, the first number of the series is 512 and the common
+ratio is 2.
+
+
rombuild only
This keyword specifies the alignment +for the executable's code. It indicates the start address of a code +segment that must be aligned to a specified value. If the original +address of the code segment does not match the alignment, the whole +executable file is relocated to meet alignment. After the image is +loaded in RAM a block of memory is unused.
The code alignment +is an optimisation depending on the hardware the ROM is being built +for. Setting the code align can allow the ROM to be built in such +a way that it reduces the work for the CPU when loading the code that +is, it can be loaded in one pass. This improves the performance. If +it is unaligned it can take multiple passes.
For example:
Define an
Build ROM with
+the above
The log file +is:
In the log file, we can find that the code start address
+of
It is unique for
Note: If an
rombuild only
Indicates that a COFF ROM wrapper +is required.
rombuild only
This is only supported when the +<cpu> is ARM and the <compiler> is GCC.
The <mode> +can take one of the following values:
rombuild only
Compresses the resulting ROM image +using the Deflate, Huffman+LZ77 algorithm.
BUILDROM only
Generates a compressed Symbian +platform XIP ROM format MBM file from the <source> MBM file and +copies it into the ROM at <dest>.
rofsbuild only
This tells rofsbuild that the +generation of the core image is not required and that the specified +core image should be used to as the base for generating the extension +image.
rombuild and rofsbuild
This keyword sets the +page attributes of executables at a global level. It is applicable +to all executables in ROM or ROFS partitions. It takes a single argument, +which can be one of the following:
For example, the following entry in the Obey file marks +all the executables as unpaged:
rombuild and rofsbuild
This sets a flag in
+the ROM when it is built, and the loader in the kernel decides a policy
+for executables that are in default state (neither marked as paged
+nor as unpaged). This keyword takes a single argument, which can be
+one of the possible values listed in
For example, the following +entry in the Obey file instructs the loader not to page the executables +in default state: