diff -r 003cc3c63855 -r f49e5a6b7804 doc/doxygen/html/sdo_8h.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/doxygen/html/sdo_8h.html Fri Jun 08 09:23:56 2007 +0200 @@ -0,0 +1,1609 @@ + + +CanFestival: include/sdo.h File Reference + + + + +
+
+
+
+ +

sdo.h File Reference

#include "timer.h"
+#include "data.h"
+ +

+Include dependency graph for sdo.h:

+ + + + + + + + + + + + + + + + + +

+This graph shows which files directly or indirectly include this file:

+ + + + + + + + + + + + + + + + + + + + + + + +

+Go to the source code of this file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  struct_s_transfer
struct  BODY
struct  struct_s_SDO

Typedefs

typedef void(*) SDOCallback_t (CO_Data *d, UNS8 nodeId)
typedef struct_s_transfer s_transfer
typedef struct_s_SDO s_SDO

Functions

void SDOTimeoutAlarm (CO_Data *d, UNS32 id)
void resetSDO (CO_Data *d)
UNS32 SDOlineToObjdict (CO_Data *d, UNS8 line)
UNS32 objdictToSDOline (CO_Data *d, UNS8 line)
UNS8 lineToSDO (CO_Data *d, UNS8 line, UNS8 nbBytes, UNS8 *data)
UNS8 SDOtoLine (CO_Data *d, UNS8 line, UNS8 nbBytes, UNS8 *data)
UNS8 failedSDO (CO_Data *d, UNS8 nodeId, UNS8 whoami, UNS16 index, UNS8 subIndex, UNS32 abortCode)
void resetSDOline (CO_Data *d, UNS8 line)
UNS8 initSDOline (CO_Data *d, UNS8 line, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 state)
UNS8 getSDOfreeLine (CO_Data *d, UNS8 whoami, UNS8 *line)
UNS8 getSDOlineOnUse (CO_Data *d, UNS8 nodeId, UNS8 whoami, UNS8 *line)
UNS8 closeSDOtransfer (CO_Data *d, UNS8 nodeId, UNS8 whoami)
UNS8 getSDOlineRestBytes (CO_Data *d, UNS8 line, UNS8 *nbBytes)
UNS8 setSDOlineRestBytes (CO_Data *d, UNS8 line, UNS8 nbBytes)
UNS8 sendSDO (CO_Data *d, UNS8 whoami, s_SDO sdo)
UNS8 sendSDOabort (CO_Data *d, UNS8 whoami, UNS16 index, UNS8 subIndex, UNS32 abortCode)
UNS8 proceedSDO (CO_Data *d, Message *m)
UNS8 writeNetworkDict (CO_Data *d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 count, UNS8 dataType, void *data)
UNS8 writeNetworkDictCallBack (CO_Data *d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 count, UNS8 dataType, void *data, SDOCallback_t Callback)
UNS8 readNetworkDict (CO_Data *d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 dataType)
UNS8 readNetworkDictCallback (CO_Data *d, UNS8 nodeId, UNS16 index, UNS8 subIndex, UNS8 dataType, SDOCallback_t Callback)
UNS8 getReadResultNetworkDict (CO_Data *d, UNS8 nodeId, void *data, UNS8 *size, UNS32 *abortCode)
UNS8 getWriteResultNetworkDict (CO_Data *d, UNS8 nodeId, UNS32 *abortCode)
+


Typedef Documentation

+ +
+
+ + + + +
typedef struct struct_s_SDO s_SDO
+
+
+ +

+ +

+Definition at line 86 of file sdo.h. +

+

+ +

+
+ + + + +
typedef struct struct_s_transfer s_transfer
+
+
+ +

+ +

+Definition at line 69 of file sdo.h. +

+

+ +

+
+ + + + +
typedef void(*) SDOCallback_t(CO_Data *d, UNS8 nodeId)
+
+
+ +

+ +

+Definition at line 30 of file sdo.h. +

+

