Style And Symbol Conventions - Microchip Technology dsPIC33E/PIC24E Series Reference Manual

1.4

STYLE AND SYMBOL CONVENTIONS

Throughout this document, certain style and font format conventions are used. Most format
conventions imply that a distinction should be made for the emphasized text.
Table 1-1
Table 1-1:
Symbol or Term
set
clear
Reset
0xnn or nnh
B'bbbbbbbb'
R-M-W
: (colon)
< >
MSb, LSb
MSB, LSB
msw, lsw
Courier New
Font
Times New Roman
Font (Italics)
Note
© 2011 Microchip Technology Inc.
defines some of the symbols and terms used throughout this manual.
Document Conventions
To force a bit/register to a value of logic '1'.
To force a bit/register to a value of logic '0'.
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 set to '0' (such as interrupt enable bits), while
others will be set to '1' (such as the I/O data direction bits).
Designates the number 'nn' in the hexadecimal number system. These
conventions are used in the code examples. For example, the
designation 0x13F or 13Fh may be used.
Designates the number 'bbbbbbbb' in the binary number system. This
convention is used in the text and in figures and tables. For example, the
designation B'10100000' may be used.
Read-Modify-Write. This occurs when a register or port is read, the value
is modified, and that value is then written back to the register or port. This
action can occur from a single instruction (such as bit set, BSET) or a
sequence of instructions.
Used to specify a range or the concatenation of registers/bits/pins.
One example is TMR3:TMR2, which is the concatenation of two 16-bit
registers to form a 32-bit timer value.
Concatenation order (left-right) usually specifies a positional relationship
(MSb to LSb, higher to lower).
Specifies bit(s) locations in a particular register. One example is SRxMPT
(SPIxSTAT<5>), which specifies the abbreviation of bit and the register
name, and associated bits or bit positions.
Indicates the Least/Most Significant bit in a field.
Indicates the Least/Most Significant Byte in a field of bits.
Indicates the least/most significant word in a field of bits.
Used for code examples, binary numbers and for instruction mnemonics
that appear in the text.
Used for equations.
A Note presents information that we want to re-emphasize, either to help
you avoid a common pitfall or to make you 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.
Section 1. Introduction
Description
DS70573B-page 1-5
1