xref: /dpdk/drivers/net/r8169/r8169_compat.h (revision b574fb4cc855f4e86659d37ded01e7a218c38865)

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2024 Realtek Corporation. All rights reserved
 */

#ifndef R8169_COMPAT_H
#define R8169_COMPAT_H

#include <stdint.h>

#include <rte_common.h>
#include <rte_cycles.h>
#include <rte_byteorder.h>
#include <rte_io.h>
#include <rte_ether.h>

typedef uint8_t   u8;
typedef uint16_t  u16;
typedef uint32_t  u32;
typedef uint64_t  u64;

struct rtl_counters {
	u64 tx_packets;
	u64 rx_packets;
	u64 tx_errors;
	u32 rx_errors;
	u16 rx_missed;
	u16 align_errors;
	u32 tx_one_collision;
	u32 tx_multi_collision;
	u64 rx_unicast;
	u64 rx_broadcast;
	u32 rx_multicast;
	u16 tx_aborted;
};

enum mcfg {
	CFG_METHOD_1 = 1,
	CFG_METHOD_2,
	CFG_METHOD_3,
	CFG_METHOD_4,
	CFG_METHOD_5,
	CFG_METHOD_6,
	CFG_METHOD_7,
	CFG_METHOD_8,
	CFG_METHOD_9,
	CFG_METHOD_10,
	CFG_METHOD_11,
	CFG_METHOD_12,
	CFG_METHOD_13,
	CFG_METHOD_14,
	CFG_METHOD_15,
	CFG_METHOD_16,
	CFG_METHOD_17,
	CFG_METHOD_18,
	CFG_METHOD_19,
	CFG_METHOD_20,
	CFG_METHOD_21,
	CFG_METHOD_22,
	CFG_METHOD_23,
	CFG_METHOD_24,
	CFG_METHOD_25,
	CFG_METHOD_26,
	CFG_METHOD_27,
	CFG_METHOD_28,
	CFG_METHOD_29,
	CFG_METHOD_30,
	CFG_METHOD_31,
	CFG_METHOD_32,
	CFG_METHOD_33,
	CFG_METHOD_34,
	CFG_METHOD_35,
	CFG_METHOD_36,
	CFG_METHOD_37,
	CFG_METHOD_38,
	CFG_METHOD_39,
	CFG_METHOD_40,
	CFG_METHOD_41,
	CFG_METHOD_42,
	CFG_METHOD_43,
	CFG_METHOD_44,
	CFG_METHOD_45,
	CFG_METHOD_46,
	CFG_METHOD_47,
	CFG_METHOD_48,
	CFG_METHOD_49,
	CFG_METHOD_50,
	CFG_METHOD_51,
	CFG_METHOD_52,
	CFG_METHOD_53,
	CFG_METHOD_54,
	CFG_METHOD_55,
	CFG_METHOD_56,
	CFG_METHOD_57,
	CFG_METHOD_58,
	CFG_METHOD_59,
	CFG_METHOD_60,
	CFG_METHOD_61,
	CFG_METHOD_62,
	CFG_METHOD_63,
	CFG_METHOD_64,
	CFG_METHOD_65,
	CFG_METHOD_66,
	CFG_METHOD_67,
	CFG_METHOD_68,
	CFG_METHOD_69,
	CFG_METHOD_70,
	CFG_METHOD_71,
	CFG_METHOD_MAX,
	CFG_METHOD_DEFAULT = 0xFF
};

enum bits {
	BIT_0 = (1UL << 0),
	BIT_1 = (1UL << 1),
	BIT_2 = (1UL << 2),
	BIT_3 = (1UL << 3),
	BIT_4 = (1UL << 4),
	BIT_5 = (1UL << 5),
	BIT_6 = (1UL << 6),
	BIT_7 = (1UL << 7),
	BIT_8 = (1UL << 8),
	BIT_9 = (1UL << 9),
	BIT_10 = (1UL << 10),
	BIT_11 = (1UL << 11),
	BIT_12 = (1UL << 12),
	BIT_13 = (1UL << 13),
	BIT_14 = (1UL << 14),
	BIT_15 = (1UL << 15),
	BIT_16 = (1UL << 16),
	BIT_17 = (1UL << 17),
	BIT_18 = (1UL << 18),
	BIT_19 = (1UL << 19),
	BIT_20 = (1UL << 20),
	BIT_21 = (1UL << 21),
	BIT_22 = (1UL << 22),
	BIT_23 = (1UL << 23),
	BIT_24 = (1UL << 24),
	BIT_25 = (1UL << 25),
	BIT_26 = (1UL << 26),
	BIT_27 = (1UL << 27),
	BIT_28 = (1UL << 28),
	BIT_29 = (1UL << 29),
	BIT_30 = (1UL << 30),
	BIT_31 = (1UL << 31)
};

