doc/doxygen/html/canOpenDriver_8h.html
author etisserant
Fri, 29 Jun 2007 19:51:39 +0200
changeset 235 f812bf6b7237
parent 215 f49e5a6b7804
child 240 34654679f262
permissions -rw-r--r--
Preliminary implementation of Event Timer and Inhibit Timer driven TPDO
+ re-organisation and cleanup of pdo.c.
215
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     3
<title>CanFestival: include/hcs12/canOpenDriver.h File Reference</title>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     4
<link href="doxygen.css" rel="stylesheet" type="text/css">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     5
<link href="tabs.css" rel="stylesheet" type="text/css">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     6
</head><body>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     7
<!-- Generated by Doxygen 1.5.1 -->
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     8
<div class="tabs">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
     9
  <ul>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    10
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    11
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    12
    <li id="current"><a href="files.html"><span>Files</span></a></li>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    13
    <li><a href="dirs.html"><span>Directories</span></a></li>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    14
  </ul></div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    15
<div class="tabs">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    16
  <ul>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    17
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    18
    <li><a href="globals.html"><span>Globals</span></a></li>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    19
  </ul></div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    20
<div class="nav">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    21
<a class="el" href="dir_2209bfb26110ae52d50da4cefad5e72f.html">include</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_9b4fbd1818b4be2ef59811982235911e.html">hcs12</a></div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    22
<h1>canOpenDriver.h File Reference</h1>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    23
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    24
<a href="canOpenDriver_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    25
<tr><td></td></tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    26
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    27
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="canOpenDriver_8h.html#02922529b60419a94afe8f369dda070b">initTimer</a> (void)</td></tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    28
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    29
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="canOpenDriver_8h.html#339b24f4eee897d3c45d88de9a4901e8">resetTimer</a> (void)</td></tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    30
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    31
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="canOpenDriver_8h.html#a62e79c9fd21304aef6aed4a2732bfbe">TimerLoop</a> (void)</td></tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    32
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    33
<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="canOpenDriver_8h.html#0bf58f014d47581c9ffd1b2db9a858d7">f_can_receive</a> (UNS8 notused, <a class="el" href="structMessage.html">Message</a> *m)</td></tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    34
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    35
</table>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    36
<hr><h2>Function Documentation</h2>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    37
<a class="anchor" name="0bf58f014d47581c9ffd1b2db9a858d7"></a><!-- doxytag: member="canOpenDriver.h::f_can_receive" ref="0bf58f014d47581c9ffd1b2db9a858d7" args="(UNS8 notused, Message *m)" -->
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    38
<div class="memitem">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    39
<div class="memproto">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    40
      <table class="memname">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    41
        <tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    42
          <td class="memname">UNS8 f_can_receive           </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    43
          <td>(</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    44
          <td class="paramtype">UNS8&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    45
          <td class="paramname"> <em>notused</em>, </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    46
        </tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    47
        <tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    48
          <td class="paramkey"></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    49
          <td></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    50
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    51
          <td class="paramname"> <em>m</em></td><td>&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    52
        </tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    53
        <tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    54
          <td></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    55
          <td>)</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    56
          <td></td><td></td><td width="100%"></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    57
        </tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    58
      </table>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    59
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    60
<div class="memdoc">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    61
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    62
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    63
Returns 0 if no message received, 0xFF if the receiving stack is not empty. May be call in polling. You can also call canDispatch(...) in void __attribute__((interrupt)) can0HdlRcv (void) (see include/hcs12/canOpenDriver.c) 
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    64
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    65
</div><p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    66
<a class="anchor" name="02922529b60419a94afe8f369dda070b"></a><!-- doxytag: member="canOpenDriver.h::initTimer" ref="02922529b60419a94afe8f369dda070b" args="(void)" -->
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    67
<div class="memitem">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    68
<div class="memproto">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    69
      <table class="memname">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    70
        <tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    71
          <td class="memname">void initTimer           </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    72
          <td>(</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    73
          <td class="paramtype">void&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    74
          <td class="paramname">          </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    75
          <td>&nbsp;)&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    76
          <td width="100%"></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    77
        </tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    78
      </table>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    79
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    80
<div class="memdoc">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    81
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    82
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    83
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    84
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    85
Definition at line <a class="el" href="canOpenDriver_8c-source.html#l00079">79</a> of file <a class="el" href="canOpenDriver_8c-source.html">canOpenDriver.c</a>.
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    86
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    87
References <a class="el" href="portsaccess_8h-source.html#l00039">IO_PORTS_8</a>, <a class="el" href="timers__unix_8c-source.html#l00016">last_sig</a>, <a class="el" href="interrupt_8c-source.html#l00049">lock()</a>, <a class="el" href="ports__def_8h-source.html#l00103">TCTL1</a>, <a class="el" href="ports__def_8h-source.html#l00107">TIE</a>, <a class="el" href="timers__unix_8c-source.html#l00018">timer</a>, <a class="el" href="timers__unix_8c-source.html#l00030">timer_notify()</a>, <a class="el" href="ports__def_8h-source.html#l00095">TIOS</a>, <a class="el" href="ports__def_8h-source.html#l00101">TSCR1</a>, <a class="el" href="ports__def_8h-source.html#l00108">TSCR2</a>, and <a class="el" href="interrupt_8c-source.html#l00057">unlock()</a>.
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    88
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    89
Here is the call graph for this function:<p><center><img src="canOpenDriver_8h_02922529b60419a94afe8f369dda070b_cgraph.png" border="0" usemap="#canOpenDriver_8h_02922529b60419a94afe8f369dda070b_cgraph_map" alt=""></center>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    90
<map name="canOpenDriver_8h_02922529b60419a94afe8f369dda070b_cgraph_map">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    91
<area href="interrupt_8c.html#eb99ff49b4a6d5157416f9b5bd0d9c2c" shape="rect" coords="164,6,212,30" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    92
<area href="timers__unix_8c.html#4cd19302f57b08fc0403a05017332735" shape="rect" coords="137,102,239,126" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    93
<area href="interrupt_8c.html#987ce601d6d4c8eedd68b58db3b7811a" shape="rect" coords="155,54,221,78" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    94
<area href="regs_8h.html#b1b104e72affb247e036289d0fc18ac7" shape="rect" coords="308,6,385,30" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    95
<area href="timers__unix_8c.html#d7fee43b8a44cf8b7036853593044037" shape="rect" coords="297,54,396,78" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    96
<area href="timers__unix_8c.html#73d9a4eb941fb20cf6b597840510394b" shape="rect" coords="295,102,399,126" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    97
<area href="timer_8c.html#fa75192a3238525618f8cb83004930cc" shape="rect" coords="289,150,404,174" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    98
<area href="canOpenDriver_8c.html#24dbe63e88d184388542037d16a8208d" shape="rect" coords="453,150,584,174" alt="">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
    99
