arch/all-unix/devs/networks/tap/README

   1 README for tap.device
   2 ---------------------
   3
   4 tap.device is a SANA-II-compliant network driver that allows AROS running in
   5 hosted environments to access the network via the host operating system
   6 (currently Linux only).
   7
   8 This driver is early alpha. Its unfinished in places, and there are probably
   9 several groovy bugs about.
  10
  11
  12 REQUIREMENTS
  13
  14  - The Linux TUN/TAP driver (Linux config item CONFIG_TUN)
  15  - The "tunctl" program, which comes with the uml-utilities package available
  16    at http://user-mode-linux.sourceforge.net/
  17
  18
  19 INSTALLATION
  20
  21  - Build AROS as normal
  22
  23  - As root, create and configure a TAP network interface
  24
  25     # tunctl -b -u <your user name> -t aros0
  26     # ifconfig aros0 192.168.0.1
  27
  28  - As your normal user, start AROS
  29
  30     % ./aros
  31
  32  - Edit SYS:System/Network/AROSTCP/db/interfaces and add the
  33    following line:
  34
  35    eth0 DEV=DEVS:networks/tap.device UNIT=0 IP=192.168.0.188 UP
  36
  37  - Start AROSTCP
  38
  39    > execute SYS:System/Network/AROSTCP/S/startnet
  40
  41  - Ping AROS from Linux
  42
  43    % ping 192.168.0.188
  44
  45 Thats it. AROS can now reach the Linux host, and vice-versa.
  46
  47
  48 NOTES
  49
  50 The driver is extremely verbose. I'm leaving the debug output in place until I
  51 consider the code to be stable. If you want to disable it, edit
  52 arch/all-unix/devs/networks/tap/tap.h and redefine DEBUG to be 0, then
  53 recompile.
  54
  55 The unit number and Linux interface name are linked such that opening unit #0
  56 on the Amiga side will result in attachment to interface aros0 on the Linux
  57 side, unit #1 -> aros1, etc. By default, the driver can handle up to four
  58 units (ie four seperate virtual networks); this can be increased by changing
  59 MAX_TAP_UNITS in tap.h.
  60
  61 To get AROS hosted onto your network, you'll need to look into Linux-side
  62 tools like iptables, brctl, etc.
  63
  64 To remove the TAP interface once AROS has exited, do this:
  65
  66     # tunctl -d aros0
  67
  68 You'd do well to create a startup script that handles all the network setup
  69 for you; something like this might be a good place to start:
  70
  71 --------------------
  72 #!/bin/sh
  73
  74 unit=0
  75 ip=192.168.0.1
  76
  77 iface=$(sudo tunctl -b -u `whoami` -t aros$unit)
  78 sudo ifconfig $iface $ip
  79 ./aros
  80 sudo tunctl -d $iface
  81 --------------------
  82
  83
  84 BUG REPORTING
  85
  86 You'll undoubtedly have problems; this is very new code. Please send reports,
  87 feedback and other comments to me at rob@cataclysm.cx, or talk to "fce2" in
  88 #aros.
  89
  90 If you are having a problem, I'm probably going to ask for debug output, and
  91 possibly steps to reproduce the problem.
  92
  93
  94 TODO
  95
  96  - Deal with remaining XXX items
  97  - Multicast support
  98  - FreeBSD support
  99  - Remove dependency on linux/* headers and host compiler
 100  - Better docs (someone want to write this?)
 101
 102
 103 COPYRIGHT & LICENSE
 104
 105 Copyright (c) 2007 Robert Norris. All rights reserved.
 106
 107 This program is free software; you can redistribute it and/or modify it under
 108 the same terms as AROS itself.