nic.h File Reference

#include <stdint.h>
#include <string.h>
#include <stdio.h>
#include <byteswap.h>
#include <ipxe/pci.h>
#include <ipxe/isapnp.h>
#include <ipxe/isa.h>
#include <ipxe/eisa.h>
#include <ipxe/mca.h>
#include <ipxe/io.h>

Go to the source code of this file.

Data Structures
struct	nic
struct	nic_operations

Macros
#define	NIC_H
#define	NIC_FAKE_BSS_PTR(type)   ( ( type * ) legacy_nic.fake_bss )
#define	NIC_FAKE_BSS(type)   ( * NIC_FAKE_BSS_PTR ( type ) )
#define	PCI_DRIVER(_name, _ids, _class)
#define	ISAPNP_DRIVER(_name, _ids)
#define	EISA_DRIVER(_name, _ids)
#define	MCA_DRIVER(_name, _ids)
#define	ISA_DRIVER(_name, _probe_addrs, _probe_addr, _vendor_id, _prod_id)
#define	DRIVER(_name_text, _unused2, _unused3, _name, _probe, _disable, _fake_bss)

Typedefs
typedef enum duplex	duplex_t

Enumerations
enum	irq_action_t { DISABLE = 0, ENABLE, FORCE }
enum	duplex { HALF_DUPLEX = 1, FULL_DUPLEX }

Functions
	FILE_LICENCE (GPL2_OR_LATER)
static int	eth_poll (int retrieve)
static void	eth_transmit (const char *dest, unsigned int type, unsigned int size, const void *packet)
int	dummy_connect (struct nic *nic)
void	dummy_irq (struct nic *nic, irq_action_t irq_action)
int	legacy_probe (void *hwdev, void(*set_drvdata)(void *hwdev, void *priv), struct device *dev, int(*probe)(struct nic *nic, void *hwdev), void(*disable)(struct nic *nic, void *hwdev), size_t fake_bss_len)
void	legacy_remove (void *hwdev, void *(*get_drvdata)(void *hwdev), void(*disable)(struct nic *nic, void *hwdev))
static void	legacy_pci_set_drvdata (void *hwdev, void *priv)
static void *	legacy_pci_get_drvdata (void *hwdev)
static void	legacy_isapnp_set_drvdata (void *hwdev, void *priv)
static void *	legacy_isapnp_get_drvdata (void *hwdev)
static void	legacy_eisa_set_drvdata (void *hwdev, void *priv)
static void *	legacy_eisa_get_drvdata (void *hwdev)
static void	legacy_mca_set_drvdata (void *hwdev, void *priv)
static void *	legacy_mca_get_drvdata (void *hwdev)
static void	legacy_isa_set_drvdata (void *hwdev, void *priv)
static void *	legacy_isa_get_drvdata (void *hwdev)

Variables
struct {
}	no_fake_bss
struct nic	legacy_nic

Macro Definition Documentation

NIC_H

#define NIC_H

Definition at line 21 of file nic.h.

NIC_FAKE_BSS_PTR

#define NIC_FAKE_BSS_PTR

(

type

)

( ( type * ) legacy_nic.fake_bss )

Definition at line 64 of file nic.h.

NIC_FAKE_BSS

#define NIC_FAKE_BSS

(

type

)

( * NIC_FAKE_BSS_PTR ( type ) )

Definition at line 65 of file nic.h.

PCI_DRIVER

#define PCI_DRIVER	(		_name,
			_ids,
			_class
	)

Value:

static inline int                                                 \
        _name ## _pci_legacy_probe ( struct pci_device *pci );            \
        static inline void                                                \
        _name ## _pci_legacy_remove ( struct pci_device *pci );           \
        struct pci_driver _name __pci_driver = {                          \
                .ids = _ids,                                              \
                .id_count = sizeof ( _ids ) / sizeof ( _ids[0] ),         \
                .probe = _name ## _pci_legacy_probe,                      \
                .remove = _name ## _pci_legacy_remove,                    \
        };                                                                \
        REQUIRE_OBJECT ( pci );

Definition at line 105 of file nic.h.

ISAPNP_DRIVER

