lan78xx.c File Reference

Microchip LAN78xx USB Ethernet driver. More...

#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <ipxe/ethernet.h>
#include <ipxe/usb.h>
#include <ipxe/usbnet.h>
#include "lan78xx.h"

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	lan78xx_eeprom_fetch_mac (struct smscusb_device *smscusb)
	Fetch MAC address from EEPROM. More...
static int	lan78xx_fetch_mac (struct smscusb_device *smscusb)
	Fetch MAC address. More...
static int	lan78xx_reset (struct smscusb_device *smscusb)
	Reset device. More...
static int	lan78xx_open (struct net_device *netdev)
	Open network device. More...
static void	lan78xx_close (struct net_device *netdev)
	Close network device. More...
static int	lan78xx_probe (struct usb_function *func, struct usb_configuration_descriptor *config)
	Probe device. More...
static void	lan78xx_remove (struct usb_function *func)
	Remove device. More...

Variables
static struct net_device_operations	lan78xx_operations
	LAN78xx network device operations. More...
static struct usb_device_id	lan78xx_ids []
	LAN78xx device IDs. More...
struct usb_driver lan78xx_driver	__usb_driver
	LAN78xx driver. More...

Detailed Description

Microchip LAN78xx USB Ethernet driver.

Definition in file lan78xx.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

lan78xx_eeprom_fetch_mac()

static int lan78xx_eeprom_fetch_mac ( struct smscusb_device *  smscusb )

static

Fetch MAC address from EEPROM.

Parameters

smscusb

SMSC USB device

Return values

rc	Return status code

Definition at line 54 of file lan78xx.c.

                                                                       {
        uint32_t hw_cfg;
        uint32_t orig_hw_cfg;
        int rc;

        /* Read original HW_CFG value */
        if ( ( rc = smscusb_readl ( smscusb, LAN78XX_HW_CFG, &hw_cfg ) ) != 0 )
                goto err_read_hw_cfg;
        orig_hw_cfg = hw_cfg;

        /* Temporarily disable LED0 and LED1 (which share physical
         * pins with EEDO and EECLK respectively).
         */
        hw_cfg &= ~( LAN78XX_HW_CFG_LED0_EN | LAN78XX_HW_CFG_LED1_EN );
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_HW_CFG, hw_cfg ) ) != 0 )
                goto err_write_hw_cfg;

        /* Fetch MAC address from EEPROM */
        if ( ( rc = smscusb_eeprom_fetch_mac ( smscusb,
                                               LAN78XX_E2P_BASE ) ) != 0 )
                goto err_fetch_mac;

 err_fetch_mac:
        smscusb_writel ( smscusb, LAN78XX_HW_CFG, orig_hw_cfg );
 err_write_hw_cfg:
 err_read_hw_cfg:
        return rc;
}

References LAN78XX_E2P_BASE, LAN78XX_HW_CFG, LAN78XX_HW_CFG_LED0_EN, LAN78XX_HW_CFG_LED1_EN, rc, smscusb_eeprom_fetch_mac(), smscusb_readl(), and smscusb_writel().

Referenced by lan78xx_fetch_mac().

lan78xx_fetch_mac()

static int lan78xx_fetch_mac ( struct smscusb_device *  smscusb )

static

Fetch MAC address.

Parameters

smscusb

SMSC USB device

Return values

rc	Return status code

Definition at line 89 of file lan78xx.c.

                                                                {
        struct net_device *netdev = smscusb->netdev;
        int rc;

        /* Read MAC address from EEPROM, if present */
        if ( ( rc = lan78xx_eeprom_fetch_mac ( smscusb ) ) == 0 )
                return 0;

        /* Read MAC address from OTP, if present */
        if ( ( rc = smscusb_otp_fetch_mac ( smscusb, LAN78XX_OTP_BASE ) ) == 0 )
                return 0;

        /* Read MAC address from device tree, if present */
        if ( ( rc = smscusb_fdt_fetch_mac ( smscusb ) ) == 0 )
                return 0;

        /* Otherwise, generate a random MAC address */
        eth_random_addr ( netdev->hw_addr );
        DBGC ( smscusb, "LAN78XX %p using random MAC %s\n",
               smscusb, eth_ntoa ( netdev->hw_addr ) );
        return 0;
}

References DBGC, eth_ntoa(), eth_random_addr(), net_device::hw_addr, lan78xx_eeprom_fetch_mac(), LAN78XX_OTP_BASE, netdev, smscusb_device::netdev, rc, smscusb_fdt_fetch_mac(), and smscusb_otp_fetch_mac().

