1.19 TCP/IP WEB & FTP SERVER with MPFS & FATFS

The Web and FTP Server configuration demonstrates creating an application where HTTP web server will use MPFS with NVM media and FTP server will use FAT FS with SDCARD as media.

The Non-Volatile Memory (NVM) Microchip Proprietary File System (MPFS) is used for storing the web pages in the internal Flash.

The FAT FS File System is used for storing any type of files and FTP server will read from and write to this FS.

TCP/IP WEB & FTP SERVER with MPFS & FATFS MCC Configuration

The following Project Graph diagram shows the Harmony components included in the WEB & FTP SERVER with MPFS & FATFS application demonstration.

  • MCC is launched by selecting Tools > Embedded > MPLAB® Code Configurator from the MPLAB X IDE and after opening the project, TCP/IP demo project is ready to be configured and regenerated.

  • TCP/IP Root Layer Project Graph

    The root layer project shows that UART2 peripheral is selected to do read and write operation for TCP/IP commands.

    This is the basic configuration with SYS_CONSOLE, SYS_DEBUG and SYS_COMMAND modules. These modules are required for TCP/IP command execution.

    TCP/IP application with both MPFS and FAT FS access. The below root project graph depicts the use of more than FS by TCP/IP stack. Also HTTP Server use Wolfssl library to support secured web server on port 443 / 80.

    • PIC32MZ DA Starter Kit

      PIC32MZ DA device performs read/write to an SD card using SDMMC driver. This demo application use SDMMC driver to read/write from SDHC peripheral module.

      SDHC (SD/MMC Host Controller) PLIB provides low level APIs to configure and transfer data using the SD host controller. SD multimedia memory card ( SDMMC ) driver provides abstraction to communicate with SD/eMMC card through the SDHC peripheral library interface. The TCP/IP application use FAT file system with SDMMC driver to read/write to an SD card.

      tcpip_pic32mz_project
    • PIC32MZ EF Starter Kit

      PIC32MZ EF Device performs read/write to an SD card using SDSPI Module. This module is selected with SPI peripheral.

      SDSPI driver uses an instance of the SPI driver to communicate to the SD card over the SPI bus.

      The TCP/IP application demonstrates FAT file system to read/write to an SD card using SDSPI driver. This demo application use SPI peripheral to read/write from SDMMC module.

      tcpip_pic32mz_project

    Wolfssl crypto module enabled with MD5,SHA authentication and AES encryption/decryption privacy protocol are enabled. Wolfssl library configured with open secured socket.

    TCP sockets calculate the ISN using the wolfSSL crypto library.

    NOTE - The above screenshot contains FreeRTOS component and that is required for RTOS application. For bare-metal(non-RTOS) FreeRTOS component shouldn't be selected.

    Both MPFS and FAT File System Configuration -

    tcpip_pic32mz_project
  • TCP/IP Configuration

    • PIC32MZ DA Starter Kit / PIC32MZ EF Starter Kit

      tcpip_pic32mz_project

  • TCP/IP Required Application

    TCP/IP demo use these application module components for this demo.

    Announce module to discover the Microchip devices within a local network.

    DHCP Client module to discover the IPv4 address from the nearest DHCP Server.

    DNS Client provides DNS resolution capabilities to the stack.

    FTP SERVER facilitates the uploading of files to, and downloading of files from, a network device.

    • FTP server use the FAT FS to access files from SDCARD media.

      tcpip_pic32mz_project

    HTTPNET Server module is selected to run the web_server for the port number 443(PIC32MZ DA SK) / 80(PIC32MZ EF SK).

    • HTTPNET server with Web directory Mount path and Security port number configuration:

      tcpip_pic32mz_project

      Http Server module use the NVM mount path with MPFS files system. Also HTTP server module use the secured port number 443.

    NBNS NetBIOS Name Service protocol associates host names with IP addresses. This assign of human-name host names to access boards on the same subnet.

    SMTP CLIENT let applications send e-mails to any recipient worldwide.

    SNTP Simple Network Time Protocol updates its internal time periodically using a pool of public global time servers.

  • TCP/IP Data Link Layer

    Internal ethernet driver(ethmac) is enabled with the external LAN8740 PHY driver library for both the starter kits. The MIIM Driver supports asynchronous read/write and scan operations for accessing the external PHY registers and notification when MIIM operations have completed.

