Conventions; Port And Attribute Names; Typographical - Xilinx RocketIO User Manual

Conventions

Conventions
This document uses the following conventions. An example illustrates each typographical and
online convention.

Port and Attribute Names

Input and output ports of the RocketIO transceiver primitives are denoted in upper-case letters.
Attributes of the RocketIO transceiver are denoted in upper-case letters with underscores. Trailing
numbers in primitive names denote the byte width of the data path. These values are preset and not
modifiable. When assumed to be the same frequency, RXUSRCLK and TXUSRCLK are referred to
as USRCLK and can be used interchangeably. This also holds true for RXUSRCLK2,
TXUSRCLK2, and USRCLK2.
Comma Definition
A comma is a "K-character" used by the transceiver to align the serial data on a byte/half-word
boundary (depending on the protocol used), so that the serial data is correctly decoded into parallel
data.

Typographical

The following typographical conventions are used in this document:
RocketIO™ Transceiver User Guide
UG024 (v2.3.2) June 24, 2004
Convention
Messages, prompts, and program
Courier font
files that the system displays
Literal commands that you enter
Courier bold
in a syntactical statement
Commands that you select from a
menu
Helvetica bold
Keyboard shortcuts
Variables in a syntax statement
for which you must supply values
References to other manuals
Italic font
Emphasis in text
An optional entry or parameter.
However, in bus specifications,
Square brackets [ ]
such as bus[7:0], they are
required.
A list of items from which you
Braces { }
must choose one or more
Vertical bar | Separates items in a list of choices lowpwr ={on|off}
www.xilinx.com
1-800-255-7778
Meaning or Use Example
speed grade: - 100
ngdbuild design_name
File → Open
Ctrl+C
ngdbuild design_name
See the Development System
Reference Guide for more
information.
If a wire is drawn so that it
overlaps the pin of a symbol, the
two nets are not connected.
ngdbuild [option_name]
design_name
lowpwr ={on|off}
R
19