Referenced by lan78xx_probe().

lan78xx_reset()

static int lan78xx_reset ( struct smscusb_device *  smscusb )

static

Reset device.

Parameters

smscusb

SMSC USB device

Return values

rc	Return status code

Definition at line 125 of file lan78xx.c.

                                                            {
        uint32_t hw_cfg;
        unsigned int i;
        int rc;

        /* Reset device */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_HW_CFG,
                                     LAN78XX_HW_CFG_LRST ) ) != 0 )
                return rc;

        /* Wait for reset to complete */
        for ( i = 0 ; i < LAN78XX_RESET_MAX_WAIT_MS ; i++ ) {

                /* Check if reset has completed */
                if ( ( rc = smscusb_readl ( smscusb, LAN78XX_HW_CFG,
                                            &hw_cfg ) ) != 0 )
                        return rc;
                if ( ! ( hw_cfg & LAN78XX_HW_CFG_LRST ) )
                        return 0;

                /* Delay */
                mdelay ( 1 );
        }

        DBGC ( smscusb, "LAN78XX %p timed out waiting for reset\n",
               smscusb );
        return -ETIMEDOUT;
}

References DBGC, ETIMEDOUT, LAN78XX_HW_CFG, LAN78XX_HW_CFG_LRST, LAN78XX_RESET_MAX_WAIT_MS, mdelay(), rc, smscusb_readl(), and smscusb_writel().

Referenced by lan78xx_close(), lan78xx_open(), and lan78xx_probe().

lan78xx_open()

static int lan78xx_open ( struct net_device *  netdev )

static

Open network device.

Parameters

netdev

Network device

Return values

rc	Return status code

Definition at line 167 of file lan78xx.c.

                                                      {
        struct smscusb_device *smscusb = netdev->priv;
        uint32_t usb_cfg0;
        int rc;

        /* Clear stored interrupt status */
        smscusb->int_sts = 0;

        /* Configure bulk IN empty response */
        if ( ( rc = smscusb_readl ( smscusb, LAN78XX_USB_CFG0,
                                    &usb_cfg0 ) ) != 0 )
                goto err_usb_cfg0_read;
        usb_cfg0 |= LAN78XX_USB_CFG0_BIR;
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_USB_CFG0,
                                     usb_cfg0 ) ) != 0 )
                goto err_usb_cfg0_write;

        /* Open USB network device */
        if ( ( rc = usbnet_open ( &smscusb->usbnet ) ) != 0 ) {
                DBGC ( smscusb, "LAN78XX %p could not open: %s\n",
                       smscusb, strerror ( rc ) );
                goto err_open;
        }

        /* Configure interrupt endpoint */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_INT_EP_CTL,
                                     ( LAN78XX_INT_EP_CTL_RDFO_EN |
                                       LAN78XX_INT_EP_CTL_PHY_EN ) ) ) != 0 )
                goto err_int_ep_ctl;

        /* Configure bulk IN delay */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_BULK_IN_DLY,
                                     LAN78XX_BULK_IN_DLY_SET ( 0 ) ) ) != 0 )
                goto err_bulk_in_dly;

        /* Enable automatic speed and duplex detection */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_MAC_CR,
                                     ( LAN78XX_MAC_CR_ADP |
                                       LAN78XX_MAC_CR_ADD |
                                       LAN78XX_MAC_CR_ASD ) ) ) != 0 )
                goto err_mac_cr;

        /* Configure receive filters */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_RFE_CTL,
                                     ( LAN78XX_RFE_CTL_AB |
                                       LAN78XX_RFE_CTL_AM |
                                       LAN78XX_RFE_CTL_AU ) ) ) != 0 )
                goto err_rfe_ctl;

        /* Configure receive FIFO */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_FCT_RX_CTL,
                                     ( LAN78XX_FCT_RX_CTL_EN |
                                       LAN78XX_FCT_RX_CTL_BAD ) ) ) != 0 )
                goto err_fct_rx_ctl;

        /* Configure transmit FIFO */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_FCT_TX_CTL,
                                     LAN78XX_FCT_TX_CTL_EN ) ) != 0 )
                goto err_fct_tx_ctl;

        /* Configure receive datapath */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_MAC_RX,
                                     ( LAN78XX_MAC_RX_MAX_SIZE_DEFAULT |
                                       LAN78XX_MAC_RX_FCS |
                                       LAN78XX_MAC_RX_EN ) ) ) != 0 )
                goto err_mac_rx;

        /* Configure transmit datapath */
        if ( ( rc = smscusb_writel ( smscusb, LAN78XX_MAC_TX,
                                     LAN78XX_MAC_TX_EN ) ) != 0 )
                goto err_mac_tx;

        /* Set MAC address */
        if ( ( rc = smscusb_set_address ( smscusb,
                                          LAN78XX_RX_ADDR_BASE ) ) != 0 )
                goto err_set_address;

        /* Set MAC address perfect filter */
        if ( ( rc = smscusb_set_filter ( smscusb,
                                         LAN78XX_ADDR_FILT_BASE ) ) != 0 )
                goto err_set_filter;

        /* Enable PHY interrupts and update link status */
        if ( ( rc = smscusb_mii_open ( smscusb, LAN78XX_MII_PHY_INTR_MASK,
                                       ( LAN78XX_PHY_INTR_ENABLE |
                                         LAN78XX_PHY_INTR_LINK |
                                         LAN78XX_PHY_INTR_ANEG_ERR |
                                         LAN78XX_PHY_INTR_ANEG_DONE ) ) ) != 0 )
                goto err_mii_open;

        return 0;

 err_mii_open:
 err_set_filter:
 err_set_address:
 err_mac_tx:
 err_mac_rx:
 err_fct_tx_ctl:
 err_fct_rx_ctl:
 err_rfe_ctl:
 err_mac_cr:
 err_bulk_in_dly:
 err_int_ep_ctl:
        usbnet_close ( &smscusb->usbnet );
 err_open:
 err_usb_cfg0_write:
 err_usb_cfg0_read:
        lan78xx_reset ( smscusb );
        return rc;
}

