doc/README.NetConsole

   1
   2 In U-Boot, we implemented the networked console via the standard
   3 "devices" mechanism, which means that you can switch between the
   4 serial and network input/output devices by adjusting the 'stdin' and
   5 'stdout' environment variables. To switch to the networked console,
   6 set either of these variables to "nc". Input and output can be
   7 switched independently.
   8
   9 We use an environment variable 'ncip' to set the IP address and the
  10 port of the destination. The format is <ip_addr>:<port>. If <port> is
  11 omitted, the value of 6666 is used. If the env var doesn't exist, the
  12 broadcast address and port 6666 are used. If it is set to an IP
  13 address of 0 (or 0.0.0.0) then no messages are sent to the network.
  14
  15 For example, if your server IP is 192.168.1.1, you could use:
  16
  17         => setenv nc 'setenv stdout nc;setenv stdin nc'
  18         => setenv ncip 192.168.1.1
  19         => saveenv
  20         => run nc
  21
  22
  23 On the host side, please use this script to access the console:
  24
  25 +++++++++++++++++++++++++++++++++++++++++++
  26 #! /bin/bash
  27
  28 [ $# = 1 ] || { echo "Usage: $0 target_ip" >&2 ; exit 1 ; }
  29 TARGET_IP=$1
  30
  31 stty -icanon -echo intr ^T
  32 nc -u -l -p 6666 < /dev/null &
  33 nc -u ${TARGET_IP} 6666
  34 stty icanon echo intr ^C
  35 +++++++++++++++++++++++++++++++++++++++++++
  36
  37 The script expects exactly one argument, which is interpreted as  the
  38 target IP address (or host name, assuming DNS is working). The script
  39 can be interrupted by pressing ^T (CTRL-T).
  40
  41 Be aware that in some distributives (Fedora Core 5 at least)
  42 usage of nc has been changed and -l and -p options are considered
  43 as mutually exclusive. If nc complains about options provided,
  44 you can just remove the -p option from the script.
  45
  46 It turns out that 'netcat' cannot be used to listen to broadcast
  47 packets. We developed our own tool 'ncb' (see tools directory) that
  48 listens to broadcast packets on a given port and dumps them to the
  49 standard output. use it as follows:
  50
  51 +++++++++++++++++++++++++++++++++++++++++++
  52 #! /bin/bash
  53
  54 [ $# = 1 ] || { echo "Usage: $0 target_ip" >&2 ; exit 1 ; }
  55 TARGET_IP=$1
  56
  57 stty icanon echo intr ^T
  58 ./ncb &
  59 nc -u ${TARGET_IP} 6666
  60 stty icanon echo intr ^C
  61 kill 0
  62 +++++++++++++++++++++++++++++++++++++++++++
  63
  64 Again, this script takes exactly one argument, which is interpreted
  65 as the target IP address (or host name, assuming DNS is working). The
  66 script can be interrupted by pressing ^T (CTRL-T).
  67
  68 The 'ncb' tool can be found in the tools directory; it will not be
  69 built by default so you will ither have to adjust the Makefile or
  70 build it manually.
  71
  72
  73 For Linux, the network-based console needs special configuration.
  74 Minimally, the host IP address needs to be specified. This can be
  75 done either via the kernel command line, or by passing parameters
  76 while loading the netconsole.o module (when used in a loadable module
  77 configuration). Please refer to Documentation/networking/logging.txt
  78 file for the original Ingo Molnar's documentation on how to pass
  79 parameters to the loadable module.
  80
  81 The format of the kernel command line parameter (for the static
  82 configuration) is as follows:
  83
  84   netconsole=[src-port]@[src-ip]/[<dev>],[tgt-port]@<tgt-ip>/[tgt-macaddr]
  85
  86 where
  87
  88   src-port      source for UDP packets
  89                 (defaults to 6665)
  90   src-ip        source IP to use
  91                 (defaults to the interface's address)
  92   dev           network interface
  93                 (defaults to eth0)
  94   tgt-port      port for logging agent
  95                 (defaults to 6666)
  96   tgt-ip        IP address for logging agent
  97                 (this is the required parameter)
  98   tgt-macaddr   ethernet MAC address for logging agent
  99                 (defaults to broadcast)
 100
 101 Examples:
 102
 103   netconsole=4444@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc
 104
 105 or
 106
 107   netconsole=@/,@192.168.3.1/
 108
 109 Please note that for the Linux networked console to work, the
 110 ethernet interface has to be up by the time the netconsole driver is
 111 initialized. This means that in case of static kernel configuration,
 112 the respective Ethernet interface has to be brought up using the "IP
 113 Autoconfiguration" kernel feature, which is usually done by defaults
 114 in the ELDK-NFS-based environment.
 115
 116 To browse the Linux network console output, use the 'netcat' tool invoked
 117 as follows:
 118
 119         nc -u -l -p 6666
 120
 121 Note that unlike the U-Boot implementation the Linux netconsole is
 122 unidirectional, i. e. you have console output only in Linux.