Merge tag 'for-linus' of git://github.com/openrisc/linux
[linux/fpc-iii.git] / Documentation / networking / framerelay.rst
blob6d904399ec6ded4dc68732ca8dfbbbdc2d88d690
1 .. SPDX-License-Identifier: GPL-2.0
3 ================
4 Frame Relay (FR)
5 ================
7 Frame Relay (FR) support for linux is built into a two tiered system of device
8 drivers.  The upper layer implements RFC1490 FR specification, and uses the
9 Data Link Connection Identifier (DLCI) as its hardware address.  Usually these
10 are assigned by your network supplier, they give you the number/numbers of
11 the Virtual Connections (VC) assigned to you.
13 Each DLCI is a point-to-point link between your machine and a remote one.
14 As such, a separate device is needed to accommodate the routing.  Within the
15 net-tools archives is 'dlcicfg'.  This program will communicate with the
16 base "DLCI" device, and create new net devices named 'dlci00', 'dlci01'...
17 The configuration script will ask you how many DLCIs you need, as well as
18 how many DLCIs you want to assign to each Frame Relay Access Device (FRAD).
20 The DLCI uses a number of function calls to communicate with the FRAD, all
21 of which are stored in the FRAD's private data area.  assoc/deassoc,
22 activate/deactivate and dlci_config.  The DLCI supplies a receive function
23 to the FRAD to accept incoming packets.
25 With this initial offering, only 1 FRAD driver is available.  With many thanks
26 to Sangoma Technologies, David Mandelstam & Gene Kozin, the S502A, S502E &
27 S508 are supported.  This driver is currently set up for only FR, but as
28 Sangoma makes more firmware modules available, it can be updated to provide
29 them as well.
31 Configuration of the FRAD makes use of another net-tools program, 'fradcfg'.
32 This program makes use of a configuration file (which dlcicfg can also read)
33 to specify the types of boards to be configured as FRADs, as well as perform
34 any board specific configuration.  The Sangoma module of fradcfg loads the
35 FR firmware into the card, sets the irq/port/memory information, and provides
36 an initial configuration.
38 Additional FRAD device drivers can be added as hardware is available.
40 At this time, the dlcicfg and fradcfg programs have not been incorporated into
41 the net-tools distribution.  They can be found at ftp.invlogic.com, in
42 /pub/linux.  Note that with OS/2 FTPD, you end up in /pub by default, so just
43 use 'cd linux'.  v0.10 is for use on pre-2.0.3 and earlier, v0.15 is for
44 pre-2.0.4 and later.