README.NetConsole 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. In U-Boot, we implemented the networked console via the standard
  2. "devices" mechanism, which means that you can switch between the
  3. serial and network input/output devices by adjusting the 'stdin' and
  4. 'stdout' environment variables. To switch to the networked console,
  5. set either of these variables to "nc". Input and output can be
  6. switched independently.
  7. We use an environment variable 'ncip' to set the IP address and the
  8. port of the destination. The format is <ip_addr>:<port>. If <port> is
  9. omitted, the value of 6666 is used. If the env var doesn't exist, the
  10. broadcast address and port 6666 are used. If it is set to an IP
  11. address of 0 (or 0.0.0.0) then no messages are sent to the network.
  12. On the host side, please use this script to access the console:
  13. +++++++++++++++++++++++++++++++++++++++++++
  14. #! /bin/bash
  15. TARGET_IP=$1
  16. stty -icanon -echo intr ^T
  17. nc -u -l -p 6666 < /dev/null &
  18. nc -u ${TARGET_IP} 6666
  19. stty icanon echo intr ^C
  20. +++++++++++++++++++++++++++++++++++++++++++
  21. It turns out that 'netcat' cannot be used to listen to broadcast
  22. packets. We developed our own tool 'ncb' (see tools directory) that
  23. listens to broadcast packets on a given port and dumps them to the
  24. standard output. use it as follows:
  25. +++++++++++++++++++++++++++++++++++++++++++
  26. #! /bin/bash
  27. stty icanon echo intr ^T
  28. ./ncb &
  29. nc -u mpc5200 6666
  30. stty icanon echo intr ^C
  31. kill 0
  32. +++++++++++++++++++++++++++++++++++++++++++
  33. For Linux, the network-based console needs special configuration.
  34. Minimally, the host IP address needs to be specified. This can be
  35. done either via the kernel command line, or by passing parameters
  36. while loading the netconsole.o module (when used in a loadable module
  37. configuration). Please refer to Documentation/networking/logging.txt
  38. file for the original Ingo Molnar's documentation on how to pass
  39. parameters to the loadable module.
  40. The format of the kernel command line parameter (for the static
  41. configuration) is as follows:
  42. netconsole=[src-port]@[src-ip]/[<dev>],[tgt-port]@<tgt-ip>/[tgt-macaddr]
  43. where
  44. src-port source for UDP packets
  45. (defaults to 6665)
  46. src-ip source IP to use
  47. (defaults to the interface's address)
  48. dev network interface
  49. (defaults to eth0)
  50. tgt-port port for logging agent
  51. (defaults to 6666)
  52. tgt-ip IP address for logging agent
  53. (this is the required parameter)
  54. tgt-macaddr ethernet MAC address for logging agent
  55. (defaults to broadcast)
  56. Examples:
  57. netconsole=4444@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc
  58. or
  59. netconsole=@/,@192.168.3.1/
  60. Please note that for the Linux networked console to work, the
  61. ethernet interface has to be up by the time the netconsole driver is
  62. initialized. This means that in case of static kernel configuration,
  63. the respective Ethernet interface has to be brought up using the "IP
  64. Autoconfiguration" kernel feature, which is usually done by defaults
  65. in the ELDK-NFS-based environment.
  66. To browse the Linux network console output, use the 'netcat' tool invoked
  67. as follows:
  68. nc -u -l -p 6666
  69. Note that unlike the U-Boot implementation the Linux netconsole is
  70. unidirectional, i. e. you have console output only in Linux.