master/ethernet.c
branchstable-1.0
changeset 1618 5cff10efb927
parent 195 674071846ee3
child 1619 0d4119024f55
--- a/master/ethernet.c	Thu Apr 20 14:38:41 2006 +0000
+++ b/master/ethernet.c	Mon Apr 24 10:47:03 2006 +0000
@@ -1,13 +1,33 @@
 /******************************************************************************
  *
- *  e t h e r n e t . c
- *
- *  Ethernet-over-EtherCAT (EoE)
- *
  *  $Id$
  *
+ *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH
+ *
+ *  This file is part of the IgH EtherCAT Master.
+ *
+ *  The IgH EtherCAT Master is free software; you can redistribute it
+ *  and/or modify it under the terms of the GNU General Public License
+ *  as published by the Free Software Foundation; version 2 of the License.
+ *
+ *  The IgH EtherCAT Master is distributed in the hope that it will be
+ *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with the IgH EtherCAT Master; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
  *****************************************************************************/
 
+/**
+   \file
+   Ethernet-over-EtherCAT (EoE).
+*/
+
+/*****************************************************************************/
+
 #include "../include/ecrt.h"
 #include "globals.h"
 #include "master.h"
@@ -17,6 +37,10 @@
 
 /*****************************************************************************/
 
+/**
+   EoE constructor.
+*/
+
 void ec_eoe_init(ec_eoe_t *eoe, ec_slave_t *slave)
 {
     eoe->slave = slave;
@@ -25,12 +49,20 @@
 
 /*****************************************************************************/
 
+/**
+   EoE destructor.
+*/
+
 void ec_eoe_clear(ec_eoe_t *eoe)
 {
 }
 
 /*****************************************************************************/
 
+/**
+   Runs the EoE state machine.
+*/
+
 void ec_eoe_run(ec_eoe_t *eoe)
 {
     uint8_t *data;
@@ -110,6 +142,10 @@
 
 /*****************************************************************************/
 
+/**
+   Prints EoE object information.
+*/
+
 void ec_eoe_print(const ec_eoe_t *eoe)
 {
     EC_INFO("  EoE slave %i\n", eoe->slave->ring_position);