sis190.h File Reference

#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <string.h>
#include <unistd.h>
#include <assert.h>
#include <byteswap.h>
#include <errno.h>
#include <mii.h>
#include <ipxe/ethernet.h>
#include <ipxe/if_ether.h>
#include <ipxe/io.h>
#include <ipxe/iobuf.h>
#include <ipxe/malloc.h>
#include <ipxe/netdevice.h>
#include <ipxe/pci.h>
#include <ipxe/timer.h>

Go to the source code of this file.

Data Structures
struct	TxDesc
struct	RxDesc
struct	sis190_private
struct	sis190_phy
struct	mii_chip_info

Macros
#define	PCI_VENDOR_ID_SI   0x1039
#define	PHY_MAX_ADDR   32
#define	PHY_ID_ANY   0x1f
#define	MII_REG_ANY   0x1f
#define	DRV_VERSION   "1.3"
#define	DRV_NAME   "sis190"
#define	SIS190_DRIVER_NAME   DRV_NAME " Gigabit Ethernet driver " DRV_VERSION
#define	PFX   DRV_NAME ": "
#define	sis190_rx_quota(count, quota)
#define	NUM_TX_DESC   8 /* [8..1024] */
#define	NUM_RX_DESC   8 /* [8..8192] */
#define	TX_RING_BYTES   (NUM_TX_DESC * sizeof(struct TxDesc))
#define	RX_RING_BYTES   (NUM_RX_DESC * sizeof(struct RxDesc))
#define	RX_BUF_SIZE   1536
#define	RX_BUF_MASK   0xfff8
#define	RING_ALIGNMENT   256
#define	SIS190_REGS_SIZE   0x80
#define	EhnMIIread   0x0000
#define	EhnMIIwrite   0x0020
#define	EhnMIIdataShift   16
#define	EhnMIIpmdShift   6 /* 7016 only */
#define	EhnMIIregShift   11
#define	EhnMIIreq   0x0010
#define	EhnMIInotDone   0x0010
#define	SIS_W8(reg, val)
#define	SIS_W16(reg, val)
#define	SIS_W32(reg, val)
#define	SIS_R8(reg)
#define	SIS_R16(reg)
#define	SIS_R32(reg)
#define	SIS_PCI_COMMIT()

