API rename, docs update, fixes

Author: danielinux

.gitignore

@@ -12,3 +12,4 @@ CMakeTmp
 build/*
 test/unit/unit
 tags
+cppcheck_results.xml

Makefile

@@ -1,14 +1,27 @@
 CC?=gcc
-CFLAGS:=-Wall -Werror -Wextra -I.
+CFLAGS:=-Wall -Werror -Wextra -I. -D_GNU_SOURCE
 CFLAGS+=-g -ggdb
 LDFLAGS+=-pthread
 
-OBJ=build/wolftcp.o \
+CPPCHECK=cppcheck
+CPPCHECK_FLAGS=--enable=all --suppress=missingIncludeSystem \
+			   --suppress=unusedFunction --suppress=unusedVariable \
+			   --suppress=missingInclude --suppress=variableScope \
+			   --suppress=constVariable --suppress=constVariablePointer \
+			   --suppress=constParameterPointer \
+			   --suppress=constParameterCallback \
+			   --suppress=toomanyconfigs \
+			   --suppress=unmatchedSuppression --inconclusive \
+			   --std=c99 --language=c \
+			   --platform=unix64 \
+			   --error-exitcode=1 --xml --xml-version=2
+
+OBJ=build/wolfip.o \
 	build/port/posix/linux_tap.o
 
 EXE=build/tcpecho build/tcp_netcat_poll build/tcp_netcat_select \
 	build/test-evloop build/test-dns
-LIB=libwolftcp.so
+LIB=libwolfip.so
 
 PREFIX=/usr/local
 
@@ -24,8 +37,8 @@ static: libtcpip.a
 libtcpip.a: $(OBJ)
 	@ar rcs $@ $^
 
-libwolftcp.so:CFLAGS+=-fPIC
-libwolftcp.so:  build/pie/port/posix/bsd_socket.o build/pie/wolftcp.o \
+libwolfip.so:CFLAGS+=-fPIC
+libwolfip.so:  build/pie/port/posix/bsd_socket.o build/pie/wolfip.o \
 	build/pie/port/posix/linux_tap.o
 	@mkdir -p `dirname $@` || true
 	@echo "[LD] $@"
@@ -65,8 +78,8 @@ build/tcp_netcat_select: $(OBJ) build/port/posix/bsd_socket.o build/test/tcp_net
 	@$(CC) $(CFLAGS) $(LDFLAGS) -o $@ -Wl,--start-group $(^) -Wl,--end-group
 
 
-build/test-wolfssl:CFLAGS+=-Wno-cpp -DWOLFSSL_DEBUG -DWOLFSSL_WOLFTCP
-build/test-httpd:CFLAGS+=-Wno-cpp -DWOLFSSL_DEBUG -DWOLFSSL_WOLFTCP -Isrc/http
+build/test-wolfssl:CFLAGS+=-Wno-cpp -DWOLFSSL_DEBUG -DWOLFSSL_WOLFIP
+build/test-httpd:CFLAGS+=-Wno-cpp -DWOLFSSL_DEBUG -DWOLFSSL_WOLFIP -Isrc/http
 
 
 build/test-wolfssl: $(OBJ) build/test/test_native_wolfssl.o build/port/wolfssl_io.o build/certs/server_key.o build/certs/ca_cert.o build/certs/server_cert.o
@@ -126,7 +139,10 @@ build/test/unit:
 # Install dynamic library to re-link linux applications
 #
 install:
-	install libwolftcp.so $(PREFIX)/lib
+	install libwolfip.so $(PREFIX)/lib
 	ldconfig
 
-.PHONY: clean all static
+.PHONY: clean all static cppcheck
+
+cppcheck:
+	$(CPPCHECK) $(CPPCHECK_FLAGS) src/ 2>cppcheck_results.xml

README.md

@@ -1,13 +1,11 @@
-# wolfTCP
-
-The smallest TCP/IP stack on the planet
+# wolfIP
 
 ## Description and project goals
 
-wolfTCP is a TCP/IP stack with no dynamic memory allocations, designed to be 
+wolfIP is a TCP/IP stack with no dynamic memory allocations, designed to be 
 used in resource-constrained embedded systems.
 
-Endpoint only mode is supported, which means that wolftcp can be used to 
+Endpoint only mode is supported, which means that wolfip can be used to 
 establish network connections but it does not route traffic between different
 network interfaces.
 
@@ -31,6 +29,6 @@ A single network interface can be associated with the device.
 
 ## Copyright and License
 
-wolfTCP is licensed under the GPLv3 license. See the LICENSE file for details.
+wolfIP is licensed under the GPLv3 license. See the LICENSE file for details.
 Copyright (c) 2025 wolfSSL Inc.
 

config.h

@@ -4,15 +4,15 @@
 #define ETHERNET
 #define LINK_MTU 1536
 
-#define MAX_TCPSOCKETS 20
+#define MAX_TCPSOCKETS 4
 #define MAX_UDPSOCKETS 2
 #define RXBUF_SIZE LINK_MTU * 4
-#define TXBUF_SIZE LINK_MTU * 16
+#define TXBUF_SIZE LINK_MTU * 4
 
 #define MAX_NEIGHBORS 16
 
 /* Linux test configuration */
