2020 Microchip Technology Inc. DS50003046A-page 1 1.0 INTRODUCTION The EtherCAT ® Software Framework Quick Start Guide provides a visual view of the step-by-step procedures for build- ing the EtherCAT Software Framework (ESF) firmware and programming the hex file on the EVB-LAN925x_SAM D51 Evaluation Board. The ESF is an open-source EtherCAT framework stack designed to be integrated into any suitably powerful MCU and is used to control the LAN925x EtherCAT Device Controller. This document also provides an overview of the software and hardware tools required for the ESF firmware to work properly with EVB-LAN925x_SAM D51 Evaluation Board. Detailed information is included in the following sections: • Section 2.0, General Considerations • Section 3.0, Creating a Project Using the ESF Firmware • Section 4.0, EVB-LAN925x_SAM D51 Programming • Section 5.0, Conclusion 2.0 GENERAL CONSIDERATIONS 2.1 Required References The EtherCAT ® Software Framework implementor should have the following documents on hand: • EtherCAT ® Software Framework User’s Guide • MPLAB ® X IDE Release Notes/User Guide v5.40 zip • MPLAB ® XC32 C/C++ Compiler User’s Guide for PIC32C/SAM MCUs • SSC v5.12 Code • SAM D5x/E5x Family Data Sheet • EVB-LAN9253_SAM D51 Evaluation Board User’s Guide 2.2 Hardware Requirements and Setup All the hardware devices mentioned in this quick start guide can be acquired using their part numbers from www.microchipdirect.com. Below is a list of devices: • EVB-LAN925x_SAM D51 Evaluation Board • Atmel ICE Debugger • Ethernet cables (RJ45) • Micro-USB cable 2.3 Software Requirements The following software programs are required when carrying out the procedures in this guide: • MPLAB ® X IDE v5.30 or later • MPLAB XC32 compiler v2.30 or later • MPLAB IPE V5.30 or later • TwinCAT 3.1 or later EtherCAT ® Software Framework Quick Start Guide
Transcript
2020 Microchip Technology Inc. DS50003046A-page 1
1.0 INTRODUCTIONThe EtherCAT® Software Framework Quick Start Guide provides a visual view of the step-by-step procedures for build-ing the EtherCAT Software Framework (ESF) firmware and programming the hex file on the EVB-LAN925x_SAM D51Evaluation Board. The ESF is an open-source EtherCAT framework stack designed to be integrated into any suitablypowerful MCU and is used to control the LAN925x EtherCAT Device Controller. This document also provides an overview of the software and hardware tools required for the ESF firmware to workproperly with EVB-LAN925x_SAM D51 Evaluation Board. Detailed information is included in the following sections: • Section 2.0, General Considerations• Section 3.0, Creating a Project Using the ESF Firmware• Section 4.0, EVB-LAN925x_SAM D51 Programming• Section 5.0, Conclusion
2.0 GENERAL CONSIDERATIONS
2.1 Required ReferencesThe EtherCAT® Software Framework implementor should have the following documents on hand:• EtherCAT® Software Framework User’s Guide• MPLAB® X IDE Release Notes/User Guide v5.40 zip• MPLAB® XC32 C/C++ Compiler User’s Guide for PIC32C/SAM MCUs• SSC v5.12 Code• SAM D5x/E5x Family Data Sheet• EVB-LAN9253_SAM D51 Evaluation Board User’s Guide
2.2 Hardware Requirements and SetupAll the hardware devices mentioned in this quick start guide can be acquired using their part numbers fromwww.microchipdirect.com. Below is a list of devices:• EVB-LAN925x_SAM D51 Evaluation Board• Atmel ICE Debugger• Ethernet cables (RJ45)• Micro-USB cable
2.3 Software RequirementsThe following software programs are required when carrying out the procedures in this guide: • MPLAB® X IDE v5.30 or later• MPLAB XC32 compiler v2.30 or later• MPLAB IPE V5.30 or later• TwinCAT 3.1 or later
2.4 Jumper SettingsJumper settings for the EVB-LAN925x_SAM D51 Evaluation Board are specified in Table 2-1. See Figure 2-1 for theimage of the board.
FIGURE 2-1: EVB-LAN925X_SAM D51 EVALUATION BOARD
TABLE 2-1: JUMPER SETTINGS FOR THE EVB-LAN9253 EVALUATION BOARDJumper Description
J11 1 and 2 connectedJ6 1 and 2 connected
2020 Microchip Technology Inc. DS50003046A-page 3
EtherCAT® Software Framework
3.0 CREATING A PROJECT USING THE ESF FIRMWAREThis chapter demonstrates the generation of an ESF project and a hex file.
3.1 General ProcedureFollow the steps below to build an environment essential for ESF firmware as well as building the ESF Project and gen-erating the hex file:1. Download and install the required software programs. 2. Download or clone the ESF firmware from the repository link at https://bitbucket.microchip.com/projects/
UNG_APPS/repos/ethercat-software-framework-public. 3. If the ESF firmware was downloaded and not cloned, extract the downloaded zip file, ethercat-software-
framework-master.zip. 4. Check if the local path to the extracted or cloned copy has spaces in folder names. Remove the spaces if there
are any. For instance, instead of “C:\Users \Desktop\ESF FW\ESF,” use “C:\Users\Desk-top\ESF_FW\ESF.”
5. Remove the Read-only permission for the code by right-clicking on Properties>Uncheck Read-Only>Apply>OK.6. Add the Generated SSC code to the SSC folder and the path to the SSC folder as ethercat-software-
framework-public\ESF\Source\SSC\.
7. Open the MPLAB X IDE and click on File>Open Project. Enter the path {Local_Folder}\ ESF\Demo\ ESF_EVB_LAN9253\firmware which contains the ESF_EVB_LAN9253.X and click on the Open Project but-ton. See Figure 3-1.
FIGURE 3-1: OPENING A PROJECT IN MPLAB® X IDE
Note: To set up the Counter Trigger application, SSC requires a sample_app source and the inclusion of sam-ple_app files in the SSC folder for quick reference. If the user has customized application, then the sam-ple_app files can be modified. The Counter Trigger application is available atESF>Demo>ESF_EVB_LAN9253.
8. To prevent or address the possible errors specified in Note 2, users can add the compiler by going to Tools>Options>Embedded>Build Tools>Scan for Build Tools. Once done, all the compiler toolchains installed in their computers are listed under Toolchain.
9. Choose the XC32 compiler previously installed and click on Apply and OK. Consequently, the Compiler Tool-chain will be properly listed in the project Dashboard as shown in Figure 3-2.
FIGURE 3-2: PROJECT DASHBOARD FROM MPLAB® X IDE
10. Make the ESF_EVB_LAN9253 as the main project by right-clicking on ESF_EVB_LAN9253_SPI and clicking on Set as Main Project.
11. Select the right configuration to build (i.e., SPI or SQI) and its different modes. The configuration can be selected by right-clicking on ESF_EVB_LAN9253_SPI>Set Configuration and select from the list. Refer to the example in Figure 3-3.
Note 1: The project may or may not have the .X extension. It is not mandatory.2: The IDE may throw a configuration load error if the compiler toolchain is not properly linked to the project.
With this error, building of the project cannot proceed. One possible error scenario could show that theconfiguration “default” builds with “XC32” but indicates no toolchain directory. Another error scenario couldshow that the configuration “default” builds with “XC32,” but no toolchains of that type are installed. Thiscase suggests that errors occurred while loading one or more configurations. If no error is shown at thispoint in the procedure, it may appear when a project is imported from another computer.
3: Users can add language tools in Tools>Options Embedded tab.
2020 Microchip Technology Inc. DS50003046A-page 5
EtherCAT® Software Framework
FIGURE 3-3: PROJECT BUILD CONFIGURATION
12. Click on the IDE menu. Select Production and Clean and Build Main Project to build the firmware.13. Once the build completes, check the output window>Build tab>log messages of the IDE for the “BUILD SUC-
CESSFUL” confirmation to make sure that the build was executed correctly. See Figure 3-4.
FIGURE 3-4: BUILD SUCCESSFUL CONFIRMATION
14. Find the generated hex file with the path ESF>Demo >ESF_EVB_LAN9253>firm-ware>ESF_EVB_LAN9253>dist>default>production as shown in Figure 3-5.
FIGURE 3-5: OUTPUT HEX FILE PATH
EtherCAT® Software Framework
DS50003046A-page 6 2020 Microchip Technology Inc.
4.0 EVB-LAN925X_SAM D51 PROGRAMMINGFollow these steps to program the EVB-LAN925x_SAM D51 with the generated hex image:1. Open MPLAB® IPE which was previously downloaded and installed. 2. Select “Family” as 32-bit MCUs (PIC32C/SAM) and “Device” as “ATSAMD51J19A” and click on Apply. See
Figure 4-1.
FIGURE 4-1: MPLAB® IPE TOOL SELECTION
3. Connect the Atmel ICE debugger to the PC. Connect the other end of the debugger to the J10 header of EVB-LAN925x_SAM D51.
4. Once the debugger is connected, it will be listed under the Tool tab of the IPE. A yellow dot will appear on the right side of the device as shown in Figure 4-2.
FIGURE 4-2: MPLAB® IPE WITH TOOL DETECTED
5. Browse the path to the generated hex image and select the file.6. Once the file is selected, the Output window of the IPE appears as shown in Figure 4-3.
7. Switch on the EVB-LAN925x_SAM D51 and click on Program on MPLAB IPE. See Figure 4-2.8. Once the programming is done, the Output window will show “Programming Complete” as illustrated in Figure 4-
4.
FIGURE 4-4: MPLAB® IPE PROGRAMMING LOG
EtherCAT® Software Framework
DS50003046A-page 8 2020 Microchip Technology Inc.
5.0 CONCLUSIONIn summary, the basic steps for implementing project configuration selection, binary image generation, and program-ming the EVB-LAN925x_SAM D51 communication have been demonstrated in this guide.The user can build upon thisapplication to extend the capabilities of the LAN925x controller with the help of the driver provided by the EtherCAT Soft-ware Framework.
2020 Microchip Technology Inc. DS50003046A-page 9
EtherCAT® Software Framework
APPENDIX A: MPLAB IDE CONFIGURATION OPTIONS
A.1 Non-MPLAB XC32 Compiler EditionIf the ESF firmware is built with a non-MPLAB XC32 compiler, build errors may occur because of compiler optimizationissues. In case a non-professional XC32 compiler is used, perform steps 1 to 4 below for a successful and error-freebuild process. Refer to Figure A-1 for easier navigation. 1. Set the ESF_EVB_LAN9253 project as the main project by right-clicking on the project and selecting Set as Main
Project. 2. Click on File, and select and click on Project Properties.3. Choose xc32-gcc under XC32(Global Options) and select Optimization under the Option Categories dropdown
menu. 4. Select optimization-level as 0 and click on OK.
FIGURE A-1: GCC OPTIMIZATION SETTINGS IN MPLAB® X IDE
A.2 Harmony Framework UsageThe installation and usage of Harmony Configurator is explained at https://github.com/Microchip-MPLAB-Harmony/mhc/wiki
Choice of mutually exclusive argu-ments; an OR selection
errorlevel {0|1}
Ellipses... Replaces repeated text var_name [, var_name...]
Represents code supplied by user void main (void){ ...}
2020 Microchip Technology Inc. DS50003046A-page 11
EtherCAT® Software Framework
APPENDIX C: REVISION HISTORY
TABLE C-1: REVISION HISTORYRevision Level & Date Section/Figure/Entry Correction
DS50003046A(09-25-20)
Initial release
DS50003046A-page 12 2020 Microchip Technology Inc.
THE MICROCHIP WEBSITEMicrochip provides online support via our WWW site at www.microchip.com. This website is used as a means to makefiles and information easily available to customers. Accessible by using your favorite Internet browser, the websitecontains the following information:• Product Support – Data sheets and errata, application notes and sample programs, design resources, user’s
guides and hardware support documents, latest software releases and archived software• General Technical Support – Frequently Asked Questions (FAQ), technical support requests, online discussion
groups, Microchip consultant program member listing• Business of Microchip – Product selector and ordering guides, latest Microchip press releases, listing of
seminars and events, listings of Microchip sales offices, distributors and factory representatives
CUSTOMER CHANGE NOTIFICATION SERVICEMicrochip’s customer notification service helps keep customers current on Microchip products. Subscribers will receivee-mail notification whenever there are changes, updates, revisions or errata related to a specified product family ordevelopment tool of interest.To register, access the Microchip website at www.microchip.com. Under “Support”, click on “Customer Change Notifi-cation” and follow the registration instructions.
CUSTOMER SUPPORTUsers of Microchip products can receive assistance through several channels:• Distributor or Representative• Local Sales Office• Field Application Engineer (FAE)• Technical SupportCustomers should contact their distributor, representative or Field Application Engineer (FAE) for support. Local salesoffices are also available to help customers. A listing of sales offices and locations is included in the back of thisdocument.Technical support is available through the website at: http://microchip.com/support
2020 Microchip Technology Inc. DS50003046A-page 13
Information contained in this publication is provided for the sole purpose of designing with and using Microchip products. Information regarding deviceapplications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your applicationmeets with your specifications.
THIS INFORMATION IS PROVIDED BY MICROCHIP "AS IS". MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KINDWHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION INCLUDING BUTNOT LIMITED TO ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSEOR WARRANTIES RELATED TO ITS CONDITION, QUALITY, OR PERFORMANCE.
IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE,COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE INFORMATION OR ITS USE, HOWEVER CAUSED, EVEN IF MICROCHIPHAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW,MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THE INFORMATION OR ITS USE WILL NOT EXCEED THE AMOUNTOF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THE INFORMATION. Use of Microchip devices in life support and/orsafety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages,claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rightsunless otherwise stated.
TrademarksThe Microchip name and logo, the Microchip logo, Adaptec, AnyRate, AVR, AVR logo, AVR Freaks, BesTime, BitCloud, chipKIT, chipKIT logo, CryptoMemory, CryptoRF, dsPIC, FlashFlex, flexPWR, HELDO, IGLOO, JukeBlox, KeeLoq, Kleer, LANCheck, LinkMD, maXStylus, maXTouch, MediaLB, megaAVR, Microsemi, Microsemi logo, MOST, MOST logo, MPLAB, OptoLyzer, PackeTime, PIC, picoPower, PICSTART, PIC32 logo, PolarFire, Prochip Designer, QTouch, SAM-BA, SenGenuity, SpyNIC, SST, SST Logo, SuperFlash, Symmetricom, SyncServer, Tachyon, TempTrackr, TimeSource, tinyAVR, UNI/O, Vectron, and XMEGA are registered trademarks of Microchip Technology Incorporated in the U.S.A. and other countries.
APT, ClockWorks, The Embedded Control Solutions Company, EtherSynch, FlashTec, Hyper Speed Control, HyperLight Load, IntelliMOS, Libero, motorBench, mTouch, Powermite 3, Precision Edge, ProASIC, ProASIC Plus, ProASIC Plus logo, Quiet-Wire, SmartFusion, SyncWorld, Temux, TimeCesium, TimeHub, TimePictra, TimeProvider, Vite, WinPath, and ZL are registered trademarks of Microchip Technology Incorporated in the U.S.A.
Adjacent Key Suppression, AKS, Analog-for-the-Digital Age, Any Capacitor, AnyIn, AnyOut, BlueSky, BodyCom, CodeGuard, CryptoAuthentication, CryptoAutomotive, CryptoCompanion, CryptoController, dsPICDEM, dsPICDEM.net, Dynamic Average Matching, DAM, ECAN, EtherGREEN, In-Circuit Serial Programming, ICSP, INICnet, Inter-Chip Connectivity, JitterBlocker, KleerNet, KleerNet logo, memBrain, Mindi, MiWi, MPASM, MPF, MPLAB Certified logo, MPLIB, MPLINK, MultiTRAK, NetDetach, Omniscient Code Generation, PICDEM, PICDEM.net, PICkit, PICtail, PowerSmart, PureSilicon, QMatrix, REAL ICE, Ripple Blocker, SAM-ICE, Serial Quad I/O, SMART-I.S., SQI, SuperSwitcher, SuperSwitcher II, Total Endurance, TSHARC, USBCheck, VariSense, ViewSpan, WiperLock, Wireless DNA, and ZENA are trademarks of Microchip Technology Incorporated in the U.S.A. and other countries.
SQTP is a service mark of Microchip Technology Incorporated in the U.S.A.The Adaptec logo, Frequency on Demand, Silicon Storage Technology, and Symmcom are registered trademarks of Microchip Technology Inc. in other countries.GestIC is a registered trademark of Microchip Technology Germany II GmbH & Co. KG, a subsidiary of Microchip Technology Inc., in other countries.
All other trademarks mentioned herein are property of their respective companies.
Note the following details of the code protection feature on Microchip devices:• Microchip products meet the specifications contained in their particular Microchip Data Sheet.
• Microchip believes that its family of products is secure when used in the intended manner and under normal conditions.
• There are dishonest and possibly illegal methods being used in attempts to breach the code protection features of the Microchip devices. We believe that these methods require using the Microchip products in a manner outside the operating specifications contained in Microchip's Data Sheets. Attempts to breach these code protection features, most likely, cannot be accomplished without violating Microchip's intellectual property rights.
• Microchip is willing to work with any customer who is concerned about the integrity of its code.
• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of its code. Code protection does not mean that we are guaranteeing the product is "unbreakable." Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our products. Attempts to break Microchip's code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act.
For information regarding Microchip’s Quality Management Systems, please visit www.microchip.com/quality.
