network.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_NETWORK_H
#define _ULTIBO_NETWORK_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/devices.h"

#define NETWORK_NAME_PREFIX "Network" 

#define NETWORK_TYPE_NONE   0
#define NETWORK_TYPE_ETHERNET   1
#define NETWORK_TYPE_TOKENRING  2
#define NETWORK_TYPE_80211  3 
 
#define NETWORK_TYPE_MAX    3

#define NETWORK_STATE_CLOSED    0
#define NETWORK_STATE_CLOSING   1
#define NETWORK_STATE_OPENING   2
#define NETWORK_STATE_OPEN  3
 
#define NETWORK_STATE_MAX   3

#define NETWORK_STATUS_DOWN 0
#define NETWORK_STATUS_UP   1
 
#define NETWORK_STATUS_MAX  1

#define NETWORK_FLAG_NONE   0x00000000
#define NETWORK_FLAG_RX_BUFFER  0x00000001 
#define NETWORK_FLAG_TX_BUFFER  0x00000002 
#define NETWORK_FLAG_RX_MULTIPACKET 0x00000004 
#define NETWORK_FLAG_TX_MULTIPACKET 0x00000008 

#define NETWORK_CONTROL_CLEAR_STATS 1 
#define NETWORK_CONTROL_SET_MAC 2 
#define NETWORK_CONTROL_GET_MAC 3 
#define NETWORK_CONTROL_SET_LOOPBACK    4 
#define NETWORK_CONTROL_RESET   5 
#define NETWORK_CONTROL_DISABLE 6 
#define NETWORK_CONTROL_GET_HARDWARE    7 
#define NETWORK_CONTROL_GET_BROADCAST   8 
#define NETWORK_CONTROL_GET_MTU 9 
#define NETWORK_CONTROL_GET_HEADERLEN   10 
#define NETWORK_CONTROL_GET_LINK    11 
#define NETWORK_CONTROL_GET_SPEED   12 
#define NETWORK_CONTROL_GET_DUPLEX  13 
#define NETWORK_CONTROL_RESET_LINK  14 
#define NETWORK_CONTROL_GET_STATS   15 
#define NETWORK_CONTROL_ADD_MULTICAST   16 
#define NETWORK_CONTROL_DEL_MULTICAST   17 
#define NETWORK_CONTROL_GET_MULTICAST   18 

#define NETWORK_LINK_DOWN   NETWORK_STATUS_DOWN
#define NETWORK_LINK_UP NETWORK_STATUS_UP

#define NETWORK_SPEED_NONE  0
#define NETWORK_SPEED_10    10
#define NETWORK_SPEED_100   100
#define NETWORK_SPEED_1000  1000

#define NETWORK_DUPLEX_NONE 0
#define NETWORK_DUPLEX_HALF 1
#define NETWORK_DUPLEX_FULL 2

#define NETWORK_LOCK_NONE   0
#define NETWORK_LOCK_READ   1
#define NETWORK_LOCK_WRITE  2

#define NETWORK_BUFFER_SIZE 1024

#define NETWORK_EVENT_NONE  0x00000000
#define NETWORK_EVENT_SYSTEM_START  0x00000001 
#define NETWORK_EVENT_SYSTEM_STOP   0x00000002 
#define NETWORK_EVENT_ADAPTERS_START    0x00000004 
#define NETWORK_EVENT_ADAPTERS_STOP 0x00000008 
#define NETWORK_EVENT_TRANSPORTS_START  0x00000010 
#define NETWORK_EVENT_TRANSPORTS_STOP   0x00000020 
#define NETWORK_EVENT_PROTOCOLS_START   0x00000040 
#define NETWORK_EVENT_PROTOCOLS_STOP    0x00000080 

#define NETWORK_EVENT_SIGNATURE 0xBE1D50C2

#define NETWORK_EVENT_STATE_UNREGISTERED    0
#define NETWORK_EVENT_STATE_REGISTERED  1

