© 2004 Microchip Technology Inc. DS70048C-page 1-5
Section 1. Introduction
Introduction
1
1.5.1 Document Conventions
Table 1-1 defines some of the symbols and terms used throughout this manual.
Table 1-1: Document Conventions
Symbol or Term Description
set To force a bit/register to a value of logic ‘1’.
clear To 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).
0xnn or nnh Designates the number ‘nn’ in the hexadecimal number system. These
conventions are used in the code examples. For example, 0x13F or
13Fh.
B‘bbbbbbbb’ Designates the number ‘bbbbbbbb’ in the binary number system. This
convention is used in the text and in figures and tables. For example,
B‘10100000’.
R-M-W Read-Modify-Write. This is when a register or port is read, then 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.
: (colon) 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 PTCON<PTMOD1:PTMOD0> (or PTMOD<1:0>), which
specifies the register and associated bits or bit positions.
MSb, MSbit, LSb,
LSbit
Indicates the Least Significant or Most Significant bit in a field.
MSByte, MSWord,
LSByte, LSWord
Indicates the Least/Most Significant Byte or Word in a field of bits.
Courier Font Used for code examples, binary numbers and for instruction mnemonics
in the text.
Times Font Used for equations and variables.
Times, Bold Font,
Italics
Used in explanatory text for items called out from a graphic/
equation/example.
Note A Note presents information that we wish to re-emphasize, either to help
you avoid a common pitfall, or make you aware of operating differences
between some device family members. A Note is always in a shaded box
(as below), unless used in a table, where it is at the bottom of the table
(as in this table).
Note: This is a Note in a shaded note box.
To Next Page
Loading...