enum RTL_registers {
	MAC0            = 0x00,     /* Ethernet hardware address */
	MAC4            = 0x04,
	MAR0            = 0x08,     /* Multicast filter */
	CounterAddrLow  = 0x10,
	CounterAddrHigh = 0x14,
	CustomLED       = 0x18,
	TxDescStartAddrLow  = 0x20,
	TxDescStartAddrHigh = 0x24,
	TxHDescStartAddrLow = 0x28,
	TxHDescStartAddrHigh = 0x2C,
	FLASH           = 0x30,
	INT_CFG0_8125   = 0x34,
	ERSR            = 0x36,
	ChipCmd         = 0x37,
	TxPoll          = 0x38,
	IntrMask        = 0x3C,
	IntrStatus      = 0x3E,
	TxConfig        = 0x40,
	RxConfig        = 0x44,
	TCTR            = 0x48,
	Cfg9346         = 0x50,
	Config0         = 0x51,
	Config1         = 0x52,
	Config2         = 0x53,
	Config3         = 0x54,
	Config4         = 0x55,
	Config5         = 0x56,
	TDFNR           = 0x57,
	TimeInt0        = 0x58,
	TimeInt1        = 0x5C,
	PHYAR           = 0x60,
	CSIDR           = 0x64,
	CSIAR           = 0x68,
	PHYstatus       = 0x6C,
	MACDBG          = 0x6D,
	GPIO            = 0x6E,
	PMCH            = 0x6F,
	ERIDR           = 0x70,
	ERIAR           = 0x74,
	INT_CFG1_8125   = 0x7A,
	EPHY_RXER_NUM   = 0x7C,
	EPHYAR          = 0x80,
	TimeInt2        = 0x8C,
	OCPDR           = 0xB0,
	MACOCP          = 0xB0,
	OCPAR           = 0xB4,
	SecMAC0         = 0xB4,
	SecMAC4         = 0xB8,
	PHYOCP          = 0xB8,
	DBG_reg         = 0xD1,
	TwiCmdReg       = 0xD2,
	MCUCmd_reg      = 0xD3,
	RxMaxSize       = 0xDA,
	EFUSEAR         = 0xDC,
	CPlusCmd        = 0xE0,
	IntrMitigate    = 0xE2,
	RxDescAddrLow   = 0xE4,
	RxDescAddrHigh  = 0xE8,
	MTPS            = 0xEC,
	FuncEvent       = 0xF0,
	PPSW            = 0xF2,
	FuncEventMask   = 0xF4,
	TimeInt3        = 0xF4,
	FuncPresetState = 0xF8,
	CMAC_IBCR0      = 0xF8,
	CMAC_IBCR2      = 0xF9,
	CMAC_IBIMR0     = 0xFA,
	CMAC_IBISR0     = 0xFB,
	FuncForceEvent  = 0xFC,

	/* 8125 */
	IMR0_8125          = 0x38,
	ISR0_8125          = 0x3C,
	TPPOLL_8125        = 0x90,
	IMR1_8125          = 0x800,
	ISR1_8125          = 0x802,
	IMR2_8125          = 0x804,
	ISR2_8125          = 0x806,
	IMR3_8125          = 0x808,
	ISR3_8125          = 0x80A,
	BACKUP_ADDR0_8125  = 0x19E0,
	BACKUP_ADDR1_8125  = 0X19E4,
	TCTR0_8125         = 0x0048,
	TCTR1_8125         = 0x004C,
	TCTR2_8125         = 0x0088,
	TCTR3_8125         = 0x001C,
	TIMER_INT0_8125    = 0x0058,
	TIMER_INT1_8125    = 0x005C,
	TIMER_INT2_8125    = 0x008C,
	TIMER_INT3_8125    = 0x00F4,
	INT_MITI_V2_0_RX   = 0x0A00,
	INT_MITI_V2_0_TX   = 0x0A02,
	INT_MITI_V2_1_RX   = 0x0A08,
	INT_MITI_V2_1_TX   = 0x0A0A,
	IMR_V2_CLEAR_REG_8125 = 0x0D00,
	ISR_V2_8125           = 0x0D04,
	IMR_V2_SET_REG_8125   = 0x0D0C,
	TDU_STA_8125       = 0x0D08,
	RDU_STA_8125       = 0x0D0A,
	IMR_V4_L2_CLEAR_REG_8125 = 0x0D10,
	IMR_V4_L2_SET_REG_8125   = 0x0D18,
	ISR_V4_L2_8125      = 0x0D14,
	SW_TAIL_PTR0_8125BP = 0x0D30,
	SW_TAIL_PTR1_8125BP = 0x0D38,
	HW_CLO_PTR0_8125BP = 0x0D34,
	HW_CLO_PTR1_8125BP = 0x0D3C,
	DOUBLE_VLAN_CONFIG = 0x1000,
	TX_NEW_CTRL        = 0x203E,
	TNPDS_Q1_LOW_8125  = 0x2100,
	PLA_TXQ0_IDLE_CREDIT = 0x2500,
	PLA_TXQ1_IDLE_CREDIT = 0x2504,
	SW_TAIL_PTR0_8125  = 0x2800,
	HW_CLO_PTR0_8125   = 0x2802,
	SW_TAIL_PTR0_8126  = 0x2800,
	HW_CLO_PTR0_8126   = 0x2800,
	RDSAR_Q1_LOW_8125  = 0x4000,
	RSS_CTRL_8125      = 0x4500,
	Q_NUM_CTRL_8125    = 0x4800,
	RSS_KEY_8125       = 0x4600,
	RSS_INDIRECTION_TBL_8125_V2 = 0x4700,
	EEE_TXIDLE_TIMER_8125       = 0x6048,
	IB2SOC_SET     = 0x0010,
	IB2SOC_DATA    = 0x0014,
	IB2SOC_CMD     = 0x0018,
	IB2SOC_IMR     = 0x001C,
};

enum RTL_register_content {
	/* Interrupt status bits */
	SYSErr      = 0x8000,
	PCSTimeout  = 0x4000,
	SWInt       = 0x0100,
	TxDescUnavail = 0x0080,
	RxFIFOOver  = 0x0040,
	LinkChg     = 0x0020,
	RxDescUnavail = 0x0010,
	TxErr       = 0x0008,
	TxOK        = 0x0004,
	RxErr       = 0x0002,
	RxOK        = 0x0001,

	/* RX status desc */
	RxRWT  = (1UL << 22),
	RxRES  = (1UL << 21),
	RxRUNT = (1UL << 20),
	RxCRC  = (1UL << 19),

	/* ChipCmd bits */
	StopReq    = 0x80,
	CmdReset   = 0x10,
	CmdRxEnb   = 0x08,
	CmdTxEnb   = 0x04,
	RxBufEmpty = 0x01,

	/* Cfg9346 bits */
	Cfg9346_Lock = 0x00,
	Cfg9346_Unlock = 0xC0,
	Cfg9346_EEDO = (1UL << 0),
	Cfg9346_EEDI = (1UL << 1),
	Cfg9346_EESK = (1UL << 2),
	Cfg9346_EECS = (1UL << 3),
	Cfg9346_EEM0 = (1UL << 6),
	Cfg9346_EEM1 = (1UL << 7),

	/* RX mode bits */
	AcceptErr       = 0x20,
	AcceptRunt      = 0x10,
	AcceptBroadcast = 0x08,
	AcceptMulticast = 0x04,
	AcceptMyPhys    = 0x02,
	AcceptAllPhys   = 0x01,

	/* Transmit priority polling */
	HPQ    = 0x80,
	NPQ    = 0x40,
	FSWInt = 0x01,