#define NETWORK_EVENT_FLAG_NONE 0x00000000

#define ADAPTER_TYPE_UNKNOWN    0
#define ADAPTER_TYPE_WIRED  1
#define ADAPTER_TYPE_LOOPBACK   2
#define ADAPTER_TYPE_WIRELESS   3
#define ADAPTER_TYPE_SLIP   4
#define ADAPTER_TYPE_PPP    5

#define ADAPTER_THREAD_NAME "Network Adapter" 
#define ADAPTER_THREAD_PRIORITY THREAD_PRIORITY_HIGHER 

#define ADAPTER_STATE_DISABLED  0
#define ADAPTER_STATE_ENABLED   1

#define ADAPTER_STATUS_DOWN 0
#define ADAPTER_STATUS_UP   1

#define CONFIG_TYPE_AUTO    0
#define CONFIG_TYPE_STATIC  1
#define CONFIG_TYPE_RARP    2
#define CONFIG_TYPE_BOOTP   3
#define CONFIG_TYPE_DHCP    4
#define CONFIG_TYPE_PSEUDO  5
#define CONFIG_TYPE_LOOPBACK    6
#define CONFIG_TYPE_SLIP    7
#define CONFIG_TYPE_PPP 8
 
#define CONFIG_TYPE_UNKNOWN Word(-1)

#define AUTH_TYPE_UNKNOWN   0
#define AUTH_TYPE_EAP   1
#define AUTH_TYPE_RSN   2

#define FRAME_TYPE_UNKNOWN  0
#define FRAME_TYPE_ETHERNET_II  1 
#define FRAME_TYPE_TOKEN_RING   3 
#define FRAME_TYPE_APPLETALK    5 
#define FRAME_TYPE_ETHERNET_8022    11 
#define FRAME_TYPE_ETHERNET_SNAP    98 
#define FRAME_TYPE_ETHERNET_8023    99 
 
#define FRAME_START_ETHERNET_SNAP   0xAAAA
#define FRAME_START_ETHERNET_8023   0xFFFF
 
#define ADAPTER_MODE_NONE   1
#define ADAPTER_MODE_LOCAL  2
#define ADAPTER_MODE_BROADCAST  3 
#define ADAPTER_MODE_LOCAL_MULTI    4 
#define ADAPTER_MODE_BROADCAST_MULTI    5 
#define ADAPTER_MODE_PROMISCUOUS    6 

#define CONFIG_ADAPTER_DISCOVER 0 
#define CONFIG_ADAPTER_REQUEST  1 
#define CONFIG_ADAPTER_RELEASE  2 
#define CONFIG_ADAPTER_RENEW    3 
#define CONFIG_ADAPTER_REBIND   4 
#define CONFIG_ADAPTER_INFORM   5 
#define CONFIG_ADAPTER_REBOOT   6 
 
#define CONFIG_RETRY_TIMEOUT    300000 
#define CONFIG_RENEW_TIMEOUT    60000 
#define CONFIG_REBIND_TIMEOUT   60000 

#define AUTH_COMMAND_ASSOCIATE  0
#define AUTH_COMMAND_DISASSOCIATE   1
#define AUTH_COMMAND_AUTHENTICATE   2
#define AUTH_COMMAND_UNAUTHENTICATE 3

#define MAX_MULTICAST_ADDRESS   8 
 
#define MAX_PHYSICAL_PACKET 2048 

#define HARDWARE_ADDRESS_SIZE   6 

#define MEDIA_TYPE_UNKNOWN  0x0000
 
#define MEDIA_TYPE_ETHERNET 0x0001 
#define MEDIA_TYPE_TOKENRING    0x0006 
#define MEDIA_TYPE_IEEE80211    0x1000
#define MEDIA_TYPE_LOOPBACK 0x1001
#define MEDIA_TYPE_PPP  0x1002
#define MEDIA_TYPE_SLIP 0x1003