Enumerations
enum	sis190_registers {   TxControl = 0x00 , TxDescStartAddr = 0x04 , rsv0 = 0x08 , TxSts = 0x0c ,   RxControl = 0x10 , RxDescStartAddr = 0x14 , rsv1 = 0x18 , RxSts = 0x1c ,   IntrStatus = 0x20 , IntrMask = 0x24 , IntrControl = 0x28 , IntrTimer = 0x2c ,   PMControl = 0x30 , rsv2 = 0x34 , ROMControl = 0x38 , ROMInterface = 0x3c ,   StationControl = 0x40 , GMIIControl = 0x44 , GIoCR = 0x48 , GIoCtrl = 0x4c ,   TxMacControl = 0x50 , TxLimit = 0x54 , RGDelay = 0x58 , rsv3 = 0x5c ,   RxMacControl = 0x60 , RxMacAddr = 0x62 , RxHashTable = 0x68 , RxWolCtrl = 0x70 ,   RxWolData = 0x74 , RxMPSControl = 0x78 , rsv4 = 0x7c }
enum	sis190_register_content {   SoftInt = 0x40000000 , Timeup = 0x20000000 , PauseFrame = 0x00080000 , MagicPacket = 0x00040000 ,   WakeupFrame = 0x00020000 , LinkChange = 0x00010000 , RxQEmpty = 0x00000080 , RxQInt = 0x00000040 ,   TxQ1Empty = 0x00000020 , TxQ1Int = 0x00000010 , TxQ0Empty = 0x00000008 , TxQ0Int = 0x00000004 ,   RxHalt = 0x00000002 , TxHalt = 0x00000001 , CmdReset = 0x10 , CmdRxEnb = 0x08 ,   CmdTxEnb = 0x01 , RxBufEmpty = 0x01 , Cfg9346_Lock = 0x00 , Cfg9346_Unlock = 0xc0 ,   AcceptErr = 0x20 , AcceptRunt = 0x10 , AcceptBroadcast = 0x0800 , AcceptMulticast = 0x0400 ,   AcceptMyPhys = 0x0200 , AcceptAllPhys = 0x0100 , RxCfgFIFOShift = 13 , RxCfgDMAShift = 8 ,   TxInterFrameGapShift = 24 , TxDMAShift = 8 , LinkStatus = 0x02 , FullDup = 0x01 ,   TBILinkOK = 0x02000000 }
enum	_DescStatusBit {   OWNbit = 0x80000000 , INTbit = 0x40000000 , CRCbit = 0x00020000 , PADbit = 0x00010000 ,   RingEnd = 0x80000000 , LSEN = 0x08000000 , IPCS = 0x04000000 , TCPCS = 0x02000000 ,   UDPCS = 0x01000000 , BSTEN = 0x00800000 , EXTEN = 0x00400000 , DEFEN = 0x00200000 ,   BKFEN = 0x00100000 , CRSEN = 0x00080000 , COLEN = 0x00040000 , THOL3 = 0x30000000 ,   THOL2 = 0x20000000 , THOL1 = 0x10000000 , THOL0 = 0x00000000 , WND = 0x00080000 ,   TABRT = 0x00040000 , FIFO = 0x00020000 , LINK = 0x00010000 , ColCountMask = 0x0000ffff ,   IPON = 0x20000000 , TCPON = 0x10000000 , UDPON = 0x08000000 , Wakup = 0x00400000 ,   Magic = 0x00200000 , Pause = 0x00100000 , DEFbit = 0x00200000 , BCAST = 0x000c0000 ,   MCAST = 0x00080000 , UCAST = 0x00040000 , TAGON = 0x80000000 , RxDescCountMask = 0x7f000000 ,   ABORT = 0x00800000 , SHORT = 0x00400000 , LIMIT = 0x00200000 , MIIER = 0x00100000 ,   OVRUN = 0x00080000 , NIBON = 0x00040000 , COLON = 0x00020000 , CRCOK = 0x00010000 ,   RxSizeMask = 0x0000ffff }
enum	sis190_eeprom_access_register_bits {   EECS = 0x00000001 , EECLK = 0x00000002 , EEDO = 0x00000008 , EEDI = 0x00000004 ,   EEREQ = 0x00000080 , EEROP = 0x00000200 , EEWOP = 0x00000100 }
enum	sis190_eeprom_address { EEPROMSignature = 0x00 , EEPROMCLK = 0x01 , EEPROMInfo = 0x02 , EEPROMMACAddr = 0x03 }
enum	sis190_feature { F_HAS_RGMII = 1 , F_PHY_88E1111 = 2 , F_PHY_BCM5461 = 4 }
enum	sis190_phy_type { UNKNOWN = 0x00 , HOME = 0x01 , LAN = 0x02 , MIX = 0x03 }

Functions
	FILE_LICENCE (GPL_ANY)
static void	sis190_phy_task (struct sis190_private *tp)
static void	sis190_free (struct net_device *dev)
static void	sis190_init_rxfilter (struct net_device *dev)

Variables
static struct mii_chip_info	mii_chip_table []

Macro Definition Documentation

PCI_VENDOR_ID_SI

#define PCI_VENDOR_ID_SI   0x1039

Definition at line 25 of file sis190.h.

PHY_MAX_ADDR

#define PHY_MAX_ADDR   32

Definition at line 27 of file sis190.h.

Referenced by sis190_mii_probe().

PHY_ID_ANY

#define PHY_ID_ANY   0x1f

Definition at line 28 of file sis190.h.

Referenced by sis190_mii_probe().

MII_REG_ANY

#define MII_REG_ANY   0x1f

Definition at line 29 of file sis190.h.

Referenced by sis190_mii_probe().

DRV_VERSION

#define DRV_VERSION   "1.3"

Definition at line 31 of file sis190.h.

DRV_NAME

#define DRV_NAME   "sis190"

Definition at line 32 of file sis190.h.

SIS190_DRIVER_NAME