	/* RX config bits */
	Reserved2_shift     = 13,
	RxCfgDMAShift       = 8,
	EnableRxDescV3      = (1 << 24),
	EnableOuterVlan     = (1 << 23),
	EnableInnerVlan     = (1 << 22),
	RxCfg_128_int_en    = (1 << 15),
	RxCfg_fet_multi_en  = (1 << 14),
	RxCfg_half_refetch  = (1 << 13),
	RxCfg_pause_slot_en = (1 << 11),
	RxCfg_9356SEL       = (1 << 6),
	EnableRxDescV4_0    = (1 << 1), /* Not in rcr */

	/* TX config bits */
	TxInterFrameGapShift = 24,
	TxDMAShift = 8, /* DMA burst value (0-7) is shift this many bits. */
	TxMACLoopBack = (1UL << 17),  /* MAC loopback */

	/* Config1 register */
	LEDS1       = (1UL << 7),
	LEDS0       = (1UL << 6),
	Speed_down  = (1UL << 4),
	MEMMAP      = (1UL << 3),
	IOMAP       = (1UL << 2),
	VPD         = (1UL << 1),
	PMEnable    = (1UL << 0), /* Power management enable */

	/* Config2 register */
	PMSTS_En    = (1UL << 5),

	/* Config3 register */
	Isolate_en  = (1UL << 12), /* Isolate enable */
	MagicPacket = (1UL << 5),  /* Wake up when receives a magic packet */
	LinkUp      = (1UL << 4),  /* This bit is reserved in RTL8125B. */

	/* Wake up when the cable connection is re-established */
	ECRCEN      = (1UL << 3), /* This bit is reserved in RTL8125B. */
	Jumbo_En0   = (1UL << 2), /* This bit is reserved in RTL8125B. */
	RDY_TO_L23  = (1UL << 1), /* This bit is reserved in RTL8125B. */
	Beacon_en   = (1UL << 0), /* This bit is reserved in RTL8125B. */

	/* Config4 register */
	Jumbo_En1   = (1UL << 1), /* This bit is reserved in RTL8125B. */

	/* Config5 register */
	BWF         = (1UL << 6), /* Accept broadcast wakeup frame */
	MWF         = (1UL << 5), /* Accept multicast wakeup frame */
	UWF         = (1UL << 4), /* Accept unicast wakeup frame */
	LanWake     = (1UL << 1), /* LanWake enable/disable */
	PMEStatus   = (1UL << 0), /* PME status can be reset by PCI RST#. */

	/* CPlusCmd */
	EnableBist      = (1UL << 15),
	Macdbgo_oe      = (1UL << 14),
	Normal_mode     = (1UL << 13),
	Force_halfdup   = (1UL << 12),
	Force_rxflow_en = (1UL << 11),
	Force_txflow_en = (1UL << 10),
	Cxpl_dbg_sel    = (1UL << 9), /* This bit is reserved in RTL8125B. */
	ASF             = (1UL << 8), /* This bit is reserved in RTL8125C. */
	PktCntrDisable  = (1UL << 7),
	RxVlan          = (1UL << 6),
	RxChkSum        = (1UL << 5),
	Macdbgo_sel = 0x001C,
	INTT_0      = 0x0000,
	INTT_1      = 0x0001,
	INTT_2      = 0x0002,
	INTT_3      = 0x0003,

	/* PHY status */
	PowerSaveStatus = 0x80,
	_5000bpsF       = 0x1000,
	_2500bpsF       = 0x400,
	TxFlowCtrl      = 0x40,
	RxFlowCtrl      = 0x20,
	_1000bpsF       = 0x10,
	_100bps         = 0x08,
	_10bps          = 0x04,
	LinkStatus      = 0x02,
	FullDup         = 0x01,

	/* DBG reg */
	Fix_Nak_1 = (1UL << 4),
	Fix_Nak_2 = (1UL << 3),
	DBGPIN_E2 = (1UL << 0),

	/* Reset counter command */
	CounterReset = 0x1,
	/* Dump counter command */
	CounterDump = 0x8,

