ReadParameterBlock.c.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. <?xml version='1.0' encoding='iso-8859-1'?>
  2. <!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  3. <html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
  4. <head>
  5. <title>
  6. ReadParameterBlock.c
  7. </title>
  8. <meta http-equiv='content-type' content='text/html;iso-8859-1'/>
  9. <meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
  10. <meta name='author' content='cmaier@cmassoc.net'/>
  11. <meta name='robots' content='noindex,nofollow'/>
  12. <link href='toolkit.css' rel='stylesheet' type='text/css'/>
  13. </head>
  14. <body>
  15. <div class='headerlink'>
  16. [<a href='readpacket.c.html' title=' readpacket.c '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='ReadParameters1.c.html' title=' ReadParameters1.c '>NEXT</a>]
  19. </div>
  20. <pre>
  21. /*====================================================================*
  22. *
  23. * Copyright (c) 2013 Qualcomm Atheros, Inc.
  24. *
  25. * All rights reserved.
  26. *
  27. * Redistribution and use in source and binary forms, with or
  28. * without modification, are permitted (subject to the limitations
  29. * in the disclaimer below) provided that the following conditions
  30. * are met:
  31. *
  32. * * Redistributions of source code must retain the above copyright
  33. * notice, this list of conditions and the following disclaimer.
  34. *
  35. * * Redistributions in binary form must reproduce the above
  36. * copyright notice, this list of conditions and the following
  37. * disclaimer in the documentation and/or other materials
  38. * provided with the distribution.
  39. *
  40. * * Neither the name of Qualcomm Atheros nor the names of
  41. * its contributors may be used to endorse or promote products
  42. * derived from this software without specific prior written
  43. * permission.
  44. *
  45. * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
  46. * GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE
  47. * COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot; AND ANY EXPRESS OR
  48. * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  49. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  50. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  51. * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  52. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  53. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  54. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  56. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  57. * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  58. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  59. *
  60. *--------------------------------------------------------------------*/
  61. /*====================================================================*
  62. *
  63. * signed PLCReadParameterBlock (struct plc * plc, void * memory, size_t extent);
  64. *
  65. * plc.h
  66. *
  67. * Read the PIB Image from an INT6x00 using as many VS_RD_MOD
  68. * messages as needed; Write image blocks to file as they are
  69. * read;
  70. *
  71. * the objective here is to read the PIB module in 1024 byte blocks
  72. * until the module offset equals or exceeds the PIB actual; we do
  73. * not know the PIB actual until we have read the header contained
  74. * in the first block read from OFFSET 0;
  75. *
  76. * MOFFSET and MLENGTH fields occupy different offsets in REQ and CNF
  77. * messages; we exploit that by initializing them using CNF message
  78. * offsets then copying values into REQ message offsets before each
  79. * read; this works because confirmation messages always return all
  80. * the data we request or nothing at all;
  81. *
  82. *
  83. * Contributor(s):
  84. * Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  85. * Nathaniel Houghton &lt;nhoughto@qca.qualcomm.com&gt;
  86. *
  87. *--------------------------------------------------------------------*/
  88. #ifndef READPARAMETERBLOCK_SOURCE
  89. #define READPARAMETERBLOCK_SOURCE
  90. #include &lt;stdint.h&gt;
  91. #include &lt;unistd.h&gt;
  92. #include &lt;memory.h&gt;
  93. #include &quot;../tools/error.h&quot;
  94. #include &quot;../tools/files.h&quot;
  95. #include &quot;../plc/plc.h&quot;
  96. #include &quot;../pib/pib.h&quot;
  97. signed ReadParameterBlock (struct plc * plc, void * memory, size_t extent)
  98. {
  99. uint8_t * buffer = (uint8_t *)(memory);
  100. struct channel * channel = (struct channel *)(plc-&gt;channel);
  101. struct message * message = (struct message *)(plc-&gt;message);
  102. #ifndef __GNUC__
  103. #pragma pack (push,1)
  104. #endif
  105. struct __packed vs_rd_mod_request
  106. {
  107. struct ethernet_hdr ethernet;
  108. struct qualcomm_hdr qualcomm;
  109. uint8_t MODULEID;
  110. uint8_t MACCESS;
  111. uint16_t MLENGTH;
  112. uint32_t MOFFSET;
  113. uint8_t MSECRET [16];
  114. }
  115. * request = (struct vs_rd_mod_request *) (message);
  116. struct __packed vs_rd_mod_confirm
  117. {
  118. struct ethernet_hdr ethernet;
  119. struct qualcomm_hdr qualcomm;
  120. uint8_t MSTATUS;
  121. uint8_t RESERVED1 [3];
  122. uint8_t MODULEID;
  123. uint8_t RESERVED;
  124. uint16_t MLENGTH;
  125. uint32_t MOFFSET;
  126. uint32_t CHKSUM;
  127. uint8_t BUFFER [PLC_RECORD_SIZE];
  128. }
  129. * confirm = (struct vs_rd_mod_confirm *) (message);
  130. #ifndef __GNUC__
  131. #pragma pack (pop)
  132. #endif
  133. uint16_t length = 0;
  134. uint32_t offset = 0;
  135. signed actual = PLC_RECORD_SIZE;
  136. do
  137. {
  138. memset (message, 0, sizeof (* message));
  139. EthernetHeader (&amp;request-&gt;ethernet, channel-&gt;peer, channel-&gt;host, channel-&gt;type);
  140. QualcommHeader (&amp;request-&gt;qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
  141. request-&gt;MODULEID = VS_MODULE_PIB;
  142. request-&gt;MLENGTH = HTOLE16 (actual);
  143. request-&gt;MOFFSET = HTOLE32 (offset);
  144. plc-&gt;packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
  145. if (SendMME (plc) &lt;= 0)
  146. {
  147. error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
  148. return (-1);
  149. }
  150. if (ReadMME (plc, 0, (VS_RD_MOD | MMTYPE_CNF)) &lt;= 0)
  151. {
  152. error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
  153. return (-1);
  154. }
  155. if (confirm-&gt;MSTATUS)
  156. {
  157. error (PLC_EXIT (plc), ECANCELED, PLC_WONTDOIT);
  158. return (-1);
  159. }
  160. if (LE16TOH (confirm-&gt;MLENGTH) != actual)
  161. {
  162. Failure (plc, PLC_ERR_LENGTH);
  163. return (-1);
  164. }
  165. if (LE32TOH (confirm-&gt;MOFFSET) != offset)
  166. {
  167. Failure (plc, PLC_ERR_OFFSET);
  168. return (-1);
  169. }
  170. actual = LE16TOH (confirm-&gt;MLENGTH);
  171. offset = LE32TOH (confirm-&gt;MOFFSET);
  172. if (checksum32 (confirm-&gt;BUFFER, actual, confirm-&gt;CHKSUM))
  173. {
  174. error (PLC_EXIT (plc), ECANCELED, &quot;Bad Packet Checksum&quot;);
  175. return (-1);
  176. }
  177. if (offset == length)
  178. {
  179. struct pib_header * pib_header = (struct pib_header *) (confirm-&gt;BUFFER);
  180. length = LE16TOH (pib_header-&gt;PIBLENGTH);
  181. }
  182. if ((offset + actual) &gt; length)
  183. {
  184. actual = length - offset;
  185. }
  186. memcpy (buffer + offset, confirm-&gt;BUFFER, actual);
  187. offset += actual;
  188. extent -= actual;
  189. }
  190. while (offset &lt; length);
  191. return (offset);
  192. }
  193. #endif
  194. </pre>
  195. <div class='footerlink'>
  196. [<a href='readpacket.c.html' title=' readpacket.c '>PREV</a>]
  197. [<a href='toolkit.html' title=' Index '>HOME</a>]
  198. [<a href='ReadParameters1.c.html' title=' ReadParameters1.c '>NEXT</a>]
  199. </div>
  200. </body>
  201. </html>