Broadcom BCM5722 - Example Code; Functional Overview; Notational Conventions; Operational Characteristics

Programmer’s Guide BCM5722
10/15/07
Broadcom Corporation
Document 5722-PG101-R Notational Conventions Page 2
• BCM5756M
NOTATIONAL CONVENTIONS
REGISTERS AND BITS
Register and bit names are concatenated with underscores:
• Mac_Mode (register)
• Enable_TDE (bit)
Periods separate a register and bit pair:
• Register.Bit
• Mac_Mode.Enable_TDE
This document generally avoids referencing bits by offset; the register definition section provides register and bit offsets.
FUNCTIONAL OVERVIEW
Functional descriptions provide high level overviews of the BCM5722 architectural blocks. The black box inputs/outputs from
block diagrams aid software developers with programming the device.
OPERATIONAL CHARACTERISTICS
This section describes how software programs or interfaces with a hardware block.
EXAMPLE CODE
This document uses both C-language coding and C-style pseudocode which is described in Table 1. Pseudocode is an
informal syntax intended to explain complex algorithms. The methods used to program the BCM5722 Ethernet controllers
and companion silicon may be defined using pseudocode. Table 1 is not meant to restrict algorithmic representations, but
help define a structure used throughout the document. This pseudocode is not a formal language and does not have a formal
grammar. When appropriate, pseudocode may deviate from these notations.
Table 1: Pseudocode
Definition Notation Notes
Register and bit field register.bit Bold
Variable variable Italics
Pointer variablePtr Italics + Ptr
Constant CONSTANT_DEFINITION Capitalization
<Conditional> If <Expression> Then
<Block>
Else
<Block>