STM32F4-Base/Drivers/BSP/NET/net_socket.h

/*
 * 模块名称：Network Socket API
 * 模块功能：BSD Socket API 兼容接口，提供 TCP/UDP 网络通信功能，
 *          底层基于 CH395F 以太网协议栈芯片
 * 适用平台：STM32F4 系列（CH395F 以太网芯片）
 * 作者：王建锋
 * 创建日期：2026-07-18
 * 修改记录：
 */

#ifndef NET_SOCKET_H
#define NET_SOCKET_H

#ifdef __cplusplus
extern "C" {
#endif

#include "net_types.h"

/*
 * OS 相关接口（FreeRTOS 消息队列 / 任务句柄 / netTask 内部 API）仅在启用
 * RTOS 的构建（MCU）编译；纯 PC 模拟器定义 NET_NO_OS 后只保留 BSD Socket 核心 API。
 */
#ifndef NET_NO_OS
#include "FreeRTOS.h"
#include "task.h"
#endif /* NET_NO_OS */

#ifndef NET_NO_OS
/*
 * 消息队列类型定义
 */
typedef enum {
    NET_MSG_SEND,
    NET_MSG_RECV,
    NET_MSG_CLOSE,
    NET_MSG_CONNECT,
    NET_MSG_LISTEN,
    NET_MSG_ACCEPT,
    /* N34 阶段1（F-NET-2/3）：NET_MSG_RESYNC_LISTEN / NET_MSG_RELISTEN 已删——
     * 静默回收由对账⑤自动认领（net_reconcile_tick），重建由 pump/D10 单一
     * 所有者负责；手动自愈 API 面退役（生产调用者本就为零） */
} net_msg_type_t;

typedef struct {
    net_msg_type_t  type;           /* 操作类型 */
    int             sockfd;         /* Socket 描述符 */
    void           *buf;            /* 数据缓冲区（send/recv） */
    int             len;            /* 数据长度/缓冲区大小 */
    int             flags;          /* 接收标志 */
    uint32_t        timeout_ms;     /* 接收超时（入队方向；0 = 用默认 NET_RECV_TIMEOUT_MS） */
    TaskHandle_t    caller;         /* 调用方任务句柄 */
    int             result;         /* 操作结果 */
    /* 连接参数 */
    struct net_sockaddr_in  addr;   /* 连接地址 */
    int             addrlen;        /* 地址长度 */
} net_msg_t;
#endif /* NET_NO_OS */

/*
 * 网络初始化接口
 */

/*
 * 函数功能：网络子系统初始化（配置 CH395F + 启用多连接模式）
 * 入口参数：ip       - 本地 IP 地址字符串 "192.168.1.100"，NULL 使用 DHCP
 *          mask     - 子网掩码字符串 "255.255.255.0"，NULL 使用默认
 *          gateway  - 网关地址字符串 "192.168.1.1"，NULL 使用默认
 *          mac      - MAC 地址（6 字节，低字节在前），NULL 或全零使用芯片内置
 * 返回值：0 成功，-1 失败
 * 限定条件：SPI2 已正确初始化
 * 函数说明：必须在所有网络操作之前调用；mac 非空且非全零时在协议栈初始化
 *          （CMD_INIT_CH395）之前下发（手册 §9.2.1 步骤①：SET_MAC 写芯片 EEPROM，
 *          INIT_CH395 加载 MAC——顺序反了则本次上电不生效，回落芯片内置/上次值）
 */
int net_init(const char *ip, const char *mask, const char *gateway, const uint8_t *mac);

/*
 * 函数功能：取网络代次号
 * 入口参数：无
 * 返回值：代次号（每次网络重建完成递增）  uint32_t
 * 限定条件：无
 * 函数说明：TCP 服务（FTP / 对时 / 远程显示）据此感知"网络已重建"——代次变化
 *          表示旧 Socket 已随芯片复位失效，服务应放弃旧监听并重建。
 *          递增点在 net_stack_bring_up() 末尾（PHY/链路就绪后），避免服务在网络
 *          尚未可用时抢先重建、也避免 uiTask 阻塞在消息队列上。
 */
uint32_t net_get_generation(void);

/*
 * 函数功能：递增网络代次号（网络重建完成、对外可用时调用）
 * 入口参数：无
 * 返回值：无
 * 限定条件：net_init() 成功且 PHY/链路就绪后调用（当前仅 net_stack_bring_up）
 * 函数说明：见 net_get_generation()
 */
void net_generation_inc(void);

/*
 * 函数功能：轮询所有 Socket 状态（必须在主循环中调用）
 * 返回值：有事件发生的 socket 数量
 * 限定条件：net_init() 已调用
 * 函数说明：此函数处理所有 Socket 的中断事件，更新状态，
 *          并触发事件回调。在非阻塞模式下必须定期调用。
 */
int net_poll(void);

/*
 * 核心 Socket API
 */

/*
 * 函数功能：创建 socket
 * 入口参数：domain   - 地址族，仅支持 AF_INET
 *          type     - SOCK_STREAM(TCP) 或 SOCK_DGRAM(UDP)
 * 返回值：socket 描述符 (0~7)，失败返回 -1
 * 限定条件：net_init() 已调用
 * 函数说明：自动分配空闲 Socket 控制块
 */
int net_socket(int domain, int type);

/*
 * 函数功能：绑定本地地址和端口
 * 入口参数：sockfd   - socket 描述符
 *          addr     - 本地地址结构体指针
 *          addrlen  - 地址结构体长度
 * 返回值：0 成功，-1 失败
 * 限定条件：socket 已创建且未绑定
 * 函数说明：设置 CH395F 源端口
 */
int net_bind(int sockfd, const struct net_sockaddr *addr, int addrlen);

/*
 * 函数功能：TCP Server 监听
 * 入口参数：sockfd   - socket 描述符
 * 返回值：0 成功，-1 失败
 * 限定条件：socket 已绑定
 * 函数说明：内部调用 ch395f_tcp_listen，监听 Socket 自身即为数据通道
 */
int net_listen(int sockfd);

/*
 * 函数功能：TCP Server 接受连接
 * 入口参数：sockfd   - 监听 socket 描述符
 *          addr     - 输出：客户端地址
 *          addrlen  - 输入输出：地址长度
 * 返回值：新 socket 描述符，失败返回 -1
 * 限定条件：socket 正在监听
 * 函数说明：在非阻塞模式下，如果没有新连接，返回 -1 并设置
 *          net_errno 为 NET_ERR_WOULDBLOCK
 */
int net_accept(int sockfd, struct net_sockaddr *addr, int *addrlen);

/* N34 阶段1（F-NET-4）：net_can_accept 已退役——只认 ESTABLISHED 的旧门控会把
 * "监听器在服役、本轮待 CONNECT"窗口全挡掉（丢 CONNECT 探针因此从不运行）；
 * 监听 accept 门控统一用 net_listener_armed()，recv 门控 net_can_read() 保留。 */

/*
 * 函数功能：查询监听 Socket 是否处于"应该尝试 accept"的就绪态（**纯 RAM 读，不发起 RPC**）
 * 入口参数：sockfd   - 监听 Socket 描述符                                      int
 * 出口参数：无
 * 返回值：1 - 就绪（ESTABLISHED 待 accept / LISTENING / CLOSED+auto_relisten
 *              +残留数据）；0 - 不就绪                                     int
 * 限定条件：net_init() 已调用；任意任务上下文
 * 函数说明：1. N-32（P1 不变量 II，N34 阶段1 补齐 ESTABLISHED 放行）：取代已退役的
 *              `net_can_accept()`（只认 ESTABLISHED）作为监听 accept 门控——原门控使
 *              :7003 永不进 `net_accept()`，
 *              `net_lost_connect_probe`（丢 CONNECT 中断补 accept，N-30 实证的
 *              "数据被吞/425"主根因修复）对该端口等于从未运行
 *           2. 放行 LISTENING：探针与 "closed-but-readable 接受" 都发生在
 *              `net_accept_locked` **内部**，门控挡在外面就永远到不了
 *           2b. 放行 ESTABLISHED（N34 阶段1 台架修正）：单连接模型下 CONNECT 处理
 *              （net_poll 分派 / 探针补 accept / 对账② standalone accept）把监听 fd
 *              转 ESTABLISHED，这正是"待 accept"电平——漏放行则任务周期慢的消费者
 *              （i104 200ms 抢不过对账② ~400ms 去抖）永不 accept、会话整场饿死
 *              （2026-10-13 实测全 18 项 FAIL）。此态 accept 必返 fd，无风暴风险
 *           3. 放行 CLOSED+auto_relisten **且 readable≠0**（有残留数据）：
 *              保住 N-30 的 "closed-but-readable" 接受；**无残留时必须返回 0**，
 *              否则调用方会在整个 CLOSED 窗口内每轮发起 `net_accept`（RPC 无上界）
 *              → 队列积压 → 喂不上狗（2026-10-12 P2a 台架实测 48 条 task stall）。
 *              重建由 `net_listener_pump` 负责，调用方无需催促
 *           4. 与已退役 `net_can_accept` 的关系：本函数 = 其 ESTABLISHED 放行态
 *              ∪ LISTENING ∪ CLOSED+残留；回答"这个监听器这一轮**值不值得**发起
 *              一次 accept"，而非"一定有连接"
 *           5. 跨任务读单字，同 `net_can_read` 的最坏情形论证
 */
int net_listener_armed(int sockfd);

/*
 * 函数功能：查询 Socket 是否"值得发一次 recv"（**纯 RAM 读，不发起 RPC**）
 * 入口参数：sockfd   - Socket 描述符                                          int
 * 出口参数：无
 * 返回值：1 - 应发 recv（有数据可读，或连接已非 ESTABLISHED 需了结）；0 - 不必发  int
 * 限定条件：net_init() 已调用；任意任务上下文
 * 函数说明：1. ESTABLISHED → 看 readable（net_poll 在 RECV_OK 置位、读空清零）
 *           2. **非 ESTABLISHED 一律返回 1**：连接已消失时必须让上层真的 recv 一次
 *              拿到 EOF/错误并自行复位；若把它门掉，"连接已不存在"会被永久藏住
 *              （推流侧 g_client 永不复位 → 再也不接受新客户端）
 *           3. 描述符失效（net_get_sock 返回 NULL）同样返回 1 → 让 recv 报 BADF，
 *              走调用方既有的错误分支重建，而不是静默卡死
 *           4. ⚠ **不可作为唯一判据**：readable 只由 RECV_OK 中断置位，而
 *              net_reconcile_tick 的三类对账**不含**"芯片 RX 非空但 readable=0"
 *              → 中断丢失时本函数会恒返 0。调用方须保留**低频兜底 recv**
 *              （ui_net_sink 每 32 轮无条件收一次，最坏延迟 ≈320 ms）
 */
int net_can_read(int sockfd);

/*
 * 函数功能：TCP Client 发起连接
 * 入口参数：sockfd   - socket 描述符
 *          addr     - 服务器地址
 *          addrlen  - 地址长度
 * 返回值：0 成功，-1 失败
 * 限定条件：socket 已创建
 * 函数说明：连接过程是异步的，需要调用 net_poll() 等待连接完成，
 *          或使用 select() 等待可写事件
 */
int net_connect(int sockfd, const struct net_sockaddr *addr, int addrlen);

/*
 * 函数功能：发送数据（TCP）
 * 入口参数：sockfd  - socket 描述符
 *          buf     - 数据缓冲区
 *          len     - 数据长度
 *          flags   - 通常为 0
 * 返回值：实际发送字节数，失败返回 -1
 * 限定条件：TCP 连接已建立，指针非空
 * 函数说明：阻塞等待发送缓冲区空闲，拷贝数据后触发发送
 */
int net_send(int sockfd, const void *buf, int len, int flags);

/*
 * 函数功能：接收数据（TCP）
 * 入口参数：sockfd  - socket 描述符
 *          buf     - 接收缓冲区
 *          len     - 缓冲区大小
 *          flags   - 通常为 0，可设置 NET_MSG_DONTWAIT 非阻塞
 * 返回值：实际接收字节数，0=对端关闭，-1=错误
 * 限定条件：TCP 连接已建立
 * 函数说明：在阻塞模式下，如果没有数据，函数会等待；
 *          在非阻塞模式下，如果没有数据，返回 -1 并设置
 *          net_errno 为 NET_ERR_WOULDBLOCK
 */
int net_recv(int sockfd, void *buf, int len, int flags);

/*
 * 函数功能：接收数据（**带调用方指定超时**的阻塞版，用于分片有界读）
 * 入口参数：sockfd     - Socket 描述符
 *           buf/len    - 接收缓冲与容量
 *           timeout_ms - 单次调用在 netTask 内的最长等待（毫秒，>0）
 * 返回值：>0 实际字节数；0 = 对端关闭(EOF)；-1 = 真错误（errno 可查）；**-2 = 超时无数据**
 * 限定条件：非 netTask 上下文；Socket 已连接
 * 函数说明：为"不能长时间占用 netTask"的调用方（如 lftpd 控制行/数据读）提供
 *          **分片**阻塞：每次调用最多占用 netTask timeout_ms，返回 -2 表示这段
 *          时间内无数据，调用方自行累计总预算并决定是否继续（E-02 头阻塞修复）。
 *          超时用独立返回码而非 errno → 无跨任务 errno 竞态。
 */
int net_recv_to(int sockfd, void *buf, int len, uint32_t timeout_ms);

/*
 * 函数功能：发送 UDP 数据
 * 入口参数：sockfd    - socket 描述符
 *          buf       - 数据缓冲区
 *          len       - 数据长度
 *          flags     - 通常为 0
 *          dest_addr - 目标地址
 *          addrlen   - 地址长度
 * 返回值：实际发送字节数，失败返回 -1
 * 限定条件：socket 已创建，指针非空
 * 函数说明：设置目标地址后调用 CH395F 发送
 */
int net_sendto(int sockfd, const void *buf, int len, int flags,
               const struct net_sockaddr *dest_addr, int addrlen);

/*
 * 函数功能：接收 UDP 数据
 * 入口参数：sockfd   - socket 描述符
 *          buf      - 接收缓冲区
 *          len      - 缓冲区大小
 *          flags    - 通常为 0
 *          src_addr - 输出：发送方地址
 *          addrlen  - 输入输出：地址长度
 * 返回值：实际接收字节数，失败返回 -1
 * 限定条件：socket 已创建，指针非空
 * 函数说明：读取 CH395F 接收缓冲区，获取对端地址
 */
int net_recvfrom(int sockfd, void *buf, int len, int flags,
                 struct net_sockaddr *src_addr, int *addrlen);

/*
 * 函数功能：关闭 socket
 * 入口参数：sockfd - socket 描述符
 * 返回值：0 成功，-1 失败
 * 限定条件：socket 已打开
 * 函数说明：释放 Socket 控制块，TCP 先断开连接
 */
int net_close(int sockfd);

/*
 * 事件回调 API
 */

/*
 * 函数功能：注册事件回调
 * 入口参数：sockfd - socket 描述符
 *          cb     - 回调函数
 *          arg    - 用户参数
 * 返回值：0 成功，-1 失败
 * 限定条件：socket 已创建
 * 函数说明：回调在 net_poll 上下文中触发
 */
int net_set_event_cb(int sockfd, net_event_cb_t cb, void *arg);

/*
 * 辅助函数
 */

/*
 * 函数功能：获取 **本任务** 最后一次 net_*() 调用失败时的精确错误码
 * 入口参数：无
 * 出口参数：无
 * 返回值：错误码（NET_ERR_xxx）；本任务尚无失败记录时为 NET_OK(0)
 * 限定条件：无（任何上下文可调用，含中断——查询为纯本任务索引读）
 * 函数说明：1. **按任务隔离**（2026-09-25 E-03 修复）：错误码存在每个任务自己的
 *             槽位里，任务间互不干扰，不存在跨任务覆写竞态——旧实现的单一全局
 *             变量会被 netTask/其他任务的 net 调用交错覆盖，调用方可能读到别人的码
 *           2. 语义：本任务最后一次返回 -1 的 net_*() 调用所对应的精确码；
 *             调用成功时**不清零**（与本 API 历史行为一致，保持向后兼容）
 *           3. 任务句柄槽位用尽时回退到共享槽位（仅影响排障，不影响功能）
 *           4. 超时类场景（net_recv_to）请直接用返回码 -2 判定，不要依赖本接口
 */
int net_get_errno(void);

/*
 * 函数功能：查询 socket 当前状态（只读快照，可能滞后于 netTask）
 * 返回值：状态值（net_sock_state_t）；描述符无效/未占用 → -1
 */
int net_sock_state(int sockfd);

/* N34 阶段1（F-NET-3）：net_resync_listen / net_relisten 声明已删——
 * 静默回收形态由对账⑤自动认领（≤400ms 去抖 + 1s 冷却，纪律"不发芯片命令"
 * 原样保留在认领动作内）；监听重建由 pump（100ms 周期）/D10（30ms 重试）
 * 单一所有者。勿再引入"应用层手动自愈"入口。 */

/*
 * 函数功能：将 IP 地址字符串转为网络字节序
 * 入口参数：cp - 点分十进制字符串 "192.168.1.100"
 * 返回值：网络字节序 IP，失败返回 0
 * 限定条件：cp 指针非空
 * 函数说明：不支持域名解析
 */
uint32_t net_inet_addr(const char *cp);

/*
 * 函数功能：将网络字节序 IP 转为字符串
 * 入口参数：addr - 网络字节序 IP
 *          buf  - 输出缓冲区（至少 16 字节）
 * 返回值：buf 指针
 * 限定条件：buf 指针非空
 */
char *net_inet_ntoa(uint32_t addr, char *buf);

/*
 * 函数功能：端口字节序转换（主机序 -> 网络序）
 * 入口参数：hostshort - 主机序端口
 * 返回值：网络序端口
 * 限定条件：无
 * 函数说明：小端 → 大端
 */
uint16_t net_htons(uint16_t hostshort);

/*
 * 函数功能：端口字节序转换（网络序 -> 主机序）
 * 入口参数：netshort - 网络序端口
 * 返回值：主机序端口
 * 限定条件：无
 * 函数说明：大端 → 小端
 */
uint16_t net_ntohs(uint16_t netshort);

/*
 * 函数功能：IP 地址字节序转换（主机序 -> 网络序）
 * 入口参数：hostlong - 主机序 IP
 * 返回值：网络序 IP
 * 限定条件：无
 * 函数说明：小端 → 大端
 */
uint32_t net_htonl(uint32_t hostlong);

/*
 * 函数功能：IP 地址字节序转换（网络序 -> 主机序）
 * 入口参数：netlong - 网络序 IP
 * 返回值：主机序 IP
 * 限定条件：无
 * 函数说明：大端 → 小端
 */
uint32_t net_ntohl(uint32_t netlong);

#ifndef NET_NO_OS
/*
 * 函数功能：处理消息队列中的请求（必须在 netTask 主循环中调用）
 * 限定条件：net_init() 已调用
 * 函数说明：处理其他任务通过 net_send/net_recv 等接口发送的请求，
 *          在 netTask 上下文中串行化执行所有 CH395F 操作
 */
void net_process_messages(void);
#endif /* NET_NO_OS */

/*
 * 函数功能：获取 Socket 控制块指针（内部使用）
 * 入口参数：sockfd - socket 描述符
 * 返回值：Socket 控制块指针，失败返回 NULL
 */
net_sock_t *net_get_sock(int sockfd);

/*
 * 函数功能：记录**本任务**最后一次失败的精确错误码（net 层内部通用工具）
 * 入口参数：err - 错误码（NET_ERR_xxx，负值）
 * 出口参数：无
 * 返回值：err 原值（便于写成 `return net_set_errno(NET_ERR_XXX);`）
 * 限定条件：无
 * 函数说明：1. 只写本任务的槽位，其他任务读不到、也改不了 → 消除跨任务覆写竞态
 *           2. N-32 §10 模块化：由 net_socket.c 的 static 提升为**模块间可见**，
 *              供 net_listener.c 等同目录内部模块复用（定义仍在 net_socket.c）
 */
int net_set_errno(int err);

/* 「记本任务错误码 + 统一失败返回 -1」的紧凑写法（取代 `s_net_errno = X; return -1;`）
 * N-32 §10：原定义在 net_socket.c，随 net_set_errno 一并提升到本头文件 */
#define NET_ERR_RETURN_1(err)   (net_set_errno(err), -1)

/*
 * 函数功能：查询本 fd 是否有在途挂起 recv（L3 pending）—— 供 net_listener.c 消费
 * 入口参数：sockfd - Socket 描述符 (0~7)                                int
 * 出口参数：无
 * 返回值：1 - 有挂起；0 - 无（含描述符越界）                            int
 * 限定条件：任意上下文（纯 RAM 读，不发起 RPC）
 * 函数说明：1. N-32 §10 模块化：net_listener_retry_tick 用它跳过"重开 Socket
 *              会摧毁在途连接"的 fd（L3 保险，原为直接读 s_net_pending[i].active）
 *           2. 定义在 net_socket.c（配对头即本文件）
 */
int net_pending_active(int sockfd);

/*
 * 函数功能：获取 Socket 本地地址（IP + Port）
 * 入口参数：sockfd  - socket 描述符
 *          addr    - 输出：本地地址
 *          addrlen - 输入输出：地址结构体长度
 * 返回值：0 成功，-1 失败
 * 限定条件：socket 已创建或已绑定
 */
int net_getsockname(int sockfd, struct net_sockaddr *addr, int *addrlen);

#ifndef NET_NO_OS
/*
 * 内部 API（需在 netTask 上下文中调用，绕过消息队列）
 */

/*
 * 函数功能：发送数据（内部版本，直接操作，不经过消息队列）
 * 入口参数：p_sock - Socket 控制块指针
 *          buf    - 数据缓冲区
 *          len    - 数据长度
 * 返回值：实际发送字节数，失败返回 -1
 * 限定条件：必须在 netTask 上下文中调用
 */
int net_send_sock(net_sock_t *p_sock, const void *buf, int len);

/*
 * 函数功能：接收数据（内部版本，直接操作，不经过消息队列）
 * 入口参数：p_sock - Socket 控制块指针
 *          buf    - 接收缓冲区
 *          len    - 缓冲区大小
 *          flags  - 通常为 0，可设置 NET_MSG_DONTWAIT
 * 返回值：实际接收字节数，0=对端关闭，-1=错误
 * 限定条件：必须在 netTask 上下文中调用
 */
int net_recv_sock(net_sock_t *p_sock, void *buf, int len, int flags);

/*
 * 函数功能：关闭 socket（内部版本，直接操作，不经过消息队列）
 * 入口参数：p_sock - Socket 控制块指针
 * 返回值：0 成功，-1 失败
 * 限定条件：必须在 netTask 上下文中调用
 */
int net_close_sock(net_sock_t *p_sock);

/*
 * 函数功能：启动 TCP Server 监听（内部版本，直接操作，不经过消息队列）
 * 入口参数：sockfd  - Socket 描述符
 * 返回值：0 成功，-1 失败
 * 限定条件：必须在 netTask 上下文中调用
 */
int net_listen_locked(int sockfd);
#endif /* NET_NO_OS */

#ifdef __cplusplus
}
#endif

#endif /* NET_SOCKET_H */