#define SIS190_DRIVER_NAME   DRV_NAME " Gigabit Ethernet driver " DRV_VERSION

Definition at line 33 of file sis190.h.

PFX

#define PFX   DRV_NAME ": "

Definition at line 34 of file sis190.h.

Referenced by __gm_phy_read(), bcom_check_link(), bcom_phy_intr(), genesis_mac_init(), gm_phy_read(), gm_phy_write(), gm_phy_write(), skge_devinit(), skge_down(), skge_link_down(), skge_link_up(), skge_probe(), skge_reset(), skge_show_addr(), skge_up(), skge_xmit_frame(), sky2_autoneg_done(), sky2_down(), sky2_err_intr(), sky2_hw_error(), sky2_hw_intr(), sky2_init(), sky2_init_netdev(), sky2_le_error(), sky2_link_down(), sky2_link_up(), sky2_mac_intr(), sky2_mhz(), sky2_phy_intr(), sky2_probe(), sky2_put_idx(), sky2_receive(), sky2_reset(), sky2_rx_stop(), sky2_show_addr(), sky2_status_intr(), sky2_tx_complete(), sky2_up(), sky2_xmit_frame(), xm_check_link(), xm_phy_read(), and yukon_phy_intr().

sis190_rx_quota

#define sis190_rx_quota	(		count,
			quota )

Value:

count

Definition at line 36 of file sis190.h.

NUM_TX_DESC

#define NUM_TX_DESC   8 /* [8..1024] */

Definition at line 38 of file sis190.h.

NUM_RX_DESC

#define NUM_RX_DESC   8 /* [8..8192] */

Definition at line 39 of file sis190.h.

TX_RING_BYTES

#define TX_RING_BYTES   (NUM_TX_DESC * sizeof(struct TxDesc))

Definition at line 40 of file sis190.h.

RX_RING_BYTES

#define RX_RING_BYTES   (NUM_RX_DESC * sizeof(struct RxDesc))

Definition at line 41 of file sis190.h.

RX_BUF_SIZE

#define RX_BUF_SIZE   1536

Definition at line 42 of file sis190.h.

RX_BUF_MASK

#define RX_BUF_MASK   0xfff8

Definition at line 43 of file sis190.h.

Referenced by sis190_give_to_asic().

RING_ALIGNMENT

#define RING_ALIGNMENT   256

Definition at line 45 of file sis190.h.

Referenced by sis190_open().

SIS190_REGS_SIZE

#define SIS190_REGS_SIZE   0x80

Definition at line 47 of file sis190.h.

Referenced by sis190_init_board().

EhnMIIread

#define EhnMIIread   0x0000

Definition at line 50 of file sis190.h.

Referenced by mdio_read().

EhnMIIwrite

#define EhnMIIwrite   0x0020

Definition at line 51 of file sis190.h.

Referenced by mdio_write().

EhnMIIdataShift

#define EhnMIIdataShift   16

Definition at line 52 of file sis190.h.

Referenced by mdio_read(), and mdio_write().

EhnMIIpmdShift

#define EhnMIIpmdShift   6 /* 7016 only */

Definition at line 53 of file sis190.h.

Referenced by mdio_read(), and mdio_write().

EhnMIIregShift

#define EhnMIIregShift   11

Definition at line 54 of file sis190.h.

Referenced by mdio_read(), and mdio_write().

EhnMIIreq

#define EhnMIIreq   0x0010

Definition at line 55 of file sis190.h.

Referenced by mdio_read(), and mdio_write().

EhnMIInotDone

#define EhnMIInotDone   0x0010

Definition at line 56 of file sis190.h.

Referenced by __mdio_cmd().

SIS_W8

#define SIS_W8	(		reg,
			val )

Value:

writeb ((val), ioaddr + (reg))

Definition at line 59 of file sis190.h.

Referenced by sis190_init_rxfilter().

SIS_W16

#define SIS_W16	(		reg,
			val )

Value:

writew ((val), ioaddr + (reg))

Definition at line 60 of file sis190.h.

Referenced by sis190_hw_start(), sis190_init_rxfilter(), and sis190_set_rx_mode().

SIS_W32

