Broadcom
®
January 29, 2016 • 5718-PG108-R
Page 44
BCM5718 Programmer’s Guide
About This Document
Purpose and Audience
This document covers the Broadcom
®
BCM5718 family of NetXtreme
®
/NetLink
®
Ethernet controllers. This
family of controllers includes the following devices:
• BCM5717
• BCM5718
• BCM5719
• BCM5720
The document focuses on the registers, control blocks, and software interfaces necessary for host software
programming. It is intended to complement the data sheet for the appropriate member of the NetXtreme/NetLink
Ethernet controller family. The errata documentation (see
) complements this
document.
Acronyms and Abbreviations
In most cases, acronyms and abbreviations are defined on first use.
For a comprehensive list of acronyms and other terms used in Broadcom documents, go to:
http://www.broadcom.com/press/glossary.php
.
Document Conventions
The following conventions may be used in this document:
Convention
Description
Bold
User input and actions: for example, type
exit
, click
OK,
press
Alt+C
Monospace
Code:
#include <iostream>
HTML:
<td rowspan = 3>
Command line commands and parameters:
wl [-l] <command>
< >
Placeholders for
required
elements: enter your <username> or
wl <command>
[ ]
Indicates
optional
command-line parameters:
wl [-l]
Indicates bit and byte ranges (inclusive): [0:3] or [7:0]
Table 1: Register Access Methods
Convention
Description
A/C
Clear contents after read
RO
Read-Only access, Write has no effect
RW
Full Read and Write access
WO
Write-Only access, Read returns garbage