csu3_am335x/EVSE/GPL/plc-utils.LNX.2.1.20/source/plc/trafficgen.1

.TH trafficgen 1 "June 2018" "plc-utils-2.1.11" "Qualcomm Atheros Powerline Toolkit"

.SH NAME
trafficgen - Traffic generation utility for 75xx devices

.SH SYNOPSIS
.BR trafficgen
.RI [ options ] 
.RI [ node ] 
.RI [ peer ] 

.SH DESCRIPTION
The Traffic generation utility creates traffic between two given devices node and peer and prints the average transmit and receive PHY rates between them.
Output is column-oriented and suitable for loading into a spreadsheet or being read by a simple program.

.PP
This program is part of the Qualcomm Atheros Powerline Toolkit.
See the \fBplc\fR man page for an overview and installation instructions.

.SH CHIPSETS
QCA75xx 

.SH OPTIONS

.TP
-\fBa \fItraffic_rate\fR
The rate (Mbps) at which traffic is sent to peer device. 
The minimum value is \fB0\fR and the maximum value is \fB50\fR .
If the value is 0, this utility sends traffic at approximately 50Mbps

.TP
.RB - c
Display coded PHY rates.
Coded PHY rates are displayed by default so this option is redundant but it has been kept for backword compatibility.
This option and option \fB-u\fR are mutually exclusive.

.TP
-\fBd \fIseconds\fR
Traffic duration in seconds per connection.
Directional traffic is systematically sent between each pair of powerline network devices for this period of time.
Consequently, the total time needed to generate traffic between two network devices will be approximately 2 times this value, so don't get carried away.
The minimum value is \fB0\fR second and the maximum value is \fB60\fR seconds.

.TP
.RB - e
Redirects stderr messages to stdout.
By convention status and error messages are printed on stderr while primary program output is printed on stdout.
This option prints all output on stdout in cases where this is desired.

.TP
-\fBi \fIinterface\fR
Select the host Ethernet interface.
All requests are sent via this host interface and only reponses received via this host interface are recognized.
The default interface is \fBeth1\fR because most people use \fBeth0\fR as their principle network connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
This option then takes precedence over either default.

.TP
.RB - n
Reads the average transmit and receive PHY rate for each device using VS_NW_INFO and prints it on stdout.
Each output line displays the ethernet interface, source address, destination address and either the transmit or receive PHY rate.

.TP
-\fBo \fImilliseconds\fR
Read timeout in milliseconds.
Values range from 0 through UINT_MAX.
This is the maximum time allowed for a response.
The default is shown in brackets on the program menu.

.TP
.RB - q
Enter quiet mode.
Progress messages are suppressed.

.TP
.RB - r
Reads device hardware and software revision information using VS_SW_VER and prints it on stdout.

.TP
.RB - R
Resets the device using VS_RS_DEV.

.TP
.RB - t
Generate powerline traffic between the local device and remote device( by using VS_TRAFFIC_GENERATOR MME ) on each powerline network connected to the host.

.TP
.RB - T
Generate unidirectional powerline traffic between the source device and destination device( by using VS_TRAFFIC_GENERATOR MME ). 2 MAC Addresses are specified in the argument , the first is taken as the source and the second one as destination.

.TP
.RB - u
Display un-coded PHY rates.
Coded PHY rates are displayed by default.
This option and option \fB-c\fR are mutually exclusive.

.TP
.RB -v
Enter verbose mode.
All Etherenet frames sent or received by the program are displayed on stdout.

.TP
.RB - x
Exit program on first error with a non-zero exit code.
This option allows shell scripts to detect failed or incomplete operations and take the appropriate action.

.TP
.RB - ? ,-- help
Print program help summary on stdout.
This option takes precedence over other options on the command line.

.TP
.RB - ! ,-- version
Print program version information on stdout.
This option takes precedence over other options on the command line.
Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of the Linux Toolkit you are using.

.SH ARGUMENTS 

.TP
.B node
The MAC address of local powerline device.
The default address is \fBlocal\fR.
See \fBDEVICES\fR for information about symbolic device addresses.

.TP
.BR peer
The MAC address of remote powerline device.
A MAC address is a 48-bit value entered as 12 hexadecimal digits in upper, lower or mixed character case.
Octets may be separated with colons for clarity.
For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.

.PP
The following MAC address is special and may be entered by name instead of number.

.TP
.BR local
A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), \fB00:B0:52:00:00:01\fR.
All local Atheros devices recognize this address but remote and foreign devices do not.
A remote device is any device at the far end of a powerline connection.
A foreign device is any device not manufactured by Atheros.

.SH REFERENCES
See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.

.SH EXAMPLES
The following example displays the average transmit and receive PHY rates from each of two devices.
One is a local device connected to interface \fBeth2\fR and the other is a remote device at the far end of the powerline.
Observe the rates shown.

.PP
   # trafficgen.exe -i3 -td3 00B052000010 -nu
  nic3 00:B0:52:00:00:99 00:B0:52:00:00:10 RX 1000 mbps MIMO
  nic3 00:B0:52:00:00:99 00:B0:52:00:00:10 TX 1011 mbps MIMO

.SH DISCLAIMER
Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros, Ocala FL USA.
Consequently, public information may not be available.
Qualcomm Atheros reserves the right to modify message structure and content in future firmware releases without any obligation to notify or compensate users of this program.

.SH SEE ALSO
.BR PLC ( 1 ), 
.BR amprate ( 1 ), 
.BR int6krate ( 1 ) 
.BR plcrate ( 1 ) 

.SH CREDITS
 Nisha K <nishk@qti.qualcomm.com>
'
'