Microchip LAN9252 SDK 与 Beckhoff EtherCAT SSC 集成 AN1916 作者 : Kansal Mariam Banu Shaick Ibrahim Microchip Technology Inc. 简介 Microchip LAN9252 是一款集成双以太网 PHY 的 2/3 端口 EtherCAT 从控制器 (EtherCAT Slave Controller,ESC) LAN9252 通常用于工业自动化解决方案并包含以下主要特性 : 集成高性能 100 Mbps 以太网收发器 3 个 FMMU, 4 个同步管理器, 分布式时钟支持, 4 KB DPRAM 8/16 位主机总线接口, 支持连接到大多数 8/16/32 位嵌入式控制器 SPI/SQI 从接口 支持 5 种不同的主要配置 : - 数字 I/O (DIGIO) - HBI - SPI 使用 GPIO - SPI 具有 MII 3 端口 (MII 上行 ) 模式 - SPI 具有 MII 3 端口 (MII 下行 ) 模式 第三个端口用于灵活的网络配置 全面的电源管理特性 低引脚数和小封装尺寸本文档的目的是说明如何将 LAN9252 SDK 与 Beckhoff 的 EtherCAT 从器件协议栈代码 (Slave Stack Code,SSC) 集成以用于 EVB-LAN9252-HBI 评估板 SSC 与 SDK 集成后, 可将应用代码 ( 具体取决于所需的应用 ) 添加到 SDK 以设计 EtherCAT 从器件 应用代码编写不在本文档范围之内 要使用 LAN9252 SDK, 设计人员必须是 EtherCAT 技术协会 (EtherCAT Technology Group,ETG) 会员才能获取对 Beckhoff SSC 的访问权 当前 SDK 旨在与 Microchip PIC32MX MCU 配合工作 但是, 可以扩展为支持其他 SOC 参考文献 Microchip LAN9252 数据手册 Microchip EVB-LAN9252-HBI 评估板用户指南 Microchip PIC32MX 数据手册 Microchip LAN9252 EEPROM 配置和编程 2015 Microchip Technology Inc. DS00001916A_CN 第 1 页
系统要求 硬件要求 Microchip EVB-LAN9252-HBI 评估板 Microchip PICkit 3 在线调试器 / 编程器 Windows 主机, 至少具有 2 GB RAM 软件要求 Microchip MPLAB IDE v2.20 或更高版本 Microchip MPLAB XC 编译器 v1.33 或更高版本 Beckhoff EtherCAT 从器件协议栈代码 v5.10 最新版本的 Microchip LAN9252 SDK 术语和缩写 表 1: ESC ETG EVB HBI IDE SDK SPI SSC 术语 术语和缩写 EtherCAT 从控制器 EtherCAT 技术协会工程验证板主机总线接口集成开发环境软件开发工具包串行协议接口从器件协议栈代码 定义 PIC32 SOC 固件框架 图 1: PIC32 SOC 固件框架 Microchip LAN9252 : PIC32 SoC 固件框架 用户模块 SOC 初始化 外设初始化 主应用程序 PIC32 本地库 EtherCAT 从器件协议栈 硬件抽象层 PIC32MX SoC 扩充板 Microchip LAN9252 评估板 DS00001916A_CN 第 2 页 2015 Microchip Technology Inc.
SDK 目录结构 本章提供对 LAN9252 SDK 内容的高级概述 主文件夹 LAN9252-PIC32_SDK_V0.2 包含以下项目, 如图 2 所示 : ESI Files (ESI 文件 ): 该文件夹包含评估板支持的不同配置的 ESI 文件 SSC: 该文件夹包含两个 MPLAB X 项目文件夹, 一个用于 SPI 接口, 一个用于 HBI 接口 Microchip_LAN9252_SSC_Config.xml: 这是从器件协议栈代码工具配置文件, 用于为 EVB-LAN9252-HBI 评估板支持的不同配置生成 ESI 文件 图 2: LAN9252-PIC32_SDK_V0.2 文件夹内容 ESI Files 文件夹 ESI Files 文件夹包含用于通过 EtherCAT 主器件工具 ( 例如 TwinCAT) 编程 LAN9252 EEPROM 和配置 LAN9252 的 EtherCAT 从器件信息文件, 如图 3 所示 有关该文件夹中每个 EtherCAT 从器件信息文件不同配置的详细信息, 请参见位于该文件夹中的 ReadMe.txt 文件 图 3: ESI FILES 文件夹内容 2015 Microchip Technology Inc. DS00001916A_CN 第 3 页
SSC 文件夹 SSC 文件夹包含以下文件 / 文件夹, 如图 4 所示 Common: 该文件夹包含硬件抽象层的 C 源文件以及 Beckhoff 从器件协议栈代码的占位符 PIC32: 这是为 HBI 接口配置的 PIC32 项目文件夹 PIC32-SPI: 这是为 SPI 接口配置的 PIC32 项目文件夹 ReadMe.txt: 该文件包含关于 MPLAB X 文件夹的目录结构的信息 图 4: SSC 文件夹内容 构建功能全面的 ETHERCAT 应用 安装 为了正确使用 LAN9252 SDK, 用户必须获得 Beckhoff EtherCAT 从器件协议栈代码 (SSC) 如果没有 SSC, 当将 LAN9252 SDK 样本项目装入 MPLAB 时, 它将导致编译错误以及缺失源文件 这是由于 SDK 对通用 Beckhoff 从器件协议栈源文件的依赖性 因此, 将 Beckhoff 的 SSC 与 LAN9252 SDK 集成是先决条件 本文档中的示例采用 : SSC v5.11 配置文件 v1.3.0.0 下面提供了使用 SSC 构建功能全面的 EtherCAT 应用的步骤 1. 下载 Microchip LAN9252 SDK 并确保以下目录结构包含 EtherCAT SDK 源代码 : {SDK_INSTALL_PATH}/ LAN9252-PIC32_SDK_Vx.x/SSC 2. 下载并安装 Beckhoff EtherCAT 从器件协议栈代码 (SSC) 工具 从以下链接下载 EtherCAT SSC: http://www.ethercat.org/login.aspx?returnurl=%2fmemberarea%2fstack_code.aspx DS00001916A_CN 第 4 页 2015 Microchip Technology Inc.
3. 输入 ETG 用户名和密码继续下载过程 图 5: 会员专区登陆 4. 按提示输入供应商 ID 并单击 Submit Registration ( 提交注册 ) 按钮, 如图 6 所示 图 6: 供应商 ID 提交 2015 Microchip Technology Inc. DS00001916A_CN 第 5 页
5. 输入所需的详细信息, 选中 I accept ( 我接受 ) 单选框, 然后单击 Register ( 注册 ) 图 7: 从器件协议栈代码下载 6. 下载链接将发送到注册的电子邮件地址 单击电子邮件下载链接来下载 EtherCAT 从器件协议栈代码 图 8: 从器件协议栈代码下载 DS00001916A_CN 第 6 页 2015 Microchip Technology Inc.
7. 解压缩已下载的.zip 文件 SSC_V5i11, 其中包含如图 9 所示的目录结构 图 9: 从器件协议栈代码目录结构 8. 安装 EtherCAT 从器件协议栈代码工具, 出现提示时接收默认值 安装完成后, 确保如图 10 所示的工具在 开始 菜单中 图 10: 从器件协议栈代码工具 2015 Microchip Technology Inc. DS00001916A_CN 第 7 页
SSC 工具 1. 从 开始 菜单启动 SSC 工具, 如图 11 所示 图 11: SSC 工具 2. 启动 SSC 工具后, 必须单击 OK ( 确定 ) 同意从器件协议栈工具使用信息 图 12: SSC 使用信息 3. 在菜单栏中, 单击 File ( 文件 ), 然后单击 New ( 新建 ) 以继续 图 13: SSC 工具主界面 DS00001916A_CN 第 8 页 2015 Microchip Technology Inc.
4. 单击 Import ( 导入 ) 从目录 {SDK_INSTALL_PATH}/LAN9252-PIC32_SDK_Vx.x/ 导入 SSC 工具配置文件 Microchip_PIC32.xml 图 14: SSC 工具新建项目 5. 选择该文件后, 单击 Open ( 打开 ) 以导入 SSC 工具配置文件 图 15: SSC 工具新建项目导入 2015 Microchip Technology Inc. DS00001916A_CN 第 9 页
6. 导入后, 选中 Custom ( 自定义 ) 下拉框, 选择相应的 Microchip 配置, 并单击 OK 注 : 图 16: EVB 配置应与在下拉框中选择的配置匹配 SSC 工具新建项目自定义 7. 在弹出窗口中单击 Yes ( 是 ) 以继续 图 17: SSC 工具外部文件确认 8. 将显示另一个弹出窗口, 请求添加 9252_HW.c 单击 OK 继续 图 18: SSC 工具 9252_HW.C 确认 DS00001916A_CN 第 10 页 2015 Microchip Technology Inc.
9. 在上一个弹出窗口中单击 OK 后, 通过文件选择对话框浏览到 9252_HW.c 文件 该文件在 {SDK_INSTALL_PATH}/LAN9252-PIC32_SDK_V0.2/SSC/Common 中 图 19: SSC 工具 9252_HW.C 选择 2015 Microchip Technology Inc. DS00001916A_CN 第 11 页
10. 添加 9252_HW.c 文件后, 显示 SSC 工具窗口, 如图 20 所示 图 20: SSC 工具创建的新项目 11. 如图 20 所示, 左侧面板包含可配置从器件协议栈代码的多个类别 请参见工具栏中的 Help ( 帮助 ) 下拉菜单了解其他配置信息 12. 单击工具栏中的 Project ( 项目 ) 下拉菜单并选择 Create New Slave Files ( 创建新从器件文件 ) 将显示如图 21 所示的弹出窗口 DS00001916A_CN 第 12 页 2015 Microchip Technology Inc.
图 21: SSC 工具创建新从器件文件 13. 单击 Start ( 开始 ) 按钮以在所需的目录路径中创建新的项目文件 Src 文件夹和 esi 文件 ( 从器件信息文件 ) 14. 弹出窗口将指示已成功创建文件 单击 OK 继续 图 22: SSC 工具文件创建对话框 15. 浏览到新创建文件目录, 如示例中所示 : Src ( 文件夹 ): 该文件夹包含 Beckhoff 从器件协议栈代码 PIC32 EtherCAT Slave (ESP): 这是 SSC 工具项目文件 PIC32 EtherCAT Slave (XML): 这是 EtherCAT 从器件信息文件, 必须用作 EtherCAT 主器件工具的输入以配置 EtherCAT 从控制器 2015 Microchip Technology Inc. DS00001916A_CN 第 13 页
图 23: 新建从器件文件 16. 将 Src 文件夹内的所有文件复制到以下目录 : {SDK_INSTALL_PATH}/LAN9252-PIC32_SDK_Vx.x/SSC/Common 17. 启动 MPLAB X IDE ( 如果未安装, 可从 Microchip.com 获取 ) 18. 单击 File ( 文件 ) 下拉菜单并选择 Open Project ( 打开项目 ) 图 24: MPLAB X IDE DS00001916A_CN 第 14 页 2015 Microchip Technology Inc.
19. 选择相应的项目 :PIC32 (HBI 接口 ) 或 PIC32-SPI (SPI 接口 ) 单击 Open 图 25: MPLAB X IDE 打开项目 20. 装入项目后,MPLAB X IDE 界面应如图 26 所示显示 确保 HAL 头文件 (9252_HW.h) 包含在以下 C 源文件中 : - 9252_HW.c - ecatappl.c - acatslv.h - main.c 图 26: MPLAB X IDE 装入的项目 2015 Microchip Technology Inc. DS00001916A_CN 第 15 页
21. 从图 27 所示的下拉列表中选择相应的配置 SDK 目录中的 ReadMe.txt 文件提供下拉列表内容的说明 注 : 所选的配置应与 EVB 配置以及图 16 中所选的配置匹配 图 27: MPLAB X IDE 配置选择 22. 单击 Clean and Build Project ( 清除并构建项目 ) 按钮 ( 锤子和画笔图标 ) 来构建项目 项目构建成功后, 调试消息应显示 BUILD SUCCESSFUL ( 构建成功 ), 如图 28 所示 图 28: MPLAB X IDE 清除并构建项目 DS00001916A_CN 第 16 页 2015 Microchip Technology Inc.
23. 将 PICKit 3 调试器连接到 EVB-LAN9252-HBI 评估板并单击 Make and Program Device ( 编译并烧写器件 ) 按钮 ( 具有向下箭头的矩形图标 ) 这将烧写 PIC 单片机 图 29: MPLAB X IDE 编译并烧写器件 24. 要确认从控制器配置正确, 通过以太网电缆将 EVB-LAN9252-HBI 评估板连接到 PC TwinCAT 主器件工具将控制器的状态显示为 OP 状态, 如图 30 所示 图 30: TWINCAT 主视图 2015 Microchip Technology Inc. DS00001916A_CN 第 17 页
附录 A: 应用笔记版本历史 表 A-1: 版本历史 版本号和日期章节 / 图 / 条目修正 DS00001916A (04-10-15) 初始版本 DS00001916A_CN 第 18 页 2015 Microchip Technology Inc.
请注意以下有关 Microchip 器件代码保护功能的要点 : Microchip 的产品均达到 Microchip 数据手册中所述的技术指标 Microchip 确信 : 在正常使用的情况下, Microchip 系列产品是当今市场上同类产品中最安全的产品之一 目前, 仍存在着恶意 甚至是非法破坏代码保护功能的行为 就我们所知, 所有这些行为都不是以 Microchip 数据手册中规定的操作规范来使用 Microchip 产品的 这样做的人极可能侵犯了知识产权 Microchip 愿与那些注重代码完整性的客户合作 Microchip 或任何其他半导体厂商均无法保证其代码的安全性 代码保护并不意味着我们保证产品是 牢不可破 的 代码保护功能处于持续发展中 Microchip 承诺将不断改进产品的代码保护功能 任何试图破坏 Microchip 代码保护功能的行为均可视为违反了 数字器件千年版权法案 (Digital Millennium Copyright Act) 如果这种行为导致他人在未经授权的情况下, 能访问您的软件或其他受版权保护的成果, 您有权依据该法案提起诉讼, 从而制止这种行为 提供本文档的中文版本仅为了便于理解 请勿忽视文档中包含的英文部分, 因为其中提供了有关 Microchip 产品性能和使用情况的有用信息 Microchip Technology Inc. 及其分公司和相关公司 各级主管与员工及事务代理机构对译文中可能存在的任何差错不承担任何责任 建议参考 Microchip Technology Inc. 的英文原版文档 本出版物中所述的器件应用信息及其他类似内容仅为您提供便利, 它们可能由更新之信息所替代 确保应用符合技术规范, 是您自身应负的责任 Microchip 对这些信息不作任何明示或暗示 书面或口头 法定或其他形式的声明或担保, 包括但不限于针对其使用情况 质量 性能 适销性或特定用途的适用性的声明或担保 Microchip 对因这些信息及使用这些信息而引起的后果不承担任何责任 如果将 Microchip 器件用于生命维持和 / 或生命安全应用, 一切风险由买方自负 买方同意在由此引发任何一切伤害 索赔 诉讼或费用时, 会维护和保障 Microchip 免于承担法律责任, 并加以赔偿 除非另外声明, 在 Microchip 知识产权保护下, 不得暗中或以其他方式转让任何许可证 商标 Microchip 的名称和徽标组合 Microchip 徽标 dspic FlashFlex flexpwr JukeBlox KEELOQ KEELOQ 徽标 Kleer LANCheck MediaLB MOST MOST 徽标 MPLAB OptoLyzer PIC PICSTART PIC 32 徽标 RightTouch SpyNIC SST SST 徽标 SuperFlash 及 UNI/O 均为 Microchip Technology Inc. 在美国和其他国家或地区的注册商标 The Embedded Control Solutions Company 和 mtouch 为 Microchip Technology Inc. 在美国的注册商标 Analog-for-the-Digital Age BodyCom chipkit chipkit 徽标 CodeGuard dspicdem dspicdem.net ECAN In-Circuit Serial Programming ICSP Inter-Chip Connectivity KleerNet KleerNet 徽标 MiWi motorbench MPASM MPF MPLAB Certified 徽标 MPLIB MPLINK MultiTRAK NetDetach Omniscient Code Generation PICDEM PICDEM.net PICkit PICtail RightTouch 徽标 REAL ICE SQI Serial Quad I/O Total Endurance TSHARC USBCheck VariSense ViewSpan WiperLock Wireless DNA 和 ZENA 均为 Microchip Technology Inc. 在美国和其他国家或地区的商标 SQTP 为 Microchip Technology Inc. 在美国的服务标记 Silicon Storage Technology 为 Microchip Technology Inc. 在除美国外的国家或地区的注册商标 GestIC 为 Microchip Technology Inc. 的子公司 Microchip Technology Germany II GmbH & Co. & KG 在除美国外的国家或地区的注册商标 在此提及的所有其他商标均为各持有公司所有 2015, Microchip Technology Inc. 版权所有 ISBN:978-1-63277-706-5 QUALITY MANAGEMENT SYSTEM CERTIFIED BY DNV == ISO/TS 16949 == Microchip 位于美国亚利桑那州 Chandler 和 Tempe 与位于俄勒冈州 Gresham 的全球总部 设计和晶圆生产厂及位于美国加利福尼亚州和印度的设计中心均通过了 ISO/TS-16949:2009 认证 Microchip 的 PIC MCU 与 dspic DSC KEELOQ 跳码器件 串行 EEPROM 单片机外设 非易失性存储器和模拟产品严格遵守公司的质量体系流程 此外, Microchip 在开发系统的设计和生产方面的质量体系也已通过了 ISO 9001:2000 认证 2015 Microchip Technology Inc. DS00001916A_CN 第 19 页
全球销售及服务网点 美洲 亚太地区 亚太地区 欧洲 公司总部 Corporate Office 2355 West Chandler Blvd. Chandler, AZ 85224-6199 Tel: 1-480-792-7200 Fax: 1-480-792-7277 技术支持 : http://www.microchip.com/ support 网址 :www.microchip.com 亚特兰大 Atlanta Duluth, GA Tel: 1-678-957-9614 Fax: 1-678-957-1455 奥斯汀 Austin, TX Tel: 1-512-257-3370 波士顿 Boston Westborough, MA Tel: 1-774-760-0087 Fax: 1-774-760-0088 芝加哥 Chicago Itasca, IL Tel: 1-630-285-0071 Fax: 1-630-285-0075 克里夫兰 Cleveland Independence, OH Tel: 1-216-447-0464 Fax: 1-216-447-0643 达拉斯 Dallas Addison, TX Tel: 1-972-818-7423 Fax: 1-972-818-2924 底特律 Detroit Novi, MI Tel: 1-248-848-4000 休斯敦 Houston, TX Tel: 1-281-894-5983 印第安纳波利斯 Indianapolis Noblesville, IN Tel: 1-317-773-8323 Fax: 1-317-773-5453 洛杉矶 Los Angeles Mission Viejo, CA Tel: 1-949-462-9523 Fax: 1-949-462-9608 纽约 New York, NY Tel: 1-631-435-6000 圣何塞 San Jose, CA Tel: 1-408-735-9110 加拿大多伦多 Toronto Tel: 1-905-673-0699 Fax: 1-905-673-6509 亚太总部 Asia Pacific Office Suites 3707-14, 37th Floor Tower 6, The Gateway Harbour City, Kowloon Hong Kong Tel: 852-2943-5100 Fax: 852-2401-3431 中国 - 北京 Tel: 86-10-8569-7000 Fax: 86-10-8528-2104 中国 - 成都 Tel: 86-28-8665-5511 Fax: 86-28-8665-7889 中国 - 重庆 Tel: 86-23-8980-9588 Fax: 86-23-8980-9500 中国 - 东莞 Tel: 86-769-8702-9880 中国 - 杭州 Tel: 86-571-8792-8115 Fax: 86-571-8792-8116 中国 - 香港特别行政区 Tel: 852-2943-5100 Fax: 852-2401-3431 中国 - 南京 Tel: 86-25-8473-2460 Fax: 86-25-8473-2470 中国 - 青岛 Tel: 86-532-8502-7355 Fax: 86-532-8502-7205 中国 - 上海 Tel: 86-21-5407-5533 Fax: 86-21-5407-5066 中国 - 沈阳 Tel: 86-24-2334-2829 Fax: 86-24-2334-2393 中国 - 深圳 Tel: 86-755-8864-2200 Fax: 86-755-8203-1760 中国 - 武汉 Tel: 86-27-5980-5300 Fax: 86-27-5980-5118 中国 - 西安 Tel: 86-29-8833-7252 Fax: 86-29-8833-7256 中国 - 厦门 Tel: 86-592-238-8138 Fax: 86-592-238-8130 中国 - 珠海 Tel: 86-756-321-0040 Fax: 86-756-321-0049 台湾地区 - 高雄 Tel: 886-7-213-7828 台湾地区 - 台北 Tel: 886-2-2508-8600 Fax: 886-2-2508-0102 台湾地区 - 新竹 Tel: 886-3-5778-366 Fax: 886-3-5770-955 澳大利亚 Australia - Sydney Tel: 61-2-9868-6733 Fax: 61-2-9868-6755 印度 India - Bangalore Tel: 91-80-3090-4444 Fax: 91-80-3090-4123 印度 India - New Delhi Tel: 91-11-4160-8631 Fax: 91-11-4160-8632 印度 India - Pune Tel: 91-20-3019-1500 日本 Japan - Osaka Tel: 81-6-6152-7160 Fax: 81-6-6152-9310 日本 Japan - Tokyo Tel: 81-3-6880-3770 Fax: 81-3-6880-3771 韩国 Korea - Daegu Tel: 82-53-744-4301 Fax: 82-53-744-4302 韩国 Korea - Seoul Tel: 82-2-554-7200 Fax: 82-2-558-5932 或 82-2-558-5934 马来西亚 Malaysia - Kuala Lumpur Tel: 60-3-6201-9857 Fax: 60-3-6201-9859 马来西亚 Malaysia - Penang Tel: 60-4-227-8870 Fax: 60-4-227-4068 菲律宾 Philippines - Manila Tel: 63-2-634-9065 Fax: 63-2-634-9069 新加坡 Singapore Tel: 65-6334-8870 Fax: 65-6334-8850 泰国 Thailand - Bangkok Tel: 66-2-694-1351 Fax: 66-2-694-1350 奥地利 Austria - Wels Tel: 43-7242-2244-39 Fax: 43-7242-2244-393 丹麦 Denmark-Copenhagen Tel: 45-4450-2828 Fax: 45-4485-2829 法国 France - Paris Tel: 33-1-69-53-63-20 Fax: 33-1-69-30-90-79 德国 Germany - Dusseldorf Tel: 49-2129-3766400 德国 Germany - Karlsruhe Tel: 49-721-625370 德国 Germany - Munich Tel: 49-89-627-144-0 Fax: 49-89-627-144-44 意大利 Italy - Milan Tel: 39-0331-742611 Fax: 39-0331-466781 意大利 Italy - Venice Tel: 39-049-7625286 荷兰 Netherlands - Drunen Tel: 31-416-690399 Fax: 31-416-690340 波兰 Poland - Warsaw Tel: 48-22-3325737 西班牙 Spain - Madrid Tel: 34-91-708-08-90 Fax: 34-91-708-08-91 瑞典 Sweden - Stockholm Tel: 46-8-5090-4654 英国 UK - Wokingham Tel: 44-118-921-5800 Fax: 44-118-921-5820 07/14/15 DS00001916A_CN 第 20 页 2015 Microchip Technology Inc.