This document is organized into chapters that are based on the modules and peripherals available in the IC.
The document status reflects the level of maturity of the document.
Document name | Description |
---|---|
Objective Product Specification (OPS) |
Applies to document versions up to 1.0. This document contains target specifications for product development. |
Product Specification (PS) |
Applies to document versions 1.0 and higher. This document contains final product specifications. Nordic Semiconductor ASA reserves the right to make changes at any time without notice in order to improve design and supply the best possible product. |
Every peripheral has a unique capitalized name or an abbreviation of its name, e.g. TIMER, used for identification and reference. This name is used in chapter headings and references, and it will appear in the Arm® Cortex® Microcontroller Software Interface Standard (CMSIS) hardware abstraction layer to identify the peripheral.
The peripheral instance name, which is different from the peripheral name, is constructed using the peripheral name followed by a numbered postfix, starting with 0, for example, TIMER0. A postfix is normally only used if a peripheral can be instantiated more than once. The peripheral instance name is also used in the CMSIS to identify the peripheral instance.
The chapters describing peripherals may include the following information:
Individual registers are described using register tables. These tables are built up of two sections. The first three colored rows describe the position and size of the different fields in the register. The following rows describe the fields in more detail.
The Id (Field Id) row specifies the bits that belong to the different fields in the register. If a field has enumerated values, then every value will be identified with a unique value id in the Value Id column.
A blank space means that the field is reserved and read as undefined, and it also must be
written as 0
to secure forward compatibility. If a register is divided into more
than one field, a unique field name is specified for each field in the Field
column. The Value Id may be omitted in the single-bit bit fields when values
can be substituted with a Boolean type enumerator range, e.g. true/false, disable(d)/enable(d),
on/off, and so on.
Values are usually provided as decimal or hexadecimal. Hexadecimal values have a
0x
prefix, decimal values have no prefix.
The Value column can be populated in the following ways:
If two or more fields are closely related, the Value Id, Value, and Description may be omitted for all but the first field. Subsequent fields will indicate inheritance with '..'.
A feature marked Deprecated should not be used for new designs.
Different fields in a register might have different access permissions enforced by hardware.
The access permission for each register field is documented in the Access column in the following ways:
Access | Description | Hardware behavior |
---|---|---|
RO | Read-only | Field can only be read. A write will be ignored. |
WO | Write-only | Field can only be written. A read will return an undefined value. |
RW | Read-write | Field can be read and written multiple times. |
W1 | Write-once | Field can only be written once per reset. Any subsequent write will be ignored. A read will return an undefined value. |
RW1 | Read-write-once | Field can be read multiple times, but only written once per reset. Any subsequent write will be ignored. |
W1C | Write 1 to clear | Field can be read multiple times. Bits set to 1 clear (set to zero) the corresponding bit in the register. Bits set to 0 are ignored. |
W1S | Write 1 to set | Field can be read multiple times. Bits set to 0 clear (set to zero) the corresponding bit in the register. Bits set to 1 are ignored. |