SOES：軟實現EtherCAT從站協議棧項目介紹及從站開發案例

在現代工業自動化領域，EtherCAT（Ethernet for Control Automation Technology）以其高速、實時和開放的特性，成為現場總線通信的主流協議之一。EtherCAT網絡中，主站（Master）負責調度和管理，而從站（Slave）則連接各類傳感器、執行器等設備。如何高效、低成本地實現EtherCAT從站，是嵌入式開發者關注的重點。SOES（Simple Open EtherCAT Slave）正是為此而生的開源協議棧解決方案。

- 一、SOES開源項目簡介
- 二、SOES源碼結構詳解
- 三、SOES項目與核心知識點的對應關系
- 四、SOES與EtherCAT從站芯片的關系
- 五、編譯與使用流程（參考 soes/doc/tutorial.txt）
- 六、典型開發流程
- 七、 SOES 從站開發案例
- - 1、開發概述
  - 2、啟動代碼示例
  - 3、配置流程
  - - 3.1. 硬件初始化
    - 3.2. 軟件初始化
    - 3.3. 應用循環
  - 4、應用層處理（DIG_process）
  - - 4.1. 輸出處理
    - 4.2. 輸入處理
  - 5、應用數據與過程數據映射
  - - SII-EEPROM
    - ESI 文件
    - 對象字典（Object Dictionary）
  - 6、SDO 參數與對象處理
  - 7、開發案例總結
- 八、總結
- 其他資源
- - 1. 直接使用EtherCAT協議開發從站的難點
  - 2. SOES的作用和優勢
  - （1）協議棧封裝
  - （2）兼容性和可靠性
  - （3）移植性和擴展性
  - （4）開發效率高
  - 3. 總結
- 1. **開源協議棧**
- - （1）**EtherLab IgH EtherCAT Slave Stack**
  - （2）**OpenEtherCAT Slave**
- 2. **商業協議棧**
- - （1）**Beckhoff EtherCAT Slave Stack Code (SSC)**
  - （2）**acontis EC-Master/EC-Slave**
  - （3）**Port GmbH EtherCAT Slave Stack**
- 3. **芯片廠商自帶協議棧**
- 4. **FPGA/軟核實現**
- 5. **對比與選擇建議**

一、SOES開源項目簡介

SOES（Simple Open EtherCAT Slave）是一個面向嵌入式系統的開源EtherCAT從站協議棧。它以C語言實現，代碼精簡、結構清晰，適合資源受限的MCU/SoC平臺。SOES的目標是為開發者提供一個易于移植、易于理解的EtherCAT從站實現，支持工業現場的高實時性和高可靠性需求。

開源項目地址：https://github.com/OpenEtherCATsociety/SOES

主要特性：

支持EtherCAT協議的核心功能，包括COE（CANopen over EtherCAT）、PDO、SDO、狀態機管理、同步機制等。
代碼高度模塊化，便于在不同硬件平臺上移植和擴展。
提供多種硬件平臺的參考實現（如樹莓派、XMC4300、TI AM335x等）。
適合學習、教學、產品開發和二次定制。

二、SOES源碼結構詳解

SOES項目結構清晰，主要目錄和文件說明如下：

SOES-master/
├── applications/         # 各硬件平臺的示例工程
│   ├── linux_lan9252demo/
│   ├── raspberry_lan9252demo/
│   ├── rtl_lwip_eoe/
│   ├── rtl_slavedemo/
│   ├── rtl_xmc4_dynpdo/
│   ├── tiesc_am335x/
│   ├── tiesc_k2gice/
│   └── xmc4300_slavedemo/
├── cmake/                # CMake構建腳本及工具鏈
├── drivers/              # EtherCAT芯片驅動（如LAN9252）
├── soes/                 # 協議棧核心代碼
│   ├── hal/              # 硬件抽象層（不同平臺適配）
│   ├── doc/              # 文檔（含tutorial.txt）
│   ├── ecat_slv.c/h      # 協議棧主控與狀態機
│   ├── esc.c/h           # EtherCAT核心功能
│   ├── esc_coe.c/h       # COE協議支持
│   ├── esc_eep.c/h       # EEPROM支持
│   ├── esc_eoe.c/h       # EOE協議支持
│   ├── esc_foe.c/h       # FOE協議支持
│   └── ...               # 其他協議與工具
├── README.md             # 項目說明
└── version.h.in

