draft/concept EoE

CMakeLists.txt

@@ -7,7 +7,7 @@ project (SOES)
 
 set (SOES_VERSION_MAJOR 2)
 set (SOES_VERSION_MINOR 1)
-set (SOES_VERSION_PATCH 4)
+set (SOES_VERSION_PATCH 5)
 
 # Generate version numbers
 configure_file (

README.md

@@ -28,6 +28,8 @@ Feature list:
  - Support DC sync0 and DC Synchronization
  - Add stack configuration via new configuration paramater to/or from 
    "stack"_init
+ - EoE
 
 TODO
  - Update documentation
+ - Add EoE sample application

soes/CMakeLists.txt

@@ -7,6 +7,8 @@ add_library (soes
   esc_coe.h
   esc_foe.c
   esc_foe.h
+  esc_eoe.c
+  esc_eoe.h
   esc_eep.c
   esc_eep.h
   ${HAL_SOURCES}
@@ -19,5 +21,6 @@ install (FILES
   esc.h
   esc_coe.h
   esc_foe.h
+  esc_eoe.h
   esc_eep.h
   DESTINATION include)

soes/esc.c

@@ -606,6 +606,8 @@ uint8_t ESC_mbxprocess (void)
       if (mbxhandle)
       {
          ESC_writembx (mbxhandle);
+         /* Refresh SM status */
+         ESC_SMstatus (1);
          /* change state */
          MBXcontrol[mbxhandle].state = MBXstate_outpost;
          ESCvar.mbxoutpost = mbxhandle;

soes/esc.h

@@ -208,6 +208,13 @@
 #define FOE_WAIT_FOR_FINAL_ACK         2
 #define FOE_WAIT_FOR_DATA              3
 
+#define EOE_RESULT_SUCCESS                   0x0000
+#define EOE_RESULT_UNSPECIFIED_ERROR         0x0001
+#define EOE_RESULT_UNSUPPORTED_FRAME_TYPE    0x0002
+#define EOE_RESULT_NO_IP_SUPPORT             0x0201
+#define EOE_RESULT_NO_DHCP_SUPPORT           0x0202
+#define EOE_RESULT_NO_FILTER_SUPPORT         0x0401
+
 #define APPSTATE_IDLE                  0x00
 #define APPSTATE_INPUT                 0x01
 #define APPSTATE_OUTPUT                0x02
@@ -543,6 +550,28 @@ typedef struct CC_PACKED
    };
 } _FOE;
 CC_PACKED_END
+
+CC_PACKED_BEGIN
+typedef struct CC_PACKED
+{
+   uint16_t frameinfo1;
+   union
+   {
+      uint16_t frameinfo2;
+      uint16_t result;
+   };
+} _EOEh;
+CC_PACKED_END
+
+CC_PACKED_BEGIN
+typedef struct CC_PACKED
+{
+   _MBXh mbxheader;
+   _EOEh eoeheader;
+   uint8_t data[0];
+} _EOE;
+CC_PACKED_END
+
 /* state definition in mailbox
  * 0 : idle
  * 1 : claimed for inbox
@@ -579,6 +608,8 @@ typedef struct
 #define ESC_MBXDSIZE        (ESC_MBXSIZE - ESC_MBXHSIZE)
 #define ESC_FOEHSIZE        sizeof(_FOEh)
 #define ESC_FOE_DATA_SIZE   (ESC_MBXSIZE - (ESC_MBXHSIZE +ESC_FOEHSIZE))
+#define ESC_EOEHSIZE        sizeof(_EOEh)
+#define ESC_EOE_DATA_SIZE   (ESC_MBXSIZE - (ESC_MBXHSIZE +ESC_EOEHSIZE))
 
 void ESC_config (esc_cfg_t * cfg);
 void ESC_ALerror (uint16_t errornumber);

soes/esc_eoe.h

@@ -0,0 +1,66 @@
+/*
+ * Licensed under the GNU General Public License version 2 with exceptions. See
+ * LICENSE file in the project root for full license information
+ */
+
+/** \file
+ * \brief
+ * Headerfile for esc_eoe.c
+ */
+
+#ifndef __esc_eoe__
+#define __esc_eoe__
+
+#include <cc.h>
+
+typedef struct eoe_pbuf
+{
+   /** Pointer to frame buffer type used by a TCP/IP stack. (Not mandatory) */
+   void * pbuf;
+   /** Pointer to frame buffer to send or read from */
+   uint8_t * payload;
+   /** Length of data in frame buffer */
+   size_t len;
+} eoe_pbuf_t;
+
+typedef struct eoe_cfg
+{
+   /** Callback function to get a frame buffer for storage of received frame */
+   void (*get_buffer) (eoe_pbuf_t * ebuf);
+   /** Callback function to free a frame buffer */
+   void (*free_buffer) (eoe_pbuf_t * ebuf);
+   /** Callback function to read local settings and update EtherCAT variables
+    *  to be delivered to the EtherCAT Master
+    */
+   int  (*load_eth_settings) (void);
+   /** Callback function to read settings provided by the EtherCAT master
+    * and store to local settings.
+    */
+   int  (*store_ethernet_settings) (void);
+   /** Callback to frame receive function in TCP(IP stack,
+    *  caller should free the buffer
+    * */
+   void (*handle_recv_buffer) (uint8_t port, eoe_pbuf_t * ebuf);
+   /** Callback to fetch a buffer to send */
+   int (*fetch_send_buffer) (uint8_t port, eoe_pbuf_t * ebuf);
+} eoe_cfg_t;
+
+int EOE_ecat_get_mac (uint8_t port, uint8_t mac[]);
+int EOE_ecat_get_ip (uint8_t port, uint32_t * ip);
+int EOE_ecat_get_subnet (uint8_t port, uint32_t * subnet);
+int EOE_ecat_get_gateway (uint8_t port, uint32_t * default_gateway);
+int EOE_ecat_get_dns_ip (uint8_t port, uint32_t * dns_ip);
+int EOE_ecat_get_dns_name (uint8_t port, char * dns_name);
+int EOE_ecat_set_mac (uint8_t port, uint8_t mac[]);
+int EOE_ecat_set_ip (uint8_t port, uint32_t ip);
+int EOE_ecat_set_subnet (uint8_t port, uint32_t subnet);
+int EOE_ecat_set_gateway (uint8_t port, uint32_t default_gateway);
+int EOE_ecat_set_dns_ip (uint8_t port, uint32_t dns_ip);
+int EOE_ecat_set_dns_name (uint8_t port, char * dns_name);
+
+void EOE_config (eoe_cfg_t * cfg);
+void EOE_init (void);
+void ESC_eoeprocess (void);
+void ESC_eoeprocess_tx (void);
+
+#endif