doc/doxygen/latex/nmtMaster_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{nmtMaster_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/nmt\-Master.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{nmtMaster_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/nmtMaster.h@{/home/epimerde/documents/tc11/CanFestival-3/include/nmtMaster.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
UNS8 \hyperlink{nmtMaster_8h_6170d95d9900ef756921a934c5fb37d2}{master\-Send\-NMTstate\-Change} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 Node\_\-ID, UNS8 cs)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
UNS8 \hyperlink{nmtMaster_8h_f63689baeabb15103c2b7afe8885c5c4}{master\-Send\-NMTnodeguard} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
void \hyperlink{nmtMaster_8h_98bee3f402438056dbd653e752054796}{master\-Request\-Node\-State} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\hypertarget{nmtMaster_8h_98bee3f402438056dbd653e752054796}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\index{nmtMaster.h@{nmt\-Master.h}!masterRequestNodeState@{masterRequestNodeState}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\index{masterRequestNodeState@{masterRequestNodeState}!nmtMaster.h@{nmt\-Master.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
\subsubsection[masterRequestNodeState]{\setlength{\rightskip}{0pt plus 5cm}void master\-Request\-Node\-State (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\label{nmtMaster_8h_98bee3f402438056dbd653e752054796}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
Prepare a Node\_\-Guard message transmission on the bus number bus\_\-id to the slave whose node\_\-id is node\-Id Put node\-Id = 0 to send an NMT broadcast. This message will ask for the slave, whose node\_\-id is node\-Id, its state bus\_\-id is hardware dependant 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
Definition at line 60 of file nmt\-Master.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
References struct\_\-s\_\-timer\_\-entry::d, master\-Send\-NMTnodeguard(), NMT\_\-MAX\_\-NODE\_\-ID, struct\_\-CO\_\-Data::NMTable, Unknown\_\-state, and UNS8.\hypertarget{nmtMaster_8h_f63689baeabb15103c2b7afe8885c5c4}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\index{nmtMaster.h@{nmt\-Master.h}!masterSendNMTnodeguard@{masterSendNMTnodeguard}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\index{masterSendNMTnodeguard@{masterSendNMTnodeguard}!nmtMaster.h@{nmt\-Master.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\subsubsection[masterSendNMTnodeguard]{\setlength{\rightskip}{0pt plus 5cm}UNS8 master\-Send\-NMTnodeguard (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\label{nmtMaster_8h_f63689baeabb15103c2b7afe8885c5c4}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
Transmit a Node\_\-Guard message on the bus number bus\_\-id to the slave whose node\_\-id is node\-Id bus\_\-id is hardware dependant return can\-Send(bus\_\-id,\&m) 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
Definition at line 45 of file nmt\-Master.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
References struct\_\-CO\_\-Data::can\-Handle, can\-Send(), Message::cob\_\-id, struct\_\-s\_\-timer\_\-entry::d, Message::len, MSG\_\-WAR, NODE\_\-GUARD, REQUEST, Message::rtr, and SHORT\_\-CAN::w.\hypertarget{nmtMaster_8h_6170d95d9900ef756921a934c5fb37d2}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\index{nmtMaster.h@{nmt\-Master.h}!masterSendNMTstateChange@{masterSendNMTstateChange}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\index{masterSendNMTstateChange@{masterSendNMTstateChange}!nmtMaster.h@{nmt\-Master.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\subsubsection[masterSendNMTstateChange]{\setlength{\rightskip}{0pt plus 5cm}UNS8 master\-Send\-NMTstate\-Change (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em Node\_\-ID}, UNS8 {\em cs})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\label{nmtMaster_8h_6170d95d9900ef756921a934c5fb37d2}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
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\_\-Pre\-Operational // 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 ---$>$ pre-operational (Automatic transition) pre-operational $<$--$>$ operational pre-operational $<$--$>$ stopped pre-operational, operational, stopped -$>$ initialisation
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
return can\-Send(bus\_\-id,\&m) 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
Definition at line 27 of file nmt\-Master.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
References struct\_\-CO\_\-Data::can\-Handle, can\-Send(), Message::cob\_\-id, struct\_\-s\_\-timer\_\-entry::d, Message::data, Message::len, MSG\_\-WAR, NOT\_\-A\_\-REQUEST, Message::rtr, and SHORT\_\-CAN::w.