-#define WOLFTCP_IP "10.10.10.2"
+#define WOLFIP_IP "10.10.10.2"
 #define LINUX_IP "10.10.10.1"
 
 #endif

core.md

@@ -1,4 +1,4 @@
-# wolfTCP
+# wolfIP
 
 ## Stack architecture
 
@@ -20,7 +20,7 @@
 
 
 
-### wolfTCP fifo
+### wolfIP fifo
 
 ```
 +---------------------------------------------------------------------------------------------------------------------------+
@@ -42,7 +42,7 @@
 
 
 
-### wolfTCP queue
+### wolfIP queue
 
 ```
  +--------------+--------------------------------------------+---------------------------------------------------------------+

docs/API.md

@@ -0,0 +1,238 @@
+# wolfIP API Documentation
+
+## Overview
+
+wolfIP is a minimal TCP/IP stack designed for resource-constrained embedded systems. It features zero dynamic memory allocation, using pre-allocated buffers and a fixed number of concurrent sockets.
+
+## Key Features
+
+- No dynamic memory allocation
+- Fixed number of concurrent sockets
+- Pre-allocated buffers for packet processing
+- BSD-like non-blocking socket API with callbacks
+- Protocol Support:
+  - ARP (RFC 826)
+  - IPv4 (RFC 791)
+  - ICMP (RFC 792) - ping replies only
+  - DHCP (RFC 2131) - client only
+  - DNS (RFC 1035) - client only
+  - UDP (RFC 768) - unicast only
+  - TCP (RFC 793) with options (Timestamps, MSS)
+
+## Core Data Structures
+
+### Device Driver Interface
+```c
+struct ll {
+    uint8_t mac[6];          // Device MAC address
+    char ifname[16];         // Interface name
+    int (*poll)(struct ll *ll, void *buf, uint32_t len);  // Receive function
+    int (*send)(struct ll *ll, void *buf, uint32_t len);  // Transmit function
+};
+```
+
+### IP Configuration
+```c
+struct ipconf {
+    struct ll *ll;           // Link layer device
+    ip4 ip;                  // IPv4 address
+    ip4 mask;                // Subnet mask
+    ip4 gw;                  // Default gateway
+};
+```
+
+### Socket Address Structures
+```c
+struct wolfIP_sockaddr_in {
+    uint16_t sin_family;     // Address family (AF_INET)
+    uint16_t sin_port;       // Port number
+    struct sin_addr {
+        uint32_t s_addr;     // IPv4 address
+    } sin_addr;
+};
+
+struct wolfIP_sockaddr {
+    uint16_t sa_family;      // Address family
+};
+```
+
+## Socket Interface Functions
+
+### Socket Creation and Control
+```c
+int wolfIP_sock_socket(struct wolfIP *s, int domain, int type, int protocol);
+```
+Creates a new socket.
+- Parameters:
+  - s: wolfIP instance
+  - domain: Address family (AF_INET)
+  - type: Socket type (SOCK_STREAM/SOCK_DGRAM)
+  - protocol: Protocol (usually 0)
+- Returns: Socket descriptor or negative error code
+
+```c
+int wolfIP_sock_bind(struct wolfIP *s, int sockfd, const struct wolfIP_sockaddr *addr, socklen_t addrlen);
+```
+Binds a socket to a local address.
+- Parameters:
+  - s: wolfIP instance
+  - sockfd: Socket descriptor
+  - addr: Local address to bind to
+  - addrlen: Length of address structure
+- Returns: 0 on success, negative error code on failure
+
+```c
+int wolfIP_sock_listen(struct wolfIP *s, int sockfd, int backlog);
+```
+Marks a socket as passive (listening for connections).
+- Parameters:
+  - s: wolfIP instance
+  - sockfd: Socket descriptor
+  - backlog: Maximum length of pending connections queue
+- Returns: 0 on success, negative error code on failure
+
+### Connection Management
+```c
+int wolfIP_sock_connect(struct wolfIP *s, int sockfd, const struct wolfIP_sockaddr *addr, socklen_t addrlen);
+```
+Initiates a connection on a socket.
+- Parameters:
+  - s: wolfIP instance
+  - sockfd: Socket descriptor
+  - addr: Address to connect to
+  - addrlen: Length of address structure
+- Returns: 0 on success, negative error code on failure
+
+```c
+int wolfIP_sock_accept(struct wolfIP *s, int sockfd, struct wolfIP_sockaddr *addr, socklen_t *addrlen);
+```
+Accepts a connection on a listening socket.
+- Parameters:
+  - s: wolfIP instance
+  - sockfd: Listening socket descriptor
+  - addr: Address of connecting peer
+  - addrlen: Length of address structure
+- Returns: New socket descriptor or negative error code
+
+### Data Transfer
+```c
+int wolfIP_sock_send(struct wolfIP *s, int sockfd, const void *buf, size_t len, int flags);
+int wolfIP_sock_recv(struct wolfIP *s, int sockfd, void *buf, size_t len, int flags);
+```
+Send/receive data on a connected socket.
+- Parameters:
+  - s: wolfIP instance
+  - sockfd: Socket descriptor
+  - buf: Data buffer
+  - len: Buffer length
+  - flags: Operation flags
+- Returns: Number of bytes transferred or negative error code
+
+```c
+int wolfIP_sock_sendto(struct wolfIP *s, int sockfd, const void *buf, size_t len, int flags, const struct wolfIP_sockaddr *dest_addr, socklen_t addrlen);
+int wolfIP_sock_recvfrom(struct wolfIP *s, int sockfd, void *buf, size_t len, int flags, struct wolfIP_sockaddr *src_addr, socklen_t *addrlen);
+```
+Send/receive data on a datagram socket.
+- Parameters similar to send/recv with additional address parameters
+
+## Stack Interface Functions
+
+```c
+void wolfIP_init(struct wolfIP *s);
+```
+Initializes the TCP/IP stack.
+- Parameters:
+  - s: wolfIP instance to initialize
+
+```c
+void wolfIP_init_static(struct wolfIP **s);
+```
+Initializes a static wolfIP instance.
+- Parameters:
+  - s: Pointer to wolfIP instance pointer
+
+```c
+int wolfIP_poll(struct wolfIP *s, uint64_t now);
+```
+Processes pending network events.
+- Parameters:
+  - s: wolfIP instance
+  - now: Current timestamp
+- Returns: Number of events processed
+
+```c
+void wolfIP_ipconfig_set(struct wolfIP *s, ip4 ip, ip4 mask, ip4 gw);
+void wolfIP_ipconfig_get(struct wolfIP *s, ip4 *ip, ip4 *mask, ip4 *gw);
+```
+Set/get IP configuration.
+- Parameters:
+  - s: wolfIP instance
+  - ip: IPv4 address
+  - mask: Subnet mask
+  - gw: Default gateway
+
+## DHCP Client Functions
+
+```c
+int dhcp_client_init(struct wolfIP *s);
+```
+Initializes DHCP client.
+- Parameters:
+  - s: wolfIP instance
+- Returns: 0 on success, negative error code on failure
+
+```c
+int dhcp_bound(struct wolfIP *s);
+```
+Checks if DHCP client is bound.
+- Parameters:
+  - s: wolfIP instance
+- Returns: 1 if bound, 0 otherwise
+
+## DNS Client Functions
+
+```c
+int nslookup(struct wolfIP *s, const char *name, uint16_t *id, void (*lookup_cb)(uint32_t ip));
+```
+Performs DNS lookup.
+- Parameters:
+  - s: wolfIP instance
+  - name: Hostname to resolve
+  - id: Transaction ID
+  - lookup_cb: Callback function for result
+- Returns: 0 on success, negative error code on failure
+
+## Utility Functions
+
+```c
+uint32_t atou(const char *s);
+```
+Converts ASCII string to unsigned integer.
+
+```c
+ip4 atoip4(const char *ip);
+```
+Converts dotted decimal IP address string to 32-bit integer.
+
+```c
+void iptoa(ip4 ip, char *buf);
+```
+Converts 32-bit IP address to dotted decimal string.
+
+## Event Callback Registration
+
+```c
+void wolfIP_register_callback(struct wolfIP *s, int sock_fd, void (*cb)(int sock_fd, uint16_t events, void *arg), void *arg);
+```
+Registers event callback for a socket.
+- Parameters:
+  - s: wolfIP instance
+  - sock_fd: Socket descriptor
+  - cb: Callback function
+  - arg: User data for callback
+
+Event flags:
+- CB_EVENT_READABLE (0x01): Data available or connection accepted
+- CB_EVENT_TIMEOUT (0x02): Operation timed out
+- CB_EVENT_WRITABLE (0x04): Connected or space available to send
+- CB_EVENT_CLOSED (0x10): Connection closed by peer