doc/doxygen/html/nmtMaster_8h.html
author lbessard
Tue, 05 Jun 2007 17:34:33 +0200
changeset 209 2cb34a4ac65a
parent 207 b6572d0336c3
permissions -rw-r--r--
Bug on RefreshStatusBar corrected
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
<title>CanFestival: /home/epimerde/documents/tc11/CanFestival-3/include/nmtMaster.h File Reference</title>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
<link href="doxygen.css" rel="stylesheet" type="text/css">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
<link href="tabs.css" rel="stylesheet" type="text/css">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
</head><body>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
<!-- Generated by Doxygen 1.5.1 -->
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
<div class="tabs">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
  <ul>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
    <li id="current"><a href="files.html"><span>Files</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
  </ul></div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
<div class="tabs">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
  <ul>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
    <li><a href="globals.html"><span>Globals</span></a></li>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
  </ul></div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
<h1>/home/epimerde/documents/tc11/CanFestival-3/include/nmtMaster.h File Reference</h1><code>#include &quot;<a class="el" href="data_8h-source.html">data.h</a>&quot;</code><br>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
<a href="nmtMaster_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
<tr><td></td></tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="nmtMaster_8h.html#6170d95d9900ef756921a934c5fb37d2">masterSendNMTstateChange</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS8 Node_ID, UNS8 cs)</td></tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="nmtMaster_8h.html#f63689baeabb15103c2b7afe8885c5c4">masterSendNMTnodeguard</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS8 nodeId)</td></tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="nmtMaster_8h.html#98bee3f402438056dbd653e752054796">masterRequestNodeState</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d, UNS8 nodeId)</td></tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
</table>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
<hr><h2>Function Documentation</h2>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
<a class="anchor" name="98bee3f402438056dbd653e752054796"></a><!-- doxytag: member="nmtMaster.h::masterRequestNodeState" ref="98bee3f402438056dbd653e752054796" args="(CO_Data *d, UNS8 nodeId)" -->
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
<div class="memitem">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
<div class="memproto">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
      <table class="memname">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
          <td class="memname">void masterRequestNodeState           </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
          <td>(</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
          <td class="paramname"> <em>d</em>, </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
          <td class="paramkey"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
          <td class="paramtype">UNS8&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
          <td class="paramname"> <em>nodeId</em></td><td>&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
          <td>)</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
          <td></td><td></td><td width="100%"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
      </table>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
<div class="memdoc">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
Prepare a Node_Guard message transmission on the bus number bus_id to the slave whose node_id is nodeId Put nodeId = 0 to send an NMT broadcast. This message will ask for the slave, whose node_id is nodeId, its state bus_id is hardware dependant 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
Definition at line <a class="el" href="nmtMaster_8c-source.html#l00060">60</a> of file <a class="el" href="nmtMaster_8c-source.html">nmtMaster.c</a>.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
References <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="nmtMaster_8c-source.html#l00045">masterSendNMTnodeguard()</a>, <a class="el" href="config_8h-source.html#l00030">NMT_MAX_NODE_ID</a>, <a class="el" href="data_8h-source.html#l00075">struct_CO_Data::NMTable</a>, <a class="el" href="states_8h.html#3136d2815abe9d284f985e0a7ec68646cb4b5cb64be091d76f846380eb0afe59">Unknown_state</a>, and <a class="el" href="hcs12_2applicfg_8h-source.html#l00139">UNS8</a>.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
</div><p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
<a class="anchor" name="f63689baeabb15103c2b7afe8885c5c4"></a><!-- doxytag: member="nmtMaster.h::masterSendNMTnodeguard" ref="f63689baeabb15103c2b7afe8885c5c4" args="(CO_Data *d, UNS8 nodeId)" -->
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
<div class="memitem">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
<div class="memproto">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
      <table class="memname">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
          <td class="memname">UNS8 masterSendNMTnodeguard           </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
          <td>(</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
          <td class="paramname"> <em>d</em>, </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
          <td class="paramkey"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
          <td class="paramtype">UNS8&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
          <td class="paramname"> <em>nodeId</em></td><td>&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
          <td>)</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
          <td></td><td></td><td width="100%"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
      </table>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