#define PACKET_MIN_TYPE 0x0600 
 
#define PACKET_TYPE_IP  0x0800
#define PACKET_TYPE_IP6 0x86DD
#define PACKET_TYPE_ARP 0x0806
#define PACKET_TYPE_RARP    0x8035
#define PACKET_TYPE_8021Q   0x8100 
#define PACKET_TYPE_IPX 0x8137 
 
#define PACKET_TYPE_EAPOL   0x888E 
#define PACKET_TYPE_RSN 0x88C7 
#define PACKET_TYPE_TDLS    0x890D 
 
#define PACKET_TYPE_RAW 0xFFFF 
#define PACKET_TYPE_LLC 0x0001 

#define MII_BMCR    0x00 
#define MII_BMSR    0x01 
#define MII_PHYSID1 0x02 
#define MII_PHYSID2 0x03 
#define MII_ADVERTISE   0x04 
#define MII_LPA 0x05 
#define MII_EXPANSION   0x06 
#define MII_CTRL1000    0x09 
#define MII_STAT1000    0x0a 
#define MII_MMD_CTRL    0x0d 
#define MII_MMD_DATA    0x0e 
#define MII_ESTATUS 0x0f 
#define MII_DCOUNTER    0x12 
#define MII_FCSCOUNTER  0x13 
#define MII_NWAYTEST    0x14 
#define MII_RERRCOUNTER 0x15 
#define MII_SREVISION   0x16 
#define MII_RESV1   0x17 
#define MII_LBRERROR    0x18 
#define MII_PHYADDR 0x19 
#define MII_RESV2   0x1a 
#define MII_TPISTATUS   0x1b 
#define MII_NCONFIG 0x1c 

#define BMCR_RESV   0x003f 
#define BMCR_SPEED1000  0x0040 
#define BMCR_CTST   0x0080 
#define BMCR_FULLDPLX   0x0100 
#define BMCR_ANRESTART  0x0200 
#define BMCR_ISOLATE    0x0400 
#define BMCR_PDOWN  0x0800 
#define BMCR_ANENABLE   0x1000 
#define BMCR_SPEED100   0x2000 
#define BMCR_LOOPBACK   0x4000 
#define BMCR_RESET  0x8000 

#define BMSR_ERCAP  0x0001 
#define BMSR_JCD    0x0002 
#define BMSR_LSTATUS    0x0004 
#define BMSR_ANEGCAPABLE    0x0008 
#define BMSR_RFAULT 0x0010 
#define BMSR_ANEGCOMPLETE   0x0020 
#define BMSR_RESV   0x00c0 
#define BMSR_ESTATEN    0x0100 
#define BMSR_100HALF2   0x0200 
#define BMSR_100FULL2   0x0400 
#define BMSR_10HALF 0x0800 
#define BMSR_10FULL 0x1000 
#define BMSR_100HALF    0x2000 
#define BMSR_100FULL    0x4000 
#define BMSR_100BASE4   0x8000 

#define ADVERTISE_SLCT  0x001f 
#define ADVERTISE_CSMA  0x0001 
#define ADVERTISE_10HALF    0x0020 
#define ADVERTISE_1000XFULL 0x0020 
#define ADVERTISE_10FULL    0x0040 
#define ADVERTISE_1000XHALF 0x0040 
#define ADVERTISE_100HALF   0x0080 
#define ADVERTISE_1000XPAUSE    0x0080 
#define ADVERTISE_100FULL   0x0100 
#define ADVERTISE_1000XPSE_ASYM 0x0100 
#define ADVERTISE_100BASE4  0x0200 
#define ADVERTISE_PAUSE_CAP 0x0400 
#define ADVERTISE_PAUSE_ASYM    0x0800 
#define ADVERTISE_RESV  0x1000 
#define ADVERTISE_RFAULT    0x2000 
#define ADVERTISE_LPACK 0x4000 
#define ADVERTISE_NPAGE 0x8000 
 