三、SOES項目與核心知識點的對應關系

EtherCAT協議棧實現
- 協議棧的核心代碼主要在 soes/ 目錄下，如 ecat_slv.c、esc.c、esc_coe.c 等文件，分別實現了EtherCAT協議的各個層級和COE（CANopen over EtherCAT）等擴展協議。
從站設備初始化
- 各平臺的初始化代碼在 applications/ 下的不同子目錄（如 main.c），以及 soes/hal/ 目錄下的硬件抽象層（HAL）代碼（如 esc_hw.c），負責初始化硬件和協議棧。
數據處理
- 數據的收發和處理主要在 ecat_slv.c 和各平臺的 main.c 文件中實現，負責與主站的數據交互。
PDO映射
- PDO的定義和映射通常在 objectlist.c 或 slave_objectlist.c 等文件中實現，這些文件定義了從站的過程數據對象結構。
SDO通信
- SDO相關的處理在 esc_coe.c 文件中實現，支持主站對從站參數的讀寫和配置。
同步機制
- 同步相關的代碼分布在 ecat_slv.c 和 esc.c，支持分布式時鐘（DC）和主站同步命令的響應。
狀態機管理
- 從站狀態機的實現主要在 ecat_slv.c，負責從站的各個狀態（如INIT、PRE-OP、SAFE-OP、OP）的切換和管理。
錯誤處理機制
- 錯誤檢測和處理邏輯分布在協議棧各層代碼中，如 esc.c、ecat_slv.c，并通過EtherCAT標準的錯誤寄存器和報警機制上報主站。
配置與診斷功能
- 相關功能在 esc_coe.c、esc_eep.c 等文件中實現，支持主站對從站的配置和診斷。
代碼的可移植性和模塊化
- SOES項目結構清晰，協議棧與硬件平臺解耦，便于在不同MCU/SoC平臺上移植。hal/ 目錄下為不同平臺提供了硬件適配層。

知識點	SOES源碼位置/實現說明
EtherCAT協議棧	`soes/ecat_slv.c`, `soes/esc.c`, `soes/esc_coe.c`
從站設備初始化	各`applications/xxx/main.c`，`soes/hal/`下各平臺代碼
數據處理	`soes/ecat_slv.c`，各平臺`main.c`
PDO映射	`applications/xxx/objectlist.c`或`slave_objectlist.c`
SDO通信	`soes/esc_coe.c`
同步機制	`soes/ecat_slv.c`, `soes/esc.c`
狀態機管理	`soes/ecat_slv.c`
錯誤處理機制	`soes/esc.c`, `soes/ecat_slv.c`
配置與診斷功能	`soes/esc_coe.c`, `soes/esc_eep.c`
可移植性和模塊化	`soes/hal/`，各平臺`applications/`

四、SOES與EtherCAT從站芯片的關系

雖然SOES是軟實現的協議棧，但在實際應用中，通常仍需配合專用的EtherCAT從站芯片（如LAN9252、ET1100等）或具備EtherCAT功能的硬件外設。

物理層與MAC層的實時性要求：EtherCAT對以太網幀的轉發延遲和時序有極高要求，專用芯片可在硬件層面實現幀的級聯轉發，保證網絡的實時性和確定性。
SOES的定位：SOES主要實現協議棧的上層邏輯（如對象字典、數據處理、狀態機等），而底層的幀收發、轉發、同步等高實時性操作，依賴硬件實現。SOES通過硬件抽象層（HAL）與這些芯片對接。
軟實現的局限性：理論上可以用MCU的以太網外設+軟件模擬EtherCAT底層，但很難達到工業級的實時性和兼容性。只有極少數高性能MCU/FPGA能做到全軟實現，但通常也會有專門的EtherCAT硬件模塊輔助。

五、編譯與使用流程（參考 soes/doc/tutorial.txt）

SOES項目的編譯和使用流程大致如下：