#define SIS_W32	(		reg,
			val )

Value:

writel ((val), ioaddr + (reg))

Definition at line 61 of file sis190.h.

Referenced by __mdio_cmd(), sis190_asic_down(), sis190_hw_start(), sis190_irq(), sis190_irq_mask_and_ack(), sis190_phy_task(), sis190_poll(), sis190_read_eeprom(), sis190_set_rx_mode(), sis190_soft_reset(), and sis190_transmit().

SIS_R8

#define SIS_R8

(

reg

)

Value:

readb (ioaddr + (reg))

Definition at line 62 of file sis190.h.

SIS_R16

#define SIS_R16

(

reg

)

Value:

readw (ioaddr + (reg))

Definition at line 63 of file sis190.h.

Referenced by sis190_init_rxfilter().

SIS_R32

#define SIS_R32

(

reg

)

Value:

readl (ioaddr + (reg))

Definition at line 64 of file sis190.h.

Referenced by __mdio_cmd(), mdio_read(), sis190_down(), sis190_phy_task(), sis190_poll(), and sis190_read_eeprom().

SIS_PCI_COMMIT

#define SIS_PCI_COMMIT

(

)

Value:

SIS_R32(IntrControl)

Definition at line 66 of file sis190.h.

Referenced by sis190_hw_start(), sis190_init_rxfilter(), sis190_irq(), sis190_irq_mask_and_ack(), and sis190_soft_reset().

Enumeration Type Documentation

sis190_registers

enum sis190_registers

Enumerator
TxControl
TxDescStartAddr
rsv0
TxSts
RxControl
RxDescStartAddr
rsv1
RxSts
IntrStatus
IntrMask
IntrControl
IntrTimer
PMControl
rsv2
ROMControl
ROMInterface
StationControl
GMIIControl
GIoCR
GIoCtrl
TxMacControl
TxLimit
RGDelay
rsv3
RxMacControl
RxMacAddr
RxHashTable
RxWolCtrl
RxWolData
RxMPSControl
rsv4

Definition at line 68 of file sis190.h.

                      {
        TxControl              = 0x00,
        TxDescStartAddr          = 0x04,
        rsv0                        = 0x08, // reserved
        TxSts                      = 0x0c, // unused (Control/Status)
        RxControl              = 0x10,
        RxDescStartAddr          = 0x14,
        rsv1                        = 0x18, // reserved
        RxSts                      = 0x1c, // unused
        IntrStatus            = 0x20,
        IntrMask                = 0x24,
        IntrControl          = 0x28,
        IntrTimer              = 0x2c, // unused (Interrupt Timer)
        PMControl              = 0x30, // unused (Power Mgmt Control/Status)
        rsv2                        = 0x34, // reserved
        ROMControl            = 0x38,
        ROMInterface                = 0x3c,
        StationControl            = 0x40,
        GMIIControl          = 0x44,
        GIoCR                      = 0x48, // unused (GMAC IO Compensation)
        GIoCtrl                  = 0x4c, // unused (GMAC IO Control)
        TxMacControl                = 0x50,
        TxLimit                  = 0x54, // unused (Tx MAC Timer/TryLimit)
        RGDelay                  = 0x58, // unused (RGMII Tx Internal Delay)
        rsv3                        = 0x5c, // reserved
        RxMacControl                = 0x60,
        RxMacAddr              = 0x62,
        RxHashTable          = 0x68,
        // Undocumented         = 0x6c,
        RxWolCtrl              = 0x70,
        RxWolData              = 0x74, // unused (Rx WOL Data Access)
        RxMPSControl                = 0x78, // unused (Rx MPS Control)
        rsv4                        = 0x7c, // reserved
};

sis190_register_content

enum sis190_register_content

Enumerator
SoftInt
Timeup
PauseFrame
MagicPacket
WakeupFrame
LinkChange
RxQEmpty
RxQInt
TxQ1Empty
TxQ1Int
TxQ0Empty
TxQ0Int
RxHalt
TxHalt
CmdReset
CmdRxEnb
CmdTxEnb
RxBufEmpty
Cfg9346_Lock
Cfg9346_Unlock
AcceptErr
AcceptRunt
AcceptBroadcast
AcceptMulticast
AcceptMyPhys
AcceptAllPhys
RxCfgFIFOShift
RxCfgDMAShift
TxInterFrameGapShift
TxDMAShift
LinkStatus
FullDup
TBILinkOK

