Skip to content
Snippets Groups Projects
Commit 8b7f196f authored by Florian Pose's avatar Florian Pose
Browse files

Added some documentation.

parent ffbcc881
No related branches found
No related tags found
No related merge requests found
...@@ -89,12 +89,15 @@ ec_datagram_state_t; ...@@ -89,12 +89,15 @@ ec_datagram_state_t;
typedef union typedef union
{ {
/**
* Physical address.
*/
struct struct
{ {
uint16_t slave; /**< configured or autoincrement address */ uint16_t slave; /**< configured or autoincrement address */
uint16_t mem; /**< physical memory address */ uint16_t mem; /**< physical memory address */
} }
physical; /**< physical address */ physical;
uint32_t logical; /**< logical address */ uint32_t logical; /**< logical address */
} }
......
...@@ -374,6 +374,7 @@ void ec_master_thread_stop(ec_master_t *master /**< EtherCAT master */) ...@@ -374,6 +374,7 @@ void ec_master_thread_stop(ec_master_t *master /**< EtherCAT master */)
/*****************************************************************************/ /*****************************************************************************/
/** /**
* Transition function from ORPHANED to IDLE mode.
*/ */
int ec_master_enter_idle_mode(ec_master_t *master /**< EtherCAT master */) int ec_master_enter_idle_mode(ec_master_t *master /**< EtherCAT master */)
...@@ -394,6 +395,7 @@ int ec_master_enter_idle_mode(ec_master_t *master /**< EtherCAT master */) ...@@ -394,6 +395,7 @@ int ec_master_enter_idle_mode(ec_master_t *master /**< EtherCAT master */)
/*****************************************************************************/ /*****************************************************************************/
/** /**
* Transition function from IDLE to ORPHANED mode.
*/ */
void ec_master_leave_idle_mode(ec_master_t *master /**< EtherCAT master */) void ec_master_leave_idle_mode(ec_master_t *master /**< EtherCAT master */)
...@@ -408,6 +410,7 @@ void ec_master_leave_idle_mode(ec_master_t *master /**< EtherCAT master */) ...@@ -408,6 +410,7 @@ void ec_master_leave_idle_mode(ec_master_t *master /**< EtherCAT master */)
/*****************************************************************************/ /*****************************************************************************/
/** /**
* Transition function from IDLE to OPERATION mode.
*/ */
int ec_master_enter_operation_mode(ec_master_t *master /**< EtherCAT master */) int ec_master_enter_operation_mode(ec_master_t *master /**< EtherCAT master */)
...@@ -467,6 +470,7 @@ int ec_master_enter_operation_mode(ec_master_t *master /**< EtherCAT master */) ...@@ -467,6 +470,7 @@ int ec_master_enter_operation_mode(ec_master_t *master /**< EtherCAT master */)
/*****************************************************************************/ /*****************************************************************************/
/** /**
* Transition function from OPERATION to IDLE mode.
*/ */
void ec_master_leave_operation_mode(ec_master_t *master void ec_master_leave_operation_mode(ec_master_t *master
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment