From 8b7f196f5ce34c284390624cedfecb86e70a9cc6 Mon Sep 17 00:00:00 2001
From: Florian Pose <fp@igh-essen.com>
Date: Wed, 10 Jan 2007 10:58:49 +0000
Subject: [PATCH] Added some documentation.
---
master/datagram.h | 5 ++++-
master/master.c | 4 ++++
2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/master/datagram.h b/master/datagram.h
index b4519df1..35fec906 100644
--- a/master/datagram.h
+++ b/master/datagram.h
@@ -89,12 +89,15 @@ ec_datagram_state_t;
typedef union
{
+ /**
+ * Physical address.
+ */
struct
{
uint16_t slave; /**< configured or autoincrement address */
uint16_t mem; /**< physical memory address */
}
- physical; /**< physical address */
+ physical;
uint32_t logical; /**< logical address */
}
diff --git a/master/master.c b/master/master.c
index 9c83e235..d558ae78 100644
--- a/master/master.c
+++ b/master/master.c
@@ -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 */)
@@ -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 */)
@@ -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 */)
@@ -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
--
GitLab