	/* PHY access */
	PHYAR_Flag      = 0x80000000,
	PHYAR_Write     = 0x80000000,
	PHYAR_Read      = 0x00000000,
	PHYAR_Reg_Mask  = 0x1f,
	PHYAR_Reg_shift = 16,
	PHYAR_Data_Mask = 0xffff,

	/* EPHY access */
	EPHYAR_Flag        = 0x80000000,
	EPHYAR_Write       = 0x80000000,
	EPHYAR_Read        = 0x00000000,
	EPHYAR_Reg_Mask    = 0x3f,
	EPHYAR_Reg_Mask_v2 = 0x7f,
	EPHYAR_Reg_shift   = 16,
	EPHYAR_Data_Mask   = 0xffff,

	/* CSI access */
	CSIAR_Flag         = 0x80000000,
	CSIAR_Write        = 0x80000000,
	CSIAR_Read         = 0x00000000,
	CSIAR_ByteEn       = 0x0f,
	CSIAR_ByteEn_shift = 12,
	CSIAR_Addr_Mask    = 0x0fff,

	/* ERI access */
	ERIAR_Flag         = 0x80000000,
	ERIAR_Write        = 0x80000000,
	ERIAR_Read         = 0x00000000,
	ERIAR_Addr_Align   = 4, /* ERI access register address must be 4 byte alignment. */
	ERIAR_ExGMAC       = 0,
	ERIAR_MSIX         = 1,
	ERIAR_ASF          = 2,
	ERIAR_OOB          = 2,
	ERIAR_Type_shift   = 16,
	ERIAR_ByteEn       = 0x0f,
	ERIAR_ByteEn_shift = 12,

	/* OCP GPHY access */
	OCPDR_Write           = 0x80000000,
	OCPDR_Read            = 0x00000000,
	OCPDR_Reg_Mask        = 0xFF,
	OCPDR_Data_Mask       = 0xFFFF,
	OCPDR_GPHY_Reg_shift  = 16,
	OCPAR_Flag            = 0x80000000,
	OCPAR_GPHY_Write      = 0x8000F060,
	OCPAR_GPHY_Read       = 0x0000F060,
	OCPR_Write            = 0x80000000,
	OCPR_Read             = 0x00000000,
	OCPR_Addr_Reg_shift   = 16,
	OCPR_Flag             = 0x80000000,
	OCP_STD_PHY_BASE_PAGE = 0x0A40,

	/* MCU command */
	Now_is_oob   = (1UL << 7),
	Txfifo_empty = (1UL << 5),
	Rxfifo_empty = (1UL << 4),

	/* E-FUSE access */
	EFUSE_WRITE       = 0x80000000,
	EFUSE_WRITE_OK    = 0x00000000,
	EFUSE_READ        = 0x00000000,
	EFUSE_READ_OK     = 0x80000000,
	EFUSE_WRITE_V3    = 0x40000000,
	EFUSE_WRITE_OK_V3 = 0x00000000,
	EFUSE_READ_V3     = 0x80000000,
	EFUSE_READ_OK_V3  = 0x00000000,
	EFUSE_Reg_Mask    = 0x03FF,
	EFUSE_Reg_Shift   = 8,
	EFUSE_Check_Cnt   = 300,
	EFUSE_READ_FAIL   = 0xFF,
	EFUSE_Data_Mask   = 0x000000FF,

	/* GPIO */
	GPIO_en = (1UL << 0),

	/* New interrupt bits */
	INT_CFG0_ENABLE_8125            = (1 << 0),
	INT_CFG0_TIMEOUT0_BYPASS_8125   = (1 << 1),
	INT_CFG0_MITIGATION_BYPASS_8125 = (1 << 2),
	INT_CFG0_RDU_BYPASS_8126        = (1 << 4),
	INT_CFG0_MSIX_ENTRY_NUM_MODE    = (1 << 5),
	ISRIMR_V2_ROK_Q0     = (1 << 0),
	ISRIMR_TOK_Q0        = (1 << 16),
	ISRIMR_TOK_Q1        = (1 << 18),
	ISRIMR_V2_LINKCHG    = (1 << 21),
};

enum RTL_chipset_name {
	RTL8125A = 0,
	RTL8125B,
	RTL8168KB,
	RTL8125BP,
	RTL8125D,
	RTL8126A,
	UNKNOWN
};

