Etusivu Tutki Apua
Kirjaudu sisään
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Haara: master
Haarat Tagit
csu3_am335x
/
EVSE
/
GPL
/
open-plc-utils-0.3
/
docbook
/
support10.xml

support10.xml 9.9 KB
Pysyvä linkki Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129 
  1. <section id="support-traffic">
    2. 

  2. 	<title>
    3. 

  3. 		Traffic Functions
    4. 

  4. 		</title>
    5. 

  5. 	<para>
    6. 

  6. 		Traffic functions generate powerline traffic in various ways. Some send traffic direct from the host to each device while others use the <constant>VS_FR_LBK</constant> message to echo Ethernet frames back to the sender.
    7. 

  7. 		</para>
    8. 

  8. 	<section id="support-CrossTraffic1">
    9. 

  9. 		<title>
    10. 

  10. 			CrossTraffic1
    11. 

  11. 			</title>
    12. 

  12. 		<funcsynopsis>
    13. 

  13. 			<funcprototype>
    14. 

  14.   				<funcdef>signed <function>CrossTraffic1</function></funcdef>
    15. 

  15.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    16. 

  16.     				</funcprototype>
    17. 

  17. 			</funcsynopsis>
    18. 

  18. 		<para>
    19. 

  19. 			Instruct a powerline device  to send a generic Ethernet frame to another powerline device for a fixed period of time in order to set the <constant>TX</constant> rate on the source device and the <constant>RX</constant> rate on the destination device. The source and destination address are specified in <varname>plc->MAC</varname> and <varname>plc->RDA</varname>, respectively, and the duration is specified in <varname>plc->timeperiod</varname>. This function is similar to function <link linkend='support-CrossTraffic2'>CrossTraffic2</link> but the source and destination addresses are reversed. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='CrossTraffic1.c.html'>CrossTraffic1.c</ulink>. 
    20. 

  20. 			</para>
    21. 

  21. 		</section>
    22. 

  22. 	<section id="support-CrossTraffic2">
    23. 

  23. 		<title>
    24. 

  24. 			CrossTraffic2
    25. 

  25. 			</title>
    26. 

  26. 		<funcsynopsis>
    27. 

  27. 			<funcprototype>
    28. 

  28.   				<funcdef>signed <function>CrossTraffic2</function></funcdef>
    29. 

  29.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    30. 

  30.     				</funcprototype>
    31. 

  31. 			</funcsynopsis>
    32. 

  32. 		<para>
    33. 

  33. 			Instruct a powerline device  to send a generic Ethernet frame to another powerline device for a fixed period of time in order to set the <constant>TX</constant> rate on the source device and the <constant>RX</constant> rate on the destination device. The source and destination address are specified in <varname>plc->RDA</varname> and <varname>plc->MAC</varname>, respectively, and the duration is specified in <varname>plc->timeperiod</varname>. This function is similar to function <link linkend='support-CrossTraffic1'>CrossTraffic1</link> but the source and destination addresses are reversed. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='CrossTraffic2.c.html'>CrossTraffic2.c</ulink>. 
    34. 

  34. 			</para>
    35. 

  35. 		</section>
    36. 

  36. 	<section id="support-LocalTraffic1">
    37. 

  37. 		<title>
    38. 

  38. 			LocalTraffic1
    39. 

  39. 			</title>
    40. 

  40. 		<funcsynopsis>
    41. 

  41. 			<funcprototype>
    42. 

  42.   				<funcdef>signed <function>LocalTraffic1</function></funcdef>
    43. 

  43.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    44. 

  44.     				</funcprototype>
    45. 

  45. 			</funcsynopsis>
    46. 

  46. 		<para>
    47. 

  47. 			Send a fixed number of generic frames from the local host a remote powerline device in order to set the <constant>TX</constant> rate on the local powerline device and the <constant>RX</constant> rate on the remote powerline device. The local and remote device address are specified in <varname>plc->MAC</varname> and <varname>plc->RDA</varname>, respectively, and the count is specified in <varname>plc->count</varname>. This function is similar to function <link linkend='support-LocalTraffic2'>LocalTraffic2</link> which instructs a remote device to echo frames back to the local device. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='LocalTraffic1.c.html'>LocalTraffic1.c</ulink>. 
    48. 

  48. 			</para>
    49. 

  49. 		</section>
    50. 

  50. 	<section id="support-LocalTraffic2">
    51. 

  51. 		<title>
    52. 

  52. 			LocalTraffic2
    53. 

  53. 			</title>
    54. 

  54. 		<funcsynopsis>
    55. 

  55. 			<funcprototype>
    56. 

  56.   				<funcdef>signed <function>LocalTraffic2</function></funcdef>
    57. 

  57.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    58. 

  58.     				</funcprototype>
    59. 

  59. 			</funcsynopsis>
    60. 

  60. 		<para>
    61. 

  61. 			Instruct a remote powerline device to echo generic Ethernet frames back to the local host for a fixed period of time in order to set the <constant>TX</constant> rate on the remote powerline device and the <constant>RX</constant> rate on the local powerline device. The local and remote device address are specified in <varname>plc->MAC</varname> and <varname>plc->RDA</varname>, respectively, and the count is specified in <varname>plc->count</varname>. This function is useful when there is no easy way to send traffic from the remote host. This function complements function <link linkend='support-LocalTraffic1'>LocalTraffic1</link> which send frames from the local device to a remote device. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='LocalTraffic2.c.html'>LocalTraffic2.c</ulink>. 
    62. 

  62. 			</para>
    63. 

  63. 		</section>
    64. 

  64. 	<section id="support-NetworkTraffic1">
    65. 

  65. 		<title>
    66. 

  66. 			NetworkTraffic1
    67. 

  67. 			</title>
    68. 

  68. 		<funcsynopsis>
    69. 

  69. 			<funcprototype>
    70. 

  70.   				<funcdef>signed <function>NetworkTraffic1</function></funcdef>
    71. 

  71.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    72. 

  72.     				</funcprototype>
    73. 

  73. 			</funcsynopsis>
    74. 

  74. 		<para>
    75. 

  75. 			This function is an alternative to function <link linkend='support-NetworkTraffic2'>NetworkTraffic2</link> which uses Qualcomm Version <constant>1</constant> management messages to determine network topology. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='NetworkTraffic1.c.html'>NetworkTraffic1.c</ulink>. 
    76. 

  76. 			</para>
    77. 

  77. 		<para>
    78. 

  78. 			This function use <constant>VS_SW_INFO</constant> and <constant>VS_NW_INFO</constant> messages to discover powerline network topology then calls functions <link linkend='support-LocalTraffic1'>LocalTraffic1</link> and <link linkend='support-LocalTraffic2'>LocalTraffic2</link> to generate traffic between the local powerline device and each remote powerline device. Unlike function <link linkend='support-NetworkTraffic1'>NetworkTraffic1</link>, it does not generate traffic between various remote devices.
    79. 

  79. 			</para>
    80. 

  80. 		</section>
    81. 

  81. 	<section id="support-NetworkTraffic2">
    82. 

  82. 		<title>
    83. 

  83. 			NetworkTraffic2
    84. 

  84. 			</title>
    85. 

  85. 		<funcsynopsis>
    86. 

  86. 			<funcprototype>
    87. 

  87.   				<funcdef>signed <function>NetworkTraffic2</function></funcdef>
    88. 

  88.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    89. 

  89.     				</funcprototype>
    90. 

  90. 			</funcsynopsis>
    91. 

  91. 		<para>
    92. 

  92. 			This function is an alternative to function <link linkend='support-NetworkTraffic1'>NetworkTraffic1</link> which uses Qualcomm Version <constant>0</constant> management messages to determine network topology. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='NetworkTraffic2.c.html'>NetworkTraffic2.c</ulink>. 
    93. 

  93. 			</para>
    94. 

  94. 		</section>
    95. 

  95. 	<section id="support-Traffic1">
    96. 

  96. 		<title>
    97. 

  97. 			Traffic1
    98. 

  98. 			</title>
    99. 

  99. 		<funcsynopsis>
    100. 

  100. 			<funcprototype>
    101. 

  101.   				<funcdef>signed <function>Traffic1</function></funcdef>
    102. 

  102.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    103. 

  103.     				</funcprototype>
    104. 

  104. 			</funcsynopsis>
    105. 

  105. 		<para>
    106. 

  106. 			This function is an alternative to function <link linkend='support-Traffic2'>Traffic2</link> which uses Qualcomm Version <constant>1</constant> management messages to determine network topology. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='Traffic1.c.html'>Traffic1.c</ulink>. 
    107. 

  107. 			</para>
    108. 

  108. 		<para>
    109. 

  109. 			This function use <constant>VS_SW_INFO</constant> and <constant>VS_NW_INFO</constant> messages to discover powerline network topology then calls functions <link linkend='support-LocalTraffic1'>LocalTraffic1</link> and <link linkend='support-LocalTraffic2'>LocalTraffic2</link> to generate traffic between the local powerline device and each remote powerline device. Unlike function <link linkend='support-NetworkTraffic1'>NetworkTraffic1</link>, it does not generate traffic between remote devices.
    110. 

  110. 			</para>
    111. 

  111. 		</section>
    112. 

  112. 	<section id="support-Traffic2">
    113. 

  113. 		<title>
    114. 

  114. 			Traffic2
    115. 

  115. 			</title>
    116. 

  116. 		<funcsynopsis>
    117. 

  117. 			<funcprototype>
    118. 

  118.   				<funcdef>signed <function>Traffic2</function></funcdef>
    119. 

  119.    				<paramdef>struct plc * <parameter>plc</parameter></paramdef>
    120. 

  120.     				</funcprototype>
    121. 

  121. 			</funcsynopsis>
    122. 

  122. 		<para>
    123. 

  123. 			This function is an alternative to function <link linkend='support-Traffic1'>Traffic1</link> which uses Qualcomm Version <constant>0</constant> management messages to determine network topology. Structure <varname>plc</varname> is declared in file <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='plc.c.html'>plc.c</ulink>. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in file <ulink url='Traffic2.c.html'>Traffic2.c</ulink>. 
    124. 

  124. 			</para>
    125. 

  125. 		<para>
    126. 

  126. 			This function use <constant>VS_SW_INFO</constant> and <constant>VS_NW_INFO</constant> messages to discover powerline network topology then calls functions <link linkend='support-LocalTraffic1'>LocalTraffic1</link> and <link linkend='support-LocalTraffic2'>LocalTraffic2</link> to generate traffic between the local powerline device and each remote powerline device. Unlike function <link linkend='support-NetworkTraffic2'>NetworkTraffic2</link>, it does not generate traffic between remote devices.
    127. 

  127. 			</para>
    128. 

  128. 		</section>
    129. 

  129. 	</section>
    130.