</map>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   100
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   101
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   102
</div><p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   103
<a class="anchor" name="339b24f4eee897d3c45d88de9a4901e8"></a><!-- doxytag: member="canOpenDriver.h::resetTimer" ref="339b24f4eee897d3c45d88de9a4901e8" args="(void)" -->
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   104
<div class="memitem">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   105
<div class="memproto">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   106
      <table class="memname">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   107
        <tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   108
          <td class="memname">void resetTimer           </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   109
          <td>(</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   110
          <td class="paramtype">void&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   111
          <td class="paramname">          </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   112
          <td>&nbsp;)&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   113
          <td width="100%"></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   114
        </tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   115
      </table>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   116
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   117
<div class="memdoc">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   118
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   119
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   120
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   121
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   122
Definition at line <a class="el" href="canOpenDriver_8c-source.html#l00073">73</a> of file <a class="el" href="canOpenDriver_8c-source.html">canOpenDriver.c</a>.
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   123
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   124
</div><p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   125
<a class="anchor" name="a62e79c9fd21304aef6aed4a2732bfbe"></a><!-- doxytag: member="canOpenDriver.h::TimerLoop" ref="a62e79c9fd21304aef6aed4a2732bfbe" args="(void)" -->
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   126
<div class="memitem">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   127
<div class="memproto">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   128
      <table class="memname">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   129
        <tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   130
          <td class="memname">void TimerLoop           </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   131
          <td>(</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   132
          <td class="paramtype">void&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   133
          <td class="paramname">          </td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   134
          <td>&nbsp;)&nbsp;</td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   135
          <td width="100%"></td>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   136
        </tr>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   137
      </table>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   138
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   139
<div class="memdoc">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   140
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   141
<p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   142
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   143
</div>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   144
</div><p>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   145
<hr size="1"><address style="align: right;"><small>Generated on Fri Jun 8 08:51:58 2007 for CanFestival by&nbsp;
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   146
<a href="http://www.doxygen.org/index.html">
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   147
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   148
</body>
f49e5a6b7804 Manual and Documentation finish
nico
parents:
diff changeset
   149
</html>