2.1.2 Ethernet Web Server Getting Started Application on SAMA7G54-EK Evaluation Kit

Download

Description

This application demonstrates the ability of the MPLAB Harmony to configure demo board as TCP IP web server on SAMA7G54 Evaluation kit. The demo board configured as web server will host web-page stored in SDCARD. The web-page will be accessed through IP Address provided in debug window. From the web-page, LEDs on the demo board will be controlled. Temperature is read from the temp sensor on a Thermo 3 Click connected to the board using TWI/I2C protocol. The temperature value is also displayed on the web-page.

Key Highlights of SAMA7G54-EK Evaluation Kit

  • External Non-Volatile Memories like QSPI, e.MMC and SD card interfaces.
  • Additional sensors can be interfaced using click boards through an on-board mikroBUS connector.
  • Two mechanical programmable buttons.
  • One User Input Switch and one RGB LED.
  • UART, USB and CAN Interfaces.
  • Raspberry pi connectors.

Modules/Technology Used

Peripheral Modules:

  • FLEXCOM
  • TC0
  • SDMMC

Hardware Used

Jumper Settings

Software/Tools Used

This project has been verified to work with the following versions of software tools:

Refer Project Manifest present in harmony-manifest-success.yml under the project folder firmware/src/config/default to know the MPLAB® X IDE, MCC Plugin, libraries version.

Hardware Setup

  • Connect RJ45 ethernet cable to the J5 Connector (Gigabit Ethernet port) of SAMA7G54-EK Evaluation Kit and to Router.
  • Connect Thermo 3 click board to the J10 connector (mikroBUS socket) of SAMA7G54-EK Evaluation Kit.
  • Power up the SAMA7G54-EK Evaluation Kit by connecting 5V/2A power adapter to J1 connector or by connecting micro-usb cable to J7 connector.
  • Press the start (nSTART switch) button on the board.
  • Connect the UART port (J24) on board to the computer using a micro-usb cable (to enable debug com port).
  • Connect external JTAG debugger to J27 or Onboard debugger micro-usb cable to J24. J24 will work as CDC COM Port as well as Onboard debugger.

