diff options
Diffstat (limited to 'ucs2-lib/doc/html/_p__u_m__s_t_a_r_t_e_d__p_r_o_g_r_a_m_m_i_n_g.html')
| -rw-r--r-- | ucs2-lib/doc/html/_p__u_m__s_t_a_r_t_e_d__p_r_o_g_r_a_m_m_i_n_g.html | 190 |
1 files changed, 0 insertions, 190 deletions
diff --git a/ucs2-lib/doc/html/_p__u_m__s_t_a_r_t_e_d__p_r_o_g_r_a_m_m_i_n_g.html b/ucs2-lib/doc/html/_p__u_m__s_t_a_r_t_e_d__p_r_o_g_r_a_m_m_i_n_g.html deleted file mode 100644 index 13937c2..0000000 --- a/ucs2-lib/doc/html/_p__u_m__s_t_a_r_t_e_d__p_r_o_g_r_a_m_m_i_n_g.html +++ /dev/null @@ -1,190 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>UNICENS: Programming</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> -<script type="text/javascript" src="jquery.js"></script> -<script type="text/javascript" src="dynsections.js"></script> -<link href="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); -</script> -<link href="search/search.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</script> -<link href="style_html.css" rel="stylesheet" type="text/css" /> -<link href="inic.css" rel="stylesheet" type="text/css"/> -</head> -<body> -<div class="GlobalWrapper"> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr> - <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td> - <td> - <div id="projectname">UNICENS <span id="projectnumber">V2.1.0-3491</span></div> - <div id="projectbrief">User Manual and API Reference</div> - <div id="searchbox"> <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> -</div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.2 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('_p__u_m__s_t_a_r_t_e_d__p_r_o_g_r_a_m_m_i_n_g.html','');}); -</script> -<div id="doc-content"> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div> - -<!-- iframe showing the search results (closed by default) --> -<div id="MSearchResultsWindow"> -<iframe src="javascript:void(0)" frameborder="0" - name="MSearchResults" id="MSearchResults"> -</iframe> -</div> - -<div class="header"> - <div class="headertitle"> -<div class="title">Programming </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><h1>Introduction</h1> -<p>The Programming API allows to program the ConfigString and/or the IdentString of a single node in the system.</p> -<h1>Initialization</h1> -<p>The Programming API has no initialization parameters.</p> -<h1>Operation</h1> -<h2>Start</h2> -<p>The Programming service assumes that the target node has received a Hello.Get command. Programming is started by calling <a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e_ga12071385b86ab6375472db80c00b80c7.html#ga12071385b86ab6375472db80c00b80c7">Ucs_Prog_Start()</a>. It requires the following parameters:</p> -<dl> -<dt><em>self</em> </dt> -<dd><p class="startdd">Reference to the UNICENS instance (<a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a>). </p> -<p class="enddd"></p> -</dd> -<dt><em>node_id</em> </dt> -<dd><p class="startdd">The node position address of the the node to be programmed. </p> -<p class="enddd"></p> -</dd> -<dt><em>signature</em> </dt> -<dd><p class="startdd">Signature of the the node to be programmed as it was reported by Hello.Status during the Node Discovery (<a class="el" href="struct_ucs___signature__t.html">Ucs_Signature_t</a>). </p> -<p class="enddd"></p> -</dd> -<dt><em>session_type</em> </dt> -<dd><p class="startdd">Defines the set of MemIDs (see command_list) (<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gab29d4eadce18cb68209671a44c1eaa3a.html#gab29d4eadce18cb68209671a44c1eaa3a">Ucs_Prg_SessionType_t</a>).</p> -<p class="enddd"></p> -</dd> -<dt><em>command_list</em> </dt> -<dd><p class="startdd">Array of programming tasks of type <a class="el" href="struct_ucs___prg___command__t.html">Ucs_Prg_Command_t</a>. Currently each entry corresponds to one ExtendedNetworkControl.MemoryWrite command. The array ends with an entry whose <a class="el" href="struct_ucs___prg___command__t_ad97c802f66f41e937c3f8b33337b8c6d.html#ad97c802f66f41e937c3f8b33337b8c6d">data_length</a> is 0 or <a class="el" href="struct_ucs___prg___command__t_abe222f6d3581e7920dcad5306cc906a8.html#abe222f6d3581e7920dcad5306cc906a8">data</a> is NULL . </p> -<dl> -<dt><em>mem_id</em> </dt> -<dd><p class="startdd">Represents the memory resource to be written. </p> -<p class="enddd"></p> -</dd> -<dt><em>address</em> </dt> -<dd><p class="startdd">Defines the memory location at which the writing operation starts. </p> -<p class="enddd"></p> -</dd> -<dt><em>unit_length</em> </dt> -<dd><p class="startdd">Sets the number of memory units to be written. Memory units can be unsigned bytes, unsigned words or unsigned masked data depending on the memory type. </p> -<p class="enddd"></p> -</dd> -<dt><em>data_length</em> </dt> -<dd><p class="startdd">Total length of data. </p> -<p class="enddd"></p> -</dd> -<dt><em>data</em> </dt> -<dd>Contains the actual data written to the memory resource and formatted as memory units. </dd> -</dl> -<p class="enddd"></p> -</dd> -<dt><em>result_fptr</em> </dt> -<dd><p class="startdd">Callback providing the result of the Programming task (<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e_ga15045bde4d6a35f1b1e20eb6e3c688ab.html#ga15045bde4d6a35f1b1e20eb6e3c688ab">Ucs_Prg_ReportCb_t</a>). </p> -<p class="enddd"></p> -</dd> -</dl> -<h2>Result</h2> -<p>When the Programming service finishes, it provides its result via the <a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e_ga15045bde4d6a35f1b1e20eb6e3c688ab.html#ga15045bde4d6a35f1b1e20eb6e3c688ab">result_fptr</a> callback function.</p> -<dl> -<dt><em>code</em> </dt> -<dd><p class="startdd">Result values of the Programming service (<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_gaa998005dc2e710169a39af0c3739ade2.html#gaa998005dc2e710169a39af0c3739ade2">Ucs_Prg_ResCode_t</a>). </p> -<p class="enddd"></p> -</dd> -<dt><em>function</em> </dt> -<dd><p class="startdd">Describes the function where an error occurred (<a class="el" href="group___g___u_c_s___p_r_o_g___m_o_d_e___t_y_p_e_s_ga25cd4c3a9113e0a25b65136fec561c83.html#ga25cd4c3a9113e0a25b65136fec561c83">Ucs_Prg_Func_t</a>). </p> -<p class="enddd"></p> -</dd> -<dt><em>ret_len</em> </dt> -<dd><p class="startdd">Length of the following error parameter field <em>parm</em>. It is 0 if no error occurred. </p> -<p class="enddd"></p> -</dd> -<dt><em>parm</em> </dt> -<dd><p class="startdd">Pointer to the parameters of a potential error message. The meaning of these parameters can be derived from <em>function</em> and the respective EXC functions. </p> -<p class="enddd"></p> -</dd> -<dt><em>user_ptr</em> </dt> -<dd><p class="startdd">User reference as provided in <a class="el" href="struct_ucs___init_data__t.html">Ucs_InitData_t::user_ptr</a> </p> -<p class="enddd"></p> -</dd> -</dl> -</div></div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li> - </ul> -</div> -</body> -<!-- -Generated on Mon Apr 3 2017 13:52:59 for UNICENS by -Doxygen 1.8.2 ---> -<script language="javascript"> -<!-- -$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); ---> -</script> -</html> |