W5500开发笔记 | 01- W5500 Socket API的说明

Posted Mculover666

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了W5500开发笔记 | 01- W5500 Socket API的说明相关的知识，希望对你有一定的参考价值。

一、准备工作

本系列文章只讲如何使用W5500驱动库。

1. 硬件环境

W5500驱动教程请参考：

本系列教程中对W5500模块和开发板之间的连接方式如图：


引脚连接情况为：

W5500引脚STM32引脚
3V33V3
GNDGND
CSPA15(SPI3_NSS)
MISOPC11(SPI3_MISO)
MOSIPB5(SPI3_MISO)
SCKPC10(SPI3_SCK)
nRSTPC0
nINTPB14

2. 网络环境

本系列实验需要PC和开发板在同一个网段（在同一个路由器）上，目前我的配置环境为：

  • 路由器网关：192.168.10.1
  • PC地址：192.168.10.156

所以将开发板地址设置为192.168.10.xxx，这里我设置为192.168.10.6：

使用PC测试是否可以ping通开发板：

如果可以ping通，则网络环境正常，可以进行后续实验。

二、W5500 驱动库提供的Socket API

W5500 驱动库提供的 Socket API 称为 WIZnet socket API，实现在：socket.h和socket.c中。

WIZnet socket API 基于Berkeley socket API，所以它具有非常相似的名称和接口，但是也有一些差异。

WIZnet socket API 和 Berkeley socket API 的对比如下：

APIWIZnetBerkeley
socket()OO
bind()XO
listen()OO
connect()OO
accept()XO
recv()OO
send()OO
recvfrom()OO
sendto()OO
closesocket()O
close() & disconnect()		O

从表里可以看到，WIZnet提供的Socket API没有bind和accept，所以使用 WIZnet API的流程如下：

三、WIZnet socket API说明

1. Socket

功能：使用传递的socket number初始化socekt并且打开socket。

原型：

int8_t  socket (uint8_t sn, uint8_t protocol, uint16_t port, uint8_t flag);

参数说明：

  • Sn：Socket number，应该为0 到 WIZCHIP_SOCK_NUM_
  • protoco：协议类型，TCP、UDP、MACRAW
  • port：端口号
  • flag：用于设置一些特殊的Socket模式。

① WIZCHIP_SOCK_NUM_是W5500芯片所能建立的最大独立socket数量，在 wizchip_conf.h 中定义，目前为8。

#if _WIZCHIP_ >= W5200
   #define _WIZCHIP_SOCK_NUM_   8   ///< The count of independant socket of @b WIZCHIP
#else
   #define _WIZCHIP_SOCK_NUM_   4   ///< The count of independant socket of @b WIZCHIP
#endif

返回值：

  • 成功：返回用户指定的端口号
  • 失败：返回错误码
    • SOCKERR_SOCKNUM - Invalid socket number
    • SOCKERR_SOCKMODE - Not support socket mode as TCP, UDP, and so on.
    • SOCKERR_SOCKFLAG - Invaild socket flag.

② 协议类型用于配置socket n 模式寄存器（Sn_MR）的低 4 位：

W5500驱动库中提供了对应的宏定义：

/**
 * @brief MAC LAYER RAW SOCK
 * @details This configures the protocol mode of Socket n.
 * @note MACRAW mode should be only used in Socket 0.
 */
#define Sn_MR_MACRAW                 0x04

/**
 * @brief UDP
 * @details This configures the protocol mode of Socket n.
 */
#define Sn_MR_UDP                    0x02

/**
 * @brief TCP
 * @details This configures the protocol mode of Socket n.
 */
#define Sn_MR_TCP                    0x01

/**
 * @brief Unused socket
 * @details This configures the protocol mode of Socket n.
 */
#define Sn_MR_CLOSE                  0x00

2. listen

功能：监听来自客户端的连接请求。

原型：

int8_t  listen (uint8_t sn);

参数说明：

  • Sn：Socket number

返回值：

  • 成功：SOCK_OK
  • 失败：返回错误码
    • SOCKERR_SOCKINIT - Socket is not initialized
    • SOCKERR_SOCKCLOSED - Socket closed unexpectedly.

3. connect

功能：连接服务端。

原型：

int8_t  connect (uint8_t sn, uint8_t *addr, uint16_t port);

参数说明：

  • Sn：Socket number
  • addr：目标IP地址指针，4个字节的数组；
  • port：目标端口

