Style and Symbol Conventions

Throughout this document, certain style and font format conventions are used. Table provides a description of the conventions used in this document.

Table . Document Conventions
Symbol or TermDescription
setTo force a bit/register to a value of logic ‘1’.
clearTo force a bit/register to a value of logic ‘0’.
Reset
  1. To force a register/bit to its default state.
  2. A condition in which the device places itself after a device reset occurs. Some bits will be forced to ‘0’ (such as Interrupt Enable bits), while others will be forced to ‘1’ (such as the I/O Data Direction bits).
0xnnnnDesignates the number ‘nnnn’ in the hexadecimal number system. These conventions are used in the code examples. For example, 0x013F or 0xA800.
: (colon)Used to specify a range or the concatenation of registers/bits/pins.

One example is ACCAU:ACCAH:ACCAL, which is the concatenation of three registers to form the 72-bit Accumulator.
Concatenation order (left-right) usually specifies a positional relationship (MSb to LSb, higher to lower).

[ ]Specifies bit locations in a particular register. 
One example is SR[7:5] (or IPL[2:0]), which specifies the register and associated bits or bit locations.
LSb, MSbIndicates the Least Significant or Most Significant bit in a field.
LSB, MSBIndicates the Least/Most Significant Byte in a field of bits.
lsw, mswIndicates the least/most significant word in a field of bits
Courier New FontUsed for code examples, binary numbers and for instruction mnemonics in the text.
Times New Roman Font, ItalicUsed for equations and variables.
Times New Roman Font, Bold ItalicUsed in explanatory text for items called out from a figure, equation or example.
Note:A Note presents information that we want to re-emphasize, either to help the user avoid a common pitfall or to make the user aware of operating differences between some device family members. A note can be in a box, or when used in a table or figure, it is located at the bottom of the table or figure.