Blame view

doc/README.NetConsole 3.68 KB
68ceb29e7   wdenk   Add support for c...
1
2
3
4
5
6
7
  
  In U-Boot, we implemented the networked console via the standard
  "devices" mechanism, which means that you can switch between the
  serial and network input/output devices by adjusting the 'stdin' and
  'stdout' environment variables. To switch to the networked console,
  set either of these variables to "nc". Input and output can be
  switched independently.
2c8fe5120   Joe Hershberger   net: Make the net...
8
  CONFIG_NETCONSOLE_BUFFER_SIZE - Override the default buffer size
eedcd078f   wdenk   * Patch by Detlev...
9
10
11
12
13
  We use an environment variable 'ncip' to set the IP address and the
  port of the destination. The format is <ip_addr>:<port>. If <port> is
  omitted, the value of 6666 is used. If the env var doesn't exist, the
  broadcast address and port 6666 are used. If it is set to an IP
  address of 0 (or 0.0.0.0) then no messages are sent to the network.
7f51898c1   Joe Hershberger   net: Make netcons...
14
15
16
  The source / listening port can be configured separately by setting
  the 'ncinport' environment variable and the destination port can be
  configured by setting the 'ncoutport' environment variable.
eedcd078f   wdenk   * Patch by Detlev...
17

b1bf6f2c9   wdenk   * Patch by Richar...
18
19
20
21
22
23
  For example, if your server IP is 192.168.1.1, you could use:
  
  	=> setenv nc 'setenv stdout nc;setenv stdin nc'
  	=> setenv ncip 192.168.1.1
  	=> saveenv
  	=> run nc
68ceb29e7   wdenk   Add support for c...
24
  On the host side, please use this script to access the console:
bcb6dd918   Mike Frysinger   tools/netconsole:...
25
  	tools/netconsole <ip> [port]
68ceb29e7   wdenk   Add support for c...
26

bcb6dd918   Mike Frysinger   tools/netconsole:...
27
28
29
  The script uses netcat to talk to the board over UDP.  It requires you to
  specify the target IP address (or host name, assuming DNS is working). The
  script can be interrupted by pressing ^T (CTRL-T).
b1bf6f2c9   wdenk   * Patch by Richar...
30

443feb740   Igor Marnat   Update usage of '...
31
32
33
34
  Be aware that in some distributives (Fedora Core 5 at least)
  usage of nc has been changed and -l and -p options are considered
  as mutually exclusive. If nc complains about options provided,
  you can just remove the -p option from the script.
25d6712a8   wdenk   * Clean up CMC PU...
35
  It turns out that 'netcat' cannot be used to listen to broadcast
eedcd078f   wdenk   * Patch by Detlev...
36
37
  packets. We developed our own tool 'ncb' (see tools directory) that
  listens to broadcast packets on a given port and dumps them to the
1c20e4a9f   Mike Frysinger   tools/netconsole:...
38
39
40
  standard output.  It will be built when compiling for a board which
  has CONFIG_NETCONSOLE defined.  If the netconsole script can find it
  in PATH or in the same directory, it will be used instead.
b1bf6f2c9   wdenk   * Patch by Richar...
41

68ceb29e7   wdenk   Add support for c...
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
  For Linux, the network-based console needs special configuration.
  Minimally, the host IP address needs to be specified. This can be
  done either via the kernel command line, or by passing parameters
  while loading the netconsole.o module (when used in a loadable module
  configuration). Please refer to Documentation/networking/logging.txt
  file for the original Ingo Molnar's documentation on how to pass
  parameters to the loadable module.
  
  The format of the kernel command line parameter (for the static
  configuration) is as follows:
  
    netconsole=[src-port]@[src-ip]/[<dev>],[tgt-port]@<tgt-ip>/[tgt-macaddr]
  
  where
  
    src-port	source for UDP packets
  		(defaults to 6665)
    src-ip	source IP to use
  		(defaults to the interface's address)
    dev		network interface
  		(defaults to eth0)
    tgt-port	port for logging agent
  		(defaults to 6666)
    tgt-ip	IP address for logging agent
  		(this is the required parameter)
    tgt-macaddr	ethernet MAC address for logging agent
  		(defaults to broadcast)
  
  Examples:
  
    netconsole=4444@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc
  
  or
  
    netconsole=@/,@192.168.3.1/
  
  Please note that for the Linux networked console to work, the
  ethernet interface has to be up by the time the netconsole driver is
  initialized. This means that in case of static kernel configuration,
  the respective Ethernet interface has to be brought up using the "IP
  Autoconfiguration" kernel feature, which is usually done by defaults
  in the ELDK-NFS-based environment.
  
  To browse the Linux network console output, use the 'netcat' tool invoked
  as follows:
  
  	nc -u -l -p 6666
25d6712a8   wdenk   * Clean up CMC PU...
89
90
91
  
  Note that unlike the U-Boot implementation the Linux netconsole is
  unidirectional, i. e. you have console output only in Linux.