Developing a Ethernet Web Server Demo Application

  1. Open MPLAB® X IDE from the main menu.
  2. Create a New Project by clicking the New Project icon or by selecting File -> New Project.
  3. In the New Project window, under Projectschoose Application Project(s). and click Next.
  4. In the Select Device dialog window, fill in or select the information for below:
    1. Family: Fill configuration name as 32-bit MCUs (PIC32C/SAM).
    2. Device : From drop down list select SAMA7G54.
  5. In the Select Compiler window, for Compiler Toolchains select XC32 COMPILER, and Click Next.
  6. Enter Project Location , Project Folder and Project Name. Click Finish
  7. This creates an empty project and set this project as main project. If there are other projects open in the project explorer window, set this project as main project by right clicking on the project, choose Set as Main Project.
  8. Once the project is created, MCC will be automatically launched. (To launch MCC manually, from main menu, click on Tools -> Embedded -> MPLAB® Code Configurator or click MCC button in the MPLAB® X IDE tool bar.) It will launch Content manger Wizard. Then click Select MPLAB Harmony.
  9. In addition to the required packages(csp,dev_packs), download the optional packages bsp, core, net, wolfssl and then click Finish. Content download will take some time. Wait till all the contents are downloaded.
  10. Once the download is complete, click Save in Save MCC Configuration file window.
  11. A project graph will be displayed. From Device Resources window, click add button to add Board Support Packages for SAMA7G5 Evaluation kit BSP to Project Graph.
  12. In Project Graph, Select TCP/IP Configuration from plugins drop-down list.
  13. TCP/IP Configuration window will be displayed. Click Application in TCP/IP Layers on the left side pane.
  14. To add DHCP CLIENT to Active Components window, drag and drop it from Available Components. Click Yes for adding Harmony Core.
  15. Click No for FreeRTOS component. This example is a Bare metal project.
  16. DHCP CLIENT is moved to Active Components window.
  17. Similarly add DNS CLIENT, HTTPNET SERVER and SNTP to Active Components window.
  18. Click Presentation in TCP/IP Layers on the left side pane.
    Add Presentation Layer to Active Components window by dragging and dropping it from Available Components window.
  19. Click Transport in TCP/IP Layers on the left side pane.
  20. Add TCP to Active Components window by dragging and dropping it from Available Components window. This will add Crypto Library also to the project.
  21. Click Yes to add Crypto Library. The wolfCrypt Library will be added to the project.
  22. Click Yes to add wolfCrypt Library.
  23. Click Yes to connect Crypto Library and wolfCrypt Library in project graph.
  24. TCP added to project.
  25. Add UDP to Active Components window by dragging and dropping from Available Components window.
  26. Click Network in TCP/IP Layers on the left side pane.
  27. Add IPv4, ARP and ICMPv4 to Active Components window by dragging and dropping them from Available Components window.
  28. Click Data Link in TCP/IP Layers on the left side pane.
  29. Click next to Network Interface in Active Components window to add an Interface. This will add NETCONFIG-0 to Network Interface section in Active Components window.
  30. Add GMAC0 to MAC section in Active Components window by dragging and dropping from MAC Components window.
  31. Add KSZ9131 and MIIM Driver to PHY section in Active Components window by drag and drop from PHY Components window.
  32. Connect NETCONFIG-0 with GMAC0 and GMAC0 with KSZ9131 in Active Components window by clicking and dragging the or button.
  33. Click Basic Config in TCP/IP Layers on the left side pane.
  34. Add TCPIP CMD to Active Components window by dragging and dropping from Available Components window.
  35. Click Overview on the left side pane to see the complete configuration.
  36. Click Config Summary on the left side pane to see the summary of configuration. The missing mandatory and optional components will be listed here.
  37. Add Harmony components listed in Unsatisfied Dependencies.
    1. Close TCP/IP Configuration window.
    2. In Project Graph, select Root in View tab and add all Unsatisfied Dependencies.
  38. To store webpages is needed a SDCARD. To access SDCARD, the user needs to enable SDMMC module in project.
  39. From Device Resources window, expand Peripherals and expand SDMMC to view SDMMC list.
  40. Click add button to add SDMMC1 to Project Graph.
  41. SDMMC1 added to Project Graph window.
  42. From Device Resources window, expand System Services to view the list.
  43. Click add button to add COMMAND, DEBUG, TIME and FILE SYSTEM to Project Graph.
  44. COMMAND, DEBUG, TIME and FILE SYSTEM are added to Project Graph window.
  45. Add SYS_CONSOLE dependency.
    1. Right Click on SYS_CONSOLE button on TCP/IP STACK box.
    2. Select Satisfiers → CONSOLE.
  46. Add COMMAND and DEBUG System Service to CONSOLE.
    1. Right Click on SYS_CONSOLE button on DEBUG box.
    2. Select Satisfiers → CONSOLE.
    3. Right Click on SYS_CONSOLE button on COMMAND box.
    4. Select Satisfiers → CONSOLE.
  47. Add SDHC consumers.
    1. Right Click on SDHC button on SDMMC1 box.
    2. Select consumers → SDMMC.
  48. Add SDMMC consumers.
    1. Right Click on DRV_MEDIA button on SDMMC box.
    2. Select consumers → FILE SYSTEM.
  49. Add TIME satisfiers.
    1. Right Click on TMR button on TIME box.
    2. Select Satisfiers → TC0.
  50. From Device Resources window, expand Peripherals and expand FLEXCOM to view FLEXCOM list.
  51. Click add button to add FLEXCOM3 and FLEXCOM9 to Project Graph.
  52. In SAMA7G54-EK Evaluation Kit, Debug UART is connected to FLEXCOM3 peripheral module.
    1. To add UART consumers, Right Click on UART button on FLEXCOM3 box.
    2. Select consumers → CONSOLE.
  53. In SAMA7G54-EK Evaluation Kit, Thermo 3 click board is connected to MikroBUS 1 Slot. I2C communication Protocol is required to access Thermo 3 click board. The I2C/TWI lines of MikroBUS 1 Slot are connected to FLEXCOM9 peripheral module.
    1. To add I2C consumers, Right Click on I2C button on FLEXCOM9 box.
    2. Select consumers → I2C.
  54. Add wolfCrypt Library consumers.
    1. Right Click on LIB_WOLFCRYPT button on wolfCrypt Library box.
    2. Select consumers → wolfSSL Library.
    3. Right Click on TLS Provider button on TCP/IP STACK box.
    4. Select Satisfiers → wolfSSL Library.
  55. Update the System Heap size and all other Stack Size.
    1. Select the System in the Project Graph window.
    2. In Configuration Options window, update the System Heap size and all other Stack Size as shown in the image below.
  56. Start Clock Configuration from Plugins drop-down menu.
  57. Verify the clock configuration. The application demo can work with default clock configuration.
    1. Verify the Processor Clock (CPU_CLK) is 800,000,000 Hz.
    2. Verify the Master Clock (MCK0) is 200,000,000 Hz.
    3. Verify the Peripheral Clocks are enabled for FLEXCOM3, FLEXCOM9, GMAC0, SDMMC1 and TC0. Select the System in the Project Graph window. In Configuration Options, expand Clock then expand Peripheral Clocks.
    4. GMAC0 requires 125,000,000 Hz clock frequency. ETHPLL should be used as clock source. To Enable ETHPLL, select the System in the Project Graph window. In Configuration Options, expand Clock then expand ETHPLL. Click on the check box of Enable PLL and update the value as shown below.
    5. Enable GMAC0 clock. Select the System in the Project Graph window. In Configuration Options, expand Clock then expand Generic Clocks.
    6. Expand GMAC0 and click on Enable check box. Update GCLKCSS as ETHPLL.
    7. Enable SDMMC1 clock. Select the System in the Project Graph window. In Configuration Options, expand Clock then expand Generic Clocks.
    8. Expand SDMMC1 and Click on Enable check box. Update GCLKCSS as MAINCK.
  58. Start Interrupt Configuration from Plugins drop-down menu.
  59. Verify whether FLEXCOM3, FLEXCOM9, GMAC0, SDMMC1 and TC0_CH0 interrupt is enabled.
  60. Start Pin Configuration from Plugins drop-down menu.
    1. Refer to the SAMA7G54-EK User's Guide for the UART pins.
    2. Configure the pins for UART as shown below.
    3. Refer to the SAMA7G54-EK User's Guide for TWI pins.
    4. Configure the pins for TWI as shown below.
    5. Configure the pins for SDMMC1 as shown below.
    6. Refer to Gigabit Ethernet Interface Schematic in SAMA7G54-EK User's Guide for the GMAC0 pins.
    7. Configure the pins for GMAC0 as shown below.
  61. Update HTTPNET SERVER Listening port and default HTTP NET file.
    1. In Project Graph window, select APPLICATION LAYER from the list in View tab.
    2. Click on HTTPNET SERVER box in Project Graph.
    3. In Configuration Options, go to HTTPNER SERVER and expand Advanced Settings. Update Default HTTP NET file as index.html and update HTTP NET Listening Port as 443.
  62. Enable Encryption setting.
    1. In Project Graph window, select PRESENTATION LAYER from the list in View tab.
    2. Click on Presentation Layer box in Project Graph.
    3. In Configuration Options window, Enable Support Encryption? by clicking on the check box.
    4. In Configuration Options window, expand Support Encryption? Update Encryption Provider as WolfSSL from list and enable Support Server Encryption? by clicking on the check box.
  63. Update TCP/IP stack Dynamic RAM Size to 92160.
    1. In Project Graph window, select BASIC CONFIGURATION from the list in View tab.
    2. Click on TCPIP CORE box in Project Graph.
    3. In Configuration Options, expand Heap Configuration and update TCP/IP stack Dynamic RAM Size to 92160.
  64. Update KSZ9131 PHY Address to 7.
    1. In Project Graph window, select DATA LINK LAYER from the list in View tab.
    2. Click on KSZ9131 box in Project Graph.
    3. In Configuration Options window, in KSZ9131 Update PHY Address to 7.
  65. Save all and then click Generate Code. This will generate code for all the Device Resource that have been added in the project graph.
  66. Up to this point in the project creation process, the user used MPLAB Code Configurator (MCC) to configure and generate code to initialize the device (SAMA7G54).
    Refer initialization.c file in project_directory/src/config to find that all the device resource added in the project graph got initialized. All that is left is for the user to write the application code in the app.c file. Documentation for each of the peripheral libraries or driver libraries can be accessed as follows:
    1. Peripheral libraries APIs can be accessed as a HTML file (.html) from the Harmony 3 Framework path. (/framework_path/csp/docs/index.html).
    2. BSP libraries APIs can be found in bsp.h.
    3. TCP/IP Stack APIs can be accessed as a HTML file (.html) from the Harmony 3 Framework path. (/framework_path/net/docs/index.html).
  67. APIs used for this application are as follows:
    • LED_GREEN_On
    • LED_GREEN_Off
    • LED_Red_On
    • LED_Red_Off
    • LED_Blue_On
    • LED_Blue_Off
    • FLEXCOM9_TWI_CallbackRegister
    • FLEXCOM9_TWI_Write
    • FLEXCOM9_TWI_IsBusy
    • FLEXCOM9_TWI_Read
    • SYS_FS_Mount
    • TCPIP_STACK_Status
    • SYS_CONSOLE_PRINT
    • SYS_CONSOLE_MESSAGE
    • TCPIP_STACK_NumberOfNetworksGet
    • TCPIP_STACK_NetAddress
    • TCPIP_STACK_NetNameGet
    • TCPIP_STACK_NetIsReady
    • TCPIP_STACK_IndexToNet
  68. Sample code can be found in app.c in project_directory/src folder.
  69. Right click on the project and click Properties. For Connected Hardware Tool -> select connected hardware debugger used, for Compiler Toolchain -> select XC32 and click Apply.
  70. From J-32/J-Link, In Option categories choose Communication and for JTAG Method, select 4-wire JTAG.
  71. Select bootstrap from Categories and select the Use Bootstrap checkbox. For bootstrap file -> select the at91bootstrap.elf file from the project directory. Click on Apply and OK.
  72. By default, MPLAB X only produces ELF and Hex format output files. To generate application output in binary format, a post build step needs to be added to the project properties. To do this, right click on project and select properties, select building, click the check box Execute this line after build, then enter the below command.
    ${MP_CC_DIR}/xc32-objcopy -O binary ${DISTDIR}/${PROJECTNAME}.${IMAGE_TYPE}.elf ${DISTDIR}/harmony.bin

    Click on Apply and OK.

  73. Clean and build the project. The user should see a message on the output console that the project was successfully built. This completes the development of the Ethernet web server getting started application.
  74. The harmony.bin binaries will be available at ./firmware/sama7g54_ek.X/dist/default/production.

