Deleted Added
full compact
sconfig.8 (129378) sconfig.8 (129500)
1.\" $FreeBSD: head/sbin/sconfig/sconfig.8 129378 2004-05-18 07:23:37Z ru $
2.Dd November 21, 2003
1.\" Copyright (c) 2002-2004 Roman Kurakin <rik@cronyx.ru>
2.\" Copyright (c) 2002-2004 Cronyx Engineering
3.\" All rights reserved.
4.\"
5.\" This software is distributed with NO WARRANTIES, not even the implied
6.\" warranties for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7.\"
8.\" Authors grant any other persons or organisations a permission to use,
9.\" modify and redistribute this software in source and binary forms,
10.\" as long as this message is kept with the software, all derivative
11.\" works or modified versions.
12.\"
13.\" $FreeBSD: head/sbin/sconfig/sconfig.8 129500 2004-05-20 16:40:06Z ru $
14.Dd May 19, 2004
3.Dt SCONFIG 8 i386
4.Os
5.Sh NAME
6.Nm sconfig
15.Dt SCONFIG 8 i386
16.Os
17.Sh NAME
18.Nm sconfig
7.Nd channel configuration utility for Cronyx adapters
19.Nd "channel configuration utility for Cronyx adapters"
8.Sh SYNOPSIS
9.Nm
10.Op Fl aimsxeftuc
11.Op Ar device
20.Sh SYNOPSIS
21.Nm
22.Op Fl aimsxeftuc
23.Op Ar device
12.Op Ar data rate options
13.Op Ar protocol options ...
14.Op Ar interface options ...
24.Op Ar data_rate_options
25.Op Ar protocol_options ...
26.Op Ar interface_options ...
15.Sh DESCRIPTION
16The
17.Nm
18utility is used for configuring the channel options of the Cronyx
19adapters.
27.Sh DESCRIPTION
28The
29.Nm
30utility is used for configuring the channel options of the Cronyx
31adapters.
20In asynchronous mode all the parameters should be set by standard
32In asynchronous mode, all parameters should be set using the standard
21.Xr stty 1
33.Xr stty 1
22utility, with
23.Nm
24you could set only few of them (see below).
34utility.
35With
36.Nm ,
37it is only possible to set some of them (see below).
25.Pp
38.Pp
26Some of the options could be set only on free channels, that is the
27corresponding network interface in
28.Ar down
29state in the synchronous mode, and in the asynchronous mode the asynchronous
30terminal device
39Some of the options can be set only on free channels,
40that is when the corresponding network interface is in the
41.Cm down
42state in the synchronous mode,
43and the terminal device
31.Pa /dev/tty*
44.Pa /dev/tty*
32closed.
45is closed in asynchronous mode.
33.Pp
46.Pp
34Other channel options could be changed
47Other channel options can be changed
35.Dq "on the fly" .
36Generally, the channel options are set up during the operating system startup,
48.Dq "on the fly" .
49Generally, the channel options are set up during the operating system startup,
37for example from the
50for example, from the
38.Pa /etc/rc
51.Pa /etc/rc
39file.
52script.
40.Pp
53.Pp
41Note, that not all options have a sense for every particular
42case, and an attempt to set some of them can hang up the channel or
43the whole adapter.
54Note that not all options make sense in every particular case,
55and an attempt to set some of them may hung up the channel
56or the whole adapter.
44.\"--------------------------------------------------------------
45.Ss "Information Options"
57.\"--------------------------------------------------------------
58.Ss "Information Options"
46You can specify only one of these options.
59Only one of these options can be specified.
47If information option is specified,
48.Nm
60If information option is specified,
61.Nm
49will show corresponding information and will ignore all other options,
62will show the corresponding information and will ignore all other options,
50except
51.Ar device .
63except
64.Ar device .
52See also description of the
53.Ar device .
65See also the description of the
66.Ar device
67argument.
54.Bl -tag -width indent
55.It <none>
56This will show settings of the channel.
57.It Fl a
58Print all settings of the channel.
59.It Fl i
68.Bl -tag -width indent
69.It <none>
70This will show settings of the channel.
71.It Fl a
72Print all settings of the channel.
73.It Fl i
60Print interface settings, equal to the output of
74Print interface settings, equal to the output of the
61.Xr ifconfig 8
62utility.
63.It Fl m
64Print modem signal status.
75.Xr ifconfig 8
76utility.
77.It Fl m
78Print modem signal status.
65The description of all signals can be found in
66any document related to the modems.
79The description of all signals can be found in any modem documentation.
67Only LE signal should be described.
80Only LE signal should be described.
68If this signal is On, than some what use channel.
69If it is Off, than channel is free.
81If this signal is ON then the channel is busy.
82If it is OFF then the channel is free.
70.It Fl s
71Print brief channel statistics.
83.It Fl s
84Print brief channel statistics.
72This is general statistics.
73See also
74.Fl x , e , f , t
85This is the generic statistics,
86see also the
87.Fl x , e , f , t ,
75and
76.Fl u
77options.
88and
89.Fl u
90options.
78For the description of output, see below.
91For a description of the output, see below.
79.Pp
80This statistics is very useful if something goes wrong.
92.Pp
93This statistics is very useful if something goes wrong.
81For example, if you
82have no any interrupts, than you use interrupt that is not registered in BIOS
83for use with ISA bus.
94For example, if all interrupt counters are zero then the device
95was configured to use an interrupt that was not registered in the
96BIOS for use with the ISA bus.
84.It Fl x
85Print full channel statistics.
97.It Fl x
98Print full channel statistics.
86This options allows to see some more counters,
99This options prints additinal counters,
87but with less precision than with the
88.Fl s
89option.
90.It Fl e
91Print brief E1/G703 statistics.
100but with less precision than with the
101.Fl s
102option.
103.It Fl e
104Print brief E1/G703 statistics.
92If you select this option, you will get
93statistics accumulated for period of time equal to 15 minutes.
94For the
95description of output, see below.
105If this option is selected, the
106statistics accumulated over the last 15 minutes is printed.
107For a description of the output, see below.
96.It Fl f
97Print full E1/G703 statistics.
108.It Fl f
109Print full E1/G703 statistics.
98This option shows all E1/G703 statistics that
99shows previous option
100.Pq Fl e ,
101but also total statistics for whole period of time and statistics for 24
102hours (if available).
103For the description of output, see below.
110This option shows all E1/G703 statistics that the
111.Fl e
112option shows,
113plus total statistics for the whole period of time and statistics for
114last 24 hours (if available).
115For a description of the output, see below.
104.It Fl t
105Print brief E3/T3/STS-1 statistics.
116.It Fl t
117Print brief E3/T3/STS-1 statistics.
106If you select this option, you will
107get statistics accumulated for period of time equal to 15 minutes.
108For
109the description of output, see below.
118If this option is selected, the
119statistics accumulated over the last 15 minutes is printed.
120For a description of the output, see below.
110.It Fl u
111Print full E3/T3/STS-1 statistics.
121.It Fl u
122Print full E3/T3/STS-1 statistics.
112This option shows all E3/T3/STS-1
113statistics that shows previous option
114.Pq Fl t ,
115but also total statistics for whole period of time and statistics for 24
116hours (if available).
117For the description of output, see below.
123This option shows all E3/T3/STS-1 statistics that the
124.Fl t
125option shows,
126plus total statistics for the whole period of time and statistics for
127last 24 hours (if available).
128For a description of the output, see below.
118.It Fl c
119Cleans all kind of statistics.
120.El
121.\"--------------------------------------------------------------
122.Ss "Device Selection"
129.It Fl c
130Cleans all kind of statistics.
131.El
132.\"--------------------------------------------------------------
133.Ss "Device Selection"
123Device is equal to the name of the interface that is used for a name of
124the interface that is sees
134The device is selected using the name of the network interface,
135as shown by
125.Xr ifconfig 8 .
136.Xr ifconfig 8 .
126The channel number depends on the order of loading drivers by the system.
137The channel number depends on the order the drivers were loaded into the system.
127Sometimes people confuse channel number and adapter number because of the
128same spelling.
138Sometimes people confuse channel number and adapter number because of the
139same spelling.
129Adapter number appears in kernel context, channel number
130in configuration context.
140The adapter number appears in the kernel context, while the channel number
141is in the configuration context.
131.Bl -tag -width indent
132.It <none>
142.Bl -tag -width indent
143.It <none>
133You can omit device name only if you want to get information.
134This will cause
135printing information about all available channels of Cronyx adapters.
136In the
137case you want to make some settings you MUST specify device name.
138.It Li cx##
144If the device name is omitted,
145.Nm
146will print information about all channels of all Cronyx adapters
147available in the system.
148If some settings need to be made, the device name must be specified.
149.It Li cx Ns Ar ##
139This is the channel name for the Sigma family of Cronyx adapters.
140(ISA bus.)
150This is the channel name for the Sigma family of Cronyx adapters.
151(ISA bus.)
141.It Li ct##
152.It Li ct Ns Ar ##
142This is the channel name for the Tau family of Cronyx adapters.
143(ISA bus.)
153This is the channel name for the Tau family of Cronyx adapters.
154(ISA bus.)
144.It Li cp##
155.It Li cp Ns Ar ##
145This is the channel name for the Tau-PCI family of Cronyx adapters.
146(PCI bus.)
156This is the channel name for the Tau-PCI family of Cronyx adapters.
157(PCI bus.)
147.It Li ce##
158.It Li ce Ns Ar ##
148This is the channel name for the Tau32-PCI family of Cronyx adapters.
149(PCI bus.)
150.El
151.\"--------------------------------------------------------------
152.Ss "Data Rate Options"
153.Bl -tag -width indent
154.It Ar value
159This is the channel name for the Tau32-PCI family of Cronyx adapters.
160(PCI bus.)
161.El
162.\"--------------------------------------------------------------
163.Ss "Data Rate Options"
164.Bl -tag -width indent
165.It Ar value
155In case of nonzero value it will cause setting data rate to given value and
156setting the internal clock source of the synchronization (in synchronous mode).
157Zero value is equal to the
158.Cm extclock .
159The transmitted data (TXD) are synchronized using the internal on-board timing
166A non-zero value will set the data rate to a given value
167in asynchronous mode,
168and will set the date rate and internal clock source of synchronization
169in synchronous mode.
170A zero value is equivalent to specifying the
171.Cm extclock
172option.
173The transmitted data (TxD) are synchronized using the internal on-board timing
160generator, the internally generated timing signal is driven on the TXCOUT pin,
161and the signal on the TXCIN pin is ignored.
162This mode is used for direct
174generator, the internally generated timing signal is driven on the TXCOUT pin,
175and the signal on the TXCIN pin is ignored.
176This mode is used for direct
163terminal-to-terminal communication, e.g., for connecting two computers together
164in a synchronous mode via relatively short cable.
177terminal-to-terminal communication, e.g., when connecting two computers together
178in synchronous mode with a relatively short cable.
165This method should also be
166used for testing channels with an external loopback connector.
167.It Cm extclock
179This method should also be
180used for testing channels with an external loopback connector.
181.It Cm extclock
168Set the external timing clock source of synchronous channels.
169External clock
170mode is the most common method for connecting external modem hardware.
171In this
172mode the external timing signal is received on TXCIN pin of the connector,
173and it is used as a synchronization clock for transmitting data (TXD).
182Set the external timing clock source for synchronous channels.
183External clock mode is the most commonly used method for connecting
184external modem hardware.
185In this mode,
186the external timing signal is received on the TXCIN pin of the connector,
187and it is used as a synchronization clock for transmitting data (TxD).
188.Pp
189Note: in
190.Cm extclock
191mode, the device cannot determine the value of the external timing clock
192since it does not have the built-in clock gauge.
174.El
175.\"--------------------------------------------------------------
176.Ss "Protocol Options"
193.El
194.\"--------------------------------------------------------------
195.Ss "Protocol Options"
177Note.
178These option could be set only if channel is free and they requires
179specifying of the device name.
196Note: these option can only be used on a free channel, and they require
197specifying the device name.
180.Bl -tag -width indent
181.It Cm async
198.Bl -tag -width indent
199.It Cm async
182Set asynchronous protocol (or mode).
183In this mode Cronyx adapters behave as a
184usual serial devices and you may work with them using usual serial utilities.
185All asynchronous settings are performed via serial configuration utilities.
186With
187.Nm
188you may set only a few of them.
189See also
190.Xr stty 1 .
191(Only for Sigma family.)
200(Only for Sigma family.)
201Select the asynchronous protocol (or mode).
202In this mode, Cronyx adapters behave as normal serial devices,
203and standard serial communications utilities can be used to
204work with them.
205All asynchronous settings should be set using the standard
206serial communications configuration utilities, e.g.,
207.Xr stty 1 .
208With
209.Nm ,
210it is only possible to set some of them.
192.It Cm cisco
211.It Cm cisco
193Set the Cisco HDLC synchronous protocol.
212Select the Cisco HDLC synchronous protocol.
194.It Cm fr
213.It Cm fr
195Set the Frame Relay synchronous protocol
214Select the Frame Relay synchronous protocol
196.Tn ( ANSI
197T1.617 Annex D).
198.It Cm ppp
215.Tn ( ANSI
216T1.617 Annex D).
217.It Cm ppp
199Set the PPP synchronous protocol.
200Parameters to the PPP could be set by the
201command
202.Xr spppcontrol 8 .
218Select the synchronous PPP protocol.
219PPP parameters can be configured using the
220.Xr spppcontrol 8
221utility.
203.It Sm Cm keepalive No = Bro Cm on , off Brc Sm
222.It Sm Cm keepalive No = Bro Cm on , off Brc Sm
204Turns on/off sending keepalive messages.
205This option is used only for
206synchronous PPP.
207If this option is on, than PPP will periodically send
208echo-request messages.
209If it would not receive any echo-reply messages for
210some (definite) period of time it will break connection.
211It is used for
212tracking line state.
223Turn on/off transmission of keepalive messages.
224This option is used only for synchronous PPP.
225If this option is
226.Cm on ,
227PPP will periodically send ECHO-REQUEST messages.
228If it will not receive any ECHO-REPLY messages for
229some (definite) period of time it will break the connection.
230It is used for tracking the line state.
213.It Cm idle
231.It Cm idle
214You are using Netgraph.
215Protocol depends on connected module.
232This mode is reported when using Netgraph.
233An actual protocol depends on the type of a connected Netgraph node,
234and it cannot be changed with
235.Nm .
216.El
217.\"--------------------------------------------------------------
218.Ss "Interface Options"
236.El
237.\"--------------------------------------------------------------
238.Ss "Interface Options"
219Not all of these options could be set on running channel and not all of them
220are suits to all kind of adapters/channels.
221In all dual state options off is
222default value.
223All this options is not applicable in asynchronous mode, except
239Not all of these options can be set on a busy channel, and not all of them
240are applicable to all kinds of adapters/channels.
241For all dual-state options,
242.Cm off
243is the default value.
244None of these options can be used in the asynchronous mode,
245except for the
224.Cm debug
225option.
226.Bl -tag -width indent
227.It Sm Cm port No = Bro Cm rs232 , v35 , rs449 Brc Sm
246.Cm debug
247option.
248.Bl -tag -width indent
249.It Sm Cm port No = Bro Cm rs232 , v35 , rs449 Brc Sm
228Set port type for old Sigma models.
250Set the port type for old Sigma models.
229.It Sm Cm cfg No = Bro Cm A , B , C Brc Sm
251.It Sm Cm cfg No = Bro Cm A , B , C Brc Sm
230Set configuration for the adapter.
231This option could be set only for Tau/E1
232and Tau/G703 and only if all channels are not running.
252Set the configuration for the adapter.
253This option can be used only with Tau/E1
254and Tau/G703 adapters, and only if all channels are free.
233.Bl -tag -width ".Cm cfg Ns = Ns Cm A"
234.It Cm cfg Ns = Ns Cm A
235Two independent E1/G703 channels.
255.Bl -tag -width ".Cm cfg Ns = Ns Cm A"
256.It Cm cfg Ns = Ns Cm A
257Two independent E1/G703 channels.
236This is default setting.
258This is the default setting.
237.It Cm cfg Ns = Ns Cm B
238(Only for ISA models.)
259.It Cm cfg Ns = Ns Cm B
260(Only for ISA models.)
239For Tau/G703 this mean one G703 channel and one digital channel.
240For Tau/E1 first physical channel divides on to subchannels.
241One of them
242goes to the first logical channel and another one goes to the second physical
243channel.
244Second (logical) channel is digital channel.
261For Tau/G703 this means one G703 channel and one digital channel.
262For Tau/E1, the first physical channel is divided into two subchannels.
263One of them goes to the first logical channel, another one goes to the
264second physical channel.
265Second (logical) channel is the digital channel.
245.It Cm cfg Ns = Ns Cm C
266.It Cm cfg Ns = Ns Cm C
246This configuration is used only for E1 models.
247In this case first
267(Only for E1 models.)
268In this mode, first
248physical channel consists of three data flows.
269physical channel consists of three data flows.
249Two of them go to two
250(logical) channels.
270Two of them go to the two (logical) channels.
251The last one goes to the second physical channel.
271The last one goes to the second physical channel.
252On new
253models (Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1) this configuration means single source
254of synchronization and passing all unused (in both channels) timeslots from
255one channel to other.
272On newer models (Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1),
273this programs the hardware to use a single source of synchronization
274and pass all unused (in both channels) timeslots from
275one channel to another.
256.El
257.Pp
276.El
277.Pp
258For the detailed description of the configuration see
259your documentation to the adapter.
260This option could not be set on running
261channel.
278For a detailed description of available configuration modes,
279see the adapter documentation.
280This option cannot be set on a busy channel.
262.It Sm Cm loop No = Bro Cm on , off Brc Sm
263Turn on/off internal loopback.
281.It Sm Cm loop No = Bro Cm on , off Brc Sm
282Turn on/off internal loopback.
264This mode is useful for testing.
265Switch on this
266option and try to send something.
267If you have no any interrupt, than, probably,
268you forgot to switch using IRQ for PCI to ISA bus.
269Check your BIOS settings.
283This mode is useful for debugging.
284When this mode is
285.Cm on ,
286some data should be sent.
287If no interrupts are generated, chances are that
288the corresponding IRQ configuration entry in the BIOS
289was not switched from
290.Dq Li "PCI/ISA PNP"
291to
292.Dq Li "Legacy ISA" .
270.It Sm Cm rloop No = Bro Cm on , off Brc Sm
271(Only for Tau32-PCI and Tau-PCI/E3.)
293.It Sm Cm rloop No = Bro Cm on , off Brc Sm
294(Only for Tau32-PCI and Tau-PCI/E3.)
272Turn on/off remote loopback.
273This mode is also useful for testing.
295Turn on/off remote loopback feature.
296This mode is also useful for debugging.
274.It Sm Cm dpll No = Bro Cm on , off Brc Sm
275Turn on/off digital phase locked loop mode (DPLL).
276When enabled, the receiver
277timing clock signal is derived from the received data.
297.It Sm Cm dpll No = Bro Cm on , off Brc Sm
298Turn on/off digital phase locked loop mode (DPLL).
299When enabled, the receiver
300timing clock signal is derived from the received data.
278Must be used with NRZI
279encoding, to avoid the synchronization loss.
301Must be used with the NRZI
302encoding to avoid the synchronization loss.
280.It Sm Cm nrzi No = Bro Cm on , off Brc Sm
303.It Sm Cm nrzi No = Bro Cm on , off Brc Sm
281Turn on/off nrzi encoding.
282In off state nrz encoding is used.
304Turn on/off NRZI encoding.
305If
306.Cm off ,
307NRZ encoding is used.
283.Bl -tag -width "NRZI"
284.It NRZ
308.Bl -tag -width "NRZI"
309.It NRZ
285the zero
286bit is transmitted by the zero signal level, the one bit - by the positive
287signal level.
310The zero bit is transmitted by the zero signal level,
311the one bit is transmitted by the positive signal level.
288.It NRZI
312.It NRZI
289the bit number zero is transmitted by the change of the
290signal level, the one bit - by the constant signal level.
291.El
292.Pp
293Commonly is used with
313The zero bit is transmitted by the change of the signal
314level, the one bit is by the constant signal level.
315Commonly used with the
294.Cm dpll Ns = Ns Cm on
295option.
316.Cm dpll Ns = Ns Cm on
317option.
318.El
296.It Sm Cm invclk No = Bro Cm on , off Brc Sm
319.It Sm Cm invclk No = Bro Cm on , off Brc Sm
297Invert the both transmit and receive clock signals (Tau and Tau-PCI only).
320(Tau and Tau-PCI only.)
321Invert both the transmit and receive clock signals.
298.It Sm Cm invrclk No = Bro Cm on , off Brc Sm
322.It Sm Cm invrclk No = Bro Cm on , off Brc Sm
299Invert the receive clock signals (Tau-PCI only).
323(Tau-PCI only.)
324Invert the receive clock signals.
300.It Sm Cm invtclk No = Bro Cm on , off Brc Sm
325.It Sm Cm invtclk No = Bro Cm on , off Brc Sm
301Invert the transmit clock signals (Tau-PCI only).
326(Tau-PCI only.)
327Invert the transmit clock signals.
302.It Sm Cm higain No = Bro Cm on , off Brc Sm
328.It Sm Cm higain No = Bro Cm on , off Brc Sm
303Turn on/off increasing the E1 receiver non linear sensitivity to -30 dB (E1
304only).
329(E1 only.)
305In of state the sensitivity is -12 dB.
330In of state the sensitivity is -12 dB.
306This allows increasing line
307distance.
331Turn on/off increasing the E1 receiver's non-linear sensitivity to -30dB.
332This allows increasing of the line distance.
308.It Sm Cm cablen No = Bro Cm on , off Brc Sm
333.It Sm Cm cablen No = Bro Cm on , off Brc Sm
309(Only for Tau-PCI/T3 and Tau-PCI/STS-1.)
310Turn on/off adjusting transmit signal for long cable T3/STS-1.
334(Tau-PCI/T3 and Tau-PCI/STS-1 only.)
335Turn on/off adjusting of the transmit signal for a long cable T3/STS-1.
311.It Sm Cm monitor No = Bro Cm on , off Brc Sm
336.It Sm Cm monitor No = Bro Cm on , off Brc Sm
312Turn on/off increasing the E1 receiver lines sensitivity to -30 dB.
313(Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1 only.)
337(Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1 only.)
314This could be used for interception
315purposes.
338Turn on/off increasing of the E1 receiver's linear sensitivity to -30dB.
339This can be used for the interception purposes.
316.It Sm Cm phony No = Bro Cm on , off Brc Sm
340.It Sm Cm phony No = Bro Cm on , off Brc Sm
317Turn on/off the so-called phony mode.
318(Tau32-PCI and Tau-PCI E1 family only.)
341(Tau32-PCI and Tau-PCI E1 family only.)
342Turn on/off the so-called
343.Dq phony
344mode.
319This mode allows
345This mode allows
320receiving raw CEPT frames from E1 line.
321Raw frames could be accessed, for
322example, via raw protocol.
323Packets would come at rate of 500 frames per second
346receiving raw CEPT frames from the E1 line.
347Raw frames can be accessed, for example, with the raw protocol.
348Packets would come at a rate of 500 frames per second
324with length
325.No 16* Ns Ar N
326(for Tau-PCI/E1 model), where
327.Ar N
328is the number of timeslots.
329For
349with length
350.No 16* Ns Ar N
351(for Tau-PCI/E1 model), where
352.Ar N
353is the number of timeslots.
354For
330Tau-PCI/2E1 and Tau-PCI/4E1 N should be equal to 32 independently from number of
355Tau-PCI/2E1 and Tau-PCI/4E1,
356.Ar N
357should be equal to 32 regardless of the number of
331used timeslots.
332.It Sm Cm unfram No = Bro Cm on , off Brc Sm
358used timeslots.
359.It Sm Cm unfram No = Bro Cm on , off Brc Sm
333Turn on/off unframed mode.
334(Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1 only.)
360(Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1 only.)
361Turn on/off unframed mode.
335.Bl -tag -width ".Cm unfram Ns = Ns Cm off"
336.It Cm unfram Ns = Ns Cm on
362.Bl -tag -width ".Cm unfram Ns = Ns Cm off"
363.It Cm unfram Ns = Ns Cm on
337switches channel to unframed G.703 mode.
364Switch channel to the unframed G.703 mode.
338.It Cm unfram Ns = Ns Cm off
365.It Cm unfram Ns = Ns Cm off
339switches channel to framed E1 (G.704 mode).
366Switch channel to the framed E1 (G.704) mode.
340.El
341.It Sm Cm scrambler No = Bro Cm on , off Brc Sm
367.El
368.It Sm Cm scrambler No = Bro Cm on , off Brc Sm
342Turn on/off the scrambling of G.703 data.
343(Tau32-PCI, Tau-PCI/G.703 and Tau-PCI/2E1,
369(Tau32-PCI, Tau-PCI/G.703, Tau-PCI/2E1, and
344Tau-PCI/4E1 in unframed mode only.)
370Tau-PCI/4E1 in unframed mode only.)
371Turn on/off scrambling of the G.703 data.
345.It Sm Cm use16 No = Bro Cm on , off Brc Sm
372.It Sm Cm use16 No = Bro Cm on , off Brc Sm
346Turn on/off the usage of 16-th timeslot for data transmission.
347(Tau32-PCI and Tau-PCI E1 family only.)
373(Tau32-PCI and Tau-PCI E1 family only.)
348Normally 16th timeslot is used for signaling information (multiframing CAS).
374Turn on/off the usage of the 16th timeslot for data transmission.
375Normally, the 16th timeslot is used for signalling information
376(multiframing CAS).
349.It Sm Cm crc4 No = Bro Cm on , off Brc Sm
377.It Sm Cm crc4 No = Bro Cm on , off Brc Sm
350Turn on/off CRC4 superframe mode.
351(E1 only.)
378(E1 only.)
379Turn on/off CRC4 superframe mode.
352.It Sm Cm syn No = Bro Cm int , rcv , rcv0 , rcv1 , rcv2 , rcv3 Brc Sm
353.Bl -tag -width ".Cm rcv3"
354.It Cm int
380.It Sm Cm syn No = Bro Cm int , rcv , rcv0 , rcv1 , rcv2 , rcv3 Brc Sm
381.Bl -tag -width ".Cm rcv3"
382.It Cm int
355use an internal clock generator for G703 transmitter
383Use an internal clock generator for G703 transmitter
356(clock master).
357.It Cm rcv
384(clock master).
385.It Cm rcv
358use the G703 receiver data clock as the transmit clock
386Use the G703 receiver data clock as the transmit clock
359(clock slave).
360.It Cm rcv0 , rcv1 , rcv2 , rcv3
387(clock slave).
388.It Cm rcv0 , rcv1 , rcv2 , rcv3
361use the G703 receiver clock of the other channel
389Use the G703 receiver clock of the other channel
362(E1 models only).
363.El
364.It Cm dir Ns = Ns Ar number
390(E1 models only).
391.El
392.It Cm dir Ns = Ns Ar number
365Binds logical channel to the physical channel.
366(Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1 only.)
393(Tau32-PCI, Tau-PCI/2E1 and Tau-PCI/4E1 only.)
367Using this parameter you could, for example, split E1 physical channel
368into several channels.
394Bind a logical channel to a physical channel.
395Using this parameter it is possible, for example, to split
396physical E1 channel into several logical channels.
369.It Cm ts Ns = Ns Ar interval
397.It Cm ts Ns = Ns Ar interval
370Set up the list of timeslots to use by the channel (E1 only).
371The
372timeslots are numbered from 1 to 31, and are separated by comma or minus sign,
398(E1 only.)
399Set up the list of timeslots for use by the channel.
400The timeslots are numbered from 1 to 31,
401and are separated by a comma or a minus sign,
373giving an interval.
402giving an interval.
374For example:
403Example:
375.Dq Li ts=1-3,5,17 .
376.It Cm pass Ns = Ns Ar interval
404.Dq Li ts=1-3,5,17 .
405.It Cm pass Ns = Ns Ar interval
406(Tau/E1 only.)
377Set up the list of timeslots, translated to the E1 subchannel in
378.Cm cfg Ns = Ns Cm B
379and
380.Cm cfg Ns = Ns Cm C
381configurations.
407Set up the list of timeslots, translated to the E1 subchannel in
408.Cm cfg Ns = Ns Cm B
409and
410.Cm cfg Ns = Ns Cm C
411configurations.
382(Tau/E1 only.)
383.It Sm Cm debug No = Bro Cm 0 , 1 , 2 Brc Sm
384Turn on/off debug messages.
385.Bl -tag -width 2n
386.It Cm 0
412.It Sm Cm debug No = Bro Cm 0 , 1 , 2 Brc Sm
413Turn on/off debug messages.
414.Bl -tag -width 2n
415.It Cm 0
387turn off debug messages.
416Turn debug messages off.
388.It Cm 1
417.It Cm 1
389turn on debug
390messages, equal to the
418Turn debug messages on, equivalent to the
391.Cm debug
419.Cm debug
392option to the
420option of the
393.Xr ifconfig 8
394utility.
395.It Cm 2
421.Xr ifconfig 8
422utility.
423.It Cm 2
396high intensive debug message, developers only.
424High intensive debug messages, for developers only.
397.El
398.El
399.\"--------------------------------------------------------------
400.Sh EXAMPLES
425.El
426.El
427.\"--------------------------------------------------------------
428.Sh EXAMPLES
401Set up the channel 1 for use with the HDSL modem or any other
429Set up channel 1 for use with the HDSL modem or any other
402synchronous leased-line modem, and PPP/HDLC protocol (for Sigma):
403.Bd -literal -offset indent
404sconfig cx1 ppp extclock
405ifconfig cx1 158.250.244.2 158.250.244.1 up
406.Ed
407.Pp
430synchronous leased-line modem, and PPP/HDLC protocol (for Sigma):
431.Bd -literal -offset indent
432sconfig cx1 ppp extclock
433ifconfig cx1 158.250.244.2 158.250.244.1 up
434.Ed
435.Pp
408Set up the channel 0 of Tau/E1 for use with the Cisco protocol
409over E1 link, with the single virtual connection.
436Set up channel 0 of Tau/E1 for use with the Cisco protocol
437over the E1 link, with a single virtual connection.
410The DLCI number is detected automatically.
411Use timeslots 1-10:
412.Bd -literal -offset indent
413sconfig ct0 cisco ts=1-10
414ifconfig ct0 158.250.244.2 158.250.244.1 up
415.Ed
416.Pp
438The DLCI number is detected automatically.
439Use timeslots 1-10:
440.Bd -literal -offset indent
441sconfig ct0 cisco ts=1-10
442ifconfig ct0 158.250.244.2 158.250.244.1 up
443.Ed
444.Pp
417Set up the channel 0 for the synchronous null-modem link to the nearby computer,
445Set up channel 0 for the synchronous null-modem link to the nearby computer,
418internal clock source, 256000 bits/sec, protocol Cisco/HDLC (for Tau):
419.Bd -literal -offset indent
420sconfig ct0 cisco 256000
421ifconfig ct0 200.1.1.1 200.1.1.2 up
422.Ed
423.Pp
446internal clock source, 256000 bits/sec, protocol Cisco/HDLC (for Tau):
447.Bd -literal -offset indent
448sconfig ct0 cisco 256000
449ifconfig ct0 200.1.1.1 200.1.1.2 up
450.Ed
451.Pp
424Set up the channel 1 for the leased line link using data-only
452Set up channel 1 for the leased line link using the data-only
425null-modem cable (or modems like Zelax+ M115).
426Synchronous DPLL mode, 128000
427bits/sec, protocol PPP/HDLC, NRZI encoding (for Sigma):
428.Bd -literal -offset indent
429sconfig cx1 ppp 128000 nrzi=on dpll=on
430ifconfig cx1 158.250.244.2 158.250.244.1 up
431.Ed
432.\"--------------------------------------------------------------
433.Sh DIAGNOSTICS
453null-modem cable (or modems like Zelax+ M115).
454Synchronous DPLL mode, 128000
455bits/sec, protocol PPP/HDLC, NRZI encoding (for Sigma):
456.Bd -literal -offset indent
457sconfig cx1 ppp 128000 nrzi=on dpll=on
458ifconfig cx1 158.250.244.2 158.250.244.1 up
459.Ed
460.\"--------------------------------------------------------------
461.Sh DIAGNOSTICS
434This section contains description of abbreviations used by
462This section contains a description of abbreviations used by
435.Nm
436while displaying various statistics.
463.Nm
464while displaying various statistics.
437For description of options connected with
438statistics see above.
465For a description of options related to
466statistics, please see above.
439.\"--------------------------------------------------------------
440.Ss Statistics
467.\"--------------------------------------------------------------
468.Ss Statistics
441When running, the driver gathers the statistics about the channels, which
442could be accessed via the
469When running, the driver gathers statistics about the channels, which
470can be accessed using the
443.Nm
471.Nm
444utility or by
472utility,
473or through the
445.Xr ioctl 2
446call
447.Dv SERIAL_GETSTAT .
474.Xr ioctl 2
475call
476.Dv SERIAL_GETSTAT .
448.Bl -tag -width indent
477.Pp
478.Bl -tag -width indent -compact
449.It Va Rintr
479.It Va Rintr
450The total number of receive interrupts.
480Total number of receive interrupts.
451.It Va Tintr
481.It Va Tintr
452The total number of transmit interrupts.
482Total number of transmit interrupts.
453.It Va Mintr
483.It Va Mintr
454The total number of modem interrupts.
484Total number of modem interrupts.
455.It Va Ibytes
485.It Va Ibytes
456The total bytes received.
486Total bytes received.
457.It Va Ipkts
487.It Va Ipkts
458The total packets received (for HDLC mode).
488Total packets received (for HDLC mode).
459.It Va Ierrs
489.It Va Ierrs
460The number of receive errors.
490Number of receive errors.
461.It Va Obytes
491.It Va Obytes
462The total bytes transmitted.
492Total bytes transmitted.
463.It Va Opkts
493.It Va Opkts
464The total packets transmitted (for HDLC mode).
494Total packets transmitted (for HDLC mode).
465.It Va Oerrs
495.It Va Oerrs
466The number of transmit errors.
496Number of transmit errors.
467.El
468.\"--------------------------------------------------------------
469.Ss E1/G.703 Statistics
497.El
498.\"--------------------------------------------------------------
499.Ss E1/G.703 Statistics
470For E1 and G.703 channels the SNMP-compatible statistics data are gathered
500For E1 and G.703 channels, the SNMP-compatible statistics data are gathered
471(see RFC 1406).
501(see RFC 1406).
472It could be accessed via the
502It can be accessed using the
473.Nm
503.Nm
474utility or by
504utility,
505or through the
475.Xr ioctl 2
476call
477.Dv SERIAL_GETESTAT .
506.Xr ioctl 2
507call
508.Dv SERIAL_GETESTAT .
478.Bl -tag -width indent
509.Bl -tag -width ".Va RCRC Pq Va rcrce"
479.It Va Unav Pq Va uas
510.It Va Unav Pq Va uas
480Unavailable seconds - receiving all ones, or loss of carrier, or loss of
511Unavailable seconds: receiving all ones, loss of carrier, or loss of
481signal.
482.It Va Degr Pq Va dm
512signal.
513.It Va Degr Pq Va dm
483Degraded minutes - having error rate more than 10e-6, not counting unavailable
514Degraded minutes: having error rate more than 10E-6, not counting unavailable
484and severely errored seconds.
485.It Va Bpv Pq Va bpv
486HDB3 bipolar violation errors.
487.It Va Fsyn Pq Va fse
488Frame synchronization errors (E1 only).
489.It Va CRC Pq Va crce
490CRC4 errors (E1).
491.It Va RCRC Pq Va rcrce
492Remote CRC4 errors: E-bit counter (E1).
493.It Va Err Pq Va es
515and severely errored seconds.
516.It Va Bpv Pq Va bpv
517HDB3 bipolar violation errors.
518.It Va Fsyn Pq Va fse
519Frame synchronization errors (E1 only).
520.It Va CRC Pq Va crce
521CRC4 errors (E1).
522.It Va RCRC Pq Va rcrce
523Remote CRC4 errors: E-bit counter (E1).
524.It Va Err Pq Va es
494Errored seconds - any framing errors, or out of frame sync, or any slip events.
525Errored seconds: any framing errors, or out of frame sync, or any slip events.
495.It Va Lerr Pq Va les
526.It Va Lerr Pq Va les
496Line errored seconds - any BPV.
527Line errored seconds: any BPV.
497.It Va Sev Pq Va ses
528.It Va Sev Pq Va ses
498Severely errored seconds - 832 or more framing errors, or 2048 or more bipolar
529Severely errored seconds: 832 or more framing errors, or 2048 or more bipolar
499violations.
500.It Va Bur Pq Va bes
530violations.
531.It Va Bur Pq Va bes
501Bursty errored seconds - more than 1 framing error, but not severely errored.
532Bursty errored seconds: more than 1 framing error, but not severely errored.
502.It Va Oof Pq Va oofs
533.It Va Oof Pq Va oofs
503Severely errored framing seconds - out of frame sync.
534Severely errored framing seconds: out of frame sync.
504.It Va Slp Pq Va css
535.It Va Slp Pq Va css
505Controlled slip second \[em] any slip buffer overflow or underflow.
536Controlled slip seconds: any slip buffer overflow or underflow.
506.El
507.\"--------------------------------------------------------------
508.Ss E1/G.703 Status
509The
510.Nm
511utility also prints the E1/G.703 channel status.
537.El
538.\"--------------------------------------------------------------
539.Ss E1/G.703 Status
540The
541.Nm
542utility also prints the E1/G.703 channel status.
512The status could have the
513following values (nonexclusive):
514.Bl -tag -width indent
543The status can have the
544following values (non-exclusive):
545.Pp
546.Bl -tag -width ".Li FARLOMF" -compact
515.It Li Ok
547.It Li Ok
516The channel is in valid state, synchronized.
548The channel is in a valid state, synchronized.
517.It Li LOS
518Loss of sync.
519.It Li AIS
520Receiving unframed all ones (E1 only).
521.It Li LOF
522Loss of framing (E1 only).
523.It Li LOMF
524Loss of multiframing (E1 only).
525.It Li FARLOF
526Receiving remote alarm (E1 only).
527.It Li AIS16
549.It Li LOS
550Loss of sync.
551.It Li AIS
552Receiving unframed all ones (E1 only).
553.It Li LOF
554Loss of framing (E1 only).
555.It Li LOMF
556Loss of multiframing (E1 only).
557.It Li FARLOF
558Receiving remote alarm (E1 only).
559.It Li AIS16
528Receiving all ones in timeslot 16 (E1 only).
560Receiving all ones in the timeslot 16 (E1 only).
529.It Li FARLOMF
530Receiving distant multiframe alarm (E1 only).
531.It Li TSTREQ
532Receiving test request code (G.703 only).
533.It Li TSTERR
534Test error (G.703 only).
535.El
536.\"--------------------------------------------------------------
537.Sh SEE ALSO
538.Xr stty 1 ,
539.Xr ioctl 2 ,
540.Xr sppp 4 ,
541.Xr ifconfig 8 ,
542.Xr route 8 ,
543.Xr spppconrol 8
544.\"--------------------------------------------------------------
545.Sh HISTORY
561.It Li FARLOMF
562Receiving distant multiframe alarm (E1 only).
563.It Li TSTREQ
564Receiving test request code (G.703 only).
565.It Li TSTERR
566Test error (G.703 only).
567.El
568.\"--------------------------------------------------------------
569.Sh SEE ALSO
570.Xr stty 1 ,
571.Xr ioctl 2 ,
572.Xr sppp 4 ,
573.Xr ifconfig 8 ,
574.Xr route 8 ,
575.Xr spppconrol 8
576.\"--------------------------------------------------------------
577.Sh HISTORY
546This utility is a replacement of utilities
578This utility is a replacement for the
547.Nm cxconfig
548and
549.Nm ctconfig
579.Nm cxconfig
580and
581.Nm ctconfig
550that was used in past with
582utilities that were used in the past with
551.Fx
552drivers.
583.Fx
584drivers.
553Those two utilities and the present
554utility are not compatible.
555And therefore all scripts should be rewritten.
556More over,
585Those two utilities and
586.Nm
587are not compatible,
588and therefore all scripts using them have to be rewritten.
589Moreover,
557.Tn Linux
558and
559.Fx
590.Tn Linux
591and
592.Fx
560version of present utility not fully compatible.
593versions of the
594.Nm
595utility are not fully compatible.
561.\"--------------------------------------------------------------
596.\"--------------------------------------------------------------
562.Sh BUGS
563All software produced by Cronyx Engineering is thoroughly tested.
564But
565as created by the man it can contain some bugs.
566If you have caught one, try to localize it and send a letter with description
567of this bug and all operation that you have done.
568We will try to reproduce
569an error and fix it.
570.\"--------------------------------------------------------------
571.Sh CONTACT
572E-mail:
573.Aq info@cronyx.ru
597.Sh AUTHORS
598.An Cronyx Engineering Aq info@cronyx.ru
574.Pp
575.Pa http://www.cronyx.ru
599.Pp
600.Pa http://www.cronyx.ru
601.\"--------------------------------------------------------------
602.Sh BUGS
603All software produced by Cronyx Engineering is thoroughly tested.
604But as created by a man, it can contain some bugs.
605If you have caught one, try to localize it and send an email with the
606description of the bug, and all operations that you have done.
607We will try to reproduce the error and fix it.