TCP/IP WEB & FTP SERVER with MPFS & FATFS Hardware Configuration

This section describes the hardware configuration for PIC32MZ DA/EF Starter Kit and one can be used for the respective application demonstration.

  1. This section describes the PIC32MZ DA Starter Kit default hardware configuration which uses the on-board debugger and programmer for this application demonstration.

    • Refer to the PIC32MZ DA Starter Kit User Guide for the programming/debugging options supported & setting up the hardware.

      required_hardware
    • Connect micro USB cable from the computer to the DEBUG USB connector(J19) on the PIC32MZ DA Starter Kit

    • Connect micro USB cable from the computer to the USB-UART connector(J5) on the PIC32MZ DA Starter Kit

    • Insert the SD Card in the SD Card slot (J10) on the PIC32MZ DA Starter Kit (as shown above).

    • Establish a connection between the router/switch with the PIC32MZ DA Starter Kit through the RJ45 connector on PHY daughter board

  2. This section describes the PIC32MZ EF Starter Kit default hardware configuration which uses the on-board debugger and programmer for this application demonstration with SDMMC(Secure Digital/ MultiMediaCard interface) interface.

    • Refer to the PIC32MZ EF Starter Kit User Guide for the programming/debugging options supported & setting up the hardware.

    • Refer to the Starter Kit I/O Expansion Board - DM320002 User Guide

    • Refer to the SDMMC PICtail daughter board - AC164122 User Guide

      required_hardware
    • Insert the SDMMC PICtail daughter board (AC164122) into the SPI1 slot of the I/O Expansion Board (DM320002)

    • Connect the 168 pin to 132 pin Starter Kit Adapter board to the Starter Kit I/O Expansion Board (DM320002), optionally use a nylon nut and bolt to secure the two boards together

    • Connect the PIC32MZ EF Starter kit to the 168 pin to 132 pin Starter Kit Adapter board, optionally use a nylon nut and bolt to secure the two boards together

    • Connect the mini USB cable from the computer to the USB DEBUG connector on the PIC32MZ EF Starter Kit

    • Connect the mini USB cable from the computer to the USB-UART connector on the PIC32MZ EF Starter Kit

    • Insert the SD Card in the SD Card slot on the SDMMC PICtail daughter board (AC164122)

    • Establish a connection between the router/switch with the PIC32MZ Starter Kit through the RJ45 connector on PHY daughter board.

  • The demo application is configured for the SPI1 slot, using the following I/O pins:

    SPI 1Pin Selection
    SCK1 - SPI clockRD1
    SDI1 - SPI Data InputRD14
    SDO1 - SPI Data OutputRD10
    SPI Chip SelectRB1

TCP/IP WEB & FTP SERVER with MPFS & FATFS Running Application

This application uses more than one FS for the TCP/IP application demonstration. Here HTTP Net server uses Microchip Proprietary File System (MPFS) as a read only FS. Here MPFS FS reads web pages from Non-Volatile Memory (NVM) media which is used to store the web server pages.

The FAT FS File System read and writes to SDCard memory media which is used for storing any type of files. FTP server will read from and write to this SDcard media using FAT FS.

This table list the name and location of the MPLAB X IDE project folder for the demonstration.