Debugging Application Project on MPLAB® X IDE

  1. Open the project (sama7g54_ek_ethernet_web_server_getting_started/firmware/sama7g54_ek.X) in MPLAB® X IDE.
  2. In the project properties, ensure SAMA7G54 is selected as the Device and for Connected Hardware Tool, select the hardware debugger connected to the board to program/debug the application.
  3. Build and debug the code by clicking on the Debug button in MPLAB® X IDE tool bar.
  4. Run the application by clicking the Run button in MPLAB® X IDE tool bar.
  5. Ensure Console Serial communications between the Host PC and the SAMA7G54-EK Evaluation Board take place through UART port J24. A terminal emulation program running on the Host PC communicates with the SAMA7G54-EK Evaluation Kit UART port. Ensure the terminal emulation program (Eg: Tera term) is configured to the COM port and settings are:
    • Speed: 115200
    • Data: 8
    • Parity: None
    • Stop Bits: 1
  6. Once the board is powered up, the user will see the Blue LED turn ON. The following message is displayed on the console:

Running the Pre-built Harmony Application from SD Card

The pre-built application bin file can be programmed by following the below steps.

Steps to program the bin file on SD card:

  1. Take an SD Card formatted with FAT32 file system.
  2. Copy the boot.bin, harmony.bin files from the project_directory/hex folder to the SD card.
  3. Copy the webpage files from sama7g54_ek/sama7g54_ek_ethernet_web_server_getting_started\firmware/src/webpage folder to the SD card.
  4. Insert the SD card to J4 on the SAMA7G54-EK Evaluation Kit.

harmony.bin

Steps to run the bin file from SD card:

  1. Press the reset button.
  2. The following debug messages will be displayed on the console. Note the IP Address.
  3. Enter the IP Address (Example: https://10.40.24.92) in web browser and press enter. The following webpage will be displayed on the browser.
  4. Control each LED from web-page and view LED status updated. View the temperature displayed on the web-page.

Comments

This application demo builds and works out of the box by following the instructions above in Running the Demo section. If the user needs to enhance/customize this application demo, should use the MPLAB Harmony v3 Software framework. Refer links below to setup and build the applications using MPLAB Harmony.