nic.h

Go to the documentation of this file.

/**
 * @file nic.h
 * @brief Network interface controller abstraction layer
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneTCP Open.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * @author Oryx Embedded SARL (www.oryx-embedded.com)
 * @version 2.4.4
 **/
 
#ifndef _NIC_H
#define _NIC_H
 
//Dependencies
#include "core/net.h"
 
//Tick interval to handle NIC periodic operations
#ifndef NIC_TICK_INTERVAL
   #define NIC_TICK_INTERVAL 1000
#elif (NIC_TICK_INTERVAL < 10)
   #error NIC_TICK_INTERVAL parameter is not valid
#endif
 
//Maximum duration a write operation may block
#ifndef NIC_MAX_BLOCKING_TIME
   #define NIC_MAX_BLOCKING_TIME INFINITE_DELAY
#elif (NIC_MAX_BLOCKING_TIME < 0)
   #error NIC_MAX_BLOCKING_TIME parameter is not valid
#endif
 
//Size of the NIC driver context
#ifndef NIC_CONTEXT_SIZE
   #define NIC_CONTEXT_SIZE 16
#elif (NIC_CONTEXT_SIZE < 1)
   #error NIC_CONTEXT_SIZE parameter is not valid
#endif
 
//Switch CPU port
#define SWITCH_CPU_PORT 32
#define SWITCH_CPU_PORT_MASK 0x80000000
 
//Serial Management Interface
#define SMI_SYNC         0xFFFFFFFF
#define SMI_START        1
#define SMI_OPCODE_0     0
#define SMI_OPCODE_WRITE 1
#define SMI_OPCODE_READ  2
#define SMI_TA           2
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * @brief NIC types
 **/
 
typedef enum
{
   NIC_TYPE_UNKNOWN  = 0, ///<Unknown interface type
   NIC_TYPE_ETHERNET = 1, ///<Ethernet interface
   NIC_TYPE_PPP      = 2, ///<PPP interface
   NIC_TYPE_IPV4     = 3, ///<IPv4 interface
   NIC_TYPE_IPV6     = 4, ///<IPv6 interface
   NIC_TYPE_6LOWPAN  = 4, ///<6LoWPAN interface
   NIC_TYPE_LOOPBACK = 5  ///<Loopback interface
} NicType;
 
 
/**
 * @brief Link state
 **/
 
typedef enum
{
   NIC_LINK_STATE_DOWN = 0,
   NIC_LINK_STATE_UP   = 1,
   NIC_LINK_STATE_AUTO = 2
} NicLinkState;
 
 
/**
 * @brief Link speed
 **/
 
typedef enum
{
   NIC_LINK_SPEED_UNKNOWN = 0,
   NIC_LINK_SPEED_10MBPS  = 10000000,
   NIC_LINK_SPEED_100MBPS = 100000000,
   NIC_LINK_SPEED_1GBPS   = 1000000000
} NicLinkSpeed;
 
 
/**
 * @brief Duplex mode
 **/
 
typedef enum
{
   NIC_UNKNOWN_DUPLEX_MODE = 0,
   NIC_HALF_DUPLEX_MODE    = 1,
   NIC_FULL_DUPLEX_MODE    = 2
} NicDuplexMode;
 
 
/**
 * @brief Switch port state
 **/
 
typedef enum
{
   SWITCH_PORT_STATE_UNKNOWN    = 0,
   SWITCH_PORT_STATE_DISABLED   = 1,
   SWITCH_PORT_STATE_BLOCKING   = 2,
   SWITCH_PORT_STATE_LISTENING  = 3,
   SWITCH_PORT_STATE_LEARNING   = 4,
   SWITCH_PORT_STATE_FORWARDING = 5
} SwitchPortState;
 
 
/**
 * @brief Forwarding database entry
 **/
 
typedef struct
{
   MacAddr macAddr;
   uint8_t srcPort;
   uint32_t destPorts;
   bool_t override;
} SwitchFdbEntry;
 
 
/**
 * @brief VLAN entry
 **/
 
typedef struct
{
   uint16_t vlanId;
   bool_t valid;
   uint16_t fid;
   uint32_t ports;
} SwitchVlanEntry;
 
 
//NIC driver abstraction layer
typedef error_t (*NicInit)(NetInterface *interface);
typedef void (*NicTick)(NetInterface *interface);
typedef void (*NicEnableIrq)(NetInterface *interface);
typedef void (*NicDisableIrq)(NetInterface *interface);
typedef void (*NicEventHandler)(NetInterface *interface);
 