準備開發環境
- 安裝CMake、GCC/ARM-GCC等交叉編譯工具鏈。
- 準備目標硬件開發板（如樹莓派、XMC4300、AM335x等）。
選擇目標平臺
- 進入applications/目錄，選擇對應硬件平臺的子目錄（如linux_lan9252demo）。
配置與編譯
- 使用CMake生成Makefile或工程文件。例如：
```
cd applications/linux_lan9252demo
mkdir build && cd build
cmake ..
make
```
- 具體編譯參數和平臺相關配置可參考CMakeLists.txt和README.md。
燒錄與運行
- 將編譯生成的二進制文件燒錄到目標硬件。
- 連接EtherCAT主站（如TwinCAT、EtherLab等）進行網絡測試。
調試與擴展
- 可根據實際需求修改objectlist.c等文件，調整PDO/SDO映射和對象字典。
- 如需適配新硬件，需在soes/hal/下添加對應的硬件抽象層代碼。

詳細的編譯和移植說明可參考 soes/doc/tutorial.txt 文件。

六、典型開發流程

選擇目標硬件平臺，適配HAL層代碼。
配置對象字典（PDO/SDO）。
編譯并燒錄到目標設備。
使用EtherCAT主站軟件進行測試和調試。

七、 SOES 從站開發案例

1、開發概述

SOES 是一個庫，為微控制器用戶應用提供訪問 EtherCAT 現場總線通信環境的能力，包括：

EtherCAT 狀態機
郵箱接口
協議支持
- CoE（CANopen over EtherCAT）
- FoE（File over EtherCAT）及引導模板

郵箱和協議的支持是典型的應用場景，通常需要從站協議棧來控制 EtherCAT 的應用層。PDI（Process Data Interface，過程數據接口）通常是 SPI 或其他微控制器接口。

本教程將展示如何快速上手 SOES，并設計一個簡單的從站應用。所有代碼均為本地應用或全局變量，便于根據實際需求進行優化和調整。

目標應用示例：

輸入 40bit
- 一個按鈕（8bit）
- 一個編碼器值（32bit）
輸出 8bit
- LED（8bit）
參數
- 編碼器設置
從站命令
- 復位計數器

2、啟動代碼示例

main 函數的作用是啟動兩個任務：一個執行 SOES 協議棧，一個控制錯誤 LED。部分 ESC（EtherCAT Slave Controller）芯片自帶 RUN/ERROR LED 引腳，否則可由微控制器控制。

int main (void)
{rprintp ("SOES (Simple Open EtherCAT Slave)\nsoes test\n");// 啟動 led_error 任務task_spawn ("led_error", led_error, 15, 512, NULL);// 啟動 soes 任務task_spawn ("soes", soes, 9, 1024, NULL);return (0);
}

3、配置流程

soes 函數是 EtherCAT 從站的主入口，可分為三部分：硬件初始化、軟件初始化、應用循環。

3.1. 硬件初始化

esc_reset：如無物理 EEPROM，用于 ESC 復位（應用層本地實現）。
ESC_init：初始化 SPI 通信或類似接口。
等待 ESC 啟動，檢測 SPI 是否正常，查詢 ESC 寄存器 DL 狀態，確認 EEPROM 加載和 PDI 正常。

void soes (void *arg)
{TXPDOsize = SM3_sml = sizeTXPDO ();RXPDOsize = SM2_sml = sizeRXPDO ();esc_reset ();ESC_init ((void *)spi_name);task_delay (tick_from_ms (200));// 等待 ESC 啟動while ((ESCvar.DLstatus & 0x0001) == 0){ESC_read (ESCREG_DLSTATUS, (void *) &ESCvar.DLstatus,sizeof (ESCvar.DLstatus));ESCvar.DLstatus = etohs (ESCvar.DLstatus);}// 復位 ESC 到初始化狀態ESC_ALstatus (ESCinit);...
}

3.2. 軟件初始化

復位從站到 Init 狀態，清除錯誤，停止應用層（禁用 SyncManager，阻止數據交換）。

void soes (void *arg)
{
...while ((ESCvar.DLstatus & 0x0001) == 0){ESC_read (ESCREG_DLSTATUS, (void *) &ESCvar.DLstatus,sizeof (ESCvar.DLstatus));ESCvar.DLstatus = etohs (ESCvar.DLstatus);}// 復位 ESC 到初始化狀態ESC_ALstatus (ESCinit);ESC_ALerror (ALERR_NONE);ESC_stopmbx ();ESC_stopinput ();ESC_stopoutput ();// 應用主循環while (1)...
}

3.3. 應用循環

