Notational Conventions; Registers And Bits; Functional Overview; Operational Characteristics - Broadcom BCM5722 Programmer's Manual

Programmer's Guide
10/15/07
• BCM5756M
N C
OTATIONAL
R B
EGISTERS AND ITS
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.
F O
UNCTIONAL VERVIEW
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.
O C
PERATIONAL HARACTERISTICS
This section describes how software programs or interfaces with a hardware block.
E C
XAMPLE ODE
This document uses both C-language coding and C-style pseudocode which is described in
informal syntax intended to explain complex algorithms. The methods used to program the BCM5722 Ethernet controllers
and companion silicon may be defined using pseudocode.
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.
Definition
Register and bit field
Variable
Pointer
Constant
<Conditional>
Document 5722-PG101-R
ONVENTIONS

Table 1: Pseudocode

Notation
register.bit
variable
variablePtr
CONSTANT_DEFINITION
If <Expression> Then
<Block>
Else
<Block>
Bro adco m Co rp or atio n
Table 1 is not meant to restrict algorithmic representations, but
Notes
Bold
Italics
Italics + Ptr
Capitalization
BCM5722
Table 1. Pseudocode is an

Notational Conventions

Page 2