1 |
23 |
wfjm |
.\" -*- nroff -*-
|
2 |
|
|
.\" $Id: ti_rri.1 558 2014-06-01 22:20:51Z mueller $
|
3 |
|
|
.\"
|
4 |
|
|
.\" Copyright 2013- by Walter F.J. Mueller
|
5 |
|
|
.\"
|
6 |
|
|
.\" ------------------------------------------------------------------
|
7 |
|
|
.
|
8 |
|
|
.TH TI_RRI 1 2013-05-20 "Retro Project" "Retro Project Manual"
|
9 |
|
|
.\" ------------------------------------------------------------------
|
10 |
|
|
.SH NAME
|
11 |
|
|
ti_rri \- \fBRlink\fP Backend Server
|
12 |
|
|
.\" ------------------------------------------------------------------
|
13 |
|
|
.SH SYNOPSIS
|
14 |
|
|
.
|
15 |
|
|
.SY ti_rri
|
16 |
|
|
.OP OPTIONS
|
17 |
|
|
.OP COMMANDS
|
18 |
|
|
.YS
|
19 |
|
|
.
|
20 |
|
|
.\" ------------------------------------------------------------------
|
21 |
|
|
.SH DESCRIPTION
|
22 |
|
|
The \fBti_rri\fP command creates a \fBtclsh\fP(1) based \fBRlink\fP backend
|
23 |
|
|
server session. After loading all basic packages and shared libraries which
|
24 |
|
|
implement the tcl binding of the \fBRlink\fP server the command
|
25 |
|
|
|
26 |
|
|
.RS 2
|
27 |
|
|
.PD 0
|
28 |
|
|
.IP "-" 2
|
29 |
|
|
creates the default \fIrlc\fP and \fIrls\fP commands representing the connection
|
30 |
|
|
and the server objects
|
31 |
|
|
.IP "-"
|
32 |
|
|
loads additional tcl packages when requested with \fB\-\-pack\fP
|
33 |
|
|
.IP "-"
|
34 |
|
|
sets up logging and debug according to \fB\-\-log\fP, \fB\-\-logl\fP,
|
35 |
|
|
\fB\-\-dmpl\fP, and \fB\-\-tiol\fP
|
36 |
|
|
.IP "-"
|
37 |
|
|
starts an additional process if requested with \fB\-\-run\fP
|
38 |
|
|
.IP "-"
|
39 |
|
|
opens a connection when requested with \fB\-\-fifo\fP,
|
40 |
|
|
\fB\-\-term\fP, or \fB\-\-cuff\fP
|
41 |
|
|
.IP "-"
|
42 |
|
|
and finally executes all remaining \fICOMMANDS\fP arguments as tcl commands
|
43 |
|
|
.PD
|
44 |
|
|
.RE
|
45 |
|
|
.PP
|
46 |
|
|
If no \fICOMMANDS\fP are present or if the \fB\-\-int\fP options is given
|
47 |
|
|
an interactive mode is entered with all features of \fBtclsh\fP(1) with
|
48 |
|
|
tclreadline loaded.
|
49 |
|
|
.
|
50 |
|
|
.\" ------------------------------------------------------------------
|
51 |
|
|
.SH OPTIONS
|
52 |
|
|
.\" ----------------------------------------------
|
53 |
|
|
.IP \fB\-\-pack=\fIplist\fR
|
54 |
|
|
load, with 'package require', additional packages. \fIplist\fP is a comma
|
55 |
|
|
separated list of package names. Note that the packages
|
56 |
|
|
.BR rutiltpp ,
|
57 |
|
|
.BR rlinktpp ,
|
58 |
|
|
and
|
59 |
|
|
.BR rlink
|
60 |
|
|
are automatically loaded already by \fBti_rri\fP.
|
61 |
|
|
.
|
62 |
|
|
.\" -- --run -------------------------------------
|
63 |
|
|
.IP \fB\-\-run=\fIcmd\fR
|
64 |
|
|
execute the shell command \fIcmd\fP as subprocess before the \fBrlink\fP
|
65 |
|
|
port is opened. This is mainly used to start \fBghdl\fP(1) based test
|
66 |
|
|
benches, usually via the \fBtbw\fP(1) wrapper script.
|
67 |
|
|
.
|
68 |
|
|
.\" -- --fifo ------------------------------------
|
69 |
|
|
.IP \fB\-\-fifo\fR[=\fIname\fR[,\fIopts\fR]]
|
70 |
|
|
open a fifo type \fBrlink\fP port. It uses a named pipe, and is usually
|
71 |
|
|
employed in conjunction with the \fB\-\-run\fP option.
|
72 |
|
|
Optional arguments are
|
73 |
|
|
.RS
|
74 |
|
|
.IP \fBname\fP
|
75 |
|
|
name prefix for the named pipe file names. Default is 'rlink_cext_fifo'.
|
76 |
|
|
Two fifo's are generated, one with a '_tx' and one with a '_tx' appended
|
77 |
|
|
to the name prefix.
|
78 |
|
|
.IP \fBopts\fP
|
79 |
|
|
comma separated list of further options for the fifo port:
|
80 |
|
|
.RS
|
81 |
|
|
.PD 0
|
82 |
|
|
.TP
|
83 |
|
|
.B keep
|
84 |
|
|
fifo is kept open on exit
|
85 |
|
|
.PD
|
86 |
|
|
.RE
|
87 |
|
|
.RE
|
88 |
|
|
.
|
89 |
|
|
.\" -- --term ------------------------------------
|
90 |
|
|
.IP \fB\-\-term\fR[=\fIname\fR[,\fIbaud\fR[,\fIopts\fR]]]
|
91 |
|
|
open a serial port type \fBrlink\fP port. Optional arguments are
|
92 |
|
|
.RS
|
93 |
|
|
.IP \fBname\fP
|
94 |
|
|
tty device name, default is 'USB0'. If \fIname\fP does not start with '/'
|
95 |
|
|
the name is prefixed with '/dev/tty'.
|
96 |
|
|
.IP \fBbaud\fP
|
97 |
|
|
serial port baud rate, default is '115k'. Allowed baud rate settings are:
|
98 |
|
|
.RS
|
99 |
|
|
.PD 0
|
100 |
|
|
.IP "" 3
|
101 |
|
|
2400, 4800, 9600, 19200, 19k, 38400, 38k,
|
102 |
|
|
57600, 57k, 115200, 115k, 230400, 230k,
|
103 |
|
|
460800, 460k, 500000, 500k, 921600, 921k,
|
104 |
|
|
1000000, 1000k, 1M, 1500000, 1500k,
|
105 |
|
|
2000000, 2000k, 2M, 2500000, 2500k,
|
106 |
|
|
3000000, 3000k, 3M, 4000000, 4000k, 4M
|
107 |
|
|
.PD
|
108 |
|
|
.RE
|
109 |
|
|
.IP \fBopts\fP
|
110 |
|
|
comma separated list of further options for the serial port connection:
|
111 |
|
|
.RS
|
112 |
|
|
.PD 0
|
113 |
|
|
.IP \fBbreak\fP
|
114 |
|
|
send a break, do autobaud
|
115 |
|
|
.IP \fBcts\fP
|
116 |
|
|
hardware flow control (cts/rts)
|
117 |
|
|
.IP \fBxon\fP
|
118 |
|
|
software flow control (xon/xoff)
|
119 |
|
|
.PD
|
120 |
|
|
.RE
|
121 |
|
|
.RE
|
122 |
|
|
.
|
123 |
|
|
.\" -- --cuff ------------------------------------
|
124 |
|
|
.IP \fB\-\-cuff\fR[=\fIname\fR[,\fIopts\fR]]
|
125 |
|
|
open a USB via Cypress FX2 type \fBrlink\fP port. Optional arguments are
|
126 |
|
|
.RS
|
127 |
|
|
.IP \fBname\fP
|
128 |
|
|
USB path, default derived from environment variables RETRO_FX2_VID and
|
129 |
|
|
RETRO_FX2_PID.
|
130 |
|
|
.IP \fBopts\fP
|
131 |
|
|
comma separated list of further options for the fifo port:
|
132 |
|
|
.RS
|
133 |
|
|
.PD 0
|
134 |
|
|
.IP \fBtrace\fP
|
135 |
|
|
trace USB activities
|
136 |
|
|
.PD
|
137 |
|
|
.RE
|
138 |
|
|
.RE
|
139 |
|
|
.
|
140 |
|
|
.\" -- --log ------------------------------------
|
141 |
|
|
.IP \fB\-\-log=\fIfile\fR
|
142 |
|
|
set log file name. Default is to write to \fBstdout\fP(3).
|
143 |
|
|
.
|
144 |
|
|
.\" -- --logl -----------------------------------
|
145 |
|
|
.IP \fB\-\-logl=\fIlvl\fR
|
146 |
|
|
set rlink logging level. Default is '2', allowed values are:
|
147 |
|
|
.RS
|
148 |
|
|
.PD 0
|
149 |
|
|
.IP \fB0\fP 3
|
150 |
|
|
no logging
|
151 |
|
|
.IP \fB1\fP 3
|
152 |
|
|
log rlink commands with communication errors
|
153 |
|
|
.IP \fB2\fP 3
|
154 |
|
|
log rlink commands with failed checks
|
155 |
|
|
.IP \fB3\fP 3
|
156 |
|
|
log all rlink commands
|
157 |
|
|
.PD
|
158 |
|
|
.RE
|
159 |
|
|
.
|
160 |
|
|
.\" -- --dmpl -----------------------------------
|
161 |
|
|
.IP \fB\-\-dmpl=\fIlvl\fR
|
162 |
|
|
set rlink dump level. Default is '0', allowed values are as for the
|
163 |
|
|
\fB\-\-logl\fP option.
|
164 |
|
|
.
|
165 |
|
|
.\" -- --tiol -----------------------------------
|
166 |
|
|
.IP \fB\-\-tiol=\fIlvl\fR
|
167 |
|
|
set I/O trace level. Default is '0', allowed values are:
|
168 |
|
|
.RS
|
169 |
|
|
.PD 0
|
170 |
|
|
.IP \fB0\fP 3
|
171 |
|
|
no I/O trace
|
172 |
|
|
.IP \fB1\fP 3
|
173 |
|
|
trace buffer activities
|
174 |
|
|
.IP \fB2\fP 3
|
175 |
|
|
trace character activities
|
176 |
|
|
.PD
|
177 |
|
|
.RE
|
178 |
|
|
.
|
179 |
|
|
.\" -- --int ------------------------------------
|
180 |
|
|
.IP \fB\-\-int\fP
|
181 |
|
|
enter interactive mode even when further tcl commands are given on the
|
182 |
|
|
\fBti_rri\fP command line.
|
183 |
|
|
.
|
184 |
|
|
.\" -- --help -----------------------------------
|
185 |
|
|
.IP \fB\-\-help\fP
|
186 |
|
|
print help text and exit
|
187 |
|
|
.
|
188 |
|
|
.\" -- -- ---------------------------------------
|
189 |
|
|
.IP \fB\-\-\fP
|
190 |
|
|
all following arguments are treated as tcl commands.
|
191 |
|
|
.
|
192 |
|
|
.\" ------------------------------------------------------------------
|
193 |
|
|
.SH COMMANDS
|
194 |
|
|
For arguments of the form '@.tcl' the respective file is
|
195 |
|
|
sourced. All other arguments are treated as Tcl commands and executed
|
196 |
|
|
with eval.
|
197 |
|
|
.
|
198 |
|
|
.\" ------------------------------------------------------------------
|
199 |
|
|
.SH EXAMPLES
|
200 |
|
|
|
201 |
|
|
.\" ------------------------------------------------------------------
|
202 |
|
|
.SH "SEE ALSO"
|
203 |
|
|
.BR ti_w11 (1),
|
204 |
|
|
.BR ghdl (1),
|
205 |
|
|
.BR tbw (1),
|
206 |
|
|
.BR tclsh (1)
|
207 |
|
|
|
208 |
|
|
.\" ------------------------------------------------------------------
|
209 |
|
|
.SH AUTHOR
|
210 |
|
|
Walter F.J. Mueller
|