Documentation/networking/z8530drv.txt:19: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:29: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:223: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:226: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:233: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:251: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:278: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:286: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:287: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:288: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:291: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:292: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:293: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:306: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:307: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:308: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:309: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:310: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:354: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:393: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:414: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:416: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:450: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:451: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:452: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:453: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:454: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:455: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:462: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:463: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:464: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:465: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:471: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:472: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:478: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:479: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:480: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:481: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:482: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:489: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:492: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:494: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:495: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:497: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:498: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:499: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:505: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:506: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:509: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:514: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:515: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:516: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:517: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:519: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:520: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:522: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:523: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:528: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:534: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:535: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:544: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:558: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:559: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:561: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:562: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:563: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:564: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:565: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:567: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:571: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:573: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:575: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:576: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:580: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:582: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:583: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:598: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:603: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:604: ERROR: trailing whitespace Documentation/networking/z8530drv.txt:610: ERROR: trailing whitespace Signed-off-by: Andrea Gelmini <andrea.gelmini@xxxxxxxxx> --- Documentation/networking/z8530drv.txt | 160 ++++++++++++++++---------------- 1 files changed, 80 insertions(+), 80 deletions(-) diff --git a/Documentation/networking/z8530drv.txt b/Documentation/networking/z8530drv.txt index 2206abb..749e6fc 100644 --- a/Documentation/networking/z8530drv.txt +++ b/Documentation/networking/z8530drv.txt @@ -16,7 +16,7 @@ http://yaina.de/jreuter ----------------------------------------------------------------------------- - SCC.C - Linux driver for Z8530 based HDLC cards for AX.25 + SCC.C - Linux driver for Z8530 based HDLC cards for AX.25 ******************************************************************** @@ -26,7 +26,7 @@ http://yaina.de/jreuter for the complete copyright notice see >> Copying.Z8530DRV << - ******************************************************************** + ******************************************************************** 1. Initialization of the driver @@ -220,17 +220,17 @@ The utility "gencfg" If you only know the parameters for the PE1CHL driver for DOS, run gencfg. It will generate the correct port addresses (I hope). Its parameters are exactly the same as the ones you use with -the "attach scc" command in net, except that the string "init" must +the "attach scc" command in net, except that the string "init" must not appear. Example: -gencfg 2 0x150 4 2 0 1 0x168 9 4915200 +gencfg 2 0x150 4 2 0 1 0x168 9 4915200 will print a skeleton z8530drv.conf for the OptoSCC to stdout. gencfg 2 0x300 2 4 5 -4 0 7 4915200 0x10 does the same for the BAYCOM USCC card. In my opinion it is much easier -to edit scc_config.h... +to edit scc_config.h... 1.2.2 channel configuration @@ -248,7 +248,7 @@ device scc0 # the device for the following params # MODEM / BUFFERS speed 1200 # the default baudrate -clock dpll # clock source: +clock dpll # clock source: # dpll = normal half duplex operation # external = MODEM provides own Rx/Tx clock # divider = use full duplex divider if @@ -275,7 +275,7 @@ idle 3 maxdef 120 group 0 txoff off -softdcd on +softdcd on slip off The order WITHIN these sections is unimportant. The order OF these @@ -283,14 +283,14 @@ sections IS important. The MODEM parameters are set with the first recognized KISS parameter... Please note that you can initialize the board only once after boot -(or insmod). You can change all parameters but "mode" and "clock" -later with the Sccparam program or through KISS. Just to avoid -security holes... +(or insmod). You can change all parameters but "mode" and "clock" +later with the Sccparam program or through KISS. Just to avoid +security holes... (1) this divider is usually mounted on the SCC-PBC (PA0HZP) or not - present at all (BayCom). It feeds back the output of the DPLL - (digital pll) as transmit clock. Using this mode without a divider - installed will normally result in keying the transceiver until + present at all (BayCom). It feeds back the output of the DPLL + (digital pll) as transmit clock. Using this mode without a divider + installed will normally result in keying the transceiver until maxkey expires --- of course without sending anything (useful). 2. Attachment of a channel by your AX.25 software @@ -303,11 +303,11 @@ To set up an AX.25 device you can simply type: ifconfig scc0 44.128.1.1 hw ax25 dl0tha-7 -This will create a network interface with the IP number 44.128.20.107 -and the callsign "dl0tha". If you do not have any IP number (yet) you -can use any of the 44.128.0.0 network. Note that you do not need -axattach. The purpose of axattach (like slattach) is to create a KISS -network device linked to a TTY. Please read the documentation of the +This will create a network interface with the IP number 44.128.20.107 +and the callsign "dl0tha". If you do not have any IP number (yet) you +can use any of the 44.128.0.0 network. Note that you do not need +axattach. The purpose of axattach (like slattach) is to create a KISS +network device linked to a TTY. Please read the documentation of the ax25-utils and the AX.25-HOWTO to learn how to set the parameters of the kernel AX.25. @@ -351,7 +351,7 @@ Or simply use "kissbridge" coming with z8530drv-utils: 3.1 Displaying SCC Parameters: ============================== -Once a SCC channel has been attached, the parameter settings and +Once a SCC channel has been attached, the parameter settings and some statistic information can be shown using the param program: dl1bke-u:~$ sccstat scc0 @@ -390,7 +390,7 @@ The status info shown is: Sent - number of frames transmitted Received - number of frames received RxErrors - number of receive errors (CRC, ABORT) -TxErrors - number of discarded Tx frames (due to various reasons) +TxErrors - number of discarded Tx frames (due to various reasons) Tx State - status of the Tx interrupt handler: idle/busy/active/tail (2) RxOver - number of receiver overruns TxUnder - number of transmitter underruns @@ -411,9 +411,9 @@ driver or the kernel AX.25. ====================== -The setting of parameters of the emulated KISS TNC is done in the +The setting of parameters of the emulated KISS TNC is done in the same way in the SCC driver. You can change parameters by using -the kissparms program from the ax25-utils package or use the program +the kissparms program from the ax25-utils package or use the program "sccparam": sccparam <device> <paramname> <decimal-|hexadecimal value> @@ -447,92 +447,92 @@ speed: Example: sccparam /dev/scc3 speed 9600 txdelay: - The delay (in units of 10 ms) after keying of the - transmitter, until the first byte is sent. This is usually - called "TXDELAY" in a TNC. When 0 is specified, the driver - will just wait until the CTS signal is asserted. This - assumes the presence of a timer or other circuitry in the - MODEM and/or transmitter, that asserts CTS when the + The delay (in units of 10 ms) after keying of the + transmitter, until the first byte is sent. This is usually + called "TXDELAY" in a TNC. When 0 is specified, the driver + will just wait until the CTS signal is asserted. This + assumes the presence of a timer or other circuitry in the + MODEM and/or transmitter, that asserts CTS when the transmitter is ready for data. A normal value of this parameter is 30-36. Example: sccparam /dev/scc0 txd 20 persist: - This is the probability that the transmitter will be keyed - when the channel is found to be free. It is a value from 0 - to 255, and the probability is (value+1)/256. The value - should be somewhere near 50-60, and should be lowered when + This is the probability that the transmitter will be keyed + when the channel is found to be free. It is a value from 0 + to 255, and the probability is (value+1)/256. The value + should be somewhere near 50-60, and should be lowered when the channel is used more heavily. Example: sccparam /dev/scc2 persist 20 slottime: - This is the time between samples of the channel. It is - expressed in units of 10 ms. About 200-300 ms (value 20-30) + This is the time between samples of the channel. It is + expressed in units of 10 ms. About 200-300 ms (value 20-30) seems to be a good value. Example: sccparam /dev/scc0 slot 20 tail: - The time the transmitter will remain keyed after the last - byte of a packet has been transferred to the SCC. This is - necessary because the CRC and a flag still have to leave the - SCC before the transmitter is keyed down. The value depends - on the baudrate selected. A few character times should be + The time the transmitter will remain keyed after the last + byte of a packet has been transferred to the SCC. This is + necessary because the CRC and a flag still have to leave the + SCC before the transmitter is keyed down. The value depends + on the baudrate selected. A few character times should be sufficient, e.g. 40ms at 1200 baud. (value 4) The value of this parameter is in 10 ms units. Example: sccparam /dev/scc2 4 full: - The full-duplex mode switch. This can be one of the following + The full-duplex mode switch. This can be one of the following values: - 0: The interface will operate in CSMA mode (the normal + 0: The interface will operate in CSMA mode (the normal half-duplex packet radio operation) - 1: Fullduplex mode, i.e. the transmitter will be keyed at - any time, without checking the received carrier. It + 1: Fullduplex mode, i.e. the transmitter will be keyed at + any time, without checking the received carrier. It will be unkeyed when there are no packets to be sent. - 2: Like 1, but the transmitter will remain keyed, also - when there are no packets to be sent. Flags will be - sent in that case, until a timeout (parameter 10) + 2: Like 1, but the transmitter will remain keyed, also + when there are no packets to be sent. Flags will be + sent in that case, until a timeout (parameter 10) occurs. Example: sccparam /dev/scc0 fulldup off wait: - The initial waittime before any transmit attempt, after the - frame has been queue for transmit. This is the length of + The initial waittime before any transmit attempt, after the + frame has been queue for transmit. This is the length of the first slot in CSMA mode. In full duplex modes it is set to 0 for maximum performance. - The value of this parameter is in 10 ms units. + The value of this parameter is in 10 ms units. Example: sccparam /dev/scc1 wait 4 maxkey: - The maximal time the transmitter will be keyed to send - packets, in seconds. This can be useful on busy CSMA - channels, to avoid "getting a bad reputation" when you are - generating a lot of traffic. After the specified time has + The maximal time the transmitter will be keyed to send + packets, in seconds. This can be useful on busy CSMA + channels, to avoid "getting a bad reputation" when you are + generating a lot of traffic. After the specified time has elapsed, no new frame will be started. Instead, the trans- - mitter will be switched off for a specified time (parameter - min), and then the selected algorithm for keyup will be + mitter will be switched off for a specified time (parameter + min), and then the selected algorithm for keyup will be started again. - The value 0 as well as "off" will disable this feature, - and allow infinite transmission time. + The value 0 as well as "off" will disable this feature, + and allow infinite transmission time. Example: sccparam /dev/scc0 maxk 20 min: - This is the time the transmitter will be switched off when + This is the time the transmitter will be switched off when the maximum transmission time is exceeded. Example: sccparam /dev/scc3 min 10 idle - This parameter specifies the maximum idle time in full duplex - 2 mode, in seconds. When no frames have been sent for this + This parameter specifies the maximum idle time in full duplex + 2 mode, in seconds. When no frames have been sent for this time, the transmitter will be keyed down. A value of 0 is has same result as the fullduplex mode 1. This parameter can be disabled. @@ -541,7 +541,7 @@ idle maxdefer This is the maximum time (in seconds) to wait for a free channel - to send. When this timer expires the transmitter will be keyed + to send. When this timer expires the transmitter will be keyed IMMEDIATELY. If you love to get trouble with other users you should set this to a very low value ;-) @@ -555,32 +555,32 @@ txoff: Example: sccparam /dev/scc2 txoff on group: - It is possible to build special radio equipment to use more than - one frequency on the same band, e.g. using several receivers and + It is possible to build special radio equipment to use more than + one frequency on the same band, e.g. using several receivers and only one transmitter that can be switched between frequencies. - Also, you can connect several radios that are active on the same - band. In these cases, it is not possible, or not a good idea, to - transmit on more than one frequency. The SCC driver provides a - method to lock transmitters on different interfaces, using the - "param <interface> group <x>" command. This will only work when + Also, you can connect several radios that are active on the same + band. In these cases, it is not possible, or not a good idea, to + transmit on more than one frequency. The SCC driver provides a + method to lock transmitters on different interfaces, using the + "param <interface> group <x>" command. This will only work when you are using CSMA mode (parameter full = 0). - The number <x> must be 0 if you want no group restrictions, and + The number <x> must be 0 if you want no group restrictions, and can be computed as follows to create restricted groups: <x> is the sum of some OCTAL numbers: - 200 This transmitter will only be keyed when all other + 200 This transmitter will only be keyed when all other transmitters in the group are off. - 100 This transmitter will only be keyed when the carrier + 100 This transmitter will only be keyed when the carrier detect of all other interfaces in the group is off. - 0xx A byte that can be used to define different groups. - Interfaces are in the same group, when the logical AND + 0xx A byte that can be used to define different groups. + Interfaces are in the same group, when the logical AND between their xx values is nonzero. Examples: - When 2 interfaces use group 201, their transmitters will never be + When 2 interfaces use group 201, their transmitters will never be keyed at the same time. - When 2 interfaces use group 101, the transmitters will only key - when both channels are clear at the same time. When group 301, + When 2 interfaces use group 101, the transmitters will only key + when both channels are clear at the same time. When group 301, the transmitters will not be keyed at the same time. Don't forget to convert the octal numbers into decimal before @@ -595,19 +595,19 @@ softdcd: Example: sccparam /dev/scc0 soft on -4. Problems +4. Problems =========== If you have tx-problems with your BayCom USCC card please check the manufacturer of the 8530. SGS chips have a slightly -different timing. Try Zilog... A solution is to write to register 8 -instead to the data port, but this won't work with the ESCC chips. +different timing. Try Zilog... A solution is to write to register 8 +instead to the data port, but this won't work with the ESCC chips. *SIGH!* A very common problem is that the PTT locks until the maxkeyup timer expires, although interrupts and clock source are correct. In most cases compiling the driver with CONFIG_SCC_DELAY (set with -make config) solves the problems. For more hints read the (pseudo) FAQ +make config) solves the problems. For more hints read the (pseudo) FAQ and the documentation coming with z8530drv-utils. I got reports that the driver has problems on some 386-based systems. -- 1.7.1.251.gf80a2 -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
