tools/Makefile: Compile ncb when CONFIG_NETCONSOLE
[oweals/u-boot.git] / 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         tools/netconsole <ip> [port]
26
27 The script uses netcat to talk to the board over UDP.  It requires you to
28 specify the target IP address (or host name, assuming DNS is working). The
29 script can be interrupted by pressing ^T (CTRL-T).
30
31 Be aware that in some distributives (Fedora Core 5 at least)
32 usage of nc has been changed and -l and -p options are considered
33 as mutually exclusive. If nc complains about options provided,
34 you can just remove the -p option from the script.
35
36 It turns out that 'netcat' cannot be used to listen to broadcast
37 packets. We developed our own tool 'ncb' (see tools directory) that
38 listens to broadcast packets on a given port and dumps them to the
39 standard output. use it as follows:
40
41 +++++++++++++++++++++++++++++++++++++++++++
42 #! /bin/bash
43
44 [ $# = 1 ] || { echo "Usage: $0 target_ip" >&2 ; exit 1 ; }
45 TARGET_IP=$1
46
47 stty icanon echo intr ^T
48 ./ncb &
49 nc -u ${TARGET_IP} 6666
50 stty icanon echo intr ^C
51 kill 0
52 +++++++++++++++++++++++++++++++++++++++++++
53
54 Again, this script takes exactly one argument, which is interpreted
55 as the target IP address (or host name, assuming DNS is working). The
56 script can be interrupted by pressing ^T (CTRL-T).
57
58 The 'ncb' tool can be found in the tools directory; it will be built
59 when compiling for a board which has CONFIG_NETCONSOLE defined.
60
61 For Linux, the network-based console needs special configuration.
62 Minimally, the host IP address needs to be specified. This can be
63 done either via the kernel command line, or by passing parameters
64 while loading the netconsole.o module (when used in a loadable module
65 configuration). Please refer to Documentation/networking/logging.txt
66 file for the original Ingo Molnar's documentation on how to pass
67 parameters to the loadable module.
68
69 The format of the kernel command line parameter (for the static
70 configuration) is as follows:
71
72   netconsole=[src-port]@[src-ip]/[<dev>],[tgt-port]@<tgt-ip>/[tgt-macaddr]
73
74 where
75
76   src-port      source for UDP packets
77                 (defaults to 6665)
78   src-ip        source IP to use
79                 (defaults to the interface's address)
80   dev           network interface
81                 (defaults to eth0)
82   tgt-port      port for logging agent
83                 (defaults to 6666)
84   tgt-ip        IP address for logging agent
85                 (this is the required parameter)
86   tgt-macaddr   ethernet MAC address for logging agent
87                 (defaults to broadcast)
88
89 Examples:
90
91   netconsole=4444@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc
92
93 or
94
95   netconsole=@/,@192.168.3.1/
96
97 Please note that for the Linux networked console to work, the
98 ethernet interface has to be up by the time the netconsole driver is
99 initialized. This means that in case of static kernel configuration,
100 the respective Ethernet interface has to be brought up using the "IP
101 Autoconfiguration" kernel feature, which is usually done by defaults
102 in the ELDK-NFS-based environment.
103
104 To browse the Linux network console output, use the 'netcat' tool invoked
105 as follows:
106
107         nc -u -l -p 6666
108
109 Note that unlike the U-Boot implementation the Linux netconsole is
110 unidirectional, i. e. you have console output only in Linux.