#define ADVERTISE_FULL  ADVERTISE_100FULL | ADVERTISE_10FULL | ADVERTISE_CSMA
#define ADVERTISE_ALL   ADVERTISE_10HALF | ADVERTISE_10FULL | ADVERTISE_100HALF | ADVERTISE_100FULL

#define LPA_SLCT    0x001f 
#define LPA_10HALF  0x0020 
#define LPA_1000XFULL   0x0020 
#define LPA_10FULL  0x0040 
#define LPA_1000XHALF   0x0040 
#define LPA_100HALF 0x0080 
#define LPA_1000XPAUSE  0x0080 
#define LPA_100FULL 0x0100 
#define LPA_1000XPAUSE_ASYM 0x0100 
#define LPA_100BASE4    0x0200 
#define LPA_PAUSE_CAP   0x0400 
#define LPA_PAUSE_ASYM  0x0800 
#define LPA_RESV    0x1000 
#define LPA_RFAULT  0x2000 
#define LPA_LPACK   0x4000 
#define LPA_NPAGE   0x8000 
 
#define LPA_DUPLEX  LPA_10FULL | LPA_100FULL
#define LPA_100 LPA_100FULL | LPA_100HALF | LPA_100BASE4

#define EXPANSION_NWAY  0x0001 
#define EXPANSION_LCWP  0x0002 
#define EXPANSION_ENABLENPAGE   0x0004 
#define EXPANSION_NPCAPABLE 0x0008 
#define EXPANSION_MFAULTS   0x0010 
#define EXPANSION_RESV  0xffe0 
 
#define ESTATUS_1000_TFULL  0x2000 
#define ESTATUS_1000_THALF  0x1000 

#define NWAYTEST_RESV1  0x00ff 
#define NWAYTEST_LOOPBACK   0x0100 
#define NWAYTEST_RESV2  0xfe00 

#define ADVERTISE_1000FULL  0x0200 
#define ADVERTISE_1000HALF  0x0100 
#define CTL1000_AS_MASTER   0x0800
#define CTL1000_ENABLE_MASTER   0x1000

#define LPA_1000MSFAIL  0x8000 
#define LPA_1000LOCALRXOK   0x2000 
#define LPA_1000REMRXOK 0x1000 
#define LPA_1000FULL    0x0800 
#define LPA_1000HALF    0x0400 

#define FLOW_CTRL_TX    0x01
#define FLOW_CTRL_RX    0x02

#define MII_MMD_CTRL_DEVAD_MASK 0x1f 
#define MII_MMD_CTRL_ADDR   0x0000 
#define MII_MMD_CTRL_NOINCR 0x4000 
#define MII_MMD_CTRL_INCR_RDWT  0x8000 
#define MII_MMD_CTRL_INCR_ON_WT 0xC000 

#define PHY_LINK_DOWN   0
#define PHY_LINK_UP 1
 
#define PHY_LINK_UNKNOWN    -1

#define PHY_INTERFACE_MODE_NONE 0
#define PHY_INTERFACE_MODE_INTERNAL 1
#define PHY_INTERFACE_MODE_MII  2
#define PHY_INTERFACE_MODE_GMII 3
#define PHY_INTERFACE_MODE_SGMII    4
#define PHY_INTERFACE_MODE_TBI  5
#define PHY_INTERFACE_MODE_REVMII   6
#define PHY_INTERFACE_MODE_RMII 7
#define PHY_INTERFACE_MODE_RGMII    8
#define PHY_INTERFACE_MODE_RGMII_ID 9
#define PHY_INTERFACE_MODE_RGMII_RXID   10
#define PHY_INTERFACE_MODE_RGMII_TXID   11
#define PHY_INTERFACE_MODE_RTBI 12
#define PHY_INTERFACE_MODE_SMII 13
#define PHY_INTERFACE_MODE_XGMII    14
#define PHY_INTERFACE_MODE_MOCA 15
#define PHY_INTERFACE_MODE_QSGMII   16
#define PHY_INTERFACE_MODE_TRGMII   17
#define PHY_INTERFACE_MODE_1000BASEX    18
#define PHY_INTERFACE_MODE_2500BASEX    19
#define PHY_INTERFACE_MODE_RXAUI    20
#define PHY_INTERFACE_MODE_XAUI 21
#define PHY_INTERFACE_MODE_10GKR    22 
#define PHY_INTERFACE_MODE_USXGMII  23

