edsu.1 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. .TH edsu 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. edsu - Qualcomm Atheros Ethernet II Data Send Utility
  4. .SH SYNOPSIS
  5. .BR edsu
  6. .RI [ options ]
  7. .IR file
  8. .RI [ file ]
  9. [...]
  10. .SH DESCRIPTION
  11. Send one or more files as a series of Ethernet II (IEEE 802.2) frames.
  12. Input files are sequentially read and sent over network as a continuous stream of standard Ethernet frames.
  13. All frames (except perhaps the last frame for each file) will contain 1500 bytes of file data.
  14. The receiving host may elect to concatenate frame data as frames arrive.
  15. .PP
  16. This program can be used to test remote Atheros UART-enabled powerline devices.
  17. The remote UART-enabled powerline device will remove frame headers and forward frame data to the local host as a serial data stream.
  18. No protocol is imposed on the serial data stream.
  19. For example, there is no indication of frame or file start or end within the stream.
  20. The retmote powerline device must be in \fBTransparent Mode\fR and configured to accept frames from the sending host.
  21. The remote host must also be ready to handle serial data as it arrives.
  22. .SH OPTIONS
  23. .TP
  24. -\fBd \fIxx:xx:xx:xx:xx:xx\fR
  25. The Ethernet address of the destination device.
  26. If the destination device is a Linux, Mac OSX or Windows host then program \fBedru\fR can be used to receive and write frame data to \fBstdout\fR as a serial stream.
  27. If the destination device is an Atheros UART-enabled powerline device then received frame data will be converted to a serial data stream and forwared to the host connected to that device.
  28. In that case, the UART-enabled powerline device must be programmed with the address of the sending host.
  29. .TP
  30. -\fBe \fIethertype\fR
  31. The protocol (or ethertype) of interest expressed as a 16-bit hexadecimal integer.
  32. Prefix "\fB0x\fR" is optional.
  33. This filters out frames having any other ethertype.
  34. The default is \fBETH_P_802_2\fR as defined in \fBif_ether.h\fR.
  35. .TP
  36. -\fBi \fIinterface\fR
  37. The host interface used to send frames.
  38. The program default is "\fBeth1\fR" on Linux, "\fBen0\fR" on MacOSX or OpenBSD and "\fB2\fR" on Windows; however, if environment string "\fBPLC\fR" is defined, it supersedes the program default.
  39. Any interface specified on the command line supersedes all others.
  40. .TP
  41. -\fBp \fIseconds\fR
  42. Pause time in seconds between sending each frame.
  43. Pauses may be necessary when the destination device is a UART-enabled powerline device because each frame must be converted and transmitted serially from the remote device to the remote host.
  44. Permitted pause times are \fB0\fR through \fB255\fR seconds.
  45. The default is \fB0\fR.
  46. .TP
  47. .RB - q
  48. Quiet mode.
  49. This option has no effect at this time.
  50. .TP
  51. .RB - v
  52. Verbose mode.
  53. This option displays outgoing frames on stdout in hexadecimal dump format as they are sent.
  54. .SH ARGUMENTS
  55. .TP
  56. .IR file
  57. The name of a text or binary file accessible from the local host.
  58. .SH EXAMPLES
  59. The following example sends files \fBabc.txt\fR then \fBdef.bin\fR to the remote Atheros UART-enabled powerline device \fB00:B0:52:BA:BE:55\fR over network interface \fBeth1\fR.
  60. There is a constant 1 second delay between each frame sent so that remote UART-enabled powerline devices have time to convert and forward each frame to their local host.
  61. .PP
  62. # edsu -ieth1 -d 00:b0:52:BA:BE:55 abc.txt def.bin
  63. .SH SEE ALSO
  64. .BR amp ( 1 ),
  65. .BR edru ( 1 )
  66. .BR efsu ( 1 ),
  67. .SH CREDITS
  68. Charles Maier <cmaier@qca.qualcomm.com>