net.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_NET_H
#define OVE_NET_H
 
#include "ove/types.h"
#include "ove_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ── Types (always visible) ──────────────────────────────────────── */
 
#ifdef __ZIG_CIMPORT__ /* @cond ZIG_ABI */
/* Zig @cImport uses clang which does not default to -fshort-enums on ARM.
 * Use fixed-width types so the struct layout matches the ARM EABI ABI. */
typedef uint8_t ove_sock_type_t;
#define OVE_SOCK_STREAM ((ove_sock_type_t)1)
#define OVE_SOCK_DGRAM ((ove_sock_type_t)2)
typedef uint8_t ove_af_t;
#define OVE_AF_INET ((ove_af_t)2)
#define OVE_AF_INET6 ((ove_af_t)10)
#else /* @endcond */
typedef enum {
    OVE_SOCK_STREAM = 1, 
    OVE_SOCK_DGRAM = 2,  
} ove_sock_type_t;
 
typedef enum {
    OVE_AF_INET = 2,   
    OVE_AF_INET6 = 10, 
} ove_af_t;
#endif
 
typedef struct {
    ove_af_t family;  
    uint16_t port;    
    uint8_t addr[16]; 
} ove_sockaddr_t;
 
typedef struct {
    int use_dhcp;         
    ove_sockaddr_t static_ip; 
    ove_sockaddr_t gateway;   
    ove_sockaddr_t netmask;   
    ove_sockaddr_t dns;   
} ove_netif_config_t;
 
#include "ove/storage.h"
 
#ifdef CONFIG_OVE_NET
 
/* ── Network interface ───────────────────────────────────────────── */
 
int ove_netif_init(ove_netif_t *netif, ove_netif_storage_t *storage);
 
void ove_netif_deinit(ove_netif_t netif);
 
int ove_netif_up(ove_netif_t netif, const ove_netif_config_t *cfg);
 
void ove_netif_down(ove_netif_t netif);
 
int ove_netif_get_addr(ove_netif_t netif, ove_sockaddr_t *ip, ove_sockaddr_t *gateway,
               ove_sockaddr_t *netmask);
 
#ifdef OVE_HEAP_NET
int ove_netif_create(ove_netif_t *netif);
 
void ove_netif_destroy(ove_netif_t netif);
#endif /* OVE_HEAP_NET */
 
/* ── Sockets ─────────────────────────────────────────────────────── */
 
int ove_socket_open(ove_socket_t *sock, ove_socket_storage_t *storage, ove_af_t af,
            ove_sock_type_t type);
 
void ove_socket_close(ove_socket_t sock);
 
int ove_socket_connect(ove_socket_t sock, const ove_sockaddr_t *addr, uint64_t timeout_ns);
 
int ove_socket_bind(ove_socket_t sock, const ove_sockaddr_t *addr);
 
int ove_socket_listen(ove_socket_t sock, int backlog);
 
int ove_socket_accept(ove_socket_t sock, ove_socket_t *client, ove_socket_storage_t *client_storage,
              uint64_t timeout_ns);
 
int ove_socket_send(ove_socket_t sock, const void *data, size_t len, size_t *sent);
 
int ove_socket_recv(ove_socket_t sock, void *buf, size_t len, size_t *received,
            uint64_t timeout_ns);
 
int ove_socket_sendto(ove_socket_t sock, const void *data, size_t len, size_t *sent,
              const ove_sockaddr_t *dest);
 
int ove_socket_recvfrom(ove_socket_t sock, void *buf, size_t len, size_t *received,
            ove_sockaddr_t *src, uint64_t timeout_ns);
 
#ifdef OVE_HEAP_NET
int ove_socket_create(ove_socket_t *sock, ove_af_t af, ove_sock_type_t type);
 
void ove_socket_destroy(ove_socket_t sock);
#endif /* OVE_HEAP_NET */
 
/* ── DNS ─────────────────────────────────────────────────────────── */
 