Definition at line 103 of file sis190.h.

                             {
        /* IntrStatus */
        SoftInt                  = 0x40000000,   // unused
        Timeup                    = 0x20000000,   // unused
        PauseFrame            = 0x00080000,   // unused
        MagicPacket          = 0x00040000,   // unused
        WakeupFrame          = 0x00020000,   // unused
        LinkChange            = 0x00010000,
        RxQEmpty                = 0x00000080,
        RxQInt                    = 0x00000040,
        TxQ1Empty              = 0x00000020,   // unused
        TxQ1Int                  = 0x00000010,
        TxQ0Empty              = 0x00000008,   // unused
        TxQ0Int                  = 0x00000004,
        RxHalt                    = 0x00000002,
        TxHalt                    = 0x00000001,
 
        /* {Rx/Tx}CmdBits */
        CmdReset                = 0x10,
        CmdRxEnb                = 0x08,         // unused
        CmdTxEnb                = 0x01,
        RxBufEmpty            = 0x01,         // unused
 
        /* Cfg9346Bits */
        Cfg9346_Lock                = 0x00,         // unused
        Cfg9346_Unlock            = 0xc0,         // unused
 
        /* RxMacControl */
        AcceptErr              = 0x20,         // unused
        AcceptRunt            = 0x10,         // unused
        AcceptBroadcast          = 0x0800,
        AcceptMulticast          = 0x0400,
        AcceptMyPhys                = 0x0200,
        AcceptAllPhys              = 0x0100,
 
        /* RxConfigBits */
        RxCfgFIFOShift            = 13,
        RxCfgDMAShift              = 8,            // 0x1a in RxControl ?
 
        /* TxConfigBits */
        TxInterFrameGapShift        = 24,
        TxDMAShift            = 8, /* DMA burst value (0-7) is shift this many bits */
 
        LinkStatus            = 0x02,         // unused
        FullDup                  = 0x01,         // unused
 
        /* TBICSRBit */
        TBILinkOK              = 0x02000000,   // unused
};

_DescStatusBit

enum _DescStatusBit

Enumerator
OWNbit
INTbit
CRCbit
PADbit
RingEnd
LSEN
IPCS
TCPCS
UDPCS
BSTEN
EXTEN
DEFEN
BKFEN
CRSEN
COLEN
THOL3
THOL2
THOL1
THOL0
WND
TABRT
FIFO
LINK
ColCountMask
IPON
TCPON
UDPON
Wakup
Magic
Pause
DEFbit
BCAST
MCAST
UCAST
TAGON
RxDescCountMask
ABORT
SHORT
LIMIT
MIIER
OVRUN
NIBON
COLON
CRCOK
RxSizeMask