#define PHY_SPEED_10    10
#define PHY_SPEED_100   100
#define PHY_SPEED_1000  1000
 
#define PHY_SPEED_UNKNOWN   -1

#define PHY_DUPLEX_HALF 0
#define PHY_DUPLEX_FULL 1
 
#define PHY_DUPLEX_UNKNOWN  -1

#define SERVICE_SET_UNKNOWN 0
#define SERVICE_SET_BSS 1 
#define SERVICE_SET_ESS 2 
#define SERVICE_SET_IBSS    3 
#define SERVICE_SET_MBSS    4 

#define ETHERNET_ADDRESS_SIZE   6 
#define ETHERNET_HEADER_SIZE    14 
#define ETHERNET_VLAN_SIZE  4 
#define ETHERNET_CRC_SIZE   4 

#define ETHERNET_MTU    1500
#define ETHERNET_MIN_PAYLOAD    46
#define ETHERNET_MIN_PACKET_SIZE    ETHERNET_HEADER_SIZE + ETHERNET_VLAN_SIZE + ETHERNET_MIN_PAYLOAD
#define ETHERNET_MAX_PACKET_SIZE    ETHERNET_HEADER_SIZE + ETHERNET_VLAN_SIZE + ETHERNET_MTU
 
#define ETHERNET_TRANSMIT_BUFFER_SIZE   ETHERNET_MAX_PACKET_SIZE

#define LLC_HEADER_SIZE 3 

#define SNAP_HEADER_SIZE    5 

typedef uint8_t HARDWARE_ADDRESS[HARDWARE_ADDRESS_SIZE];
 
typedef HARDWARE_ADDRESS HARDWARE_ADDRESSES[];
 
typedef HARDWARE_ADDRESS MULTICAST_ADDRESSES[MAX_MULTICAST_ADDRESS];
 
typedef struct _PACKET_FRAGMENT PACKET_FRAGMENT;
struct _PACKET_FRAGMENT
{
    int size;
    void *data;
    PACKET_FRAGMENT *next;
};

typedef struct _ADAPTER_STATISTICS ADAPTER_STATISTICS;
struct _ADAPTER_STATISTICS
{
    uint64_t packetsin;
    uint64_t packetsout;
    uint64_t bytesin;
    uint64_t bytesout;
    uint64_t errorsin;
    uint64_t errorsout;
    uint64_t packetslost;
};

typedef struct _NETWORK_PACKET NETWORK_PACKET;
struct _NETWORK_PACKET
{
    void *buffer; 
    void *data; 
    int32_t length; 
    uint32_t flags; 
};

typedef struct _NETWORK_BUFFER NETWORK_BUFFER;
struct _NETWORK_BUFFER
{
    SEMAPHORE_HANDLE wait; 
    uint32_t start; 
    uint32_t count; 
    NETWORK_PACKET *packets[NETWORK_BUFFER_SIZE];
};

typedef struct _NETWORK_ENTRY NETWORK_ENTRY;
struct _NETWORK_ENTRY
{
    void *buffer; 
    uint32_t size; 
    uint32_t offset; 
    uint32_t count; 
    void *driverdata; 
    NETWORK_PACKET *packets[]; 
};