Project NameTarget DeviceTarget Development BoardDescription
pic32mz_das_sk.XPIC32MZ2064DAS169PIC32MZ DA Starter KitDemonstrates the WEB & FTP SERVER with MPFS & FATFS on development board with PIC32MZ2064DAS169 device and LAN8740 PHY daughter board. This implementation is based on bare-metal(non-RTOS).
pic32mz_das_sk_freertos.XPIC32MZ2064DAS169PIC32MZ DA Starter KitDemonstrates the WEB & FTP SERVER with MPFS & FATFS on development board with PIC32MZ2064DAS169 device and LAN8740 PHY daughter board. This implementation is based on FreeRTOS.
pic32mz_ef_sk_freertos.XPIC32MZ2048EFH144PIC32MZ EF Starter KitDemonstrates the WEB & FTP SERVER with MPFS & FATFS on development board with PIC32MZ2048EFH144 device and LAN8740 PHY daughter board. This implementation is based on FreeRTOS.
  • Ensure SD card is formatted and loaded with the files whichever are to be used for performing file transfer using FTP.

Running Demonstration Steps

  1. Build and download the demonstration project on the target board.

  2. If the board has a UART connection:

    1. A virtual COM port will be detected on the computer, when the USB cable is connected to USB-UART connector.

    2. Open a standard terminal application on the computer (like Hyper-terminal or Tera Term) and configure the virtual COM port.

    3. Set the serial baud rate to 115200 baud in the terminal application.

    4. See that the initialization prints on the serial port terminal.

    5. When the DHCP client is enabled in the demonstration, wait for the DHCP server to assign an IP address for the development board. This will be printed on the serial port terminal.

      • Alternatively: Use the Announce service or ping to get the IP address of the board.

      • Run tcpip_discoverer.jar to discover the IPv4 and IPv6 address for the board.

  3. Execution :

    After the successful board bring up, the console output becomes

    tcpip_pic32mz_project
  4. HTTP Server Output -

    An HTTP server is hosted by the demonstration application. Open a web browser and direct it to the board running the HTTP server by typing the URL in the address bar (for example, https://mchpboard_e or https://< ip-address as shown in the console > ), and then pressing Enter.

    tcpip_pic32mz_project

    The demonstration application features following:

    1. Dynamic Variables and Real-time Hardware Control - On the Overview page the LEDs can be clicked to toggle the LEDs on the Microchip hardware development board. The SWITCHes on the Microchip hardware development board can be pressed to toggle the Buttons on the web page. The dynamic variables can be updated in real-time on the HTTP server.

    2. Form Processing - Input can be handled from the client by using the GET and POST methods (this functionality controls the on-board LEDs and is operational only on the Explorer 16 Development Board)

    3. Authentication - Shows an example of the commonly used restricted access feature

    4. Cookies - Shows an example of storing small text strings on the client side

    5. Server Side Includes - An example of how SSI can be used to support dynamic content

    6. File Uploads - Shows an example of a file upload using the POST method. The HTTP server can_accept_a user-defined MPFS/MPFS2 image file for web pages.

    7. Send E-mail - Shows simple SMTP POST methods

    8. Dynamic DNS - Exercises Dynamic DNS capabilities

    9. Network Configuration - The MAC address, host name, and IP address of the evaluation kit can be viewed in the Network Configuration page and some configurations can be updated

    10. MPFS Upload - A new set of web pages can be uploaded to the web server using this feature, which is accessed through http://mchpboard_e/mpfsupload

    Notes:

    • For the LED and SWITCH functionality portion of the demonstration, configure the GPIOs connected to LEDs and Switches on Microchip hardware development board, through the Pin Configuration manager in MPLAB® Code Configurator (MCC).

    • The location of the MPFS image is fixed at the beginning of the Flash page specified by DRV_MEMORY_DEVICE_START_ADDRESS. The size of the MPFS upload is limited to DRV_MEMORY_DEVICE_MEDIA_SIZE in the demonstration. The HTTP File Upload functionality has to be enabled when the project is generated.

  5. FTP Server output -

  • Open the windows command prompt (i.e., cmd).

  • First check if the board is available by pinging (i.e., ping < ip address of board >), the response obtained is shown in the below screenshot.

  • Enter the command ftp < ip address of board >, the response obtained is shown in the below screenshot.

  • Users must use ftp login credentials to connect to the ftp server.

  • The File transfer to and from the user’s computer is shown below.

    tcpip_pic32mz_project