Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wirel...
[linux-2.6.git] / Documentation / networking / ipddp.txt
1 Text file for ipddp.c:
2         AppleTalk-IP Decapsulation and AppleTalk-IP Encapsulation
3
4 This text file is written by Jay Schulist <jschlst@samba.org>
5
6 Introduction
7 ------------
8
9 AppleTalk-IP (IPDDP) is the method computers connected to AppleTalk
10 networks can use to communicate via IP. AppleTalk-IP is simply IP datagrams
11 inside AppleTalk packets.
12
13 Through this driver you can either allow your Linux box to communicate
14 IP over an AppleTalk network or you can provide IP gatewaying functions
15 for your AppleTalk users.
16
17 You can currently encapsulate or decapsulate AppleTalk-IP on LocalTalk,
18 EtherTalk and PPPTalk. The only limit on the protocol is that of what
19 kernel AppleTalk layer and drivers are available.
20
21 Each mode requires its own user space software.
22
23 Compiling AppleTalk-IP Decapsulation/Encapsulation
24 =================================================
25
26 AppleTalk-IP decapsulation needs to be compiled into your kernel. You
27 will need to turn on AppleTalk-IP driver support. Then you will need to
28 select ONE of the two options; IP to AppleTalk-IP encapsulation support or
29 AppleTalk-IP to IP decapsulation support. If you compile the driver
30 statically you will only be able to use the driver for the function you have
31 enabled in the kernel. If you compile the driver as a module you can
32 select what mode you want it to run in via a module loading param.
33 ipddp_mode=1 for AppleTalk-IP encapsulation and ipddp_mode=2 for
34 AppleTalk-IP to IP decapsulation.
35
36 Basic instructions for user space tools
37 =======================================
38
39 I will briefly describe the operation of the tools, but you will
40 need to consult the supporting documentation for each set of tools.
41
42 Decapsulation - You will need to download a software package called
43 MacGate. In this distribution there will be a tool called MacRoute
44 which enables you to add routes to the kernel for your Macs by hand.
45 Also the tool MacRegGateWay is included to register the
46 proper IP Gateway and IP addresses for your machine. Included in this
47 distribution is a patch to netatalk-1.4b2+asun2.0a17.2 (available from
48 ftp.u.washington.edu/pub/user-supported/asun/) this patch is optional
49 but it allows automatic adding and deleting of routes for Macs. (Handy
50 for locations with large Mac installations)
51
52 Encapsulation - You will need to download a software daemon called ipddpd.
53 This software expects there to be an AppleTalk-IP gateway on the network.
54 You will also need to add the proper routes to route your Linux box's IP
55 traffic out the ipddp interface.
56
57 Common Uses of ipddp.c
58 ----------------------
59 Of course AppleTalk-IP decapsulation and encapsulation, but specifically
60 decapsulation is being used most for connecting LocalTalk networks to
61 IP networks. Although it has been used on EtherTalk networks to allow
62 Macs that are only able to tunnel IP over EtherTalk.
63
64 Encapsulation has been used to allow a Linux box stuck on a LocalTalk
65 network to use IP. It should work equally well if you are stuck on an
66 EtherTalk only network.
67
68 Further Assistance
69 -------------------
70 You can contact me (Jay Schulist <jschlst@samba.org>) with any
71 questions regarding decapsulation or encapsulation. Bradford W. Johnson
72 <johns393@maroon.tc.umn.edu> originally wrote the ipddp.c driver for IP
73 encapsulation in AppleTalk.