Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: networking: convert 6pack.txt to ReST

- add SPDX header;
- use title markups;
- mark code blocks and literals as such;
- adjust identation, whitespaces and blank lines;
- add to networking/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>

authored by

Mauro Carvalho Chehab and committed by
David S. Miller
a434aaba da50d57a

+33 -16
+31 -15
Documentation/networking/6pack.txt Documentation/networking/6pack.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ============== 4 + 6pack Protocol 5 + ============== 6 + 1 7 This is the 6pack-mini-HOWTO, written by 2 8 3 9 Andreas Könsgen DG3KQ 4 - Internet: ajk@comnets.uni-bremen.de 5 - AMPR-net: dg3kq@db0pra.ampr.org 6 - AX.25: dg3kq@db0ach.#nrw.deu.eu 10 + 11 + :Internet: ajk@comnets.uni-bremen.de 12 + :AMPR-net: dg3kq@db0pra.ampr.org 13 + :AX.25: dg3kq@db0ach.#nrw.deu.eu 7 14 8 15 Last update: April 7, 1998 9 16 10 17 1. What is 6pack, and what are the advantages to KISS? 18 + ====================================================== 11 19 12 20 6pack is a transmission protocol for data exchange between the PC and 13 21 the TNC over a serial line. It can be used as an alternative to KISS. 14 22 15 23 6pack has two major advantages: 24 + 16 25 - The PC is given full control over the radio 17 26 channel. Special control data is exchanged between the PC and the TNC so 18 27 that the PC knows at any time if the TNC is receiving data, if a TNC 19 28 buffer underrun or overrun has occurred, if the PTT is 20 29 set and so on. This control data is processed at a higher priority than 21 30 normal data, so a data stream can be interrupted at any time to issue an 22 - important event. This helps to improve the channel access and timing 23 - algorithms as everything is computed in the PC. It would even be possible 24 - to experiment with something completely different from the known CSMA and 31 + important event. This helps to improve the channel access and timing 32 + algorithms as everything is computed in the PC. It would even be possible 33 + to experiment with something completely different from the known CSMA and 25 34 DAMA channel access methods. 26 35 This kind of real-time control is especially important to supply several 27 36 TNCs that are connected between each other and the PC by a daisy chain ··· 45 36 in the doc directory of the AX.25 utilities package. 46 37 47 38 2. Who has developed the 6pack protocol? 39 + ======================================== 48 40 49 41 The 6pack protocol has been developed by Ekki Plicht DF4OR, Henning Rech 50 42 DF9IC and Gunter Jost DK7WJ. A driver for 6pack, written by Gunter Jost and ··· 54 44 protocol (see section 4 below). 55 45 56 46 3. Where can I get the latest version of 6pack for LinuX? 47 + ========================================================= 57 48 58 49 At the moment, the 6pack stuff can obtained via anonymous ftp from 59 50 db0bm.automation.fh-aachen.de. In the directory /incoming/dg3kq, 60 51 there is a file named 6pack.tgz. 61 52 62 53 4. Preparing the TNC for 6pack operation 54 + ======================================== 63 55 64 56 To be able to use 6pack, a special firmware for the TNC is needed. The EPROM 65 57 of a newly bought TNC does not contain 6pack, so you will have to ··· 87 75 the TNC correctly. 88 76 89 77 5. Building and installing the 6pack driver 78 + =========================================== 90 79 91 80 The driver has been tested with kernel version 2.1.90. Use with older 92 81 kernels may lead to a compilation error because the interface to a kernel 93 82 function has been changed in the 2.1.8x kernels. 94 83 95 84 How to turn on 6pack support: 85 + ============================= 96 86 97 87 - In the linux kernel configuration program, select the code maturity level 98 88 options menu and turn on the prompting for development drivers. ··· 108 94 has to be modified. 109 95 110 96 - Do a cd to the directory that holds the kissattach sources. Edit the 111 - kissattach.c file. At the top, insert the following lines: 97 + kissattach.c file. At the top, insert the following lines:: 112 98 113 - #ifndef N_6PACK 114 - #define N_6PACK (N_AX25+1) 115 - #endif 99 + #ifndef N_6PACK 100 + #define N_6PACK (N_AX25+1) 101 + #endif 116 102 117 - Then find the line 118 - 119 - int disc = N_AX25; 103 + Then find the line: 104 + 105 + int disc = N_AX25; 120 106 121 107 and replace N_AX25 by N_6PACK. 122 108 123 109 - Recompile kissattach. Rename it to spattach to avoid confusions. 124 110 125 111 Installing the driver: 112 + ---------------------- 126 113 127 - - Do an insmod 6pack. Look at your /var/log/messages file to check if the 114 + - Do an insmod 6pack. Look at your /var/log/messages file to check if the 128 115 module has printed its initialization message. 129 116 130 117 - Do a spattach as you would launch kissattach when starting a KISS port. 131 - Check if the kernel prints the message '6pack: TNC found'. 118 + Check if the kernel prints the message '6pack: TNC found'. 132 119 133 120 - From here, everything should work as if you were setting up a KISS port. 134 121 The only difference is that the network device that represents ··· 153 138 sent to the PC. 154 139 155 140 6. Known problems 141 + ================= 156 142 157 143 When testing the driver with 2.0.3x kernels and 158 144 operating with data rates on the radio channel of 9600 Baud or higher,
+1
Documentation/networking/index.rst
··· 37 37 tls-offload 38 38 nfc 39 39 6lowpan 40 + 6pack 40 41 41 42 .. only:: subproject and html 42 43
+1 -1
drivers/net/hamradio/Kconfig
··· 30 30 31 31 Note that this driver is still experimental and might cause 32 32 problems. For details about the features and the usage of the 33 - driver, read <file:Documentation/networking/6pack.txt>. 33 + driver, read <file:Documentation/networking/6pack.rst>. 34 34 35 35 To compile this driver as a module, choose M here: the module 36 36 will be called 6pack.