typedef struct _NETWORK_QUEUE NETWORK_QUEUE;
struct _NETWORK_QUEUE
{
    BUFFER_HANDLE buffer; 
    SEMAPHORE_HANDLE wait; 
    uint32_t start; 
    uint32_t count; 
    uint32_t flags; 
    NETWORK_ENTRY *entries[]; 
};

typedef struct _NETWORK_STATISTICS NETWORK_STATISTICS;
struct _NETWORK_STATISTICS
{
    uint64_t receivebytes;
    uint64_t receivecount;
    uint64_t receiveerrors;
    uint64_t transmitbytes;
    uint64_t transmitcount;
    uint64_t transmiterrors;
    uint64_t statuscount;
    uint64_t statuserrors;
    uint64_t bufferoverruns;
    uint64_t bufferunavailable;
};

typedef struct _NETWORK_DEVICE NETWORK_DEVICE;

typedef uint32_t STDCALL (*network_enumerate_cb)(NETWORK_DEVICE *network, void *data);
typedef uint32_t STDCALL (*network_notification_cb)(DEVICE *device, void *data, uint32_t notification);

typedef uint32_t STDCALL (*network_device_open_proc)(NETWORK_DEVICE *network);
typedef uint32_t STDCALL (*network_device_close_proc)(NETWORK_DEVICE *network);
typedef uint32_t STDCALL (*network_device_read_proc)(NETWORK_DEVICE *network, void *buffer, uint32_t size, uint32_t *length);
typedef uint32_t STDCALL (*network_device_write_proc)(NETWORK_DEVICE *network, void *buffer, uint32_t size, uint32_t *length);
typedef uint32_t STDCALL (*network_device_control_proc)(NETWORK_DEVICE *network, int request, size_t argument1, size_t *argument2);
 
typedef uint32_t STDCALL (*network_buffer_allocate_proc)(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);
typedef uint32_t STDCALL (*network_buffer_release_proc)(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);
typedef uint32_t STDCALL (*network_buffer_receive_proc)(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);
typedef uint32_t STDCALL (*network_buffer_transmit_proc)(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);
 
struct _NETWORK_DEVICE
{
    // Device Properties
    DEVICE device; 
    // Network Properties
    uint32_t networkid; 
    uint32_t networkstate; 
    uint32_t networkstatus; 
    network_device_open_proc deviceopen; 
    network_device_close_proc deviceclose; 
    network_device_read_proc deviceread; 
    network_device_write_proc devicewrite; 
    network_device_control_proc devicecontrol; 
    network_buffer_allocate_proc bufferallocate; 
    network_buffer_release_proc bufferrelease; 
    network_buffer_receive_proc bufferreceive; 
    network_buffer_transmit_proc buffertransmit; 
    // Driver Properties
    MUTEX_HANDLE lock; 
    NETWORK_BUFFER buffer; 
    SEMAPHORE_HANDLE transmitwait; 
    BUFFER_HANDLE receivebuffer; 
    BUFFER_HANDLE transmitbuffer; 
    NETWORK_QUEUE receivequeue; 
    NETWORK_QUEUE transmitqueue; 
    // Statistics Properties
    uint64_t receivebytes;
    uint64_t receivecount;
    uint64_t receiveerrors;
    uint64_t transmitbytes;
    uint64_t transmitcount;
    uint64_t transmiterrors;
    uint64_t statuscount;
    uint64_t statuserrors;
    uint64_t bufferoverruns;
    uint64_t bufferunavailable;
    // Internal Properties
    NETWORK_DEVICE *prev; 
    NETWORK_DEVICE *next; 
};

typedef struct _NETWORK_EVENT NETWORK_EVENT;

typedef uint32_t STDCALL (*network_event_callback_cb)(void *data, uint32_t event);
 
struct _NETWORK_EVENT
{
    // Event Properties
    uint32_t signature; 
    uint32_t eventstate; 
    uint32_t eventflags; 
    network_event_callback_cb callback; 
    void *data; 
    uint32_t event; 
    // Internal Properties
    NETWORK_EVENT *prev; 
    NETWORK_EVENT *next; 
};

