EtherCAT主站SOEM -- 2 -- SOEM之ethercatbase.h/c文件解析
EtherCAT主站SOEM -- 2 -- SOEM之ethercatbase.h/c文件解析
- 一 ethercatbase.h/c文件功能预览：
- 二 ethercatbase.h/c 文件的主要函数的作用：
-
- 2.1 ecx_writedatagramdata：
- 2.2 ecx_setupdatagram：
- 2.3 ecx_adddatagram：
- 2.4 分布式时钟同步 ecx_LRWDC 函数：
- 2.5 函数（例如 ecx_BWR、ecx_BRD、ecx_APRD、ecx_ARMW 等）：
- 三 ethercatbase.c 原文件的中文注释
- 该文档修改记录：
- 总结
一 ethercatbase.h/c文件功能预览：
| 函数名称 | 功能和用途 | 使用场景 |
|---|---|---|
ecx_setupdatagram |
设置EtherCAT数据报文的头部信息，包括通信类型、索引、ADP、ADO、长度和数据。 | 用于配置EtherCAT数据报文的头部信息，以便进行数据通信。 |
ecx_adddatagram |
向EtherCAT数据报文中添加数据段，包括通信类型、索引、更多标志、ADP、ADO、长度和数据。 | 适用于逐步构建EtherCAT数据报文，可以添加多个数据段。 |
ecx_BWR |
向EtherCAT从站写入数据，指定ADP、ADO、长度和数据。 | 用于将数据写入EtherCAT从站的寄存器或数据区域。 |
ecx_BRD |
从EtherCAT从站读取数据，指定ADP、ADO、长度和数据。 | 用于从EtherCAT从站的寄存器或数据区域读取数据。 |
ecx_APRD |
从EtherCAT从站异步读取数据，指定ADP、ADO、长度和数据。 | 用于异步读取EtherCAT从站的寄存器或数据区域数据。 |
ecx_ARMW |
从EtherCAT从站异步写入数据，指定ADP、ADO、长度和数据。 | 用于异步写入数据到EtherCAT从站的寄存器或数据区域。 |
ecx_FRMW |
向EtherCAT从站发送帧数据，指定ADP、ADO、长度和数据。 | 用于发送帧数据到EtherCAT从站。 |
ecx_APRDw |
从EtherCAT从站异步读取字数据，指定ADP和ADO。 | 用于异步读取EtherCAT从站的字数据。 |
ecx_FPRD |
从EtherCAT从站快速读取数据，指定ADP、ADO、长度和数据。 | 用于快速读取EtherCAT从站的数据。 |
ecx_FPRDw |
从EtherCAT从站快速读取字数据，指定ADP和ADO。 | 用于快速读取EtherCAT从站的字数据。 |
ecx_APWRw |
向EtherCAT从站异步写入字数据，指定ADP、ADO和数据。 | 用于异步写入字数据到EtherCAT从站。 |
ecx_APWR |
向EtherCAT从站写入数据，指定ADP、ADO、长度和数据。 | 用于向EtherCAT从站的寄存器或数据区域写入数据。 |
ecx_FPWRw |
向EtherCAT从站快速写入字数据，指定ADP、ADO和数据。 | 用于快速写入字数据到EtherCAT从站。 |
ecx_FPWR |
向EtherCAT从站快速写入数据，指定ADP、ADO、长度和数据。 | 用于快速写入数据到EtherCAT从站。 |
ecx_LRW |
从EtherCAT从站的逻辑地址中读取数据，指定逻辑地址、长度和数据。 | 用于从EtherCAT从站的逻辑地址读取数据。 |
ecx_LRD |
从EtherCAT从站的逻辑地址中读取字数据，指定逻辑地址和数据。 | 用于从EtherCAT从站的逻辑地址读取字数据。 |
ecx_LWR |
向EtherCAT从站的逻辑地址中写入数据，指定逻辑地址、长度和数据。 | 用于向EtherCAT从站的逻辑地址写入数据。 |
ecx_LRWDC |
从EtherCAT从站的逻辑地址中读取数据，包括数据校验和时序信息，指定逻辑地址、长度、数据、数据校验标志和时间信息。 | 用于从EtherCAT从站的逻辑地址读取数据，同时获取数据的校验和时序信息。 |
ec_setupdatagram |
(适用于EC_VER1) 设置EtherCAT数据报文的头部信息，包括通信类型、索引、ADP、ADO、长度和数据。 | (适用于EC_VER1) 用于配置EtherCAT数据报文的头部信息，以便进行数据通信。 |
ec_adddatagram |
(适用于EC_VER1) 向EtherCAT数据报文中添加数据段，包括通信类型、索引、更多标志、ADP、ADO、长度和数据。 | (适用于EC_VER1) 适用于逐步构建EtherCAT数据报文，可以添加多个数据段。 |
ec_BWR |
(适用于EC_VER1) 向EtherCAT从站写入数据，指定ADP、ADO、长度和数据。 | (适用于EC_VER1) 用于将数据写入EtherCAT从站的寄存器或数据区域。 |
ec_BRD |
(适用于EC_VER1) 从EtherCAT从站读取数据，指定ADP、ADO、长度和数据。 | (适用于EC_VER1) 用于从EtherCAT从站的寄存器或数据区域读取数据。 |
| ...
二 ethercatbase.h/c 文件的主要函数的作用：
ethercatbase.h 文件包含了一系列数据结构、常量和函数声明，用于实现 EtherCAT 主站的核心功能。以下是一些可能包含在 ethercatbase.h 文件中的内容：
-
数据结构：定义了用于管理 EtherCAT 主站的数据结构，包括主站状态、从站配置、数据对象映射等。
-
常量：包含了一些与 EtherCAT 相关的常量，如 EtherCAT 数据帧的大小、标志位等。
-
函数声明：定义了用于初始化、配置和管理 EtherCAT 主站的函数接口。
ethercatbase.c 文件包含了 SOEM 库中实际实现 EtherCAT 主站功能的代码。它包括了与 EtherCAT 通信相关的底层功能，以及用于初始化和配置 EtherCAT 主站的代码。以下是一些 ethercatbase.c 文件中可能包含的功能：
-
初始化 EtherCAT 主站：包括初始化数据结构、配置网络接口等。
-
从站配置：配置网络中的 EtherCAT 从站，包括分配地址、数据对象映射等。
-
数据帧处理：处理来自 EtherCAT 从站的数据帧，以实现数据交换。
-
周期性通信：根据配置的周期时间，发送和接收 EtherCAT 数据帧。
-
状态管理：管理主站的状态，以确保网络正常运行。
总之，ethercatbase.h 和 ethercatbase.c 文件是 SOEM 库的核心部分，用于实现 EtherCAT 主站的基本功能，包括初始化、配置、数据交换和状态管理。
2.1 ecx_writedatagramdata：
这个函数用于向 EtherCAT 数据报中写入数据。它会根据提供的命令（Command）、长度（Length）和数据（Data）来填充数据报的数据部分。这是在 EtherCAT 主站发送数据给从站的过程中使用的函数。
2.2 ecx_setupdatagram：
该函数用于生成并设置 EtherCAT 数据报，这些数据报将包含在标准以太网帧中。您可以通过此函数指定命令、索引、地址位置、地址偏移、长度和数据等信息，以准备 EtherCAT 数据报。这是为了创建要发送到 EtherCAT 从站的命令和数据。
2.3 ecx_adddatagram：
这个函数用于将 EtherCAT 数据报添加到现有的以太网帧中，使得多个数据报可以连续发送到不同的 EtherCAT 从站。它有助于组装一个完整的以太网帧，包括多个 EtherCAT 数据报。
2.4 分布式时钟同步 ecx_LRWDC 函数：
类似于 ecx_LRW，但它还包括分布式时钟同步的处理。它在同一帧中发送两个数据报，一个用于 LRW 操作，另一个用于时钟分布，从而实现与参考从站的同步和获取分布式时钟时间。
2.5 函数（例如 ecx_BWR、ecx_BRD、ecx_APRD、ecx_ARMW 等）：
这些函数实现了不同的 EtherCAT 数据传输原语，允许主站与从站进行数据读取和写入。它们涉及广播命令和指定地址位置和偏移来进行数据交互。
总的来说，ethercatbase.c 中的函数提供了与 EtherCAT 从站进行通信所需的基本功能。这些函数允许 EtherCAT 主站配置数据报、发送命令和数据，以及处理从站的响应。SOEM 库的 ethercatbase.c 文件是构建自定义 EtherCAT 主站应用程序的重要组成部分。
三 ethercatbase.c 原文件的中文注释
/*
* 根据GNU通用公共许可证第2版（附有例外情况）授权。请参阅
* 项目根目录中的LICENSE文件以获取完整的许可信息
*/
/** \file
* \brief
* 基本EtherCAT功能。
*
* 在以太网帧中设置数据报。
* EtherCAT数据报原语，广播，自动增量，配置和
* 逻辑寻址数据传输。所有基本传输都是阻塞的，因此
* 等待帧被返回给主站或超时。如果这不可接受，可以构建您自己的数据报
* 并使用nicdrv.c中的函数。
*/
#include 该文档修改记录：
| 修改时间 | 修改说明 |
|---|---|
| 2023年11月3日 | EtherCAT主站SOEM – 2 – SOEM之ethercatbase.h/c文件解析 |
总结
以上就是EtherCAT主站SOEM – 2 – SOEM之ethercatbase.h/c文件解析的内容。
有不明白的地方欢迎留言；有建议欢迎留言，我后面编写文档好改进。
创作不容，如果文档对您有帮助，记得给个赞。