處理 ALevent（狀態變化、SyncManager 變化等）
處理 ESC 狀態機
處理郵箱及協議（如 CoE、FoE）
調用應用層處理函數（如 DIG_process）

void soes (void *arg)
{
...while (1){if((ESCvar.ALstatus & 0x0f) == ESCinit){txpdomap = DEFAULTTXPDOMAP;rxpdomap = DEFAULTRXPDOMAP;txpdoitems = DEFAULTTXPDOITEMS;rxpdoitems = DEFAULTTXPDOITEMS;}ESC_read (ESCREG_LOCALTIME, (void *) &ESCvar.Time, sizeof (ESCvar.Time));ESCvar.Time = etohl (ESCvar.Time);ESC_state ();if (ESC_mbxprocess ()){ESC_coeprocess ();ESC_foeprocess ();ESC_xoeprocess ();}DIG_process ();};
}

4、應用層處理（DIG_process）

4.1. 輸出處理

判斷當前是否處于支持輸出的狀態（如 OP 狀態）。
若在 OP 狀態，從 SyncManager2 讀取輸出 PDO 數據，刷新本地變量（如 LED 狀態），并寫入實際硬件（如 GPIO）。
包含看門狗機制，超時則關閉輸出并切換到安全狀態。

void RXPDO_update (void)
{ESC_read (SM2_sma, &Wb.LED, RXPDOsize);
}void DIG_process (void)
{if (App.state & APPSTATE_OUTPUT){if (ESCvar.ALevent & ESCREG_ALEVENT_SM2)  // SM2 觸發{RXPDO_update ();reset_wd ();gpio_set(GPIO_LED, Wb.LED & BIT(0));}if (!wd_cnt){ESC_stopoutput ();// 看門狗，輸出無效ESC_ALerror (ALERR_WATCHDOG);// 切換到安全操作狀態并設置錯誤位ESC_ALstatus (ESCsafeop | ESCerror);wd_trigger = 1;}}else{reset_wd ();}
...
}

4.2. 輸入處理

在安全操作狀態下持續更新輸入。
讀取用戶應用數據（如 GPIO），寫入本地 PDO 變量，再通過 SyncManager3 寫入 ESC RAM，供主站讀取。

void TXPDO_update (void)
{ESC_write (SM3_sma, &Rb.button, TXPDOsize);
}void DIG_process (void)
{
...Rb.button = gpio_get(GPIO_WAKEUP);Cb.reset_counter++;Rb.encoder =  Cb.reset_counter;TXPDO_update ();
}

5、應用數據與過程數據映射

要通過 EtherCAT 過程數據傳遞應用數據，需要用三種對象來描述數據：

ESI 文件（EtherCAT Slave Information，XML）
SII-EEPROM（Slave Information Interface，硬件存儲）
CoE 對象字典（Object Dictionary）

ESI 和 SII-EEPROM 是必需的，CoE 對象字典用于描述復雜從站。

SII-EEPROM

存儲設備標識、組、設備描述、SyncManager、Mailbox、DC（分布式時鐘）、EEPROM 配置等信息。

ESI 文件

XML 格式，描述從站的廠商、設備、組、SyncManager、Mailbox、CoE 支持、DC 支持等。

對象字典（Object Dictionary）

遵循 CANopen DS301 范圍，分區明確（如輸入區、輸出區、配置區等）。
RxPDO、TxPDO 分別映射到 0x1600-0x17FF、0x1A00-0x1BFF。
通過對象字典將本地變量與 EtherCAT PDO/SDO 映射關聯。

示例：

// objectlist.h
FLASHSTORE _objd SDO7000[] =
{ {0x00, DTYPE_UNSIGNED8, 8, ATYPE_R, &acNameNOE[0], 0x01, nil},{0x01, DTYPE_UNSIGNED8, 8, ATYPE_RW, &acName7000_01[0], 0, &(Wb.LED)}
};typedef struct
{uint8 LED;
} _Wbuffer;

6、SDO 參數與對象處理

SDO 參數可異步讀寫，支持參數鏡像、寫入鉤子等功能。
通過 ESC_objecthandler 鉤子函數可在 SDO 下載時執行自定義邏輯。

void ESC_objecthandler (uint16 index, uint8 subindex)
{switch (index){case 0x7100:{switch (subindex){case 0x01:{encoder_scale_mirror = encoder_scale;break;}}break;}}
}