typedef error_t (*NicSendPacket)(NetInterface *interface,
   const NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
 
typedef error_t (*NicUpdateMacAddrFilter)(NetInterface *interface);
typedef error_t (*NicUpdateMacConfig)(NetInterface *interface);
 
typedef void (*NicWritePhyReg)(uint8_t opcode, uint8_t phyAddr,
   uint8_t regAddr, uint16_t data);
 
typedef uint16_t (*NicReadPhyReg)(uint8_t opcode, uint8_t phyAddr,
   uint8_t regAddr);
 
//Ethernet PHY driver abstraction layer
typedef error_t (*PhyInit)(NetInterface *interface);
typedef void (*PhyTick)(NetInterface *interface);
typedef void (*PhyEnableIrq)(NetInterface *interface);
typedef void (*PhyDisableIrq)(NetInterface *interface);
typedef void (*PhyEventHandler)(NetInterface *interface);
 
//Ethernet switch driver abstraction layer
typedef error_t (*SwitchInit)(NetInterface *interface);
typedef void (*SwitchTick)(NetInterface *interface);
typedef void (*SwitchEnableIrq)(NetInterface *interface);
typedef void (*SwitchDisableIrq)(NetInterface *interface);
typedef void (*SwitchEventHandler)(NetInterface *interface);
 
typedef error_t (*SwitchTagFrame)(NetInterface *interface, NetBuffer *buffer,
   size_t *offset, NetTxAncillary *ancillary);
 
typedef error_t (*SwitchUntagFrame)(NetInterface *interface, uint8_t **frame,
   size_t *length, NetRxAncillary *ancillary);
 
typedef bool_t (*SwitchGetLinkState)(NetInterface *interface, uint8_t port);
typedef uint32_t (*SwitchGetLinkSpeed)(NetInterface *interface, uint8_t port);
 
typedef NicDuplexMode (*SwitchGetDuplexMode)(NetInterface *interface,
   uint8_t port);
 
typedef void (*SwitchSetPortState)(NetInterface *interface, uint8_t port,
   SwitchPortState state);
 
typedef SwitchPortState (*SwitchGetPortState)(NetInterface *interface,
   uint8_t port);
 
typedef void (*SwitchSetAgingTime)(NetInterface *interface, uint32_t agingTime);
 
typedef void (*SwitchEnableIgmpSnooping)(NetInterface *interface,
   bool_t enable);
 
typedef void (*SwitchEnableMldSnooping)(NetInterface *interface,
   bool_t enable);
 
typedef void (*SwitchEnableRsvdMcastTable)(NetInterface *interface,
   bool_t enable);
 
typedef error_t (*SwitchAddFdbEntry)(NetInterface *interface,
   const SwitchFdbEntry *entry);
 
typedef error_t (*SwitchDeleteFdbEntry)(NetInterface *interface,
   const SwitchFdbEntry *entry);
 
typedef error_t (*SwitchGetFdbEntry)(NetInterface *interface, uint_t index,
   SwitchFdbEntry *entry);
 
typedef void (*SwitchFlushStaticFdbTable)(NetInterface *interface);
 
typedef void (*SwitchFlushDynamicFdbTable)(NetInterface *interface,
   uint8_t port);
 
typedef void (*SwitchSetUnknownMcastFwdPorts)(NetInterface *interface,
   bool_t enable, uint32_t forwardPorts);
 
//SMI driver abstraction layer
typedef error_t (*SmiInit)(void);
 
typedef void (*SmiWritePhyReg)(uint8_t opcode, uint8_t phyAddr,
   uint8_t regAddr, uint16_t data);
 
typedef uint16_t (*SmiReadPhyReg)(uint8_t opcode, uint8_t phyAddr,
   uint8_t regAddr);
 
//SPI driver abstraction layer
typedef error_t (*SpiInit)(void);
typedef error_t (*SpiSetMode)(uint_t mode);
typedef error_t (*SpiSetBitrate)(uint_t bitrate);
typedef void (*SpiAssertCs)(void);
typedef void (*SpiDeassertCs)(void);
typedef uint8_t (*SpiTransfer)(uint8_t data);
 
typedef void (*SpiTransferMultipleBytes)(const uint8_t *txBuffer,
   uint8_t *rxBuffer, size_t length);
 
//UART driver abstraction layer
typedef error_t (*UartInit)(void);
typedef void (*UartEnableIrq)(void);
typedef void (*UartDisableIrq)(void);
typedef void (*UartStartTx)(void);
 
//External interrupt line driver abstraction layer
typedef error_t (*ExtIntInit)(void);
typedef void (*ExtIntEnableIrq)(void);
typedef void (*ExtIntDisableIrq)(void);
 
 
/**
 * @brief NIC driver
 **/
 
typedef struct
{
   NicType type;
   size_t mtu;
   NicInit init;
   NicTick tick;
   NicEnableIrq enableIrq;
   NicDisableIrq disableIrq;
   NicEventHandler eventHandler;
   NicSendPacket sendPacket;
   NicUpdateMacAddrFilter updateMacAddrFilter;
   NicUpdateMacConfig updateMacConfig;
   NicWritePhyReg writePhyReg;
   NicReadPhyReg readPhyReg;
   bool_t autoPadding;
   bool_t autoCrcCalc;
   bool_t autoCrcVerif;
   bool_t autoCrcStrip;
} NicDriver;
 
 
/**
 * @brief Ethernet PHY driver
 **/
 
typedef struct
{
   PhyInit init;
   PhyTick tick;
   PhyEnableIrq enableIrq;
   PhyDisableIrq disableIrq;
   PhyEventHandler eventHandler;
} PhyDriver;
 
 
/**
 * @brief Ethernet switch driver
 **/
 
typedef struct
{
   SwitchInit init;
   SwitchTick tick;
   SwitchEnableIrq enableIrq;
   SwitchDisableIrq disableIrq;
   SwitchEventHandler eventHandler;
   SwitchTagFrame tagFrame;
   SwitchUntagFrame untagFrame;
   SwitchGetLinkState getLinkState;
   SwitchGetLinkSpeed getLinkSpeed;
   SwitchGetDuplexMode getDuplexMode;
   SwitchSetPortState setPortState;
   SwitchGetPortState getPortState;
   SwitchSetAgingTime setAgingTime;
   SwitchEnableIgmpSnooping enableIgmpSnooping;
   SwitchEnableMldSnooping enableMldSnooping;
   SwitchEnableRsvdMcastTable enableRsvdMcastTable;
   SwitchAddFdbEntry addStaticFdbEntry;
   SwitchDeleteFdbEntry deleteStaticFdbEntry;
   SwitchGetFdbEntry getStaticFdbEntry;
   SwitchFlushStaticFdbTable flushStaticFdbTable;
   SwitchGetFdbEntry getDynamicFdbEntry;
   SwitchFlushDynamicFdbTable flushDynamicFdbTable;
   SwitchSetUnknownMcastFwdPorts setUnknownMcastFwdPorts;
} SwitchDriver;
 
 
/**
 * @brief SMI driver
 **/
 
typedef struct
{
   SmiInit init;
   SmiWritePhyReg writePhyReg;
   SmiReadPhyReg readPhyReg;
} SmiDriver;
 
 
/**
 * @brief SPI driver
 **/
 
typedef struct
{
   SpiInit init;
   SpiSetMode setMode;
   SpiSetBitrate setBitrate;
   SpiAssertCs assertCs;
   SpiDeassertCs deassertCs;
   SpiTransfer transfer;
   SpiTransferMultipleBytes transferMultipleBytes;
} SpiDriver;
 
 
/**
 * @brief UART driver
 **/
 
typedef struct
{
   UartInit init;
   UartEnableIrq enableIrq;
   UartDisableIrq disableIrq;
   UartStartTx startTx;
} UartDriver;
 
 
/**
 * @brief External interrupt line driver
 **/
 
typedef struct
{
   ExtIntInit init;
   ExtIntEnableIrq enableIrq;
   ExtIntDisableIrq disableIrq;
} ExtIntDriver;
 
 
//Tick counter to handle periodic operations
extern systime_t nicTickCounter;
 
//NIC abstraction layer
NetInterface *nicGetLogicalInterface(NetInterface *interface);
NetInterface *nicGetPhysicalInterface(NetInterface *interface);
uint8_t nicGetSwitchPort(NetInterface *interface);
uint16_t nicGetVlanId(NetInterface *interface);
uint16_t nicGetVmanId(NetInterface *interface);
 
bool_t nicIsParentInterface(NetInterface *interface, NetInterface *parent);
 
void nicTick(NetInterface *interface);
 
error_t nicSendPacket(NetInterface *interface, const NetBuffer *buffer,
   size_t offset, NetTxAncillary *ancillary);
 
error_t nicUpdateMacAddrFilter(NetInterface *interface);
 
void nicProcessPacket(NetInterface *interface, uint8_t *packet, size_t length,
   NetRxAncillary *ancillary);
 
void nicNotifyLinkChange(NetInterface *interface);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif