support8.xml 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <section id="support-download">
  2. <title>
  3. Download Functions
  4. </title>
  5. <para>
  6. Download function write applets, parameters and runtime firmware to device SDRAM or NVRAM.
  7. </para>
  8. <section id="WriteExecuteApplet">
  9. <title>
  10. WriteExecuteApplet
  11. </title>
  12. <funcsynopsis>
  13. <funcprototype>
  14. <funcdef>signed <function>WriteExecuteApplet</function></funcdef>
  15. <paramdef>struct plc * <parameter>plc</parameter></paramdef>
  16. <paramdef>void const * <parameter>header</parameter></paramdef>
  17. </funcprototype>
  18. </funcsynopsis>
  19. <para>
  20. Write an NVM image directly into <acronym>SDRAM</acronym> using <constant>VS_WRITE_AND_EXECUTE</constant> messages. This function calls either <link linkend='WriteExecuteApplet1'>WriteExecuteApplet1</link> or <link linkend='WriteExecuteApplet2'>WriteExecuteApplet2</link> based on the NVM header version. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in <ulink url='WriteExecuteApplet.c.html'>WriteExecuteApplet.c</ulink>. The <varname>plc</varname> structure is defined in <ulink url='plc.h.html'>plc.h</ulink>.
  21. </para>
  22. </section>
  23. <section id="WriteExecuteApplet1">
  24. <title>
  25. WriteExecuteApplet1
  26. </title>
  27. <funcsynopsis>
  28. <funcprototype>
  29. <funcdef>signed <function>WriteExecuteApplet1</function></funcdef>
  30. <paramdef>struct plc * <parameter>plc</parameter></paramdef>
  31. <paramdef>struct nvm_header1 * <parameter>header</parameter></paramdef>
  32. </funcprototype>
  33. </funcsynopsis>
  34. <para>
  35. Write an NVM image directly into <acronym>SDRAM</acronym> using <constant>VS_WRITE_AND_EXECUTE</constant> messages. This function is similar to <link linkend='WriteExecuteApplet2'>WriteExecuteApplet2</link> but expects a structure <varname>nvm_header1</varname> pointer instead of a structure <varname>nvm_header2</varname> pointer. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in <ulink url='WriteExecuteApplet.c.html'>WriteExecuteApplet.c</ulink>. Structure <varname>plc</varname> is defined in file <ulink url='plc.h.html'>plc.h</ulink>. Structure <varname>nvm_header1</varname> is defined in file <ulink url='nvm.h.html'>nvm.h</ulink>.
  36. </para>
  37. </section>
  38. <section id="WriteExecuteApplet2">
  39. <title>
  40. WriteExecuteApplet2
  41. </title>
  42. <funcsynopsis>
  43. <funcprototype>
  44. <funcdef>signed <function>WriteExecuteApplet2</function></funcdef>
  45. <paramdef>struct plc * <parameter>plc</parameter></paramdef>
  46. <paramdef>struct nvm_header2 * <parameter>header</parameter></paramdef>
  47. </funcprototype>
  48. </funcsynopsis>
  49. <para>
  50. Write an NVM image directly into <acronym>SDRAM</acronym> using <constant>VS_WRITE_AND_EXECUTE</constant> messages. This function is similar to <link linkend='WriteExecuteApplet1'>WriteExecuteApplet1</link> but expects a structure <varname>nvm_header2</varname> pointer instead of a structure <varname>nvm_header1</varname> pointer. The function is declared in <ulink url='plc.h.html'>plc.h</ulink> and defined in <ulink url='WriteExecuteApplet.c.html'>WriteExecuteApplet.c</ulink>. Structure <varname>plc</varname> is defined in file <ulink url='plc.h.html'>plc.h</ulink>. Structure <varname>nvm_header1</varname> is defined in file <ulink url='nvm.h.html'>nvm.h</ulink>.
  51. </para>
  52. </section>
  53. </section>