References DBGC, smscusb_device::int_sts, LAN78XX_ADDR_FILT_BASE, LAN78XX_BULK_IN_DLY, LAN78XX_BULK_IN_DLY_SET, LAN78XX_FCT_RX_CTL, LAN78XX_FCT_RX_CTL_BAD, LAN78XX_FCT_RX_CTL_EN, LAN78XX_FCT_TX_CTL, LAN78XX_FCT_TX_CTL_EN, LAN78XX_INT_EP_CTL, LAN78XX_INT_EP_CTL_PHY_EN, LAN78XX_INT_EP_CTL_RDFO_EN, LAN78XX_MAC_CR, LAN78XX_MAC_CR_ADD, LAN78XX_MAC_CR_ADP, LAN78XX_MAC_CR_ASD, LAN78XX_MAC_RX, LAN78XX_MAC_RX_EN, LAN78XX_MAC_RX_FCS, LAN78XX_MAC_RX_MAX_SIZE_DEFAULT, LAN78XX_MAC_TX, LAN78XX_MAC_TX_EN, LAN78XX_MII_PHY_INTR_MASK, LAN78XX_PHY_INTR_ANEG_DONE, LAN78XX_PHY_INTR_ANEG_ERR, LAN78XX_PHY_INTR_ENABLE, LAN78XX_PHY_INTR_LINK, lan78xx_reset(), LAN78XX_RFE_CTL, LAN78XX_RFE_CTL_AB, LAN78XX_RFE_CTL_AM, LAN78XX_RFE_CTL_AU, LAN78XX_RX_ADDR_BASE, LAN78XX_USB_CFG0, LAN78XX_USB_CFG0_BIR, netdev, net_device::priv, rc, smscusb_mii_open(), smscusb_readl(), smscusb_set_address(), smscusb_set_filter(), smscusb_writel(), strerror(), smscusb_device::usbnet, usbnet_close(), and usbnet_open().

lan78xx_close()

static void lan78xx_close ( struct net_device *  netdev )

static

Close network device.

Parameters

netdev

Network device

Definition at line 283 of file lan78xx.c.

                                                        {
        struct smscusb_device *smscusb = netdev->priv;

        /* Close USB network device */
        usbnet_close ( &smscusb->usbnet );

        /* Dump statistics (for debugging) */
        if ( DBG_LOG )
                smsc75xx_dump_statistics ( smscusb );

        /* Reset device */
        lan78xx_reset ( smscusb );
}

References DBG_LOG, lan78xx_reset(), netdev, net_device::priv, smsc75xx_dump_statistics(), smscusb_device::usbnet, and usbnet_close().

lan78xx_probe()

static int lan78xx_probe ( struct usb_function *  func, struct usb_configuration_descriptor *  config  )

static

Probe device.

Parameters

func	USB function
config	Configuration descriptor

Return values

rc	Return status code

