doc/doxygen/latex/sdo_8h.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
\hypertarget{sdo_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/sdo.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{sdo_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/sdo.h@{/home/epimerde/documents/tc11/CanFestival-3/include/sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include \char`\"{}timer.h\char`\"{}}\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*{Data Structures}
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
struct \hyperlink{structstruct__s__transfer}{struct\_\-s\_\-transfer}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
struct \hyperlink{structBODY}{BODY}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
struct \hyperlink{structstruct__s__SDO}{struct\_\-s\_\-SDO}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\subsection*{Typedefs}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
typedef void($\ast$) \hyperlink{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{SDOCallback\_\-t} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
typedef \hyperlink{structstruct__s__transfer}{struct\_\-s\_\-transfer} \hyperlink{sdo_8h_0c41985ac8cf4546cbce64eb0f2ac897}{s\_\-transfer}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
typedef \hyperlink{structstruct__s__SDO}{struct\_\-s\_\-SDO} \hyperlink{sdo_8h_f9e5cbdc9fba242ca4060f6bffa6d7c8}{s\_\-SDO}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
void \hyperlink{sdo_8h_9309025e29b59e09026abcd3b45a5b61}{SDOTimeout\-Alarm} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS32 id)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
void \hyperlink{sdo_8h_1f4f07eccc4890a11ccf4f632da7740b}{reset\-SDO} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
UNS32 \hyperlink{sdo_8h_2eb5309dca3a7363da5e5e7230b85d58}{SDOline\-To\-Objdict} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
UNS32 \hyperlink{sdo_8h_29427a80fd1aeabff30bf0602fbc220f}{objdict\-To\-SDOline} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
UNS8 \hyperlink{sdo_8h_ad6eb8be03b832ebba4dfb87aaba4065}{line\-To\-SDO} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line, UNS8 nb\-Bytes, UNS8 $\ast$data)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
UNS8 \hyperlink{sdo_8h_18b6f7e9c9441640a88ffef1e8720694}{SDOto\-Line} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line, UNS8 nb\-Bytes, UNS8 $\ast$data)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
UNS8 \hyperlink{sdo_8h_2019db2a4d17e6d29c055cbae173e2b9}{failed\-SDO} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS8 whoami, UNS16 index, UNS8 sub\-Index, UNS32 abort\-Code)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
void \hyperlink{sdo_8h_42d33be015d4c4c83c73f1f0e588f481}{reset\-SDOline} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
UNS8 \hyperlink{sdo_8h_b9c873a15f55b29112b5527a6cc6898d}{init\-SDOline} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line, UNS8 node\-Id, UNS16 index, UNS8 sub\-Index, UNS8 state)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
UNS8 \hyperlink{sdo_8h_58d1f9691977617601beb9e5b4123252}{get\-SDOfree\-Line} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 whoami, UNS8 $\ast$line)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
UNS8 \hyperlink{sdo_8h_bb0c376b048ab2c6e0524b135b62376f}{get\-SDOline\-On\-Use} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS8 whoami, UNS8 $\ast$line)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
UNS8 \hyperlink{sdo_8h_555a772d3a88a29c495f33513f8b2d58}{close\-SDOtransfer} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS8 whoami)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
UNS8 \hyperlink{sdo_8h_acceb714c6e457e98deb9ba164ba2a2f}{get\-SDOline\-Rest\-Bytes} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line, UNS8 $\ast$nb\-Bytes)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
UNS8 \hyperlink{sdo_8h_601a837ecb5f21bf4c66b058c5ae7810}{set\-SDOline\-Rest\-Bytes} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 line, UNS8 nb\-Bytes)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
UNS8 \hyperlink{sdo_8h_c6b5d7d1439d537da992a96644a1ca5d}{send\-SDO} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 whoami, \hyperlink{structstruct__s__SDO}{s\_\-SDO} sdo)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
UNS8 \hyperlink{sdo_8h_b26c3f2fb63d81055809d6ccaa785b7c}{send\-SDOabort} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 whoami, UNS16 index, UNS8 sub\-Index, UNS32 abort\-Code)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
UNS8 \hyperlink{sdo_8h_2a93a7c780472b1d8666d89aa270f661}{proceed\-SDO} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
UNS8 \hyperlink{sdo_8h_bc20ed246e00053dcf71faa8f45ee39c}{write\-Network\-Dict} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS16 index, UNS8 sub\-Index, UNS8 count, UNS8 data\-Type, void $\ast$data)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
UNS8 \hyperlink{sdo_8h_f4ec05293fb8971a1b282994498ed4f5}{write\-Network\-Dict\-Call\-Back} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS16 index, UNS8 sub\-Index, UNS8 count, UNS8 data\-Type, void $\ast$data, \hyperlink{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{SDOCallback\_\-t} Callback)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
UNS8 \hyperlink{sdo_8h_0e102a0835e4115920cd406e80a8d135}{read\-Network\-Dict} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS16 index, UNS8 sub\-Index, UNS8 data\-Type)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
UNS8 \hyperlink{sdo_8h_542a5cdd20c00aa130a39fe68295e769}{read\-Network\-Dict\-Callback} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS16 index, UNS8 sub\-Index, UNS8 data\-Type, \hyperlink{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{SDOCallback\_\-t} Callback)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
UNS8 \hyperlink{sdo_8h_05b0c8eee1faee3c7a2f6e2ba3a16533}{get\-Read\-Result\-Network\-Dict} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, void $\ast$data, UNS8 $\ast$size, UNS32 $\ast$abort\-Code)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
UNS8 \hyperlink{sdo_8h_8671e306873f19362c60bb50ab930d1d}{get\-Write\-Result\-Network\-Dict} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id, UNS32 $\ast$abort\-Code)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\hypertarget{sdo_8h_f9e5cbdc9fba242ca4060f6bffa6d7c8}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\index{sdo.h@{sdo.h}!s_SDO@{s\_\-SDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\index{s_SDO@{s\_\-SDO}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
\subsubsection[s\_\-SDO]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{structstruct__s__SDO}{struct\_\-s\_\-SDO} \hyperlink{structstruct__s__SDO}{s\_\-SDO}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
\label{sdo_8h_f9e5cbdc9fba242ca4060f6bffa6d7c8}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
Definition at line 86 of file sdo.h.\hypertarget{sdo_8h_0c41985ac8cf4546cbce64eb0f2ac897}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{sdo.h@{sdo.h}!s_transfer@{s\_\-transfer}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\index{s_transfer@{s\_\-transfer}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\subsubsection[s\_\-transfer]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{structstruct__s__transfer}{struct\_\-s\_\-transfer} \hyperlink{structstruct__s__transfer}{s\_\-transfer}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\label{sdo_8h_0c41985ac8cf4546cbce64eb0f2ac897}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
Definition at line 69 of file sdo.h.\hypertarget{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
\index{sdo.h@{sdo.h}!SDOCallback_t@{SDOCallback\_\-t}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
\index{SDOCallback_t@{SDOCallback\_\-t}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
\subsubsection[SDOCallback\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef void($\ast$) \hyperlink{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{SDOCallback\_\-t}(\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d, UNS8 node\-Id)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
\label{sdo_8h_606eccfef67e572723e1efba3f0d87ba}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
Definition at line 30 of file sdo.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
\hypertarget{sdo_8h_555a772d3a88a29c495f33513f8b2d58}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
\index{sdo.h@{sdo.h}!closeSDOtransfer@{closeSDOtransfer}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
\index{closeSDOtransfer@{closeSDOtransfer}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
\subsubsection[closeSDOtransfer]{\setlength{\rightskip}{0pt plus 5cm}UNS8 close\-SDOtransfer (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS8 {\em whoami})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
\label{sdo_8h_555a772d3a88a29c495f33513f8b2d58}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
Close a transmission. node\-Id : Node id of the server if both server or client whoami : Line opened as SDO\_\-CLIENT or SDO\_\-SERVER 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
Definition at line 318 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
References struct\_\-s\_\-timer\_\-entry::d, get\-SDOline\-On\-Use(), MSG\_\-WAR, reset\-SDOline(), and UNS8.\hypertarget{sdo_8h_2019db2a4d17e6d29c055cbae173e2b9}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
\index{sdo.h@{sdo.h}!failedSDO@{failedSDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
\index{failedSDO@{failedSDO}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
\subsubsection[failedSDO]{\setlength{\rightskip}{0pt plus 5cm}UNS8 failed\-SDO (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS8 {\em whoami}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS32 {\em abort\-Code})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
\label{sdo_8h_2019db2a4d17e6d29c055cbae173e2b9}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
Called when an internal SDO abort occurs. Release the line $\ast$ Only if server $\ast$ If client, the line must be released manually in the core application. The reason of that is to permit the program to read the transfers\mbox{[}\mbox{]}\mbox{[}\mbox{]} structure before its reset, because many informations are stored on it : index, subindex, data received or trasmited, ... In all cases, sends a SDO abort. Returns 0 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   127
Definition at line 227 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   128
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   129
References struct\_\-s\_\-timer\_\-entry::d, get\-SDOline\-On\-Use(), MSG\_\-WAR, reset\-SDOline(), SDO\_\-ABORTED\_\-INTERNAL, SDO\_\-CLIENT, SDO\_\-SERVER, send\-SDOabort(), struct\_\-s\_\-transfer::state, Stop\-SDO\_\-TIMER, struct\_\-CO\_\-Data::transfers, and UNS8.\hypertarget{sdo_8h_05b0c8eee1faee3c7a2f6e2ba3a16533}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   130
\index{sdo.h@{sdo.h}!getReadResultNetworkDict@{getReadResultNetworkDict}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   131
\index{getReadResultNetworkDict@{getReadResultNetworkDict}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   132
\subsubsection[getReadResultNetworkDict]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-Read\-Result\-Network\-Dict (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, void $\ast$ {\em data}, UNS8 $\ast$ {\em size}, UNS32 $\ast$ {\em abort\-Code})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   133
\label{sdo_8h_05b0c8eee1faee3c7a2f6e2ba3a16533}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   134
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   135
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   136
Use this function after a read\-Network\-Dict to get the result. Returns : SDO\_\-FINISHED // data is available SDO\_\-ABORTED\_\-RCV // Transfert failed. (abort SDO received) SDO\_\-ABORTED\_\-INTERNAL // Transfert failed. Internal abort. SDO\_\-UPLOAD\_\-IN\_\-PROGRESS // Data not yet available SDO\_\-DOWNLOAD\_\-IN\_\-PROGRESS // Should not arrive !
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   137
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   138
data\-Type (defined in \hyperlink{objdictdef_8h}{objdictdef.h}) : type expected. put \char`\"{}visible\_\-string\char`\"{} for strings, 0 for integers or reals. abort\-Code : 0 = not available. Else : SDO abort code. (received if return SDO\_\-ABORTED\_\-RCV) example : UNS32 data; UNS8 size; read\-Network\-Dict(0, 0x05, 0x1016, 1, 0) // get the data index 1016 subindex 1 of node 5 while (get\-Read\-Result\-Network\-Dict (0, 0x05, \&data, \&size) != SDO\_\-UPLOAD\_\-IN\_\-PROGRESS); 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   139
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   140
Definition at line 1295 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   141
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   142
References CANOPEN\_\-BIG\_\-ENDIAN, struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data, struct\_\-s\_\-transfer::data\-Type, get\-SDOline\-On\-Use(), MSG\_\-ERR, SDO\_\-ABORTED\_\-INTERNAL, SDO\_\-CLIENT, SDO\_\-FINISHED, struct\_\-s\_\-transfer::state, struct\_\-CO\_\-Data::transfers, UNS8, and visible\_\-string.\hypertarget{sdo_8h_58d1f9691977617601beb9e5b4123252}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   143
\index{sdo.h@{sdo.h}!getSDOfreeLine@{getSDOfreeLine}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   144
\index{getSDOfreeLine@{getSDOfreeLine}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   145
\subsubsection[getSDOfreeLine]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-SDOfree\-Line (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em whoami}, UNS8 $\ast$ {\em line})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   146
\label{sdo_8h_58d1f9691977617601beb9e5b4123252}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   147
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   148
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   149
Search for an unused line in the transfers array to store a new SDO. ie a line which value of the field \char`\"{}state\char`\"{} is \char`\"{}SDO\_\-RESET\char`\"{} An unused line have the field \char`\"{}state\char`\"{} at the value SDO\_\-RESET bus\_\-id is hardware dependant whoami : create the line for a SDO\_\-SERVER or SDO\_\-CLIENT. return 0x\-FF if all the lines are on use. Else, return 0 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   150
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   151
Definition at line 284 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   152
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   153
References struct\_\-s\_\-timer\_\-entry::d, SDO\_\-MAX\_\-SIMULTANEOUS\_\-TRANSFERTS, SDO\_\-RESET, struct\_\-s\_\-transfer::state, struct\_\-CO\_\-Data::transfers, UNS8, and struct\_\-s\_\-transfer::whoami.\hypertarget{sdo_8h_bb0c376b048ab2c6e0524b135b62376f}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   154
\index{sdo.h@{sdo.h}!getSDOlineOnUse@{getSDOlineOnUse}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   155
\index{getSDOlineOnUse@{getSDOlineOnUse}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   156
\subsubsection[getSDOlineOnUse]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-SDOline\-On\-Use (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS8 {\em whoami}, UNS8 $\ast$ {\em line})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   157
\label{sdo_8h_bb0c376b048ab2c6e0524b135b62376f}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   158
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   159
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   160
Search for the line, in the transfers array, which contains the beginning of the reception of a fragmented SDO whoami takes 2 values : look for a line opened as SDO\_\-CLIENT or SDO\_\-SERVER bus\_\-id is hardware dependant node\-Id correspond to the message node-id return 0x\-FF if error. Else, return 0 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   161
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   162
Definition at line 301 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   163
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   164
References struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::node\-Id, SDO\_\-MAX\_\-SIMULTANEOUS\_\-TRANSFERTS, SDO\_\-RESET, struct\_\-s\_\-transfer::state, struct\_\-CO\_\-Data::transfers, UNS8, and struct\_\-s\_\-transfer::whoami.\hypertarget{sdo_8h_acceb714c6e457e98deb9ba164ba2a2f}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   165
\index{sdo.h@{sdo.h}!getSDOlineRestBytes@{getSDOlineRestBytes}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   166
\index{getSDOlineRestBytes@{getSDOlineRestBytes}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   167
\subsubsection[getSDOlineRestBytes]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-SDOline\-Rest\-Bytes (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line}, UNS8 $\ast$ {\em nb\-Bytes})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   168
\label{sdo_8h_acceb714c6e457e98deb9ba164ba2a2f}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   169
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   170
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   171
Bytes in the line structure which must be transmited (or received) bus\_\-id is hardware dependant. return 0. 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   172
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   173
Definition at line 332 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   174
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   175
References struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::offset, struct\_\-CO\_\-Data::transfers, and UNS8.\hypertarget{sdo_8h_8671e306873f19362c60bb50ab930d1d}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   176
\index{sdo.h@{sdo.h}!getWriteResultNetworkDict@{getWriteResultNetworkDict}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   177
\index{getWriteResultNetworkDict@{getWriteResultNetworkDict}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   178
\subsubsection[getWriteResultNetworkDict]{\setlength{\rightskip}{0pt plus 5cm}UNS8 get\-Write\-Result\-Network\-Dict (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS32 $\ast$ {\em abort\-Code})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   179
\label{sdo_8h_8671e306873f19362c60bb50ab930d1d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   180
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   181
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   182
Use this function after a write\-Network\-Dict to get the result of the write It is mandatory to call this function because it is releasing the line used for the transfer. Returns : SDO\_\-FINISHED // data is available SDO\_\-ABORTED\_\-RCV // Transfert failed. (abort SDO received) SDO\_\-ABORTED\_\-INTERNAL // Transfert failed. Internal abort. SDO\_\-DOWNLOAD\_\-IN\_\-PROGRESS // Data not yet available SDO\_\-UPLOAD\_\-IN\_\-PROGRESS // Should not arrive ! abort\-Code : 0 = not available. Else : SDO abort code. (received if return SDO\_\-ABORTED\_\-RCV) example : UNS32 data = 0x50; UNS8 size; UNS32 abort\-Code; write\-Network\-Dict(0, 0x05, 0x1016, 1, size, \&data) // write the data index 1016 subindex 1 of node 5 while ( get\-Write\-Result\-Network\-Dict (0, 0x05, \&abort\-Code) != SDO\_\-DOWNLOAD\_\-IN\_\-PROGRESS); 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   183
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   184
Definition at line 1329 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   185
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   186
References struct\_\-s\_\-transfer::abort\-Code, struct\_\-s\_\-timer\_\-entry::d, get\-SDOline\-On\-Use(), MSG\_\-ERR, SDO\_\-ABORTED\_\-INTERNAL, SDO\_\-CLIENT, struct\_\-s\_\-transfer::state, struct\_\-CO\_\-Data::transfers, and UNS8.\hypertarget{sdo_8h_b9c873a15f55b29112b5527a6cc6898d}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   187
\index{sdo.h@{sdo.h}!initSDOline@{initSDOline}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   188
\index{initSDOline@{initSDOline}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   189
\subsubsection[initSDOline]{\setlength{\rightskip}{0pt plus 5cm}UNS8 init\-SDOline (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line}, UNS8 {\em node\-Id}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS8 {\em state})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   190
\label{sdo_8h_b9c873a15f55b29112b5527a6cc6898d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   191
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   192
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   193
Initialize some fields of the structure. Returns 0 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   194
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   195
Definition at line 263 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   196
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   197
References struct\_\-s\_\-transfer::Callback, struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data\-Type, struct\_\-s\_\-transfer::index, MSG\_\-WAR, struct\_\-s\_\-transfer::node\-Id, struct\_\-s\_\-transfer::offset, SDO\_\-DOWNLOAD\_\-IN\_\-PROGRESS, SDO\_\-UPLOAD\_\-IN\_\-PROGRESS, Start\-SDO\_\-TIMER, struct\_\-s\_\-transfer::state, Stop\-SDO\_\-TIMER, struct\_\-s\_\-transfer::sub\-Index, struct\_\-s\_\-transfer::toggle, and struct\_\-CO\_\-Data::transfers.\hypertarget{sdo_8h_ad6eb8be03b832ebba4dfb87aaba4065}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   198
\index{sdo.h@{sdo.h}!lineToSDO@{lineToSDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   199
\index{lineToSDO@{lineToSDO}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   200
\subsubsection[lineToSDO]{\setlength{\rightskip}{0pt plus 5cm}UNS8 line\-To\-SDO (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line}, UNS8 {\em nb\-Bytes}, UNS8 $\ast$ {\em data})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   201
\label{sdo_8h_ad6eb8be03b832ebba4dfb87aaba4065}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   202
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   203
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   204
copy data from an existant line in the argument \char`\"{}$\ast$ data\char`\"{} Returns 0x\-FF if error. Else, returns 0; 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   205
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   206
Definition at line 189 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   208
References struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data, MSG\_\-ERR, struct\_\-s\_\-transfer::offset, SDO\_\-MAX\_\-LENGTH\_\-TRANSFERT, struct\_\-CO\_\-Data::transfers, and UNS8.\hypertarget{sdo_8h_29427a80fd1aeabff30bf0602fbc220f}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   209
\index{sdo.h@{sdo.h}!objdictToSDOline@{objdictToSDOline}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   210
\index{objdictToSDOline@{objdictToSDOline}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   211
\subsubsection[objdictToSDOline]{\setlength{\rightskip}{0pt plus 5cm}UNS32 objdict\-To\-SDOline (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   212
\label{sdo_8h_29427a80fd1aeabff30bf0602fbc220f}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   213
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   214
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   215
Copy the data from the object dictionary to the SDO line for a network transfert. Returns SDO error code if error. Else, returns 0; 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   216
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   217
Definition at line 157 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   218
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   219
References struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data, get\-ODentry(), struct\_\-s\_\-transfer::index, MSG\_\-WAR, OD\_\-SUCCESSFUL, struct\_\-s\_\-transfer::offset, struct\_\-s\_\-transfer::sub\-Index, struct\_\-CO\_\-Data::transfers, UNS32, and UNS8.\hypertarget{sdo_8h_2a93a7c780472b1d8666d89aa270f661}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   220
\index{sdo.h@{sdo.h}!proceedSDO@{proceedSDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   221
\index{proceedSDO@{proceedSDO}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   222
\subsubsection[proceedSDO]{\setlength{\rightskip}{0pt plus 5cm}UNS8 proceed\-SDO (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   223
\label{sdo_8h_2a93a7c780472b1d8666d89aa270f661}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   224
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   225
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   226
Treat a SDO frame reception bus\_\-id is hardware dependant call the function send\-SDO return 0x\-FF if error 0x80 if transfert aborted by the server 0x0 ok 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   227
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   228
Definition at line 447 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   229
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   230
References struct\_\-s\_\-transfer::abort\-Code, struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-s\_\-SDO::body, td\_\-indextable::b\-Sub\-Count, struct\_\-s\_\-transfer::Callback, struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, BODY::data, Message::data, failed\-SDO(), struct\_\-CO\_\-Data::first\-Index, get\-SDOc, get\-SDOcs, get\-SDOe, get\-SDOfree\-Line(), get\-SDOindex, get\-SDOline\-On\-Use(), get\-SDOline\-Rest\-Bytes(), get\-SDOn2, get\-SDOn3, get\-SDOs, get\-SDOsub\-Index, get\-SDOt, struct\_\-s\_\-transfer::index, init\-SDOline(), struct\_\-CO\_\-Data::last\-Index, line\-To\-SDO(), MSG\_\-ERR, MSG\_\-WAR, struct\_\-s\_\-SDO::node\-Id, struct\_\-CO\_\-Data::objdict, objdict\-To\-SDOline(), td\_\-subindex::p\-Object, td\_\-indextable::p\-Subindex, reset\-SDOline(), Restart\-SDO\_\-TIMER, SDO\_\-ABORTED\_\-RCV, SDO\_\-CLIENT, s\_\-quick\_\-index::SDO\_\-CLT, SDO\_\-DOWNLOAD\_\-IN\_\-PROGRESS, SDO\_\-FINISHED, SDO\_\-SERVER, s\_\-quick\_\-index::SDO\_\-SVR, SDO\_\-UNKNOWN, SDO\_\-UPLOAD\_\-IN\_\-PROGRESS, SDOABT\_\-GENERAL\_\-ERROR, SDOABT\_\-LOCAL\_\-CTRL\_\-ERROR, SDOABT\_\-TOGGLE\_\-NOT\_\-ALTERNED, SDOline\-To\-Objdict(), SDOto\-Line(), send\-SDO(), set\-SDOline\-Rest\-Bytes(), struct\_\-s\_\-transfer::state, Stop\-SDO\_\-TIMER, struct\_\-s\_\-transfer::sub\-Index, struct\_\-s\_\-transfer::toggle, struct\_\-CO\_\-Data::transfers, UNS16, UNS32, and UNS8.\hypertarget{sdo_8h_0e102a0835e4115920cd406e80a8d135}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   231
\index{sdo.h@{sdo.h}!readNetworkDict@{readNetworkDict}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   232
\index{readNetworkDict@{readNetworkDict}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   233
\subsubsection[readNetworkDict]{\setlength{\rightskip}{0pt plus 5cm}UNS8 read\-Network\-Dict (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS8 {\em data\-Type})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   234
\label{sdo_8h_0e102a0835e4115920cd406e80a8d135}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   235
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   236
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   237
Used by the application to send a SDO request frame to read in the dictionary of a server node whose node\_\-id is ID at the index and sub\-Index indicated bus\_\-id is hardware dependant datatype (defined in \hyperlink{objdictdef_8h}{objdictdef.h}) : put \char`\"{}visible\_\-string\char`\"{} for strings, 0 for integers or reals or other value. return 0x\-FF if error, else return 0 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   238
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   239
Definition at line 1282 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   240
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   241
References \_\-read\-Network\-Dict(), and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{sdo_8h_542a5cdd20c00aa130a39fe68295e769}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   242
\index{sdo.h@{sdo.h}!readNetworkDictCallback@{readNetworkDictCallback}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   243
\index{readNetworkDictCallback@{readNetworkDictCallback}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   244
\subsubsection[readNetworkDictCallback]{\setlength{\rightskip}{0pt plus 5cm}UNS8 read\-Network\-Dict\-Callback (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS8 {\em data\-Type}, \hyperlink{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{SDOCallback\_\-t} {\em Callback})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   245
\label{sdo_8h_542a5cdd20c00aa130a39fe68295e769}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   246
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   247
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   248
Used to send a SDO request frame to read in a distant node dictionnary. The function Callback which must be defined in the user code is called at the end of the exchange. (on succes or abort). 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   249
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   250
Definition at line 1288 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   251
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   252
References \_\-read\-Network\-Dict(), and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{sdo_8h_1f4f07eccc4890a11ccf4f632da7740b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   253
\index{sdo.h@{sdo.h}!resetSDO@{resetSDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   254
\index{resetSDO@{resetSDO}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   255
\subsubsection[resetSDO]{\setlength{\rightskip}{0pt plus 5cm}void reset\-SDO (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   256
\label{sdo_8h_1f4f07eccc4890a11ccf4f632da7740b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   257
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   258
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   259
Reset all sdo buffers 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   260
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   261
Definition at line 131 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   262
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   263
References struct\_\-s\_\-timer\_\-entry::d, reset\-SDOline(), SDO\_\-MAX\_\-SIMULTANEOUS\_\-TRANSFERTS, and UNS8.\hypertarget{sdo_8h_42d33be015d4c4c83c73f1f0e588f481}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   264
\index{sdo.h@{sdo.h}!resetSDOline@{resetSDOline}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   265
\index{resetSDOline@{resetSDOline}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   266
\subsubsection[resetSDOline]{\setlength{\rightskip}{0pt plus 5cm}void reset\-SDOline (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   267
\label{sdo_8h_42d33be015d4c4c83c73f1f0e588f481}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   268
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   269
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   270
Reset an unused line. 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   271
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   272
Definition at line 253 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   273
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   274
References struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data, init\-SDOline(), MSG\_\-WAR, SDO\_\-MAX\_\-LENGTH\_\-TRANSFERT, SDO\_\-RESET, struct\_\-CO\_\-Data::transfers, and UNS8.\hypertarget{sdo_8h_2eb5309dca3a7363da5e5e7230b85d58}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   275
\index{sdo.h@{sdo.h}!SDOlineToObjdict@{SDOlineToObjdict}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   276
\index{SDOlineToObjdict@{SDOlineToObjdict}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   277
\subsubsection[SDOlineToObjdict]{\setlength{\rightskip}{0pt plus 5cm}UNS32 SDOline\-To\-Objdict (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   278
\label{sdo_8h_2eb5309dca3a7363da5e5e7230b85d58}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   279
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   280
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   281
Copy the data received from the SDO line transfert to the object dictionary Returns SDO error code if error. Else, returns 0; 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   282
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   283
Definition at line 141 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   284
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   285
References struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data, struct\_\-s\_\-transfer::index, MSG\_\-WAR, OD\_\-SUCCESSFUL, set\-ODentry(), struct\_\-s\_\-transfer::sub\-Index, struct\_\-CO\_\-Data::transfers, UNS32, and UNS8.\hypertarget{sdo_8h_9309025e29b59e09026abcd3b45a5b61}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   286
\index{sdo.h@{sdo.h}!SDOTimeoutAlarm@{SDOTimeoutAlarm}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   287
\index{SDOTimeoutAlarm@{SDOTimeoutAlarm}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   288
\subsubsection[SDOTimeoutAlarm]{\setlength{\rightskip}{0pt plus 5cm}void SDOTimeout\-Alarm (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS32 {\em id})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   289
\label{sdo_8h_9309025e29b59e09026abcd3b45a5b61}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   290
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   291
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   292
Reset of a SDO exchange on timeout. Send a SDO abort 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   293
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   294
Definition at line 93 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   295
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   296
References struct\_\-s\_\-transfer::abort\-Code, struct\_\-s\_\-transfer::Callback, struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::index, MSG\_\-ERR, MSG\_\-WAR, struct\_\-s\_\-transfer::node\-Id, reset\-SDOline(), SDO\_\-ABORTED\_\-INTERNAL, SDO\_\-SERVER, SDOABT\_\-TIMED\_\-OUT, send\-SDOabort(), struct\_\-s\_\-transfer::state, struct\_\-s\_\-transfer::sub\-Index, struct\_\-s\_\-transfer::timer, struct\_\-CO\_\-Data::transfers, UNS8, and struct\_\-s\_\-transfer::whoami.\hypertarget{sdo_8h_18b6f7e9c9441640a88ffef1e8720694}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   297
\index{sdo.h@{sdo.h}!SDOtoLine@{SDOtoLine}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   298
\index{SDOtoLine@{SDOtoLine}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   299
\subsubsection[SDOtoLine]{\setlength{\rightskip}{0pt plus 5cm}UNS8 SDOto\-Line (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line}, UNS8 {\em nb\-Bytes}, UNS8 $\ast$ {\em data})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   300
\label{sdo_8h_18b6f7e9c9441640a88ffef1e8720694}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   301
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   302
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   303
Add data to an existant line Returns 0x\-FF if error. Else, returns 0; 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   304
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   305
Definition at line 210 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   306
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   307
References struct\_\-s\_\-timer\_\-entry::d, struct\_\-s\_\-transfer::data, MSG\_\-ERR, struct\_\-s\_\-transfer::offset, SDO\_\-MAX\_\-LENGTH\_\-TRANSFERT, struct\_\-CO\_\-Data::transfers, and UNS8.\hypertarget{sdo_8h_c6b5d7d1439d537da992a96644a1ca5d}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   308
\index{sdo.h@{sdo.h}!sendSDO@{sendSDO}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   309
\index{sendSDO@{sendSDO}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   310
\subsubsection[sendSDO]{\setlength{\rightskip}{0pt plus 5cm}UNS8 send\-SDO (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em whoami}, \hyperlink{structstruct__s__SDO}{s\_\-SDO} {\em sdo})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   311
\label{sdo_8h_c6b5d7d1439d537da992a96644a1ca5d}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   312
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   313
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   314
Transmit a SDO frame on the bus bus\_\-id sdo is a structure which contains the sdo to transmit bus\_\-id is hardware dependant whoami takes 2 values : SDO\_\-CLIENT or SDO\_\-SERVER return can\-Send(bus\_\-id,\&m) or 0x\-FF if error 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   315
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   316
Definition at line 354 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   317
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   318
References struct\_\-s\_\-SDO::body, td\_\-indextable::b\-Sub\-Count, struct\_\-CO\_\-Data::can\-Handle, can\-Send(), Message::cob\_\-id, struct\_\-s\_\-timer\_\-entry::d, BODY::data, Message::data, struct\_\-CO\_\-Data::first\-Index, struct\_\-CO\_\-Data::last\-Index, Message::len, MSG\_\-ERR, MSG\_\-WAR, struct\_\-s\_\-SDO::node\-Id, struct\_\-CO\_\-Data::node\-State, NOT\_\-A\_\-REQUEST, struct\_\-CO\_\-Data::objdict, Operational, td\_\-subindex::p\-Object, Pre\_\-operational, td\_\-indextable::p\-Subindex, Message::rtr, s\_\-quick\_\-index::SDO\_\-CLT, SDO\_\-SERVER, s\_\-quick\_\-index::SDO\_\-SVR, UNS16, UNS32, UNS8, and SHORT\_\-CAN::w.\hypertarget{sdo_8h_b26c3f2fb63d81055809d6ccaa785b7c}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   319
\index{sdo.h@{sdo.h}!sendSDOabort@{sendSDOabort}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   320
\index{sendSDOabort@{sendSDOabort}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   321
\subsubsection[sendSDOabort]{\setlength{\rightskip}{0pt plus 5cm}UNS8 send\-SDOabort (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em whoami}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS32 {\em abort\-Code})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   322
\label{sdo_8h_b26c3f2fb63d81055809d6ccaa785b7c}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   323
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   324
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   325
Transmit a SDO error to the client. The reasons may be : Read/Write to a undefined object Read/Write to a undefined subindex Read/write a not valid length object Write a read only object whoami takes 2 values : SDO\_\-CLIENT or SDO\_\-SERVER 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   326
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   327
Definition at line 424 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   328
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   329
References struct\_\-CO\_\-Data::b\-Device\-Node\-Id, struct\_\-s\_\-SDO::body, struct\_\-s\_\-timer\_\-entry::d, BODY::data, MSG\_\-WAR, struct\_\-s\_\-SDO::node\-Id, send\-SDO(), and UNS8.\hypertarget{sdo_8h_601a837ecb5f21bf4c66b058c5ae7810}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   330
\index{sdo.h@{sdo.h}!setSDOlineRestBytes@{setSDOlineRestBytes}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   331
\index{setSDOlineRestBytes@{setSDOlineRestBytes}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   332
\subsubsection[setSDOlineRestBytes]{\setlength{\rightskip}{0pt plus 5cm}UNS8 set\-SDOline\-Rest\-Bytes (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em line}, UNS8 {\em nb\-Bytes})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   333
\label{sdo_8h_601a837ecb5f21bf4c66b058c5ae7810}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   334
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   335
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   336
Store in the line structure the nb of bytes which must be transmited (or received) bus\_\-id is hardware dependant. return 0 if success, 0x\-FF if error. 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   337
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   338
Definition at line 342 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   339
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   340
References struct\_\-s\_\-transfer::count, struct\_\-s\_\-timer\_\-entry::d, MSG\_\-ERR, SDO\_\-MAX\_\-LENGTH\_\-TRANSFERT, and struct\_\-CO\_\-Data::transfers.\hypertarget{sdo_8h_bc20ed246e00053dcf71faa8f45ee39c}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   341
\index{sdo.h@{sdo.h}!writeNetworkDict@{writeNetworkDict}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   342
\index{writeNetworkDict@{writeNetworkDict}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   343
\subsubsection[writeNetworkDict]{\setlength{\rightskip}{0pt plus 5cm}UNS8 write\-Network\-Dict (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS8 {\em count}, UNS8 {\em data\-Type}, void $\ast$ {\em data})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   344
\label{sdo_8h_bc20ed246e00053dcf71faa8f45ee39c}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   345
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   346
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   347
Used by the application to send a SDO request frame to write the data $\ast$data at the index and sub\-Index indicated in the dictionary of the slave whose node\_\-id is node\-Id Count : nb of bytes to write in the dictionnary. datatype (defined in \hyperlink{objdictdef_8h}{objdictdef.h}) : put \char`\"{}visible\_\-string\char`\"{} for strings, 0 for integers or reals or other value. bus\_\-id is hardware dependant return 0x\-FF if error, else return 0 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   348
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   349
Definition at line 1182 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   350
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   351
References \_\-write\-Network\-Dict(), and struct\_\-s\_\-timer\_\-entry::d.\hypertarget{sdo_8h_f4ec05293fb8971a1b282994498ed4f5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   352
\index{sdo.h@{sdo.h}!writeNetworkDictCallBack@{writeNetworkDictCallBack}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   353
\index{writeNetworkDictCallBack@{writeNetworkDictCallBack}!sdo.h@{sdo.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   354
\subsubsection[writeNetworkDictCallBack]{\setlength{\rightskip}{0pt plus 5cm}UNS8 write\-Network\-Dict\-Call\-Back (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d}, UNS8 {\em node\-Id}, UNS16 {\em index}, UNS8 {\em sub\-Index}, UNS8 {\em count}, UNS8 {\em data\-Type}, void $\ast$ {\em data}, \hyperlink{sdo_8h_606eccfef67e572723e1efba3f0d87ba}{SDOCallback\_\-t} {\em Callback})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   355
\label{sdo_8h_f4ec05293fb8971a1b282994498ed4f5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   356
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   357
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   358
Used to send a SDO request frame to write in a distant node dictionnary. The function Callback which must be defined in the user code is called at the end of the exchange. (on succes or abort). 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   359
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   360
Definition at line 1190 of file sdo.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   361
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   362
References \_\-write\-Network\-Dict(), and struct\_\-s\_\-timer\_\-entry::d.