#define ISAPNP_DRIVER	(		_name,
			_ids
	)

Value:

static inline int                                                 \
        _name ## _isapnp_legacy_probe ( struct isapnp_device *isapnp,     \
                                        const struct isapnp_device_id *id ); \
        static inline void                                                \
        _name ## _isapnp_legacy_remove ( struct isapnp_device *isapnp );  \
        struct isapnp_driver _name __isapnp_driver = {                    \
                .ids = _ids,                                              \
                .id_count = sizeof ( _ids ) / sizeof ( _ids[0] ),         \
                .probe = _name ## _isapnp_legacy_probe,                   \
                .remove = _name ## _isapnp_legacy_remove,                 \
        };                                                                \
        REQUIRE_OBJECT ( isapnp );

Definition at line 125 of file nic.h.

EISA_DRIVER

#define EISA_DRIVER	(		_name,
			_ids
	)

Value:

static inline int                                                 \
        _name ## _eisa_legacy_probe ( struct eisa_device *eisa,           \
                                      const struct eisa_device_id *id );  \
        static inline void                                                \
        _name ## _eisa_legacy_remove ( struct eisa_device *eisa );        \
        struct eisa_driver _name __eisa_driver = {                        \
                .ids = _ids,                                              \
                .id_count = sizeof ( _ids ) / sizeof ( _ids[0] ),         \
                .probe = _name ## _eisa_legacy_probe,                     \
                .remove = _name ## _eisa_legacy_remove,                   \
        };                                                                \
        REQUIRE_OBJECT ( eisa );

Definition at line 146 of file nic.h.

MCA_DRIVER

#define MCA_DRIVER	(		_name,
			_ids
	)

Value:

static inline int                                                 \
        _name ## _mca_legacy_probe ( struct mca_device *mca,              \
                                     const struct mca_device_id *id );    \
        static inline void                                                \
        _name ## _mca_legacy_remove ( struct mca_device *mca );           \
        struct mca_driver _name __mca_driver = {                          \
                .ids = _ids,                                              \
                .id_count = sizeof ( _ids ) / sizeof ( _ids[0] ),         \
                .probe = _name ## _mca_legacy_probe,                      \
                .remove = _name ## _mca_legacy_remove,                    \
        };                                                                \
        REQUIRE_OBJECT ( mca );

Definition at line 167 of file nic.h.

ISA_DRIVER

#define ISA_DRIVER	(		_name,
			_probe_addrs,
			_probe_addr,
			_vendor_id,
			_prod_id
	)

Value:

static inline int                                                 \
        _name ## _isa_legacy_probe ( struct isa_device *isa );            \
        static inline int                                                 \
        _name ## _isa_legacy_probe_at_addr ( struct isa_device *isa ) {   \
                if ( ! _probe_addr ( isa->ioaddr ) )                      \
                        return -ENODEV;                                   \
                return _name ## _isa_legacy_probe ( isa );                \
        }                                                                 \
        static inline void                                                \
        _name ## _isa_legacy_remove ( struct isa_device *isa );           \
        static const char _name ## _text[];                               \
        struct isa_driver _name __isa_driver = {                          \
                .name = _name ## _text,                                   \
                .probe_addrs = _probe_addrs,                              \
                .addr_count = ( sizeof ( _probe_addrs ) /                 \
                                sizeof ( _probe_addrs[0] ) ),             \
                .vendor_id = _vendor_id,                                  \
                .prod_id = _prod_id,                                      \
                .probe = _name ## _isa_legacy_probe_at_addr,              \
                .remove = _name ## _isa_legacy_remove,                    \
        };                                                                \
        REQUIRE_OBJECT ( isa );

Definition at line 188 of file nic.h.

DRIVER

#define DRIVER	(		_name_text,
			_unused2,
			_unused3,
			_name,
			_probe,
			_disable,
			_fake_bss
	)

Definition at line 220 of file nic.h.

Typedef Documentation

duplex_t

typedef enum duplex duplex_t

Enumeration Type Documentation

irq_action_t

enum irq_action_t

Enumerator
DISABLE
ENABLE
FORCE