Definition at line 319 of file lan78xx.c.

                                                                         {
        struct net_device *netdev;
        struct smscusb_device *smscusb;
        int rc;

        /* Allocate and initialise structure */
        netdev = alloc_etherdev ( sizeof ( *smscusb ) );
        if ( ! netdev ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        netdev_init ( netdev, &lan78xx_operations );
        netdev->dev = &func->dev;
        smscusb = netdev->priv;
        memset ( smscusb, 0, sizeof ( *smscusb ) );
        smscusb_init ( smscusb, netdev, func, &smsc75xx_in_operations );
        smscusb_mii_init ( smscusb, LAN78XX_MII_BASE,
                           LAN78XX_MII_PHY_INTR_SOURCE );
        usb_refill_init ( &smscusb->usbnet.in, 0, SMSC75XX_IN_MTU,
                          SMSC75XX_IN_MAX_FILL );
        DBGC ( smscusb, "LAN78XX %p on %s\n", smscusb, func->name );

        /* Describe USB network device */
        if ( ( rc = usbnet_describe ( &smscusb->usbnet, config ) ) != 0 ) {
                DBGC ( smscusb, "LAN78XX %p could not describe: %s\n",
                       smscusb, strerror ( rc ) );
                goto err_describe;
        }

        /* Reset device */
        if ( ( rc = lan78xx_reset ( smscusb ) ) != 0 )
                goto err_reset;

        /* Read MAC address */
        if ( ( rc = lan78xx_fetch_mac ( smscusb ) ) != 0 )
                goto err_fetch_mac;

        /* Register network device */
        if ( ( rc = register_netdev ( netdev ) ) != 0 )
                goto err_register;

        usb_func_set_drvdata ( func, netdev );
        return 0;

        unregister_netdev ( netdev );
 err_register:
 err_fetch_mac:
 err_reset:
 err_describe:
        netdev_nullify ( netdev );
        netdev_put ( netdev );
 err_alloc:
        return rc;
}

References alloc_etherdev(), DBGC, net_device::dev, usb_function::dev, ENOMEM, usbnet_device::in, lan78xx_fetch_mac(), LAN78XX_MII_BASE, LAN78XX_MII_PHY_INTR_SOURCE, lan78xx_operations, lan78xx_reset(), memset(), usb_function::name, netdev, netdev_init(), netdev_nullify(), netdev_put(), net_device::priv, rc, register_netdev(), SMSC75XX_IN_MAX_FILL, SMSC75XX_IN_MTU, smsc75xx_in_operations, smscusb_init(), smscusb_mii_init(), strerror(), unregister_netdev(), usb_func_set_drvdata(), usb_refill_init(), smscusb_device::usbnet, and usbnet_describe().

lan78xx_remove()

static void lan78xx_remove ( struct usb_function *  func )

static

Remove device.

Parameters

func	USB function

Definition at line 380 of file lan78xx.c.

                                                         {
        struct net_device *netdev = usb_func_get_drvdata ( func );

        unregister_netdev ( netdev );
        netdev_nullify ( netdev );
        netdev_put ( netdev );
}

References netdev, netdev_nullify(), netdev_put(), unregister_netdev(), and usb_func_get_drvdata().

Variable Documentation

lan78xx_operations

struct net_device_operations lan78xx_operations

static

Initial value:

= {
        .open           = lan78xx_open,
        .close          = lan78xx_close,
        .transmit       = smsc75xx_transmit,
        .poll           = smsc75xx_poll,
}

LAN78xx network device operations.

Definition at line 298 of file lan78xx.c.

Referenced by lan78xx_probe().

lan78xx_ids

struct usb_device_id lan78xx_ids[]

static

Initial value:

= {
        {
                .name = "lan7800",
                .vendor = 0x0424,
                .product = 0x7800,
        },
        {
                .name = "lan7850",
                .vendor = 0x0424,
                .product = 0x7850,
        },
}

LAN78xx device IDs.

Definition at line 389 of file lan78xx.c.

__usb_driver

struct usb_driver lan78xx_driver __usb_driver

Initial value:

= {
        .ids = lan78xx_ids,
        .id_count = ( sizeof ( lan78xx_ids ) / sizeof ( lan78xx_ids[0] ) ),
        .class = USB_CLASS_ID ( 0xff, 0x00, 0xff ),
        .score = USB_SCORE_NORMAL,
        .probe = lan78xx_probe,
        .remove = lan78xx_remove,
}

LAN78xx driver.

Definition at line 403 of file lan78xx.c.