static const HARDWARE_ADDRESS HARDWARE_DEFAULT = {0x00,0x00,0x00,0x00,0x00,0x00};
static const HARDWARE_ADDRESS HARDWARE_LOOPBACK = {0x00,0x00,0x00,0x00,0x00,0x01};
static const HARDWARE_ADDRESS HARDWARE_BROADCAST = {0xFF,0xFF,0xFF,0xFF,0xFF,0xFF};

typedef uint8_t ETHERNET_ADDRESS[ETHERNET_ADDRESS_SIZE];

typedef struct _ETHERNET_HEADER ETHERNET_HEADER;
struct _ETHERNET_HEADER
{
    HARDWARE_ADDRESS destaddress;
    HARDWARE_ADDRESS sourceaddress;
    uint16_t typelength; 
    uint8_t data[]; 
} PACKED;

typedef struct _LLC_HEADER LLC_HEADER;
struct _LLC_HEADER
{
    uint8_t dsap;
    uint8_t ssap;
    uint8_t control;
    uint8_t information[]; 
} PACKED;

typedef struct _SNAP_HEADER SNAP_HEADER;
struct _SNAP_HEADER
{
    uint8_t oui[3];
    uint16_t protocolid;
    uint8_t data[]; 
} PACKED;

static const HARDWARE_ADDRESS ETHERNET_DEFAULT = {0x00,0x00,0x00,0x00,0x00,0x00};
static const HARDWARE_ADDRESS ETHERNET_LOOPBACK = {0x00,0x00,0x00,0x00,0x00,0x01};
static const HARDWARE_ADDRESS ETHERNET_BROADCAST = {0xFF,0xFF,0xFF,0xFF,0xFF,0xFF};
static const HARDWARE_ADDRESS ETHERNET_MULTICAST = {0x01,0x00,0x5E,0x00,0x00,0x00};

uint32_t STDCALL network_start(void);
uint32_t STDCALL network_stop(void);

BOOL STDCALL network_start_completed(void);

uint32_t STDCALL network_device_open(NETWORK_DEVICE *network);
uint32_t STDCALL network_device_close(NETWORK_DEVICE *network);
uint32_t STDCALL network_device_read(NETWORK_DEVICE *network, void *buffer, uint32_t size, uint32_t *length);
uint32_t STDCALL network_device_write(NETWORK_DEVICE *network, void *buffer, uint32_t size, uint32_t *length);
uint32_t STDCALL network_device_control(NETWORK_DEVICE *network, int request, size_t argument1, size_t *argument2);

uint32_t STDCALL network_buffer_allocate(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);

uint32_t STDCALL network_buffer_release(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);

uint32_t STDCALL network_buffer_receive(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);

uint32_t STDCALL network_buffer_transmit(NETWORK_DEVICE *network, NETWORK_ENTRY *entry);

uint32_t STDCALL network_device_set_state(NETWORK_DEVICE *network, uint32_t state);

uint32_t STDCALL network_device_set_status(NETWORK_DEVICE *network, uint32_t status);

NETWORK_DEVICE * STDCALL network_device_create(void);

NETWORK_DEVICE * STDCALL network_device_create_ex(uint32_t size);

uint32_t STDCALL network_device_destroy(NETWORK_DEVICE *network);

uint32_t STDCALL network_device_register(NETWORK_DEVICE *network);

uint32_t STDCALL network_device_deregister(NETWORK_DEVICE *network);
 
NETWORK_DEVICE * STDCALL network_device_find(uint32_t networkid);
NETWORK_DEVICE * STDCALL network_device_find_by_name(const char *name);
NETWORK_DEVICE * STDCALL network_device_find_by_description(const char *description);
uint32_t STDCALL network_device_enumerate(network_enumerate_cb callback, void *data);
 