Definition at line 34 of file nic.h.

             {
        DISABLE = 0,
        ENABLE,
        FORCE
} irq_action_t;

duplex

enum duplex

Enumerator
HALF_DUPLEX
FULL_DUPLEX

Definition at line 40 of file nic.h.

                    {
        HALF_DUPLEX = 1,
        FULL_DUPLEX
} duplex_t;

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER

)

eth_poll()

static int eth_poll ( int  retrieve )

inlinestatic

Definition at line 78 of file nic.h.

                                            {
        struct nic *nic = &legacy_nic;
        return nic->nic_op->poll ( nic, retrieve );
}

References legacy_nic, nic::nic_op, and nic_operations::poll.

eth_transmit()

static void eth_transmit ( const char *  dest, unsigned int  type, unsigned int  size, const void *  packet  )

inlinestatic

Definition at line 83 of file nic.h.

                                                                          {
        struct nic *nic = &legacy_nic;
        nic->nic_op->transmit ( nic, dest, type, size, packet );
}

References dest, legacy_nic, nic::nic_op, nic::packet, size, nic_operations::transmit, and type.

dummy_connect()

int dummy_connect

(

struct nic *

nic

)

dummy_irq()

void dummy_irq	(	struct nic *	nic,
		irq_action_t	irq_action
	)

legacy_probe()

int legacy_probe	(	void *	hwdev,
		void(*)(void *hwdev, void *priv)	set_drvdata,
		struct device *	dev,
		int(*)(struct nic *nic, void *hwdev)	probe,
		void(*)(struct nic *nic, void *hwdev)	disable,
		size_t	fake_bss_len
	)