+


Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 closeSDOtransfer (CO_Data d,
UNS8  nodeId,
UNS8  whoami 
)
+
+
+ +

+

Parameters:
+ + + + +
d 
nodeId 
whoami 
+
+
Returns:
+ +

+Definition at line 439 of file sdo.c. +

+References struct_s_timer_entry::d, getSDOlineOnUse(), MSG_WAR, resetSDOline(), and UNS8. +

+Referenced by ReadSDO(), and TestMaster_post_TPDO(). +

+Here is the call graph for this function:

+ + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 failedSDO (CO_Data d,
UNS8  nodeId,
UNS8  whoami,
UNS16  index,
UNS8  subIndex,
UNS32  abortCode 
)
+
+
+ +

+

Parameters:
+ + + + + + + +
d 
nodeId 
whoami 
index 
subIndex 
abortCode 
+
+
Returns:
+ +

+Definition at line 307 of file sdo.c. +

+References struct_s_timer_entry::d, getSDOlineOnUse(), MSG_WAR, resetSDOline(), SDO_ABORTED_INTERNAL, SDO_CLIENT, SDO_SERVER, sendSDOabort(), struct_s_transfer::state, StopSDO_TIMER, struct_CO_Data::transfers, and UNS8. +

+Referenced by proceedSDO(). +

+Here is the call graph for this function:

+ + + + + + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 getReadResultNetworkDict (CO_Data d,
UNS8  nodeId,
void *  data,
UNS8 *  size,
UNS32 *  abortCode 
)
+
+
+ +

+

Parameters:
+ + + + + + +
d 
nodeId 
data 
size 
abortCode 
+
+
Returns:
+ +

+Definition at line 1532 of file sdo.c. +

+References CANOPEN_BIG_ENDIAN, struct_s_transfer::count, struct_s_timer_entry::d, struct_s_transfer::data, struct_s_transfer::dataType, getSDOlineOnUse(), MSG_ERR, SDO_ABORTED_INTERNAL, SDO_CLIENT, SDO_FINISHED, struct_s_transfer::state, struct_CO_Data::transfers, UNS8, and visible_string. +

+Referenced by ReadSDO(), and TestMaster_post_TPDO(). +

+Here is the call graph for this function:

+ + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 getSDOfreeLine (CO_Data d,
UNS8  whoami,
UNS8 *  line 
)
+
+
+ +

+

Parameters:
+ + + + +
d 
whoami 
line 
+
+
Returns:
+ +

+Definition at line 388 of file sdo.c. +

+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. +