uint32_t STDCALL network_device_notification(NETWORK_DEVICE *network, network_notification_cb callback, void *data, uint32_t notification, uint32_t flags);

NETWORK_EVENT * STDCALL network_event_allocate(network_event_callback_cb callback, void *data, uint32_t event);

uint32_t STDCALL network_event_release(NETWORK_EVENT *event);

HANDLE STDCALL network_event_register(network_event_callback_cb callback, void *data, uint32_t event);

uint32_t STDCALL network_event_deregister(HANDLE handle);
 
uint32_t STDCALL network_event_notify(uint32_t event);


int32_t STDCALL network_get_last_error(void);

void STDCALL network_set_last_error(int32_t error);

uint32_t STDCALL network_get_count(void);

NETWORK_DEVICE * STDCALL network_device_check(NETWORK_DEVICE *network);
 
uint32_t STDCALL network_device_type_to_string(uint32_t networktype, char *string, uint32_t len);
uint32_t STDCALL network_device_state_to_string(uint32_t networkstate, char *string, uint32_t len);
uint32_t STDCALL network_device_status_to_string(uint32_t networkstatus, char *string, uint32_t len);

uint32_t STDCALL network_device_state_to_notification(uint32_t state);

uint32_t STDCALL network_device_status_to_notification(uint32_t status);

NETWORK_EVENT * STDCALL network_event_check(NETWORK_EVENT *event);
 
uint32_t STDCALL hardware_address_to_string(HARDWARE_ADDRESS *address, char *separator, char *string, uint32_t len);
void STDCALL string_to_hardware_address(char *string, HARDWARE_ADDRESS *address);
 
BOOL STDCALL valid_hardware_address(HARDWARE_ADDRESS *address);
void STDCALL random_hardware_address(HARDWARE_ADDRESS *address);
 
BOOL STDCALL compare_hardware_address(HARDWARE_ADDRESS *address1, HARDWARE_ADDRESS *address2);
BOOL STDCALL compare_hardware_default(HARDWARE_ADDRESS *address);
BOOL STDCALL compare_hardware_broadcast(HARDWARE_ADDRESS *address);
BOOL STDCALL compare_hardware_multicast(HARDWARE_ADDRESS *address);
 
uint32_t STDCALL adapter_type_to_string(uint16_t _type, char *string, uint32_t len);
uint32_t STDCALL adapter_mode_to_string(uint16_t mode, char *string, uint32_t len);
uint32_t STDCALL adapter_config_to_string(uint16_t config, char *string, uint32_t len);
uint32_t STDCALL adapter_state_to_string(int state, char *string, uint32_t len);
uint32_t STDCALL adapter_status_to_string(int status, char *string, uint32_t len);
 
uint32_t STDCALL frame_type_to_string(uint16_t _type, char *string, uint32_t len);
uint32_t STDCALL network_media_type_to_string(uint16_t _type, char *string, uint32_t len);
uint32_t STDCALL packet_type_to_string(uint16_t _type, char *string, uint32_t len);
 
uint32_t STDCALL config_type_to_string(uint16_t _type, char *string, uint32_t len);
uint32_t STDCALL config_command_to_string(uint16_t command, char *string, uint32_t len);
 
uint32_t STDCALL auth_type_to_string(uint16_t _type, char *string, uint32_t len);
uint32_t STDCALL auth_command_to_string(uint16_t command, char *string, uint32_t len);
 
uint32_t STDCALL phy_interface_mode_to_string(uint16_t mode, char *string, uint32_t len);
uint32_t STDCALL phy_link_speed_to_string(uint16_t speed, char *string, uint32_t len);
uint32_t STDCALL phy_duplex_mode_to_string(uint16_t mode, char *string, uint32_t len);
 
uint16_t STDCALL match_string_to_phy_interface_mode(char *mode);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_NETWORK_H