Definition at line 83 of file legacy.c.

                                         {
        struct net_device *netdev;
        struct nic *nic;
        int rc;

        if ( legacy_registered ) {
                rc = -EBUSY;
                goto err_registered;
        }

        netdev = alloc_etherdev ( 0 );
        if ( ! netdev ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        netdev_init ( netdev, &legacy_operations );
        nic = &legacy_nic;
        netdev->priv = nic;
        memset ( nic, 0, sizeof ( *nic ) );
        set_drvdata ( hwdev, netdev );
        netdev->dev = dev;

        nic->node_addr = netdev->hw_addr;
        nic->irqno = dev->desc.irq;

        if ( fake_bss_len ) {
                nic->fake_bss = malloc_phys ( fake_bss_len, PAGE_SIZE );
                if ( ! nic->fake_bss ) {
                        rc = -ENOMEM;
                        goto err_fake_bss;
                }
        }
        nic->fake_bss_len = fake_bss_len;

        if ( ! probe ( nic, hwdev ) ) {
                rc = -ENODEV;
                goto err_probe;
        }

        /* Overwrite the IRQ number.  Some legacy devices set
         * nic->irqno to 0 in the probe routine to indicate that they
         * don't support interrupts; doing this allows the timer
         * interrupt to be used instead.
         */
        dev->desc.irq = nic->irqno;

        if ( ( rc = register_netdev ( netdev ) ) != 0 )
                goto err_register;

        /* Mark as link up; legacy devices don't handle link state */
        netdev_link_up ( netdev );

        /* Do not remove this message */
        printf ( "WARNING: Using legacy NIC wrapper on %s\n",
                 netdev->ll_protocol->ntoa ( nic->node_addr ) );

        legacy_registered = 1;
        return 0;

 err_register:
        disable ( nic, hwdev );
 err_probe:
        if ( fake_bss_len )
                free_phys ( nic->fake_bss, fake_bss_len );
 err_fake_bss:
        netdev_nullify ( netdev );
        netdev_put ( netdev );
 err_alloc:
 err_registered:
        return rc;
}

References alloc_etherdev(), device::desc, net_device::dev, EBUSY, ENODEV, ENOMEM, nic::fake_bss, nic::fake_bss_len, free_phys(), net_device::hw_addr, device_description::irq, nic::irqno, legacy_nic, legacy_operations, legacy_registered, net_device::ll_protocol, malloc_phys(), memset(), netdev, netdev_init(), netdev_link_up(), netdev_nullify(), netdev_put(), nic::node_addr, ll_protocol::ntoa, PAGE_SIZE, printf(), net_device::priv, rc, and register_netdev().

Referenced by t509_probe().

legacy_remove()

void legacy_remove	(	void *	hwdev,
		void *(*)(void *hwdev)	get_drvdata,
		void(*)(struct nic *nic, void *hwdev)	disable
	)

Definition at line 160 of file legacy.c.

                                                                           {
        struct net_device *netdev = get_drvdata ( hwdev );
        struct nic *nic = netdev->priv;

        unregister_netdev ( netdev );
        disable ( nic, hwdev );
        if ( nic->fake_bss_len )
                free_phys ( nic->fake_bss, nic->fake_bss_len );
        netdev_nullify ( netdev );
        netdev_put ( netdev );
        legacy_registered = 0;
}

References nic::fake_bss, nic::fake_bss_len, free_phys(), legacy_registered, netdev, netdev_nullify(), netdev_put(), net_device::priv, and unregister_netdev().

Referenced by t509_remove().

legacy_pci_set_drvdata()

static void legacy_pci_set_drvdata ( void *  hwdev, void *  priv  )

inlinestatic

Definition at line 118 of file nic.h.

                                                                      {
        pci_set_drvdata ( hwdev, priv );
}

References pci_set_drvdata(), and priv.

legacy_pci_get_drvdata()

static void* legacy_pci_get_drvdata ( void *  hwdev )

inlinestatic

Definition at line 121 of file nic.h.

                                                            {
        return pci_get_drvdata ( hwdev );
}

References pci_get_drvdata().

legacy_isapnp_set_drvdata()

static void legacy_isapnp_set_drvdata ( void *  hwdev, void *  priv  )

inlinestatic

Definition at line 139 of file nic.h.

                                                                         {
        isapnp_set_drvdata ( hwdev, priv );
}

References isapnp_set_drvdata(), and priv.

legacy_isapnp_get_drvdata()

static void* legacy_isapnp_get_drvdata ( void *  hwdev )

inlinestatic

Definition at line 142 of file nic.h.

                                                               {
        return isapnp_get_drvdata ( hwdev );
}

References isapnp_get_drvdata().

legacy_eisa_set_drvdata()

static void legacy_eisa_set_drvdata ( void *  hwdev, void *  priv  )

inlinestatic

Definition at line 160 of file nic.h.

                                                                       {
        eisa_set_drvdata ( hwdev, priv );
}

References eisa_set_drvdata(), and priv.

legacy_eisa_get_drvdata()

static void* legacy_eisa_get_drvdata ( void *  hwdev )

inlinestatic

Definition at line 163 of file nic.h.

                                                             {
        return eisa_get_drvdata ( hwdev );
}

References eisa_get_drvdata().

legacy_mca_set_drvdata()

static void legacy_mca_set_drvdata ( void *  hwdev, void *  priv  )

inlinestatic

Definition at line 181 of file nic.h.

                                                                      {
        mca_set_drvdata ( hwdev, priv );
}

References mca_set_drvdata(), and priv.

legacy_mca_get_drvdata()

static void* legacy_mca_get_drvdata ( void *  hwdev )

inlinestatic

Definition at line 184 of file nic.h.

                                                            {
        return mca_get_drvdata ( hwdev );
}

References mca_get_drvdata().

legacy_isa_set_drvdata()

static void legacy_isa_set_drvdata ( void *  hwdev, void *  priv  )

inlinestatic

Definition at line 212 of file nic.h.

                                                                      {
        isa_set_drvdata ( hwdev, priv );
}

References isa_set_drvdata(), and priv.

legacy_isa_get_drvdata()

static void* legacy_isa_get_drvdata ( void *  hwdev )

inlinestatic

Definition at line 215 of file nic.h.

                                                            {
        return isa_get_drvdata ( hwdev );
}

References isa_get_drvdata().

Variable Documentation

no_fake_bss

struct { ... } no_fake_bss

legacy_nic

struct nic legacy_nic

Definition at line 22 of file legacy.c.

Referenced by eth_poll(), eth_transmit(), and legacy_probe().