+Referenced by _readNetworkDict(), _writeNetworkDict(), and proceedSDO(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 getSDOlineOnUse (CO_Data d,
UNS8  nodeId,
UNS8  whoami,
UNS8 *  line 
)
+
+
+ +

+

Parameters:
+ + + + + +
d 
nodeId 
whoami 
line 
+
+
Returns:
+ +

+Definition at line 414 of file sdo.c. +

+References struct_s_timer_entry::d, struct_s_transfer::nodeId, SDO_MAX_SIMULTANEOUS_TRANSFERTS, SDO_RESET, struct_s_transfer::state, struct_CO_Data::transfers, UNS8, and struct_s_transfer::whoami. +

+Referenced by _readNetworkDict(), _writeNetworkDict(), closeSDOtransfer(), failedSDO(), getReadResultNetworkDict(), getWriteResultNetworkDict(), and proceedSDO(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 getSDOlineRestBytes (CO_Data d,
UNS8  line,
UNS8 *  nbBytes 
)
+
+
+ +

+

Parameters:
+ + + + +
d 
line 
nbBytes 
+
+
Returns:
+ +

+Definition at line 461 of file sdo.c. +

+References struct_s_transfer::count, struct_s_timer_entry::d, struct_s_transfer::offset, struct_CO_Data::transfers, and UNS8. +

+Referenced by proceedSDO(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 getWriteResultNetworkDict (CO_Data d,
UNS8  nodeId,
UNS32 *  abortCode 
)
+
+
+ +

+

Parameters:
+ + + + +
d 
nodeId 
abortCode 
+
+
Returns:
+ +

+Definition at line 1573 of file sdo.c. +

+References struct_s_transfer::abortCode, struct_s_timer_entry::d, getSDOlineOnUse(), MSG_ERR, SDO_ABORTED_INTERNAL, SDO_CLIENT, struct_s_transfer::state, struct_CO_Data::transfers, and UNS8. +

+Here is the call graph for this function:

+ + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 initSDOline (CO_Data d,
UNS8  line,
UNS8  nodeId,
UNS16  index,
UNS8  subIndex,
UNS8  state 
)
+
+
+ +

+

Parameters:
+ + + + + + + +
d 
line 
nodeId 
index 
subIndex 
state 
+
+
Returns:
+ +

+Definition at line 359 of file sdo.c. +

+References struct_s_transfer::Callback, struct_s_transfer::count, struct_s_timer_entry::d, struct_s_transfer::dataType, struct_s_transfer::index, MSG_WAR, struct_s_transfer::nodeId, struct_s_transfer::offset, SDO_DOWNLOAD_IN_PROGRESS, SDO_UPLOAD_IN_PROGRESS, StartSDO_TIMER, struct_s_transfer::state, StopSDO_TIMER, struct_s_transfer::subIndex, struct_s_transfer::toggle, and struct_CO_Data::transfers. +

+Referenced by _readNetworkDict(), _writeNetworkDict(), proceedSDO(), and resetSDOline(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 lineToSDO (CO_Data d,
UNS8  line,
UNS8  nbBytes,
UNS8 *  data 
)
+
+
+ +

+

Parameters:
+ + + + + +
d 
line 
nbBytes 
data 
+
+
Returns:
+ +

+Definition at line 250 of file sdo.c. +

+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. +

+Referenced by proceedSDO(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
UNS32 objdictToSDOline (CO_Data d,
UNS8  line 
)
+
+
+ +

+

Parameters:
+ + + +
d 
line 
+
+
Returns:
+ +

+Definition at line 209 of file sdo.c. +

+References struct_s_transfer::count, struct_s_timer_entry::d, struct_s_transfer::data, getODentry(), struct_s_transfer::index, MSG_WAR, OD_SUCCESSFUL, struct_s_transfer::offset, struct_s_transfer::subIndex, struct_CO_Data::transfers, UNS32, and UNS8. +

+Referenced by proceedSDO(). +

+Here is the call graph for this function:

+ + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
UNS8 proceedSDO (CO_Data d,
Message m 
)
+
+
+ +

+

Parameters:
+ + + +
d 
m 
+
+
Returns:
+ +

+The server node Id;

+The server node Id; +

+Definition at line 608 of file sdo.c. +

+References struct_s_transfer::abortCode, struct_CO_Data::bDeviceNodeId, struct_s_SDO::body, td_indextable::bSubCount, struct_s_transfer::Callback, struct_s_transfer::count, struct_s_timer_entry::d, BODY::data, Message::data, failedSDO(), struct_CO_Data::firstIndex, getSDOc, getSDOcs, getSDOe, getSDOfreeLine(), getSDOindex, getSDOlineOnUse(), getSDOlineRestBytes(), getSDOn2, getSDOn3, getSDOs, getSDOsubIndex, getSDOt, struct_s_transfer::index, initSDOline(), struct_CO_Data::lastIndex, lineToSDO(), MSG_ERR, MSG_WAR, struct_s_SDO::nodeId, struct_CO_Data::objdict, objdictToSDOline(), td_subindex::pObject, td_indextable::pSubindex, resetSDOline(), RestartSDO_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, SDOlineToObjdict(), SDOtoLine(), sendSDO(), setSDOlineRestBytes(), struct_s_transfer::state, StopSDO_TIMER, struct_s_transfer::subIndex, struct_s_transfer::toggle, struct_CO_Data::transfers, UNS16, UNS32, and UNS8. +

+Referenced by canDispatch(). +

+Here is the call graph for this function:

+ + + + + + + + + + + + + + + + + + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 readNetworkDict (CO_Data d,
UNS8  nodeId,
UNS16  index,
UNS8  subIndex,
UNS8  dataType 
)
+
+
+ +

+

Parameters:
+ + + + + + +
d 
nodeId 
index 
subIndex 
dataType 
+
+
Returns:
+ +

+Definition at line 1499 of file sdo.c. +

+References _readNetworkDict(), and struct_s_timer_entry::d. +

+Referenced by ReadSDO(), and TestMaster_post_TPDO(). +

+Here is the call graph for this function:

+ + + + + + + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 readNetworkDictCallback (CO_Data d,
UNS8  nodeId,
UNS16  index,
UNS8  subIndex,
UNS8  dataType,
SDOCallback_t  Callback 
)
+
+
+ +

+

Parameters:
+ + + + + + + +
d 
nodeId 
index 
subIndex 
dataType 
Callback 
+
+
Returns:
+ +

+Definition at line 1516 of file sdo.c. +

+References _readNetworkDict(), and struct_s_timer_entry::d. +

+Here is the call graph for this function:

+ + + + + + + + + + + +
+

+ +

+
+ + + + + + + + + +
void resetSDO (CO_Data d  ) 
+
+
+ +

+Reset all sdo buffers

+

Parameters:
+ + +
d 
+
+ +

+Definition at line 169 of file sdo.c. +

+References struct_s_timer_entry::d, resetSDOline(), SDO_MAX_SIMULTANEOUS_TRANSFERTS, and UNS8. +

+Referenced by switchCommunicationState(). +

+Here is the call graph for this function:

+ + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void resetSDOline (CO_Data d,
UNS8  line 
)
+
+
+ +

+

Parameters:
+ + + +
d 
line 
+
+ +

+Definition at line 338 of file sdo.c. +

+References struct_s_timer_entry::d, struct_s_transfer::data, initSDOline(), MSG_WAR, SDO_MAX_LENGTH_TRANSFERT, SDO_RESET, struct_CO_Data::transfers, and UNS8. +

+Referenced by _readNetworkDict(), _writeNetworkDict(), closeSDOtransfer(), failedSDO(), proceedSDO(), resetSDO(), and SDOTimeoutAlarm(). +

+Here is the call graph for this function:

+ + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
UNS32 SDOlineToObjdict (CO_Data d,
UNS8  line 
)
+
+
+ +

+

Parameters:
+ + + +
d 
line 
+
+
Returns:
+ +

+Definition at line 186 of file sdo.c. +

+References struct_s_transfer::count, struct_s_timer_entry::d, struct_s_transfer::data, struct_s_transfer::index, MSG_WAR, OD_SUCCESSFUL, setODentry(), struct_s_transfer::subIndex, struct_CO_Data::transfers, UNS32, and UNS8. +

+Referenced by proceedSDO(). +

+Here is the call graph for this function:

+ + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void SDOTimeoutAlarm (CO_Data d,
UNS32  id 
)
+
+
+ +

+

Parameters:
+ + + +
d 
id 
+
+ +

+Definition at line 129 of file sdo.c. +

+References struct_s_transfer::abortCode, struct_s_transfer::Callback, struct_s_timer_entry::d, struct_s_transfer::index, MSG_ERR, MSG_WAR, struct_s_transfer::nodeId, resetSDOline(), SDO_ABORTED_INTERNAL, SDO_SERVER, SDOABT_TIMED_OUT, sendSDOabort(), struct_s_transfer::state, struct_s_transfer::subIndex, struct_s_transfer::timer, struct_CO_Data::transfers, UNS8, and struct_s_transfer::whoami. +

+Here is the call graph for this function:

+ + + + + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 SDOtoLine (CO_Data d,
UNS8  line,
UNS8  nbBytes,
UNS8 *  data 
)
+
+
+ +

+

Parameters:
+ + + + + +
d 
line 
nbBytes 
data 
+
+
Returns:
+ +

+Definition at line 279 of file sdo.c. +

+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. +

+Referenced by proceedSDO(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 sendSDO (CO_Data d,
UNS8  whoami,
s_SDO  sdo 
)
+
+
+ +

+

Parameters:
+ + + + +
d 
whoami 
sdo 
+
+
Returns:
+ +

+Definition at line 498 of file sdo.c. +

+References struct_s_SDO::body, td_indextable::bSubCount, struct_CO_Data::canHandle, canSend(), Message::cob_id, struct_s_timer_entry::d, BODY::data, Message::data, struct_CO_Data::firstIndex, struct_CO_Data::lastIndex, Message::len, MSG_ERR, MSG_WAR, struct_s_SDO::nodeId, struct_CO_Data::nodeState, NOT_A_REQUEST, struct_CO_Data::objdict, Operational, td_subindex::pObject, Pre_operational, td_indextable::pSubindex, Message::rtr, s_quick_index::SDO_CLT, SDO_SERVER, s_quick_index::SDO_SVR, UNS16, UNS32, UNS8, and SHORT_CAN::w. +

+Referenced by _readNetworkDict(), _writeNetworkDict(), proceedSDO(), and sendSDOabort(). +

+Here is the call graph for this function:

+ + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 sendSDOabort (CO_Data d,
UNS8  whoami,
UNS16  index,
UNS8  subIndex,
UNS32  abortCode 
)
+
+
+ +

+

Parameters:
+ + + + + + +
d 
whoami 
index 
subIndex 
abortCode 
+
+
Returns:
+ +

+Definition at line 578 of file sdo.c. +

+References struct_CO_Data::bDeviceNodeId, struct_s_SDO::body, struct_s_timer_entry::d, BODY::data, MSG_WAR, struct_s_SDO::nodeId, sendSDO(), and UNS8. +

+Referenced by failedSDO(), and SDOTimeoutAlarm(). +

+Here is the call graph for this function:

+ + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 setSDOlineRestBytes (CO_Data d,
UNS8  line,
UNS8  nbBytes 
)
+
+
+ +

+

Parameters:
+ + + + +
d 
line 
nbBytes 
+
+
Returns:
+ +

+Definition at line 479 of file sdo.c. +

+References struct_s_transfer::count, struct_s_timer_entry::d, MSG_ERR, SDO_MAX_LENGTH_TRANSFERT, and struct_CO_Data::transfers. +

+Referenced by proceedSDO(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 writeNetworkDict (CO_Data d,
UNS8  nodeId,
UNS16  index,
UNS8  subIndex,
UNS8  count,
UNS8  dataType,
void *  data 
)
+
+
+ +

+

Parameters:
+ + + + + + + + +
d 
nodeId 
index 
subIndex 
count 
dataType 
data 
+
+
Returns:
+ +

+Definition at line 1368 of file sdo.c. +

+References _writeNetworkDict(), and struct_s_timer_entry::d. +

+Here is the call graph for this function:

+ + + + + + + + + + + +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
UNS8 writeNetworkDictCallBack (CO_Data d,
UNS8  nodeId,
UNS16  index,
UNS8  subIndex,
UNS8  count,
UNS8  dataType,
void *  data,
SDOCallback_t  Callback 
)
+
+
+ +

+

Parameters:
+ + + + + + + + + +
d 
nodeId 
index 
subIndex 
count 
dataType 
data 
Callback 
+
+
Returns:
+ +

+Definition at line 1388 of file sdo.c. +

+References _writeNetworkDict(), and struct_s_timer_entry::d. +

+Here is the call graph for this function:

+ + + + + + + + + + + +
+

+


Generated on Fri Jun 8 08:52:04 2007 for CanFestival by  + +doxygen 1.5.1
+ +