sbin/cxconfig/cxconfig.8

   1 .\" $FreeBSD$
   2 .Dd December 2, 1994
   3 .Dt CXCONFIG 8
   4 .Os FreeBSD
   5 .Sh NAME
   6 .Nm cxconfig
   7 .Nd channel options management utility for Cronyx-Sigma adapter
   8 .Sh SYNOPSIS
   9 .Nm cxconfig
  10 .Op Fl a
  11 .Op Ar <channel> Op Ar <option>...
  12 .Sh DESCRIPTION
  13 The
  14 .Nm
  15 utility is used for configuring the channel options of
  16 the Cronyx-Sigma adapter.
  17 .Pp
  18 To change channel options the channel should be free: the corresponding
  19 network interface in ``down'' state, the asynchronous terminal device
  20 .Pa /dev/tty*
  21 closed.
  22 Generally, the channel options are set up during the operating
  23 system startup, for example from the
  24 .Pa /etc/rc
  25 file.
  26 .Pp
  27 Note, that not all options have a sense for every particular
  28 case, and an attempt to set some of them can hang up the channel or
  29 the whole adapter.
  30 .Pp
  31 The following option is available:
  32 .Bl -tag -width indent
  33 .It Fl a
  34 Display full information.
  35 .El
  36 .Sh "Channel options"
  37 .Bl -tag -width 10n
  38 .It ispeed=#
  39 Set the receiver baud rate to the number given.
  40 The maximal value is 256000 bits/sec.
  41 In the synchronous mode the receiver baud rate is significant
  42 only when DPLL mode is used.
  43 .It ospeed=#
  44 Set the transmitter baud rate to the number given.
  45 The maximal value is 256000 bits/sec.
  46 In the synchronous mode the transmitter baud rate is significant
  47 only in the case of the internal clock source.
  48 If receiver and transmitter have equal data rate, then it could
  49 be set by specifying only the numerical argument.
  50 .It async
  51 Set the asynchronous channel mode.
  52 .It "hdlc, bisync, bsc, x.21, x21
  53 Set the synchronous channel mode: HDLC, Bisync (BSC) or X.21.
  54 .It ppp
  55 Set the link-level protocol: PpP/HDLC.  The built-in simplified synchronous PPP
  56 implementation is used (see RFC-1548, RFC-1549).
  57 .It cisco
  58 Set the link-level protocol: Cisco/HDLC (see RFC-1547).
  59 This protocol is intended for compatibility with old models of Cisco routers,
  60 and with early versions of BSD/386 drivers.
  61 The extensive usage of this protocol is not recommended.
  62 .It ext
  63 Use the external link-level protocol suite (for BSD/386 only).
  64 .It "+keepalive, -keepalive"
  65 Enable the automatic line state control sub-protocol.
  66 This setting is not significant when the external link-level protocol is used.
  67 .It "+autorts, -autorts"
  68 Enable the automatic RTS signal control.
  69 When enabled, the RTS signal goes up only when both halves of
  70 the receiver ring buffer are free and ready for receive,
  71 and goes down when one or both buffers are busy.
  72 .It "port=rs232, port=rs449, port=v35
  73 Set the zero channel hardware interface type.
  74 .El
  75 .Sh "Common options"
  76 .Bl -tag -width 10n
  77 .It "nrz, nrzi, manchester"
  78 Set the data line signal encoding.
  79 In the case of
  80 .Em NRZ
  81 encoding the zero bit is transmitted by the zero signal
  82 level, the one bit - by the positive signal level.
  83 In the case of
  84 .Em NRZI
  85 encoding the zero bit is transmitted by the change of
  86 the signal level, the one bit - by the constant signal level.
  87 In the case of
  88 .Em Manchester
  89 encoding the zero bit is encoded as 01 value,
  90 the one bit - as 10 value.
  91 .It "+dpll, -dpll"
  92 Enable the digital phase locked loop mode (DPLL).
  93 When enabled, the receiver timing clock signal
  94 is derived from the received data.
  95 .It "+lloop, -lloop"
  96 Set the local loopback mode.
  97 .It "+extclock, -extclock"
  98 Set the timing clock source of synchronous channels.  There are
  99 two possible variants:
 100 .Em "external clock"
 101 source or
 102 .Em "internal clock"
 103 generation.
 104 .Pp
 105 .Em "External clock"
 106 mode is the most common method for connecting
 107 external modem hardware.  In this mode the external timing
 108 signal is received on TXCIN pin of the connector, and it is
 109 used as a synchronization clock for transmitting data (TXD).
 110 .Pp
 111 In the case of
 112 .Em "internal clock"
 113 mode the transmitted data (TXD)
 114 are synchronized using the internal on-board timing generator,
 115 the internally generated timing signal is driven on the TXCOUT
 116 pin, and the signal on the TXCIN pin is ignored.  This mode
 117 is used for direct terminal-to-terminal communication,
 118 e.g. for connecting two computers together in a synchronous mode
 119 via relatively short cable.  This method should also be used
 120 for testing channels with an external loopback connector.
 121 .It fifo=#
 122 FIFO threshold level setup for receiver and transmitter.
 123 .It rfifo=#
 124 Hardware RTS/CTS flow control FIFO threshold setup.
 125 .It "+ctsup, -ctsup"
 126 Enable/disable interrupts on CTS (Clear To Send) signal setup (0 to 1 transition).
 127 .It "+ctsdown, -ctsdown"
 128 Enable/disable interrupts on CTS (Clear To Send) signal clear (1 to 0 transition).
 129 .It "+cdup, -cdup"
 130 Enable/disable interrupts on CD (Carrier Detect) signal setup (0 to 1 transition).
 131 .It "+cddown, -cddown"
 132 Enable/disable interrupts on CD (Carrier Detect) signal clear (1 to 0 transition).
 133 .It "+dsrup, -dsrup"
 134 Enable/disable interrupts on DSR (Data Set Ready) signal setup (0 to 1 transition).
 135 .It "+dsrdown, -dsrdown"
 136 Enable/disable interrupts on DSR (Data Set Ready) signal clear (1 to 0 transition).
 137 .El
 138 .Sh "Asynchronous mode options"
 139 .Bl -tag -width 10n
 140 .It cs#
 141 Select character size: 5, 6, 7 or 8 bits.
 142 .It "parodd, pareven
 143 Parity mode: odd or even.
 144 .It "+ignpar, -ignpar
 145 Disable/enable parity detection.
 146 .It nopar
 147 Disable parity bit generation.
 148 .It forcepar
 149 Force parity: even - 0, odd - 1.
 150 .It "stopb1, stopb1.5, stopb2
 151 Use 1 or 1.5 or 2 stop bits per character.
 152 .It "+dsr, -dsr"
 153 Use the DSR input signal as receiver enable/disable.
 154 .It "+cts, -cts"
 155 Use the CTS input signal as transmitter enable/disable.
 156 .It "+rts, -rts"
 157 Drive the RTS output signal as transmitter ready.
 158 .It "+rloop, -rloop"
 159 Set the remote loopback mode.
 160 .It "+etc, -etc"
 161 Enable the embedded transmit commands mode.
 162 .It "+ixon, -ixon"
 163 Enable the hardware XON/XOFF flow control support.
 164 .It "+ixany, -ixany"
 165 Use the hardware IXANY mode support.
 166 .It "+sdt, -sdt"
 167 Detect the spec. characters SCHR1 and SCHR2 in the receive data.
 168 .It "+flowct, -flowct"
 169 Receive the flow control spec. characters as data.
 170 .It "+rdt, -rdt"
 171 Detect the spec. characters in range SCRL..SCRH in the receive data.
 172 .It "+exdt, -exdt"
 173 Detect the spec. characters SCHR3 and SCHR4 in the receive data.
 174 .It "parintr, parnull, parign, pardisc, parffnull
 175 Action on parity errors:
 176 .Pp
 177 .Bl -tag -width parffnullxxx -compact
 178 .It Mode
 179 Action
 180 .It parintr
 181 Generate the receiver error interrupt
 182 .It parnull
 183 Input the NUL character
 184 .It parign
 185 Ignore the error, receive as good data
 186 .It pardisc
 187 Ignore the character
 188 .It parffnull
 189 Input the sequence <0xFF, NUL, character>
 190 .El
 191 .It "brkintr, brknull, brkdisc
 192 Line break state action:
 193 .Pp
 194 .Bl -tag -width parffnullxxx -compact
 195 .It Mode
 196 Action
 197 .It brkintr
 198 Generate the receiver error interrupt
 199 .It brknull
 200 Input the NUL character
 201 .It brkdisc
 202 Ignore the line break state
 203 .El
 204 .It "+inlcr, -inlcr"
 205 Translate received NL characters to CR.
 206 .It "+icrnl, -icrnl"
 207 Translate received CR characters to NL.
 208 .It "+igncr, -igncr"
 209 Ignore received CR characters.
 210 .It "+ocrnl, -ocrnl"
 211 Translate transmitted CR characters to NL.
 212 .It "+onlcr, -onlcr"
 213 Translate transmitted NL characters to CR.
 214 .It "+fcerr, -fcerr"
 215 Process (don't process) the characters, received with errors,
 216 for special character/flow control matching.
 217 .It "+lnext, -lnext"
 218 Enable the LNEXT character option: the character following
 219 the LNEXT character is not processed for special character/flow
 220 control matching.
 221 .It "+istrip, -istrip"
 222 Strip input characters to seven bits.
 223 .It schr1=#
 224 The XON flow control character value.
 225 .It schr2=#
 226 The XOFF flow control character value.
 227 .It schr3=#
 228 The SCHR3 spec. character value.
 229 .It schr4=#
 230 The SCHR4 spec. character value.
 231 .It "scrl=#, scrh=#
 232 The spec. character range (inclusive).
 233 .It lnext=#
 234 The LNEXT spec. character value.
 235 .El
 236 .Sh "HDLC mode options"
 237 .Bl -tag -width 10n
 238 .It if#
 239 The minimum number of flags transmitted before a frame is started.
 240 .It noaddr
 241 No frame address recognition.
 242 .It "addrlen1, addrlen2"
 243 Address field length: 1 or 2 bytes.
 244 .It "addr1, addr2"
 245 Addressing mode: 4x1 bytes or 2x2 bytes.
 246 Registers RFAR1..RFAR4 should contain the address to be matched.
 247 .It "+clrdet, -clrdet"
 248 Enable/disable clear detect for X.21 protocol support.
 249 .It "+dsr, -dsr"
 250 Use the DSR input signal as receiver enable/disable.
 251 .It "+cts, -cts"
 252 Use the CTS input signal as transmitter enable/disable.
 253 .It "+rts, -rts"
 254 Drive the RTS output signal as transmitter ready.
 255 .It "+fcs, -fcs"
 256 Enable/disable the frame checksum generation and checking.
 257 .It "crc-16, crc-v.41
 258 Select the CRC polynomial: CRC-16 (x^16+x^15+x^2+1)
 259 or CRC V.41 (x^16+x^12+x^5+1).
 260 .It "fcs-crc-16, fcs-v.41
 261 Frame checksum preset: all zeros (CRC-16) or all ones (CRC V.41).
 262 .It "+crcinv, -crcinv"
 263 Invert (ie. CRC V.41) or don't invert (ie. CRC-16) the transmitted frame checksum.
 264 .It "+fcsapd, -fcsapd"
 265 Pass the received CRC to the host at the end of receiver data buffer.
 266 .It "idlemark, idleflag
 267 Idle mode: idle in mark (transmit all ones) or idle in flag (transmit flag).
 268 .It "+syn, -syn"
 269 Enable/disable sending pad characters before sending flag when coming out
 270 of the idle mode.
 271 .It pad#
 272 The number of synchronous characters sent (0..4).
 273 .It "syn=0xaa, syn=0x00
 274 Send sync pattern.
 275 .It "rfar1=#, rfar2=#, rfar3=#, rfar4=#
 276 Frame address registers for address recognition.
 277 .El
 278 .Sh EXAMPLES
 279 Set up the channel 7 of the adapter Sigma-400 under
 280 .Bx Free .
 281 Physical 4-wire leased line with Zelax+ M115 short-range modems.
 282 Synchronous mode, 128000 bits/sec, interface RS-232,
 283 protocol PpP/HDLC without keepalive support, NRZI encoding,
 284 DPLL mode, no flow control:
 285 .Bd -literal
 286 cxconfig cx7 128000 hdlc ppp -keepalive nrzi -cts +dpll -extclock
 287 ifconfig cx7 158.250.244.2 158.250.244.1 up
 288 .Ed
 289 .Pp
 290 Set up the channel 0 of the adapter Sigma-100 under
 291 .Bx Free .
 292 Attachment to the near computer by short cable, internal clock source.
 293 Synchronous mode, 256000 bits/sec, interface RS-232,
 294 protocol Cisco/HDLC with keepalive support:
 295 .Bd -literal
 296 cxconfig cx0 hdlc 256000 cisco +keepalive -extclock
 297 ifconfig cx0 200.1.1.1 200.1.1.2 up
 298 .Ed
 299 .Pp
 300 Set up the channel 1 of the adapter Sigma-840 under BSD/386.
 301 Synchronous 64 kbit/sec leased line, external clock source.
 302 Synchronous mode, interface V.35, external protocol suite:
 303 .Bd -literal
 304 cxconfig cx1 hdlc ext
 305 ifconfig cx1 193.124.254.50 193.124.254.49 multicast up
 306 .Ed
 307 .Pp
 308 Set up the channel 0 of the adapter Sigma-840 under
 309 .Bx Free .
 310 Attachment to the Cisco-4000 router by null-modem cable, internal clock source.
 311 Synchronous mode, 64000 bits/sec, interface RS-232,
 312 protocol PpP/HDLC with keepalive support and flow control,
 313 LCP and IPCP protocols (see RFC-1548 and RFC-1332) debug tracing enabled:
 314 .Bd -literal
 315 cxconfig cx0 hdlc 64000 port=rs232 ppp +keepalive -extclock +cts
 316 ifconfig cx0 100.0.0.2 100.0.0.1 debug up
 317 .Ed
 318 .Sh FILES
 319 .Bl -tag -width /dev/cronyx -compact
 320 .Pa /dev/cronyx
 321 the special device file for adapter options management
 322 .El
 323 .Sh SEE ALSO
 324 .Xr cx 4