Documentation/networking/ipddp.rst

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