mmipal.h

/*
 * Copyright 2023 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#ifndef MMIPAL_IPADDR_STR_MAXLEN
#define MMIPAL_IPADDR_STR_MAXLEN (48)
#endif
 
#ifndef MMIPAL_MAX_IPV6_ADDRESSES
#define MMIPAL_MAX_IPV6_ADDRESSES (3)
#endif
 
#ifndef MMIPAL_MACADDR_LEN
#define MMIPAL_MACADDR_LEN (6)
#endif
 
enum mmipal_status
{
    MMIPAL_SUCCESS,
    MMIPAL_INVALID_ARGUMENT,
    MMIPAL_NO_LINK,
    MMIPAL_NO_MEM,
    MMIPAL_NOT_SUPPORTED,
};
 
enum mmipal_link_state
{
    MMIPAL_LINK_DOWN,
    MMIPAL_LINK_UP,
};
 
enum mmipal_addr_mode
{
    MMIPAL_DISABLED,
    MMIPAL_STATIC,
    MMIPAL_DHCP,
    MMIPAL_AUTOIP,
    MMIPAL_DHCP_OFFLOAD,
};
 
typedef char mmipal_ip_addr_t[MMIPAL_IPADDR_STR_MAXLEN];
 
typedef uint8_t mmipal_mac_addr_t[MMIPAL_MACADDR_LEN];
 
struct mmipal_ip_config
{
    enum mmipal_addr_mode mode;
    mmipal_ip_addr_t ip_addr;
    mmipal_ip_addr_t netmask;
    mmipal_ip_addr_t gateway_addr;
};
 
#define MMIPAL_IP_CONFIG_DEFAULT \
    {                            \
        MMIPAL_DHCP,             \
        "",                      \
        "",                      \
        "",                      \
    }
 
enum mmipal_ip6_addr_mode
{
    MMIPAL_IP6_DISABLED,
    MMIPAL_IP6_STATIC,
    MMIPAL_IP6_AUTOCONFIG,
    MMIPAL_IP6_DHCP6_STATELESS,
};
 
struct mmipal_ip6_config
{
    enum mmipal_ip6_addr_mode ip6_mode;
    mmipal_ip_addr_t ip6_addr[MMIPAL_MAX_IPV6_ADDRESSES];
};
 
#define MMIPAL_IP6_CONFIG_DEFAULT { MMIPAL_IP6_AUTOCONFIG }
 
struct mmipal_arp_config
{
    mmipal_ip_addr_t ip_addr;
    mmipal_mac_addr_t mac_addr;
};
 
struct mmipal_init_args
{
    enum mmipal_addr_mode mode;
    mmipal_ip_addr_t ip_addr;
    mmipal_ip_addr_t netmask;
    mmipal_ip_addr_t gateway_addr;
 
    enum mmipal_ip6_addr_mode ip6_mode;
    mmipal_ip_addr_t ip6_addr;
    bool offload_arp_response;
    uint32_t offload_arp_refresh_s;
};
 
#define MMIPAL_INIT_ARGS_DEFAULT \
    { MMIPAL_DHCP, { 0 }, { 0 }, { 0 }, MMIPAL_IP6_DISABLED, { 0 }, false, 0 }
 
enum mmipal_status mmipal_init(const struct mmipal_init_args *args);
 
struct mmipal_link_status
{
    enum mmipal_link_state link_state;
    mmipal_ip_addr_t ip_addr;
    mmipal_ip_addr_t netmask;
    mmipal_ip_addr_t gateway;
};
 
typedef void (*mmipal_link_status_cb_fn_t)(const struct mmipal_link_status *link_status);
 
void mmipal_set_link_status_callback(mmipal_link_status_cb_fn_t fn);
 
typedef void (*mmipal_ext_link_status_cb_fn_t)(const struct mmipal_link_status *link_status,
                                               void *arg);
 
void mmipal_set_ext_link_status_callback(mmipal_ext_link_status_cb_fn_t fn, void *arg);
 
void mmipal_get_link_packet_counts(uint32_t *tx_packets, uint32_t *rx_packets);
 
void mmipal_set_tx_qos_tid(uint8_t tid);
 
enum mmipal_status mmipal_get_local_addr(mmipal_ip_addr_t local_addr,
                                         const mmipal_ip_addr_t dest_addr);
 
enum mmipal_status mmipal_get_ip_config(struct mmipal_ip_config *config);
 
enum mmipal_status mmipal_set_ip_config(const struct mmipal_ip_config *config);
 
enum mmipal_status mmipal_get_ip_broadcast_addr(mmipal_ip_addr_t broadcast_addr);
 
enum mmipal_status mmipal_get_ip6_config(struct mmipal_ip6_config *config);
 
enum mmipal_status mmipal_set_ip6_config(const struct mmipal_ip6_config *config);
 
enum mmipal_status mmipal_add_static_arp_entry(const struct mmipal_arp_config *config);
 
enum mmipal_status mmipal_remove_static_arp_entry(const struct mmipal_arp_config *config);
 
enum mmipal_link_state mmipal_get_link_state(void);
 
enum mmipal_status mmipal_set_dns_server(uint8_t index, const mmipal_ip_addr_t addr);
 
enum mmipal_status mmipal_get_dns_server(uint8_t index, mmipal_ip_addr_t addr);
 
#ifdef __cplusplus
}
#endif