1 .\" $FreeBSD: src/sbin/i386/cxconfig/cxconfig.8,v 1.5.2.4 2001/08/16 11:35:43 ru Exp $
2 .\" $DragonFly: src/sbin/i386/cxconfig/cxconfig.8,v 1.3 2006/02/17 19:33:32 swildner Exp $
8 .Nd channel options management utility for Cronyx-Sigma adapter
12 .Op Ar <channel> Op Ar <option>...
16 utility is used for configuring the channel options of
17 the Cronyx-Sigma adapter.
19 To change channel options the channel should be free: the corresponding
20 network interface in ``down'' state, the asynchronous terminal device
23 Generally, the channel options are set up during the operating
24 system startup, for example from the
28 Note, that not all options have a sense for every particular
29 case, and an attempt to set some of them can hang up the channel or
32 The following option is available:
33 .Bl -tag -width indent
35 Display full information.
40 Set the receiver baud rate to the number given.
41 The maximal value is 256000 bits/sec.
42 In the synchronous mode the receiver baud rate is significant
43 only when DPLL mode is used.
45 Set the transmitter baud rate to the number given.
46 The maximal value is 256000 bits/sec.
47 In the synchronous mode the transmitter baud rate is significant
48 only in the case of the internal clock source.
49 If receiver and transmitter have equal data rate, then it could
50 be set by specifying only the numerical argument.
52 Set the asynchronous channel mode.
53 .It "hdlc, bisync, bsc, x.21, x21
54 Set the synchronous channel mode: HDLC, Bisync (BSC) or X.21.
56 Set the link-level protocol: PpP/HDLC. The built-in simplified synchronous PPP
57 implementation is used (see RFC-1548, RFC-1549).
59 Set the link-level protocol: Cisco/HDLC (see RFC-1547).
60 This protocol is intended for compatibility with old models of Cisco routers,
61 and with early versions of
64 The extensive usage of this protocol is not recommended.
66 Use the external link-level protocol suite (for
69 .It "+keepalive, -keepalive"
70 Enable the automatic line state control sub-protocol.
71 This setting is not significant when the external link-level protocol is used.
72 .It "+autorts, -autorts"
73 Enable the automatic RTS signal control.
74 When enabled, the RTS signal goes up only when both halves of
75 the receiver ring buffer are free and ready for receive,
76 and goes down when one or both buffers are busy.
77 .It "port=rs232, port=rs449, port=v35
78 Set the zero channel hardware interface type.
82 .It "nrz, nrzi, manchester"
83 Set the data line signal encoding.
86 encoding the zero bit is transmitted by the zero signal
87 level, the one bit - by the positive signal level.
90 encoding the zero bit is transmitted by the change of
91 the signal level, the one bit - by the constant signal level.
94 encoding the zero bit is encoded as 01 value,
95 the one bit - as 10 value.
97 Enable the digital phase locked loop mode (DPLL).
98 When enabled, the receiver timing clock signal
99 is derived from the received data.
101 Set the local loopback mode.
102 .It "+extclock, -extclock"
103 Set the timing clock source of synchronous channels. There are
104 two possible variants:
111 mode is the most common method for connecting
112 external modem hardware. In this mode the external timing
113 signal is received on TXCIN pin of the connector, and it is
114 used as a synchronization clock for transmitting data (TXD).
118 mode the transmitted data (TXD)
119 are synchronized using the internal on-board timing generator,
120 the internally generated timing signal is driven on the TXCOUT
121 pin, and the signal on the TXCIN pin is ignored. This mode
122 is used for direct terminal-to-terminal communication,
123 e.g. for connecting two computers together in a synchronous mode
124 via relatively short cable. This method should also be used
125 for testing channels with an external loopback connector.
127 FIFO threshold level setup for receiver and transmitter.
129 Hardware RTS/CTS flow control FIFO threshold setup.
131 Enable/disable interrupts on CTS (Clear To Send) signal setup (0 to 1 transition).
132 .It "+ctsdown, -ctsdown"
133 Enable/disable interrupts on CTS (Clear To Send) signal clear (1 to 0 transition).
135 Enable/disable interrupts on CD (Carrier Detect) signal setup (0 to 1 transition).
136 .It "+cddown, -cddown"
137 Enable/disable interrupts on CD (Carrier Detect) signal clear (1 to 0 transition).
139 Enable/disable interrupts on DSR (Data Set Ready) signal setup (0 to 1 transition).
140 .It "+dsrdown, -dsrdown"
141 Enable/disable interrupts on DSR (Data Set Ready) signal clear (1 to 0 transition).
143 .Sh "Asynchronous mode options"
146 Select character size: 5, 6, 7 or 8 bits.
148 Parity mode: odd or even.
149 .It "+ignpar, -ignpar
150 Disable/enable parity detection.
152 Disable parity bit generation.
154 Force parity: even - 0, odd - 1.
155 .It "stopb1, stopb1.5, stopb2
156 Use 1 or 1.5 or 2 stop bits per character.
158 Use the DSR input signal as receiver enable/disable.
160 Use the CTS input signal as transmitter enable/disable.
162 Drive the RTS output signal as transmitter ready.
164 Set the remote loopback mode.
166 Enable the embedded transmit commands mode.
168 Enable the hardware XON/XOFF flow control support.
170 Use the hardware IXANY mode support.
172 Detect the spec. characters SCHR1 and SCHR2 in the receive data.
173 .It "+flowct, -flowct"
174 Receive the flow control spec. characters as data.
176 Detect the spec. characters in range SCRL..SCRH in the receive data.
178 Detect the spec. characters SCHR3 and SCHR4 in the receive data.
179 .It "parintr, parnull, parign, pardisc, parffnull
180 Action on parity errors:
182 .Bl -tag -width parffnullxxx -compact
186 Generate the receiver error interrupt
188 Input the NUL character
190 Ignore the error, receive as good data
194 Input the sequence <0xFF, NUL, character>
196 .It "brkintr, brknull, brkdisc
197 Line break state action:
199 .Bl -tag -width parffnullxxx -compact
203 Generate the receiver error interrupt
205 Input the NUL character
207 Ignore the line break state
210 Translate received NL characters to CR.
212 Translate received CR characters to NL.
214 Ignore received CR characters.
216 Translate transmitted CR characters to NL.
218 Translate transmitted NL characters to CR.
220 Process (don't process) the characters, received with errors,
221 for special character/flow control matching.
223 Enable the LNEXT character option: the character following
224 the LNEXT character is not processed for special character/flow
226 .It "+istrip, -istrip"
227 Strip input characters to seven bits.
229 The XON flow control character value.
231 The XOFF flow control character value.
233 The SCHR3 spec. character value.
235 The SCHR4 spec. character value.
237 The spec. character range (inclusive).
239 The LNEXT spec. character value.
241 .Sh "HDLC mode options"
244 The minimum number of flags transmitted before a frame is started.
246 No frame address recognition.
247 .It "addrlen1, addrlen2"
248 Address field length: 1 or 2 bytes.
250 Addressing mode: 4x1 bytes or 2x2 bytes.
251 Registers RFAR1..RFAR4 should contain the address to be matched.
252 .It "+clrdet, -clrdet"
253 Enable/disable clear detect for X.21 protocol support.
255 Use the DSR input signal as receiver enable/disable.
257 Use the CTS input signal as transmitter enable/disable.
259 Drive the RTS output signal as transmitter ready.
261 Enable/disable the frame checksum generation and checking.
262 .It "crc-16, crc-v.41
263 Select the CRC polynomial: CRC-16 (x^16+x^15+x^2+1)
264 or CRC V.41 (x^16+x^12+x^5+1).
265 .It "fcs-crc-16, fcs-v.41
266 Frame checksum preset: all zeros (CRC-16) or all ones (CRC V.41).
267 .It "+crcinv, -crcinv"
268 Invert (ie. CRC V.41) or don't invert (ie. CRC-16) the transmitted frame checksum.
269 .It "+fcsapd, -fcsapd"
270 Pass the received CRC to the host at the end of receiver data buffer.
271 .It "idlemark, idleflag
272 Idle mode: idle in mark (transmit all ones) or idle in flag (transmit flag).
274 Enable/disable sending pad characters before sending flag when coming out
277 The number of synchronous characters sent (0..4).
278 .It "syn=0xaa, syn=0x00
280 .It "rfar1=#, rfar2=#, rfar3=#, rfar4=#
281 Frame address registers for address recognition.
284 .Bl -tag -width /dev/cronyx -compact
286 the special device file for adapter options management
289 Set up the channel 7 of the adapter Sigma-400 under
291 Physical 4-wire leased line with Zelax+ M115 short-range modems.
292 Synchronous mode, 128000 bits/sec, interface RS-232,
293 protocol PpP/HDLC without keepalive support, NRZI encoding,
294 DPLL mode, no flow control:
296 cxconfig cx7 128000 hdlc ppp -keepalive nrzi -cts +dpll -extclock
297 ifconfig cx7 158.250.244.2 158.250.244.1 up
300 Set up the channel 0 of the adapter Sigma-100 under
302 Attachment to the near computer by short cable, internal clock source.
303 Synchronous mode, 256000 bits/sec, interface RS-232,
304 protocol Cisco/HDLC with keepalive support:
306 cxconfig cx0 hdlc 256000 cisco +keepalive -extclock
307 ifconfig cx0 200.1.1.1 200.1.1.2 up
310 Set up the channel 1 of the adapter Sigma-840 under
312 Synchronous 64 kbit/sec leased line, external clock source.
313 Synchronous mode, interface V.35, external protocol suite:
315 cxconfig cx1 hdlc ext
316 ifconfig cx1 193.124.254.50 193.124.254.49 multicast up
319 Set up the channel 0 of the adapter Sigma-840 under
321 Attachment to the Cisco-4000 router by null-modem cable, internal clock source.
322 Synchronous mode, 64000 bits/sec, interface RS-232,
323 protocol PpP/HDLC with keepalive support and flow control,
324 LCP and IPCP protocols (see RFC-1548 and RFC-1332) debug tracing enabled:
326 cxconfig cx0 hdlc 64000 port=rs232 ppp +keepalive -extclock +cts
327 ifconfig cx0 100.0.0.2 100.0.0.1 debug up