doc/doxygen/latex/appli_8c.tex
author nico
Thu, 07 Jun 2007 09:03:41 +0200
changeset 213 1df3055de547
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\section{examples/gene\_\-SYNC\_\-HCS12/appli.c File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\label{appli_8c}\index{examples/gene_SYNC_HCS12/appli.c@{examples/gene\_\-SYNC\_\-HCS12/appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
{\tt \#include $<$stddef.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
{\tt \#include $<$asm-m68hc12/portsaccess.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$asm-m68hc12/ports\_\-def.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include $<$asm-m68hc12/ports.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include $<$interrupt.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include \char`\"{}../include/data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
{\tt \#include $<$applicfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
{\tt \#include \char`\"{}../include/hcs12/candriver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
{\tt \#include \char`\"{}../include/hcs12/can\-Open\-Driver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
{\tt \#include \char`\"{}../include/def.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
{\tt \#include \char`\"{}../include/can.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
{\tt \#include \char`\"{}../include/objdictdef.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
{\tt \#include \char`\"{}../include/objacces.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
{\tt \#include \char`\"{}../include/sdo.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
{\tt \#include \char`\"{}../include/pdo.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
{\tt \#include \char`\"{}../include/timer.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
{\tt \#include \char`\"{}../include/lifegrd.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
{\tt \#include \char`\"{}../include/sync.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
{\tt \#include \char`\"{}../include/nmt\-Slave.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
{\tt \#include \char`\"{}objdict.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
\subsection*{Defines}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\#define {\bf DEBUG\_\-WAR\_\-CONSOLE\_\-ON}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\#define {\bf DEBUG\_\-ERR\_\-CONSOLE\_\-ON}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\subsection*{Enumerations}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
enum {\bf E\_\-Can\-Baudrate} \{ {\bf CAN\_\-BAUDRATE\_\-250K}, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
{\bf CAN\_\-BAUDRATE\_\-500K}, 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
{\bf CAN\_\-BAUDRATE\_\-1M}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
 \}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
void {\bf init\-Canopencapteur} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
void {\bf init\-Sensor} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
void {\bf init\-Port\-B} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
void {\bf init\-Port\-H} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
void {\bf gene\_\-SYNC\_\-heartbeat\-Error} (UNS8 heartbeat\-ID)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
void {\bf gene\_\-SYNC\_\-initialisation} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
void {\bf gene\_\-SYNC\_\-pre\-Operational} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
void {\bf gene\_\-SYNC\_\-operational} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
void {\bf gene\_\-SYNC\_\-stopped} ()
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
UNS8 {\bf main} (void)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
\subsection*{Variables}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
const {\bf can\-Bus\-Time} {\bf CAN\_\-Baudrates} [$\,$]
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\subsection{Define Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\index{appli.c@{appli.c}!DEBUG_ERR_CONSOLE_ON@{DEBUG\_\-ERR\_\-CONSOLE\_\-ON}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
\index{DEBUG_ERR_CONSOLE_ON@{DEBUG\_\-ERR\_\-CONSOLE\_\-ON}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DEBUG\_\-ERR\_\-CONSOLE\_\-ON}\label{appli_8c_bb416887a32f7e4333e095356774f07f}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\index{appli.c@{appli.c}!DEBUG_WAR_CONSOLE_ON@{DEBUG\_\-WAR\_\-CONSOLE\_\-ON}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
\index{DEBUG_WAR_CONSOLE_ON@{DEBUG\_\-WAR\_\-CONSOLE\_\-ON}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DEBUG\_\-WAR\_\-CONSOLE\_\-ON}\label{appli_8c_4f52c00ab0d519e2965ebaa533975904}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
\subsection{Enumeration Type Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
\index{appli.c@{appli.c}!E_CanBaudrate@{E\_\-CanBaudrate}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
\index{E_CanBaudrate@{E\_\-CanBaudrate}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf E\_\-Can\-Baudrate}}\label{appli_8c_a5385c49943465978358d459b4fc430f}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\begin{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\item[Enumerator: ]\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\begin{description}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\index{CAN_BAUDRATE_250K@{CAN\_\-BAUDRATE\_\-250K}!appli.c@{appli.c}}\index{appli.c@{appli.c}!CAN_BAUDRATE_250K@{CAN\_\-BAUDRATE\_\-250K}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
CAN\_\-BAUDRATE\_\-250K\label{appli_8c_a5385c49943465978358d459b4fc430f8d90575842d76640697deb1398f7023c}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
}]\index{CAN_BAUDRATE_500K@{CAN\_\-BAUDRATE\_\-500K}!appli.c@{appli.c}}\index{appli.c@{appli.c}!CAN_BAUDRATE_500K@{CAN\_\-BAUDRATE\_\-500K}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
CAN\_\-BAUDRATE\_\-500K\label{appli_8c_a5385c49943465978358d459b4fc430f07239165beed5e840aed12e7f46af89b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
}]\index{CAN_BAUDRATE_1M@{CAN\_\-BAUDRATE\_\-1M}!appli.c@{appli.c}}\index{appli.c@{appli.c}!CAN_BAUDRATE_1M@{CAN\_\-BAUDRATE\_\-1M}}\item[{\em 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
CAN\_\-BAUDRATE\_\-1M\label{appli_8c_a5385c49943465978358d459b4fc430ff84d248d0fb707925b35c9ec18624809}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
}]\end{description}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
\end{Desc}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
\index{appli.c@{appli.c}!gene_SYNC_heartbeatError@{gene\_\-SYNC\_\-heartbeatError}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
\index{gene_SYNC_heartbeatError@{gene\_\-SYNC\_\-heartbeatError}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void gene\_\-SYNC\_\-heartbeat\-Error (UNS8 {\em heartbeat\-ID})}\label{appli_8c_07f58b5c2d6a07142f3e6e695798646b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
\index{appli.c@{appli.c}!gene_SYNC_initialisation@{gene\_\-SYNC\_\-initialisation}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
\index{gene_SYNC_initialisation@{gene\_\-SYNC\_\-initialisation}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void gene\_\-SYNC\_\-initialisation (void)}\label{appli_8c_5249682c125c7e4ad9583bf63c20b5fa}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
\index{appli.c@{appli.c}!gene_SYNC_operational@{gene\_\-SYNC\_\-operational}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
\index{gene_SYNC_operational@{gene\_\-SYNC\_\-operational}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void gene\_\-SYNC\_\-operational (void)}\label{appli_8c_688e52d5ec8da35ad5c61b4337df495d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
\index{appli.c@{appli.c}!gene_SYNC_preOperational@{gene\_\-SYNC\_\-preOperational}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
\index{gene_SYNC_preOperational@{gene\_\-SYNC\_\-preOperational}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void gene\_\-SYNC\_\-pre\-Operational (void)}\label{appli_8c_ccd49c1b2614c38aeac93733ede6cd91}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
\index{appli.c@{appli.c}!gene_SYNC_stopped@{gene\_\-SYNC\_\-stopped}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
\index{gene_SYNC_stopped@{gene\_\-SYNC\_\-stopped}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void gene\_\-SYNC\_\-stopped (void)}\label{appli_8c_00e6a6d0f2186f329263023a7f1de155}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
\index{appli.c@{appli.c}!initCanopencapteur@{initCanopencapteur}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
\index{initCanopencapteur@{initCanopencapteur}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void init\-Canopencapteur (void)}\label{appli_8c_8d772d897083e5a5c5f41878cfea50b8}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   130
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   131
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   132
\index{appli.c@{appli.c}!initPortB@{initPortB}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   133
\index{initPortB@{initPortB}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   134
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void init\-Port\-B (void)}\label{appli_8c_c17a18fa3b7965bf6e850effaba7179a}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   135
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   136
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   137
\index{appli.c@{appli.c}!initPortH@{initPortH}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   138
\index{initPortH@{initPortH}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   139
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void init\-Port\-H (void)}\label{appli_8c_b7c33a91e5101b8d7371482fcfd6111d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   140
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   141
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   142
\index{appli.c@{appli.c}!initSensor@{initSensor}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   143
\index{initSensor@{initSensor}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   144
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void init\-Sensor (void)}\label{appli_8c_ff8c2bab7ede63d3529f62b4fa3aca8c}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   145
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   146
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   147
\index{appli.c@{appli.c}!main@{main}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   148
\index{main@{main}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   149
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}UNS8 main (void)}\label{appli_8c_ef83014be811ae964a5ef7f0af7b46a2}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   150
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   151
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   152
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   153
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   154
\subsection{Variable Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   155
\index{appli.c@{appli.c}!CAN_Baudrates@{CAN\_\-Baudrates}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   156
\index{CAN_Baudrates@{CAN\_\-Baudrates}!appli.c@{appli.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   157
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const {\bf can\-Bus\-Time} {\bf CAN\_\-Baudrates}[$\,$]}\label{appli_8c_43fd1d8fc333eddd19554acb6cc2baf8}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   158
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   159