#define PCI_VENDOR_ID_REALTEK 0x10EC

#define RTL_PCI_REG_ADDR(hw, reg) ((u8 *)(hw)->mmio_addr + (reg))

#define RTL_R8(hw, reg) rte_read8(RTL_PCI_REG_ADDR(hw, reg))
#define RTL_R16(hw, reg) rtl_read16(RTL_PCI_REG_ADDR(hw, reg))
#define RTL_R32(hw, reg) rtl_read32(RTL_PCI_REG_ADDR(hw, reg))

#define RTL_W8(hw, reg, val) \
	rte_write8((val), RTL_PCI_REG_ADDR(hw, reg))
#define RTL_W16(hw, reg, val) \
	rte_write16((rte_cpu_to_le_16(val)), RTL_PCI_REG_ADDR(hw, reg))
#define RTL_W32(hw, reg, val) \
	rte_write32((rte_cpu_to_le_32(val)), RTL_PCI_REG_ADDR(hw, reg))

#define RX_DMA_BURST_unlimited  7   /* Maximum PCI burst, '7' is unlimited */
#define RX_DMA_BURST_512    5
#define RX_DMA_BURST_256    4
#define TX_DMA_BURST_unlimited  7
#define TX_DMA_BURST_1024   6
#define TX_DMA_BURST_512    5
#define TX_DMA_BURST_256    4
#define TX_DMA_BURST_128    3
#define TX_DMA_BURST_64     2
#define TX_DMA_BURST_32     1
#define TX_DMA_BURST_16     0
#define InterFrameGap       0x03    /* 3 means InterFrameGap = the shortest one */
#define Rx_Fetch_Number_8  (1 << 30)
#define Rx_Close_Multiple  (1 << 21)

#define TRUE  1
#define FALSE 0

#define SPEED_10	10
#define SPEED_100	100
#define SPEED_1000	1000
#define SPEED_2500	2500
#define SPEED_5000	5000

#define DUPLEX_HALF	1
#define DUPLEX_FULL	2

#define AUTONEG_ENABLE	1
#define AUTONEG_DISABLE	0

#define ADVERTISE_10_HALF     0x0001
#define ADVERTISE_10_FULL     0x0002
#define ADVERTISE_100_HALF    0x0004
#define ADVERTISE_100_FULL    0x0008
#define ADVERTISE_1000_HALF   0x0010 /* Not used, just FYI */
#define ADVERTISE_1000_FULL   0x0020
#define ADVERTISE_2500_HALF   0x0040 /* NOT used, just FYI */
#define ADVERTISE_2500_FULL   0x0080
#define ADVERTISE_5000_HALF   0x0100 /* NOT used, just FYI */
#define ADVERTISE_5000_FULL   0x0200

#define MAC_ADDR_LEN    RTE_ETHER_ADDR_LEN

#define RTL_MAX_TX_DESC 4096
#define RTL_MAX_RX_DESC 4096
#define RTL_MIN_TX_DESC 64
#define RTL_MIN_RX_DESC 64

#define RTL_RING_ALIGN 256

#define RTL_MAX_TX_SEG 64
#define RTL_DESC_ALIGN 64

#define RTL_RX_FREE_THRESH 32
#define RTL_TX_FREE_THRESH 32

#define VLAN_TAG_SIZE   4

/*
 * The overhead from MTU to max frame size.
 * Considering VLAN so a tag needs to be counted.
 */
#define RTL_ETH_OVERHEAD (RTE_ETHER_HDR_LEN + RTE_ETHER_CRC_LEN + VLAN_TAG_SIZE)
#define JUMBO_FRAME_9K  (9 * 1024 - RTE_ETHER_HDR_LEN - RTE_VLAN_HLEN - RTE_ETHER_CRC_LEN)

#define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL << (n)) - 1))

static inline u32
rtl_read32(void *addr)
{
	return rte_le_to_cpu_32(rte_read32(addr));
}

static inline u32
rtl_read16(void *addr)
{
	return rte_le_to_cpu_16(rte_read16(addr));
}

#endif /* R8169_COMPAT_H */