返回值：

  • 成功：SOCK_OK
  • 失败：返回错误码
    • SOCKERR_SOCKNUM - Invalid socket number
    • SOCKERR_SOCKMODE - Invalid socket mode
    • SOCKERR_SOCKINIT - Socket is not initialized
    • SOCKERR_IPINVALID - Wrong server IP address
    • SOCKERR_PORTZERO - Server port zero
    • SOCKERR_TIMEOUT - Timeout occurred during request connection
    • SOCK_BUSY - In non-block io mode, it returned immediately

4. send

功能：发送TCP数据。

原型：

int32_t  send (uint8_t sn, uint8_t *buf, uint16_t len);

参数说明：

  • Sn：Socket number
  • buf：发送数据缓冲区指针
  • len：发送数据的大小

返回值：

  • 成功：发送数据的大小
  • 失败：返回错误码
    • SOCKERR_SOCKSTATUS - Invalid socket status for socket operation
    • SOCKERR_TIMEOUT - Timeout occurred
    • SOCKERR_SOCKMODE - Invalid operation in the socket
    • SOCKERR_SOCKNUM - Invalid socket number
    • SOCKERR_DATALEN - zero data length
    • SOCK_BUSY - Socket is busy.

5. recv

功能：接收TCP数据。

原型：

int32_t recv(uint8_t sn, uint8_t * buf, uint16_t len);

参数说明：

  • Sn：Socket number
  • buf：接收数据缓冲区指针
  • len：buffer大小（接收数据的最大长度）

返回值：

  • 成功：实际接收数据的大小
  • 失败：返回错误码
    • SOCKERR_SOCKSTATUS - Invalid socket status for socket operation
    • SOCKERR_SOCKMODE - Invalid operation in the socket
    • SOCKERR_SOCKNUM - Invalid socket number
    • SOCKERR_DATALEN - zero data length
    • SOCK_BUSY - Socket is busy

6. sendto

功能：发送UDP数据。

原型：

int32_t sendto(uint8_t sn, uint8_t * buf, uint16_t len, uint8_t * addr, uint16_t port);

参数说明：

  • Sn：Socket number
  • buf：发送数据缓冲区指针
  • len：发送数据的大小
  • addr：目标地址
  • port：目标端口

返回值：

  • 成功：发送数据的大小
  • 失败：返回错误码
    • SOCKERR_SOCKNUM - Invalid socket number
    • SOCKERR_SOCKMODE - Invalid operation in the socket
    • SOCKERR_SOCKSTATUS - Invalid socket status for socket operation
    • SOCKERR_DATALEN - zero data length
    • SOCKERR_IPINVALID - Wrong server IP address
    • SOCKERR_PORTZERO - Server port zero
    • SOCKERR_SOCKCLOSED - Socket unexpectedly closed
    • SOCKERR_TIMEOUT - Timeout occurred
    • SOCK_BUSY - Socket is busy

7. recvfrom

功能：接收 UDP 数据。

原型：

int32_t recvfrom(uint8_t sn, uint8_t * buf, uint16_t len, uint8_t * addr, uint16_t *port);

参数说明：

  • Sn：Socket number
  • buf：接收数据缓冲区指针
  • len：buffer大小（接收数据的最大长度）
  • addr：目标地址
  • port：目标ip

返回值：

  • 成功：实际接收数据的大小
  • 失败：返回错误码
    • SOCKERR_SOCKSTATUS - Invalid socket status for socket operation
    • SOCKERR_SOCKMODE - Invalid operation in the socket
    • SOCKERR_SOCKNUM - Invalid socket number
    • SOCKERR_DATALEN - zero data length
    • SOCK_BUSY - Socket is busy

8. close

功能：关闭socket。

原型：

int8_t close(uint8_t sn);

参数说明：

  • Sn：Socket number

返回值：

  • 成功：SOCK_OK
  • 失败：返回错误码
    • SOCKERR_SOCKNUM - Invalid socket number

以上是关于W5500开发笔记 | 01- W5500 Socket API的说明的主要内容，如果未能解决你的问题，请参考以下文章

STM32F412应用开发笔记之五：结合W5500实现以太网通讯

W5500 学习开发: W5500学习说明

W5500 学习开发: 硬件使用说明

W5500 学习开发: 硬件使用说明

W5500 学习开发: TCP客户端

W5500 学习开发: TCP客户端