# Document Conventions

The following typographical conventions are used in this documentation:

monospace font

Assembly code, macros, functions, registers, defines and addresses.

italics

File and path names, or any portion of them.

<angle brackets and bold>

Optional parameters and placeholders for specific information. To use an optional parameter or replace a placeholder, specify the information within the brackets; do not include the brackets themselves.

Bold

GUI items (text that can be seen on a screen).

Note, Important, Caution, Warning

Information requiring special notice is presented in several attention-grabbing formats depending on the consequences of ignoring the information:

NOTE: Significant supplemental information, hints, or tips.

IMPORTANT: Information that is more significant than a Note; intended to help you avoid frustration.

CAUTION: Information that can prevent you from damaging equipment or software.

WARNING: Information that can prevent harm to humans.

Registers:

Registers are shown in monospace font using their full descriptors, depending on which core the register is accessing. The full description takes the form <PREFIX><GROUP>_<REGISTER>.

All registers are accessible from the Arm Cortex-M33 processor.

A register prefix of D_ is used in the following circumstances:

| • | In cases where there are multiple instances of a block of registers, the summary of the registers at the beginning of the Register section have slightly different names from the detailed register sections below that table. For example, the DMA*_CFG0 registers are referred to as DMA_CFG0 when we are defining bit-fields and settings.

The firmware provides access to these registers in two ways:

| • | In the flat header files (e.g.: sk5_hw_flat_cid*.h), each register is individually accessible by directly using the naming provided in this manual. This is helpful for assembly and low-level C programming.

| • | In the normal header files (e.g.: sk5_hw_cid*.h), each register group forms a structure, with the registers being defined as members within that structure. The structures defined by these header files provide access to registers under the naming conventions PREFIX_GROUP->REGISTER (for the structure) and GROUP->REGISTER (for the register).

| • | For more information, see the Hardware Definitions chapter of the RSL15 Firmware Reference.

Default settings for registers and bit fields are marked with an asterisk (*).

Any undefined bits must be written to 0, if they are written at all.

Numbers

In general, numbers are presented in decimal notation. In cases where hexadecimal or binary notation is more convenient, these numbers are identified by the prefixes "0x" and "0b" respectively. For example, the decimal number 123456 can also be represented as 0x1E240 or 0b11110001001000000.

Sample Rates

All sample rates specified are the final decimated sample rates, unless stated otherwise.