These sections will guide you through a series of steps from configuring development environment to running ethernet examples using the WIZnet's ethernet products.
To test the ethernet examples, the development environment must be configured to use Raspberry Pi Pico, W5100S-EVB-Pico, W5500-EVB-Pico, W55RP20-EVB-Pico, W6100-EVB-Pico, W6300-EVB-Pico, W5100S-EVB-Pico2, W5500-EVB-Pico2, W6100-EVB-Pico2 or W6300-EVB-Pico2.
These examples were tested after configuring the development environment on Windows. Please refer to 'Chapter 3: Installing the Raspberry Pi Pico VS Code Extension' in the document below and configure accordingly.
Visual Studio Code was used during development and testing of ethernet examples, the guide document in each directory was prepared also base on development with Visual Studio Code. Please refer to corresponding document.
The Ethernet examples are compatible with the following Raspberry Pi-compatible WIZnet Ethernet I/O modules. These modules integrate WIZnet Ethernet chips with either the RP2040 or RP2350 microcontrollers.
| Board/Module Name | MCU | Ethernet Chip | Interface | Socket # | TX/RX Buffer | Notes |
|---|---|---|---|---|---|---|
| WIZnet Ethernet HAT | W5100S | SPI | 4 | 16KB | RP Pico-compatible | |
| W5100S-EVB-Pico | RP2040 | W5100S | SPI | 4 | 16KB | |
| W5500-EVB-Pico | RP2040 | W5500 | SPI | 8 | 32KB | |
| W55RP20-EVB-Pico | RP2040 | W5500 | SPI (PIO) | 8 | 32KB | SiP: RP2040 + W5500 |
| W6100-EVB-Pico | RP2040 | W6100 | SPI | 8 | 32KB | Supports IPv4/IPv6 |
| W6300-EVB-Pico | RP2040 | W6300 | QSPI (PIO) | 8 | 64KB | Supports IPv4/IPv6 |
| W5100S-EVB-Pico2 | RP2350 | W5100S | SPI | 4 | 16KB | |
| W5500-EVB-Pico2 | RP2350 | W5500 | SPI | 8 | 32KB | |
| W6100-EVB-Pico2 | RP2350 | W6100 | SPI | 8 | 32KB | Supports IPv4/IPv6 |
| W6300-EVB-Pico2 | RP2350 | W6300 | QSPI (PIO) | 8 | 64KB | Supports IPv4/IPv6 |
Examples are available at 'WIZnet-PICO-C/examples/' directory. As of now, following examples are provided.
- CAN
- DHCP & DNS
- FTP
- HTTP
- Loopback
- MQTT
- NETBIOS
- Network install
- PPPoE
- SNTP
- TCP Client over SSL
- TCP server multi socket
- TFTP
- UDP
- UDP multicast
- uPnP
Note that ioLibrary_Driver, mbedtls, pico-sdk are needed to run ethernet examples.
- ioLibrary_Driver library is applicable to WIZnet's WIZchip ethernet chip.
- mbedtls library supports additional algorithms and support related to SSL and TLS connections.
- pico-sdk is made available by Pico to enable developers to build software applications for the Pico platform.
Libraries are located in the 'WIZnet-PICO-C/libraries/' directory.
If you want to modify the code that MCU-dependent and use a MCU other than RP2040, you can modify it in the 'WIZnet-PICO-C/port/' directory.
port is located in the 'WIZnet-PICO-C/port/' directory.
The structure of this WIZnet-PICO-C 2.0.0 version or higher has changed a lot compared to the previous version. If you want to refer to the previous version, please refer to the link below.
- Download
If the ethernet examples are cloned, the library set as a submodule is an empty directory. Therefore, if you want to download the library set as a submodule together, clone the ethernet examples with the following Git command.
/* Change directory */
// change to the directory to clone
cd [user path]
// e.g.
cd D:/WIZnet-PICO
/* Clone */
git clone --recurse-submodules https://github.com/WIZnet-ioNIC/WIZnet-PICO-C.gitWith Visual Studio Code, the library set as a submodule is automatically downloaded, so it doesn't matter whether the library set as a submodule is an empty directory or not, so refer to it.
- Setup board
Setup the board in 'CMakeLists.txt' in 'WIZnet-PICO-C/' directory according to the evaluation board to be used referring to the following.
- WIZnet Ethernet HAT
- W5100S-EVB-Pico
- W5500-EVB-Pico
- W55RP20-EVB-Pico
- W6100-EVB-Pico
- W6300-EVB-Pico
- W5100S-EVB-Pico2
- W5500-EVB-Pico2
- W6100-EVB-Pico2
- W6300-EVB-Pico2
For example, when using WIZnet Ethernet HAT :
# Set board
set(BOARD_NAME WIZnet_Ethernet_HAT)When using W5500-EVB-Pico :
# Set board
set(BOARD_NAME W5500_EVB_PICO)You can easily configure SPI clock speed of the WIZnet chip in the CMakeLists.txt file. Enter your desired clock speed in the code below and build.
# Set WIZchip Clock Speed
add_definitions(-D_WIZCHIP_SPI_SCLK_SPEED=40) # SPEED MHzWhen using W6300, you can configure the QSPI mode by modifying the board selection parameter.
For example, when using QSPI QUAD MODE:
# Set QSPI MODE for W6300
add_definitions(-D_WIZCHIP_QSPI_MODE_=QSPI_QUAD_MODE) # QSPI_QUAD_MODE
# add_definitions(-D_WIZCHIP_QSPI_MODE_=QSPI_DUAL_MODE) # QSPI_DUAL_MODE
# add_definitions(-D_WIZCHIP_QSPI_MODE_=QSPI_SINGLE_MODE) # QSPI_SINGLE_MODE - Test
Please refer to 'README.md' in each example directory to find detail guide for testing ethernet examples.
The following provides instructions for applying a patch file for example testing.
※ If the board pauses when rebooting using W55RP20-EVB-Pico, patch it as follows.
// Patch git apply ./patches/0001_pico_sdk_clocks.patch
※ To test the TFTP example, please apply the following patch.
cd libraries/ioLibrary_Driver git apply ../../patches/0002_iolibrary_driver_tftp.patch
※ To test the FTP client example, please apply the following patch.
cd libraries/ioLibrary_Driver git apply ../../patches/0003_iolibrary_driver_ftp_client.patch
We moved the MCU dependent code to the port directory. The tree of port is shown below.
WIZnet-PICO-C
┣ port
┣ board
┃ ┣ can
┃ ┃ ┣ can.h
┃ ┃ ┣ can.c
┃ ┃ ┗ can.pio
┃ ┃
┣ ioLibrary_Driver
┃ ┣ inc
┃ ┃ ┣ wizchip_gpio_irq.h
┃ ┃ ┣ wizchip_spi.h
┃ ┃ ┗ wizchip_qspi_pio.h
┃ ┗ src
┃ ┃ ┣ wizchip_gpio_irq.c
┃ ┃ ┣ wizchip_spi.c
┃ ┃ ┣ wizchip_qspi_pio.c
┃ ┃ ┗ wizchip_spi_pio.pio
┣ mbedtls
┃ ┗ inc
┃ ┃ ┗ ssl_config.h
┣ timer
┃ ┣ timer.c
┃ ┗ timer.h
┣ CMakeLists.txt
┗ port_common.h
-
All board-specific SPI pin settings can be configured in
wizchip_spi.h. -
The following files are intended for use with W55RP20-EVB-PICO, W6300-EVB-PICO, and W6300-EVB-PICO2:
wizchip_qspi_pio.cwizchip_qspi_pio.hwizchip_qspi_pio.pio
-
W55RP20-EVB-PICO uses SPI implemented with PIO.
-
W6300-EVB-PICO and W6300-EVB-PICO2 use QSPI (Single/Dual/Quad) via PIO.
-
Therefore, all PIO-related configurations should be made inside:
wizchip_qspi_pio.cwizchip_qspi_pio.hwizchip_qspi_pio.pio
- ioLibrary_Driver
If you want to change things related to SPI, such as the SPI port number and SPI read/write function, or GPIO port number and function related to interrupt or use a different MCU without using the RP2040, you need to change the code in the 'WIZnet-PICO-C/port/ioLibrary_Driver/' directory. Here is information about functions
/*! \brief Set CS pin
* \ingroup wizchip_spi
*
* Set chip select pin of spi0 to low(Active low).
*
* \param none
*/
static inline void wizchip_select(void);
/*! \brief Set CS pin
* \ingroup wizchip_spi
*
* Set chip select pin of spi0 to high(Inactive high).
*
* \param none
*/
static inline void wizchip_deselect(void);
/*! \brief Read from an SPI device, blocking
* \ingroup wizchip_spi
*
* Set spi_read_blocking function.
* Read byte from SPI to rx_data buffer.
* Blocks until all data is transferred. No timeout, as SPI hardware always transfers at a known data rate.
*
* \param none
*/
static uint8_t wizchip_read(void);
/*! \brief Write to an SPI device, blocking
* \ingroup wizchip_spi
*
* Set spi_write_blocking function.
* Write byte from tx_data buffer to SPI device.
* Blocks until all data is transferred. No timeout, as SPI hardware always transfers at a known data rate.
*
* \param tx_data Buffer of data to write
*/
static void wizchip_write(uint8_t tx_data);
#ifdef USE_SPI_DMA
/*! \brief Configure all DMA parameters and optionally start transfer
* \ingroup wizchip_spi
*
* Configure all DMA parameters and read from DMA
*
* \param pBuf Buffer of data to read
* \param len element count (each element is of size transfer_data_size)
*/
static void wizchip_read_burst(uint8_t *pBuf, uint16_t len);
/*! \brief Configure all DMA parameters and optionally start transfer
* \ingroup wizchip_spi
*
* Configure all DMA parameters and write to DMA
*
* \param pBuf Buffer of data to write
* \param len element count (each element is of size transfer_data_size)
*/
static void wizchip_write_burst(uint8_t *pBuf, uint16_t len);
#endif
/*! \brief Enter a critical section
* \ingroup wizchip_spi
*
* Set ciritical section enter blocking function.
* If the spin lock associated with this critical section is in use, then this
* method will block until it is released.
*
* \param none
*/
static void wizchip_critical_section_lock(void);
/*! \brief Release a critical section
* \ingroup wizchip_spi
*
* Set ciritical section exit function.
* Release a critical section.
*
* \param none
*/
static void wizchip_critical_section_unlock(void);
/*! \brief Initialize SPI instances and Set DMA channel
* \ingroup wizchip_spi
*
* Set GPIO to spi0.
* Puts the SPI into a known state, and enable it.
* Set DMA channel completion channel.
*
* \param none
*/
void wizchip_spi_initialize(void);
/*! \brief Initialize a critical section structure
* \ingroup wizchip_spi
*
* The critical section is initialized ready for use.
* Registers callback function for critical section for WIZchip.
*
* \param none
*/
void wizchip_cris_initialize(void);
/*! \brief WIZchip chip reset
* \ingroup wizchip_spi
*
* Set a reset pin and reset.
*
* \param none
*/
void wizchip_reset(void);
/*! \brief Initialize WIZchip
* \ingroup wizchip_spi
*
* Set callback function to read/write byte using SPI.
* Set callback function for WIZchip select/deselect.
* Set memory size of WIZchip and monitor PHY link status.
*
* \param none
*/
void wizchip_initialize(void);
/*! \brief Check chip version
* \ingroup wizchip_spi
*
* Get version information.
*
* \param none
*/
void wizchip_check(void);
/* Network */
/*! \brief Initialize network
* \ingroup wizchip_spi
*
* Set network information.
*
* \param net_info network information.
*/
void network_initialize(wiz_NetInfo net_info);
/*! \brief Print network information
* \ingroup wizchip_spi
*
* Print network information about MAC address, IP address, Subnet mask, Gateway, DHCP and DNS address.
*
* \param net_info network information.
*/
void print_network_information(wiz_NetInfo net_info);/* GPIO */
/*! \brief Initialize wizchip gpio interrupt callback function
* \ingroup wizchip_gpio_irq
*
* Add a wizchip interrupt callback.
*
* \param socket socket number
* \param callback the gpio interrupt callback function
*/
void wizchip_gpio_interrupt_initialize(uint8_t socket, void (*callback)(void));
/*! \brief Assign gpio interrupt callback function
* \ingroup wizchip_gpio_irq
*
* GPIO interrupt callback function.
*
* \param gpio Which GPIO caused this interrupt
* \param events Which events caused this interrupt. See \ref gpio_set_irq_enabled for details.
*/
static void wizchip_gpio_interrupt_callback(uint gpio, uint32_t events);- timer
If you want to change things related to the timer. Also, if you use a different MCU without using the RP2040, you need to change the code in the 'WIZnet-PICO-C/port/timer/' directory. Here is information about functions.
/* Timer */
/*! \brief Initialize timer callback function
* \ingroup timer
*
* Add a repeating timer that is called repeatedly at the specified interval in microseconds.
*
* \param callback the repeating timer callback function
*/
void wizchip_1ms_timer_initialize(void (*callback)(void));
/*! \brief Assign timer callback function
* \ingroup timer
*
* 1ms timer callback function.
*
* \param t Information about a repeating timer
*/
bool wizchip_1ms_timer_callback(struct repeating_timer *t);
/* Delay */
/*! \brief Wait for the given number of milliseconds before returning
* \ingroup timer
*
* This method attempts to perform a lower power sleep (using WFE) as much as possible.
*
* \param ms the number of milliseconds to sleep
*/
void wizchip_delay_ms(uint32_t ms);