doc/doxygen/latex/canOpenDriver_8h.tex
author nico
Tue, 05 Jun 2007 18:43:21 +0200
changeset 210 6b5a4c21e061
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{canOpenDriver_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/hcs12/can\-Open\-Driver.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{canOpenDriver_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/hcs12/canOpenDriver.h@{/home/epimerde/documents/tc11/CanFestival-3/include/hcs12/canOpenDriver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
void \hyperlink{canOpenDriver_8h_02922529b60419a94afe8f369dda070b}{init\-Timer} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
void \hyperlink{canOpenDriver_8h_339b24f4eee897d3c45d88de9a4901e8}{reset\-Timer} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
void \hyperlink{canOpenDriver_8h_a62e79c9fd21304aef6aed4a2732bfbe}{Timer\-Loop} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
UNS8 \hyperlink{canOpenDriver_8h_0bf58f014d47581c9ffd1b2db9a858d7}{f\_\-can\_\-receive} (UNS8 notused, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\hypertarget{canOpenDriver_8h_0bf58f014d47581c9ffd1b2db9a858d7}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\index{canOpenDriver.h@{can\-Open\-Driver.h}!f_can_receive@{f\_\-can\_\-receive}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
\index{f_can_receive@{f\_\-can\_\-receive}!canOpenDriver.h@{can\-Open\-Driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\subsubsection[f\_\-can\_\-receive]{\setlength{\rightskip}{0pt plus 5cm}UNS8 f\_\-can\_\-receive (UNS8 {\em notused}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
\label{canOpenDriver_8h_0bf58f014d47581c9ffd1b2db9a858d7}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
Returns 0 if no message received, 0x\-FF if the receiving stack is not empty. May be call in polling. You can also call can\-Dispatch(...) in void \_\-\_\-attribute\_\-\_\-((interrupt)) can0Hdl\-Rcv (void) (see include/hcs12/can\-Open\-Driver.c) \hypertarget{canOpenDriver_8h_02922529b60419a94afe8f369dda070b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\index{canOpenDriver.h@{can\-Open\-Driver.h}!initTimer@{initTimer}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\index{initTimer@{initTimer}!canOpenDriver.h@{can\-Open\-Driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\subsubsection[initTimer]{\setlength{\rightskip}{0pt plus 5cm}void init\-Timer (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\label{canOpenDriver_8h_02922529b60419a94afe8f369dda070b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
Definition at line 79 of file can\-Open\-Driver.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
References IO\_\-PORTS\_\-8, last\_\-sig, lock(), TCTL1, TIE, timer, timer\_\-notify(), TIOS, TSCR1, TSCR2, and unlock().\hypertarget{canOpenDriver_8h_339b24f4eee897d3c45d88de9a4901e8}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
\index{canOpenDriver.h@{can\-Open\-Driver.h}!resetTimer@{resetTimer}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\index{resetTimer@{resetTimer}!canOpenDriver.h@{can\-Open\-Driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\subsubsection[resetTimer]{\setlength{\rightskip}{0pt plus 5cm}void reset\-Timer (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\label{canOpenDriver_8h_339b24f4eee897d3c45d88de9a4901e8}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
Definition at line 73 of file can\-Open\-Driver.c.\hypertarget{canOpenDriver_8h_a62e79c9fd21304aef6aed4a2732bfbe}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
\index{canOpenDriver.h@{can\-Open\-Driver.h}!TimerLoop@{TimerLoop}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\index{TimerLoop@{TimerLoop}!canOpenDriver.h@{can\-Open\-Driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
\subsubsection[TimerLoop]{\setlength{\rightskip}{0pt plus 5cm}void Timer\-Loop (void)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
\label{canOpenDriver_8h_a62e79c9fd21304aef6aed4a2732bfbe}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52