1 |
22 |
wfjm |
.\" -*- nroff -*-
|
2 |
|
|
.\" $Id: config_wrapper.1 550 2014-02-03 08:16:57Z mueller $
|
3 |
|
|
.\"
|
4 |
|
|
.\" Copyright 2013- by Walter F.J. Mueller
|
5 |
|
|
.\"
|
6 |
|
|
.\" ------------------------------------------------------------------
|
7 |
|
|
.
|
8 |
|
|
.TH CONFIG_WRAPPER 1 2013-01-02 "Retro Project" "Retro Project Manual"
|
9 |
|
|
.\" ------------------------------------------------------------------
|
10 |
|
|
.SH NAME
|
11 |
|
|
config_wrapper \- configure FPGA via ISE impact or Linux jtag
|
12 |
|
|
.\" ------------------------------------------------------------------
|
13 |
|
|
.SH SYNOPSIS
|
14 |
|
|
.
|
15 |
|
|
.SY config_wrapper
|
16 |
|
|
.OP \-\-board=\fIb\fP
|
17 |
|
|
.OP \-\-path=\fIp\fP
|
18 |
|
|
.I COMMAND
|
19 |
|
|
.I FILE
|
20 |
|
|
.
|
21 |
|
|
.SY config_wrapper
|
22 |
|
|
.B \-\-help
|
23 |
|
|
.YS
|
24 |
|
|
.
|
25 |
|
|
.\" ------------------------------------------------------------------
|
26 |
|
|
.SH DESCRIPTION
|
27 |
|
|
Wrapper script to handle the configuration of an FPGA board with either
|
28 |
|
|
a XILINX JTAG programming cable and the ISE \fBimpact\fP program or with
|
29 |
|
|
an onboard Cypress FX2 USB controller and the \fBjtag\fP(1) program.
|
30 |
|
|
The \fICOMMAND\fP argument controls the action:
|
31 |
|
|
|
32 |
|
|
.RS 3
|
33 |
|
|
.PD 0
|
34 |
|
|
.IP \fBiconfigf\fP 10
|
35 |
|
|
configure using \fBimpact\fP with \fI.bit\fP file \fIFILE\fP
|
36 |
|
|
.IP \fBjconfigf\fP
|
37 |
|
|
configure using \fBjtag\fP(1) with \fI.svf\fP file \fIFILE\fP
|
38 |
|
|
.IP \fBbit2svf\fP
|
39 |
|
|
create a \fI.svf\fP file from the \fI.bit\fP file \fIFILE\fP
|
40 |
|
|
.PD
|
41 |
|
|
.
|
42 |
|
|
.\" ------------------------------------------------------------------
|
43 |
|
|
.SH OPTIONS
|
44 |
|
|
.
|
45 |
|
|
.\" ----------------------------------------------
|
46 |
|
|
.IP \fB\-\-board=\fIb\fR
|
47 |
|
|
determines the type of board to be configured. The default is 's3board',
|
48 |
|
|
currently supported boards are:
|
49 |
|
|
.RS
|
50 |
|
|
.RS 3
|
51 |
|
|
.PD 0
|
52 |
|
|
.IP \fBs3board\fP 10
|
53 |
|
|
Digilent S3BOARD. Default path: xc3s1000
|
54 |
|
|
.IP \fBnexys2\fP
|
55 |
|
|
Digilent Nexys2. Default path: xc3s1200e
|
56 |
|
|
.IP \fBnexys3\fP
|
57 |
|
|
Digilent Nexys3. Default path: xc6slx16
|
58 |
|
|
.IP \fBatlys\fP
|
59 |
|
|
Digilent Atlys. Default path: xc6slx45
|
60 |
|
|
.IP \fBsp605\fP
|
61 |
|
|
Xilinx SP605. Default path: xc6slx45t
|
62 |
|
|
.RE
|
63 |
|
|
.RE
|
64 |
|
|
.PD
|
65 |
|
|
.
|
66 |
|
|
.\" ----------------------------------------------
|
67 |
|
|
.IP \fB\-\-path=\fIp\fR
|
68 |
|
|
determines the type of FPGA to be configured. It usually properly defaulted
|
69 |
|
|
based on the \fB\-\-board\fP option. Only in cases were a board is available
|
70 |
|
|
with several die sizes this option will be needed.
|
71 |
|
|
.
|
72 |
|
|
.\" ----------------------------------------------
|
73 |
|
|
.IP \fB\-\-help\fP
|
74 |
|
|
print help text and exit.
|
75 |
|
|
.
|
76 |
|
|
.\" ------------------------------------------------------------------
|
77 |
|
|
.SH COMMANDS
|
78 |
|
|
.
|
79 |
|
|
.\" ----------------------------------------------
|
80 |
|
|
.IP \fBbit2svf\fP
|
81 |
|
|
Convert a FPGA configuration file from \fI.bit\fP format (the native XILINX
|
82 |
|
|
format) to \fI.svf\fP format (the portable Serial Vector Format). The
|
83 |
|
|
XILINX ISE \fBimpact\fP program is used, the input \fIFILE\fP must be in
|
84 |
|
|
\fI.bit\fP format.
|
85 |
|
|
.
|
86 |
|
|
.\" ----------------------------------------------
|
87 |
|
|
.IP \fBiconfig\fP
|
88 |
|
|
Configure a FPGA with XILINX ISE \fBimpact\fP. The input \fIFILE\fP must be in
|
89 |
|
|
\fI.bit\fP format.
|
90 |
|
|
.
|
91 |
|
|
.\" ----------------------------------------------
|
92 |
|
|
.IP \fBjconfig\fP
|
93 |
|
|
Configure a FPGA with \fBjtag\fP(1). The input \fIFILE\fP must be in
|
94 |
|
|
\fI.svf\fP format. This sub command is usually used for boards with a
|
95 |
|
|
Cypress FX2 USB controller, like the Digilent Nexys2, Nexys3 or Atlys,
|
96 |
|
|
and a FX2 firmware which emulates an Altera USB-Blaster programming cable.
|
97 |
|
|
|
98 |
|
|
The USB device path is defined by the environment variables RETRO_FX2_VID
|
99 |
|
|
and RETRO_FX2_PID, or defaults to vid=16c0 and pid=03ef.
|
100 |
|
|
|
101 |
|
|
Use the \fBfx2load_wrapper\fP(1) command to ensure that the proper firmware
|
102 |
|
|
is loaded in the Cypress FX2 USB controller.
|
103 |
|
|
The \fBbit2svf\fP sub command can be used to create a \fI.svf\fP from
|
104 |
|
|
a \fI.bit\fP file.
|
105 |
|
|
.
|
106 |
|
|
.\" ------------------------------------------------------------------
|
107 |
|
|
.SH EXIT STATUS
|
108 |
|
|
In case of an error an exit status 1 is returned.
|
109 |
|
|
.
|
110 |
|
|
.\" ------------------------------------------------------------------
|
111 |
|
|
.SH ENVIRONMENT
|
112 |
|
|
.IP "\fBRETRO_FX2_VID, RETRO_FX2_PID\fR" 4
|
113 |
|
|
Used by the \fBjconfig\fP sub command to define the USB path of the
|
114 |
|
|
Cypress FX2 USB controller emulating an Altera USB-Blaster cable.
|
115 |
|
|
.IP \fBXILINX\fR
|
116 |
|
|
Path to current XILINX ISE installation. Required by all sub commands,
|
117 |
|
|
mainly to locate the \fI.bsdl\fP files which describe the JTAG commands
|
118 |
|
|
of all devices in the JTAG chain.
|
119 |
|
|
.
|
120 |
|
|
.\" ------------------------------------------------------------------
|
121 |
|
|
.SH EXAMPLES
|
122 |
|
|
.IP "\fBconfig_wrapper bit2svf test.bit\fR" 4
|
123 |
|
|
Creates \fItest.svf\fP from \fItest.bit\fP.
|
124 |
|
|
.
|
125 |
|
|
.IP "\fBconfig_wrapper --board=nexys2 iconfig test.bit\fR"
|
126 |
|
|
Configures a Nexys2 board with \fItest.bit\fP using ISE \fBimpact\fP.
|
127 |
|
|
.
|
128 |
|
|
.IP "\fBconfig_wrapper --board=nexys3 jconfig test.svf\fR"
|
129 |
|
|
Configures a Nexys3 board with \fItest.svf\fP using \fBjtag\fP(1).
|
130 |
|
|
.
|
131 |
|
|
.\" ------------------------------------------------------------------
|
132 |
|
|
.SH "SEE ALSO"
|
133 |
|
|
.BR jtag (1),
|
134 |
|
|
.BR fx2load_wrapper (1)
|
135 |
|
|
|
136 |
|
|
.\" ------------------------------------------------------------------
|
137 |
|
|
.SH AUTHOR
|
138 |
|
|
Walter F.J. Mueller
|