int ove_dns_resolve(const char *hostname, ove_sockaddr_t *addr, uint64_t timeout_ns);
 
/* ── Helpers ─────────────────────────────────────────────────────── */
 
void ove_sockaddr_ipv4(ove_sockaddr_t *addr, uint8_t a, uint8_t b, uint8_t c, uint8_t d,
               uint16_t port);
 
#else /* !CONFIG_OVE_NET */
 
/* Provide dummy storage types so the disabled inline stubs compile. */
#ifndef CONFIG_OVE_NET
typedef struct {
    uint8_t _unused;
} ove_socket_storage_t;
typedef struct {
    uint8_t _unused;
} ove_netif_storage_t;
#endif
 
static inline int ove_netif_init(ove_netif_t *netif, ove_netif_storage_t *storage)
{
    (void)netif;
    (void)storage;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_netif_deinit(ove_netif_t netif)
{
    (void)netif;
}
static inline int ove_netif_up(ove_netif_t netif, const ove_netif_config_t *cfg)
{
    (void)netif;
    (void)cfg;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_netif_down(ove_netif_t netif)
{
    (void)netif;
}
static inline int ove_netif_get_addr(ove_netif_t netif, ove_sockaddr_t *ip, ove_sockaddr_t *gw,
                     ove_sockaddr_t *nm)
{
    (void)netif;
    (void)ip;
    (void)gw;
    (void)nm;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_open(ove_socket_t *sock, ove_socket_storage_t *storage, ove_af_t af,
                  ove_sock_type_t type)
{
    (void)sock;
    (void)storage;
    (void)af;
    (void)type;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_socket_close(ove_socket_t sock)
{
    (void)sock;
}
static inline int ove_socket_connect(ove_socket_t sock, const ove_sockaddr_t *addr,
                     uint64_t timeout_ns)
{
    (void)sock;
    (void)addr;
    (void)timeout_ns;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_bind(ove_socket_t sock, const ove_sockaddr_t *addr)
{
    (void)sock;
    (void)addr;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_listen(ove_socket_t sock, int backlog)
{
    (void)sock;
    (void)backlog;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_accept(ove_socket_t sock, ove_socket_t *client,
                    ove_socket_storage_t *client_storage, uint64_t timeout_ns)
{
    (void)sock;
    (void)client;
    (void)client_storage;
    (void)timeout_ns;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_send(ove_socket_t sock, const void *data, size_t len, size_t *sent)
{
    (void)sock;
    (void)data;
    (void)len;
    (void)sent;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_recv(ove_socket_t sock, void *buf, size_t len, size_t *received,
                  uint64_t timeout_ns)
{
    (void)sock;
    (void)buf;
    (void)len;
    (void)received;
    (void)timeout_ns;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_sendto(ove_socket_t sock, const void *data, size_t len, size_t *sent,
                    const ove_sockaddr_t *dest)
{
    (void)sock;
    (void)data;
    (void)len;
    (void)sent;
    (void)dest;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_socket_recvfrom(ove_socket_t sock, void *buf, size_t len, size_t *received,
                      ove_sockaddr_t *src, uint64_t timeout_ns)
{
    (void)sock;
    (void)buf;
    (void)len;
    (void)received;
    (void)src;
    (void)timeout_ns;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_dns_resolve(const char *hostname, ove_sockaddr_t *addr, uint64_t timeout_ns)
{
    (void)hostname;
    (void)addr;
    (void)timeout_ns;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_sockaddr_ipv4(ove_sockaddr_t *addr, uint8_t a, uint8_t b, uint8_t c,
                     uint8_t d, uint16_t port)
{
    (void)addr;
    (void)a;
    (void)b;
    (void)c;
    (void)d;
    (void)port;
}
#endif /* CONFIG_OVE_NET */
 
#ifdef __cplusplus
}
#endif
 
#endif /* OVE_NET_H */