<div class="memdoc">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
Transmit a Node_Guard message on the bus number bus_id to the slave whose node_id is nodeId bus_id is hardware dependant return canSend(bus_id,&amp;m) 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
Definition at line <a class="el" href="nmtMaster_8c-source.html#l00045">45</a> of file <a class="el" href="nmtMaster_8c-source.html">nmtMaster.c</a>.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
References <a class="el" href="data_8h-source.html#l00090">struct_CO_Data::canHandle</a>, <a class="el" href="canOpenDriver_8c-source.html#l00505">canSend()</a>, <a class="el" href="can_8h-source.html#l00042">Message::cob_id</a>, <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="can_8h-source.html#l00045">Message::len</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00190">MSG_WAR</a>, <a class="el" href="def_8h-source.html#l00099">NODE_GUARD</a>, <a class="el" href="def_8h-source.html#l00054">REQUEST</a>, <a class="el" href="can_8h-source.html#l00043">Message::rtr</a>, and <a class="el" href="can_8h-source.html#l00036">SHORT_CAN::w</a>.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
</div><p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
<a class="anchor" name="6170d95d9900ef756921a934c5fb37d2"></a><!-- doxytag: member="nmtMaster.h::masterSendNMTstateChange" ref="6170d95d9900ef756921a934c5fb37d2" args="(CO_Data *d, UNS8 Node_ID, UNS8 cs)" -->
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
<div class="memitem">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
<div class="memproto">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
      <table class="memname">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
          <td class="memname">UNS8 masterSendNMTstateChange           </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
          <td>(</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
          <td class="paramname"> <em>d</em>, </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
          <td class="paramkey"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
          <td class="paramtype">UNS8&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
          <td class="paramname"> <em>Node_ID</em>, </td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
          <td class="paramkey"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
          <td class="paramtype">UNS8&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
          <td class="paramname"> <em>cs</em></td><td>&nbsp;</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
        <tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
          <td></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
          <td>)</td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
          <td></td><td></td><td width="100%"></td>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
        </tr>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
      </table>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
<div class="memdoc">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   130
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   131
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   132
Transmit a NMT message on the bus number bus_id to the slave whose node_id is ID bus_id is hardware dependant cs represents the order of state changement: cs = NMT_Start_Node // Put the node in operational mode cs = NMT_Stop_Node // Put the node in stopped mode cs = NMT_Enter_PreOperational // Put the node in pre_operational mode cs = NMT_Reset_Node // Put the node in initialization mode cs = NMT_Reset_Comunication // Put the node in initialization mode The mode is changed according to the slave state machine mode : initialisation ---&gt; pre-operational (Automatic transition) pre-operational &lt;--&gt; operational pre-operational &lt;--&gt; stopped pre-operational, operational, stopped -&gt; initialisation<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   133
return canSend(bus_id,&amp;m) 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   134
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   135
Definition at line <a class="el" href="nmtMaster_8c-source.html#l00027">27</a> of file <a class="el" href="nmtMaster_8c-source.html">nmtMaster.c</a>.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   136
<p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   137
References <a class="el" href="data_8h-source.html#l00090">struct_CO_Data::canHandle</a>, <a class="el" href="canOpenDriver_8c-source.html#l00505">canSend()</a>, <a class="el" href="can_8h-source.html#l00042">Message::cob_id</a>, <a class="el" href="timer_8h-source.html#l00045">struct_s_timer_entry::d</a>, <a class="el" href="can_8h-source.html#l00046">Message::data</a>, <a class="el" href="can_8h-source.html#l00045">Message::len</a>, <a class="el" href="hcs12_2applicfg_8h-source.html#l00190">MSG_WAR</a>, <a class="el" href="def_8h-source.html#l00055">NOT_A_REQUEST</a>, <a class="el" href="can_8h-source.html#l00043">Message::rtr</a>, and <a class="el" href="can_8h-source.html#l00036">SHORT_CAN::w</a>.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   138
</div>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   139
</div><p>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   140
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 4 16:29:07 2007 for CanFestival by&nbsp;
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   141
<a href="http://www.doxygen.org/index.html">
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   142
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   143
</body>
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   144
</html>