doc/doxygen/latex/nmtSlave_8h.tex
author nico
Mon, 04 Jun 2007 17:59:50 +0200
changeset 207 b6572d0336c3
permissions -rw-r--r--
First doxygen implementation
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{nmtSlave_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/nmt\-Slave.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{nmtSlave_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/nmtSlave.h@{/home/epimerde/documents/tc11/CanFestival-3/include/nmtSlave.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$applicfg.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
void \hyperlink{nmtSlave_8h_97d175ea168c149c99b01dcde0989743}{proceed\-NMTstate\-Change} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
UNS8 \hyperlink{nmtSlave_8h_aced28a97b2c256320dfde3c4b36a7d5}{slave\-Send\-Boot\-Up} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\hypertarget{nmtSlave_8h_97d175ea168c149c99b01dcde0989743}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\index{nmtSlave.h@{nmt\-Slave.h}!proceedNMTstateChange@{proceedNMTstateChange}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\index{proceedNMTstateChange@{proceedNMTstateChange}!nmtSlave.h@{nmt\-Slave.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\subsubsection[proceedNMTstateChange]{\setlength{\rightskip}{0pt plus 5cm}void proceed\-NMTstate\-Change (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
\label{nmtSlave_8h_97d175ea168c149c99b01dcde0989743}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
Threat the reception of a NMT message from the master $\ast$m is a pointer to the message received bus\_\-id is hardware dependant return 0 if OK, -1 if the slave is not allowed, by its state, to receive the message 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
Definition at line 29 of file nmt\-Slave.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-s\_\-timer\_\-entry::d, Initialisation, MSG\_\-WAR, NMT\_\-Enter\_\-Pre\-Operational, NMT\_\-Reset\_\-Comunication, NMT\_\-Reset\_\-Node, NMT\_\-Start\_\-Node, NMT\_\-Stop\_\-Node, struct\_\-CO\_\-Data::node\-State, Operational, Pre\_\-operational, set\-State(), and Stopped.\hypertarget{nmtSlave_8h_aced28a97b2c256320dfde3c4b36a7d5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\index{nmtSlave.h@{nmt\-Slave.h}!slaveSendBootUp@{slaveSendBootUp}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\index{slaveSendBootUp@{slaveSendBootUp}!nmtSlave.h@{nmt\-Slave.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\subsubsection[slaveSendBootUp]{\setlength{\rightskip}{0pt plus 5cm}UNS8 slave\-Send\-Boot\-Up (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\label{nmtSlave_8h_aced28a97b2c256320dfde3c4b36a7d5}
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
Transmit the boot-Up frame when the slave is moving from initialization state to pre\_\-operational state. bus\_\-id is hardware dependant return can\-Send(bus\_\-id,\&m) 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
Definition at line 76 of file nmt\-Slave.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-CO\_\-Data::can\-Handle, can\-Send(), Message::cob\_\-id, struct\_\-s\_\-timer\_\-entry::d, Message::data, Message::len, MSG\_\-WAR, NODE\_\-GUARD, NOT\_\-A\_\-REQUEST, Message::rtr, and SHORT\_\-CAN::w.