Definition at line 167 of file sis190.h.

                    {
        /* _Desc.status */
        OWNbit            = 0x80000000, // RXOWN/TXOWN
        INTbit            = 0x40000000, // RXINT/TXINT
        CRCbit            = 0x00020000, // CRCOFF/CRCEN
        PADbit            = 0x00010000, // PREADD/PADEN
        /* _Desc.size */
        RingEnd          = 0x80000000,
        /* TxDesc.status */
        LSEN                = 0x08000000, // TSO ? -- FR
        IPCS                = 0x04000000,
        TCPCS              = 0x02000000,
        UDPCS              = 0x01000000,
        BSTEN              = 0x00800000,
        EXTEN              = 0x00400000,
        DEFEN              = 0x00200000,
        BKFEN              = 0x00100000,
        CRSEN              = 0x00080000,
        COLEN              = 0x00040000,
        THOL3              = 0x30000000,
        THOL2              = 0x20000000,
        THOL1              = 0x10000000,
        THOL0              = 0x00000000,
 
        WND          = 0x00080000,
        TABRT              = 0x00040000,
        FIFO                = 0x00020000,
        LINK                = 0x00010000,
        ColCountMask        = 0x0000ffff,
        /* RxDesc.status */
        IPON                = 0x20000000,
        TCPON              = 0x10000000,
        UDPON              = 0x08000000,
        Wakup              = 0x00400000,
        Magic              = 0x00200000,
        Pause              = 0x00100000,
        DEFbit            = 0x00200000,
        BCAST              = 0x000c0000,
        MCAST              = 0x00080000,
        UCAST              = 0x00040000,
        /* RxDesc.PSize */
        TAGON              = 0x80000000,
        RxDescCountMask  = 0x7f000000, // multi-desc pkt when > 1 ? -- FR
        ABORT              = 0x00800000,
        SHORT              = 0x00400000,
        LIMIT              = 0x00200000,
        MIIER              = 0x00100000,
        OVRUN              = 0x00080000,
        NIBON              = 0x00040000,
        COLON              = 0x00020000,
        CRCOK              = 0x00010000,
        RxSizeMask    = 0x0000ffff
        /*
        * The asic could apparently do vlan, TSO, jumbo (sis191 only) and
        * provide two (unused with Linux) Tx queues. No publicly
        * available documentation alas.
        */
};

sis190_eeprom_access_register_bits

enum sis190_eeprom_access_register_bits

Enumerator
EECS
EECLK
EEDO
EEDI
EEREQ
EEROP
EEWOP

Definition at line 226 of file sis190.h.

                                        {
        EECS        = 0x00000001,   // unused
        EECLK      = 0x00000002,   // unused
        EEDO        = 0x00000008,   // unused
        EEDI        = 0x00000004,   // unused
        EEREQ      = 0x00000080,
        EEROP      = 0x00000200,
        EEWOP      = 0x00000100    // unused
};

sis190_eeprom_address

enum sis190_eeprom_address

Enumerator
EEPROMSignature
EEPROMCLK
EEPROMInfo
EEPROMMACAddr

Definition at line 237 of file sis190.h.

                           {
        EEPROMSignature  = 0x00,
        EEPROMCLK      = 0x01, // unused
        EEPROMInfo    = 0x02,
        EEPROMMACAddr      = 0x03
};

sis190_feature

enum sis190_feature

Enumerator
F_HAS_RGMII
F_PHY_88E1111
F_PHY_BCM5461

Definition at line 244 of file sis190.h.

                    {
        F_HAS_RGMII  = 1,
        F_PHY_88E1111      = 2,
        F_PHY_BCM5461      = 4
};

sis190_phy_type

enum sis190_phy_type

Enumerator
UNKNOWN
HOME
LAN
MIX

Definition at line 277 of file sis190.h.

                     {
        UNKNOWN  = 0x00,
        HOME        = 0x01,
        LAN  = 0x02,
        MIX  = 0x03
};

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL_ANY

)

sis190_phy_task()

void sis190_phy_task ( struct sis190_private * tp )

static

References tp.

sis190_free()

void sis190_free ( struct net_device * dev )

static

sis190_init_rxfilter()

void sis190_init_rxfilter ( struct net_device * dev )

inlinestatic

Variable Documentation

mii_chip_table

struct mii_chip_info mii_chip_table[]

static

Initial value:

= {
        { "Atheros PHY",          { 0x004d, 0xd010 }, LAN, 0 },
        { "Atheros PHY AR8012",   { 0x004d, 0xd020 }, LAN, 0 },
        { "Broadcom PHY BCM5461", { 0x0020, 0x60c0 }, LAN, F_PHY_BCM5461 },
        { "Broadcom PHY AC131",   { 0x0143, 0xbc70 }, LAN, 0 },
        { "Agere PHY ET1101B",    { 0x0282, 0xf010 }, LAN, 0 },
        { "Marvell PHY 88E1111",  { 0x0141, 0x0cc0 }, LAN, F_PHY_88E1111 },
        { "Realtek PHY RTL8201",  { 0x0000, 0x8200 }, LAN, 0 },
        { NULL, { 0x00, 0x00 }, 0, 0 }
}

Referenced by sis190_init_phy(), and sis900_probe().