axge.c File Reference

Asix 10/100/1000 USB Ethernet driver. More...

#include <stdint.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <ipxe/netdevice.h>
#include <ipxe/ethernet.h>
#include <ipxe/if_ether.h>
#include <ipxe/profile.h>
#include <ipxe/usb.h>
#include "axge.h"

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	axge_read_register (struct axge_device *axge, unsigned int offset, void *data, size_t len)
	Read register. More...
static int	axge_read_byte (struct axge_device *axge, unsigned int offset, uint8_t *value)
	Read one-byte register. More...
static int	axge_read_word (struct axge_device *axge, unsigned int offset, uint16_t *value)
	Read two-byte register. More...
static int	axge_read_dword (struct axge_device *axge, unsigned int offset, uint32_t *value)
	Read four-byte register. More...
static int	axge_write_register (struct axge_device *axge, unsigned int offset, void *data, size_t len)
	Write register. More...
static int	axge_write_byte (struct axge_device *axge, unsigned int offset, uint8_t value)
	Write one-byte register. More...
static int	axge_write_word (struct axge_device *axge, unsigned int offset, uint16_t value)
	Write two-byte register. More...
static int	axge_write_dword (struct axge_device *axge, unsigned int offset, uint32_t value)
	Write one-byte register. More...
static int	axge_check_link (struct axge_device *axge)
	Get link status. More...
static void	axge_intr_complete (struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
	Complete interrupt transfer. More...
static void	axge_in_complete (struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
	Complete bulk IN transfer. More...
static int	axge_out_transmit (struct axge_device *axge, struct io_buffer *iobuf)
	Transmit packet. More...
static void	axge_out_complete (struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
	Complete bulk OUT transfer. More...
static int	axge_open (struct net_device *netdev)
	Open network device. More...
static void	axge_close (struct net_device *netdev)
	Close network device. More...
static int	axge_transmit (struct net_device *netdev, struct io_buffer *iobuf)
	Transmit packet. More...
static void	axge_poll (struct net_device *netdev)
	Poll for completed and received packets. More...
static int	axge_probe (struct usb_function *func, struct usb_configuration_descriptor *config)
	Probe device. More...
static void	axge_remove (struct usb_function *func)
	Remove device. More...

Variables
static struct profiler axge_intr_profiler	__profiler
	Interrupt completion profiler. More...
static struct axge_bulk_in_control	axge_bicr
	Default bulk IN configuration. More...
static struct usb_endpoint_driver_operations	axge_intr_operations
	Interrupt endpoint operations. More...
static struct usb_endpoint_driver_operations	axge_in_operations
	Bulk IN endpoint operations. More...
static struct usb_endpoint_driver_operations	axge_out_operations
	Bulk OUT endpoint operations. More...
static struct net_device_operations	axge_operations
	AXGE network device operations. More...
static struct usb_device_id	axge_ids []
	AXGE device IDs. More...
struct usb_driver axge_driver	__usb_driver
	AXGE driver. More...

Detailed Description

Asix 10/100/1000 USB Ethernet driver.

Large chunks of functionality are undocumented in the available datasheets. The gaps are deduced from combinations of the Linux driver, the FreeBSD driver, and experimentation with the hardware.

Definition in file axge.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

axge_read_register()

static int axge_read_register ( struct axge_device *  axge, unsigned int  offset, void *  data, size_t  len  )

inlinestatic

Read register.

Parameters

asix	AXGE device
offset	Register offset
data	Data buffer
len	Length of data

Return values

rc	Return status code

Definition at line 92 of file axge.c.

                                                    {

        return usb_control ( axge->usb, AXGE_READ_MAC_REGISTER,
                             offset, len, data, len );
}

References AXGE_READ_MAC_REGISTER, data, len, offset, axge_device::usb, and usb_control().

Referenced by axge_probe(), axge_read_byte(), axge_read_dword(), and axge_read_word().

axge_read_byte()

static int axge_read_byte ( struct axge_device *  axge, unsigned int  offset, uint8_t *  value  )

inlinestatic

Read one-byte register.

Parameters

asix	AXGE device
offset	Register offset
value	Value to fill in

Return values

rc	Return status code

Definition at line 108 of file axge.c.

                                                                         {

        return axge_read_register ( axge, offset, value, sizeof ( *value ) );
}

References axge_read_register(), offset, and value.

Referenced by axge_check_link().

axge_read_word()

static int axge_read_word ( struct axge_device *  axge, unsigned int  offset, uint16_t *  value  )

inlinestatic

Read two-byte register.

Parameters

asix	AXGE device
offset	Register offset
value	Value to fill in

Return values

rc	Return status code

Definition at line 122 of file axge.c.

                                                                          {

        return axge_read_register ( axge, offset, value, sizeof ( *value ) );
}

References axge_read_register(), offset, and value.

axge_read_dword()

static int axge_read_dword ( struct axge_device *  axge, unsigned int  offset, uint32_t *  value  )

inlinestatic

Read four-byte register.

Parameters

asix	AXGE device
offset	Register offset
value	Value to fill in

Return values

rc	Return status code

Definition at line 136 of file axge.c.

                                                                           {

        return axge_read_register ( axge, offset, value, sizeof ( *value ) );
}

References axge_read_register(), offset, and value.

axge_write_register()

static int axge_write_register ( struct axge_device *  axge, unsigned int  offset, void *  data, size_t  len  )

inlinestatic

Write register.

Parameters

asix	AXGE device
offset	Register offset
data	Data buffer
len	Length of data

Return values

rc	Return status code

Definition at line 151 of file axge.c.

                                                     {

        return usb_control ( axge->usb, AXGE_WRITE_MAC_REGISTER,
                             offset, len, data, len );
}

References AXGE_WRITE_MAC_REGISTER, data, len, offset, axge_device::usb, and usb_control().

Referenced by axge_open(), axge_probe(), axge_write_byte(), axge_write_dword(), and axge_write_word().

axge_write_byte()

static int axge_write_byte ( struct axge_device *  axge, unsigned int  offset, uint8_t  value  )

inlinestatic

Write one-byte register.

Parameters

asix	AXGE device
offset	Register offset
value	Value

Return values

rc	Return status code

Definition at line 167 of file axge.c.

                                                                         {

        return axge_write_register ( axge, offset, &value, sizeof ( value ));
}

References axge_write_register(), offset, and value.

Referenced by axge_probe().

axge_write_word()

static int axge_write_word ( struct axge_device *  axge, unsigned int  offset, uint16_t  value  )

inlinestatic

Write two-byte register.

Parameters

asix	AXGE device
offset	Register offset
value	Value

Return values

rc	Return status code

Definition at line 181 of file axge.c.

                                                                          {

        return axge_write_register ( axge, offset, &value, sizeof ( value ));
}

References axge_write_register(), offset, and value.

Referenced by axge_check_link(), axge_close(), axge_open(), and axge_probe().

axge_write_dword()

static int axge_write_dword ( struct axge_device *  axge, unsigned int  offset, uint32_t  value  )

inlinestatic

Write one-byte register.

Parameters

asix	AXGE device
offset	Register offset
value	Value

Return values

rc	Return status code

Definition at line 195 of file axge.c.

                                                                           {

        return axge_write_register ( axge, offset, &value, sizeof ( value ));
}

References axge_write_register(), offset, and value.

axge_check_link()

static int axge_check_link ( struct axge_device *  axge )

static

Get link status.

Parameters

asix	AXGE device

Return values

rc	Return status code

Definition at line 214 of file axge.c.

                                                        {
        struct net_device *netdev = axge->netdev;
        uint8_t plsr;
        uint16_t msr;
        int rc;

        /* Read physical link status register */
        if ( ( rc = axge_read_byte ( axge, AXGE_PLSR, &plsr ) ) != 0 ) {
                DBGC ( axge, "AXGE %p could not read PLSR: %s\n",
                       axge, strerror ( rc ) );
                return rc;
        }

        /* Write medium status register */
        msr = cpu_to_le16 ( AXGE_MSR_FD | AXGE_MSR_RFC | AXGE_MSR_TFC |
                            AXGE_MSR_RE );
        if ( plsr & AXGE_PLSR_EPHY_1000 ) {
                msr |= cpu_to_le16 ( AXGE_MSR_GM );
        } else if ( plsr & AXGE_PLSR_EPHY_100 ) {
                msr |= cpu_to_le16 ( AXGE_MSR_PS );
        }
        if ( ( rc = axge_write_word ( axge, AXGE_MSR, msr ) ) != 0 ) {
                DBGC ( axge, "AXGE %p could not write MSR: %s\n",
                       axge, strerror ( rc ) );
                return rc;
        }

        /* Update link status */
        if ( plsr & AXGE_PLSR_EPHY_ANY ) {
                DBGC ( axge, "AXGE %p link up (PLSR %02x MSR %04x)\n",
                       axge, plsr, msr );
                netdev_link_up ( netdev );
        } else {
                DBGC ( axge, "AXGE %p link down (PLSR %02x MSR %04x)\n",
                       axge, plsr, msr );
                netdev_link_down ( netdev );
        }

        return 0;
}

References AXGE_MSR, AXGE_MSR_FD, AXGE_MSR_GM, AXGE_MSR_PS, AXGE_MSR_RE, AXGE_MSR_RFC, AXGE_MSR_TFC, AXGE_PLSR, AXGE_PLSR_EPHY_100, AXGE_PLSR_EPHY_1000, AXGE_PLSR_EPHY_ANY, axge_read_byte(), axge_write_word(), cpu_to_le16, DBGC, netdev, axge_device::netdev, netdev_link_down(), netdev_link_up(), rc, and strerror().

Referenced by axge_open(), axge_poll(), and axge_probe().

axge_intr_complete()

static void axge_intr_complete ( struct usb_endpoint *  ep, struct io_buffer *  iobuf, int  rc  )

static

Complete interrupt transfer.

Parameters

ep	USB endpoint
iobuf	I/O buffer
rc	Completion status code

Definition at line 269 of file axge.c.

                                                                   {
        struct axge_device *axge = container_of ( ep, struct axge_device,
                                                  usbnet.intr );
        struct net_device *netdev = axge->netdev;
        struct axge_interrupt *intr;
        size_t len = iob_len ( iobuf );
        unsigned int link_ok;

        /* Profile completions */
        profile_start ( &axge_intr_profiler );

        /* Ignore packets cancelled when the endpoint closes */
        if ( ! ep->open )
                goto ignore;

        /* Drop packets with errors */
        if ( rc != 0 ) {
                DBGC ( axge, "AXGE %p interrupt failed: %s\n",
                       axge, strerror ( rc ) );
                DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                goto error;
        }

        /* Extract message header */
        if ( len < sizeof ( *intr ) ) {
                DBGC ( axge, "AXGE %p underlength interrupt:\n", axge );
                DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                rc = -EINVAL;
                goto error;
        }
        intr = iobuf->data;

        /* Check magic signature */
        if ( intr->magic != cpu_to_le16 ( AXGE_INTR_MAGIC ) ) {
                DBGC ( axge, "AXGE %p malformed interrupt:\n", axge );
                DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                rc = -EINVAL;
                goto error;
        }

        /* Extract link status */
        link_ok = ( intr->link & cpu_to_le16 ( AXGE_INTR_LINK_PPLS ) );
        if ( ( !! link_ok ) ^ ( !! netdev_link_ok ( netdev ) ) )
                axge->check_link = 1;

        /* Free I/O buffer */
        free_iob ( iobuf );
        profile_stop ( &axge_intr_profiler );

        return;

 error:
        netdev_rx_err ( netdev, iob_disown ( iobuf ), rc );
 ignore:
        free_iob ( iobuf );
        return;
}

References AXGE_INTR_LINK_PPLS, AXGE_INTR_MAGIC, axge_device::check_link, container_of, cpu_to_le16, io_buffer::data, DBGC, DBGC_HDA, EINVAL, error, free_iob(), intr, usbnet_device::intr, iob_disown, iob_len(), len, netdev, axge_device::netdev, netdev_link_ok(), netdev_rx_err(), usb_endpoint::open, profile_start(), profile_stop(), rc, strerror(), and axge_device::usbnet.

axge_in_complete()

static void axge_in_complete ( struct usb_endpoint *  ep, struct io_buffer *  iobuf, int  rc  )

static

Complete bulk IN transfer.

Parameters

ep	USB endpoint
iobuf	I/O buffer
rc	Completion status code

Definition at line 347 of file axge.c.

                                                                 {
        struct axge_device *axge = container_of ( ep, struct axge_device,
                                                  usbnet.in );
        struct net_device *netdev = axge->netdev;
        struct axge_rx_footer *ftr;
        struct axge_rx_descriptor *desc;
        struct io_buffer *pkt;
        unsigned int count;
        unsigned int offset;
        size_t len;
        size_t padded_len;

        /* Profile receive completions */
        profile_start ( &axge_in_profiler );

        /* Ignore packets cancelled when the endpoint closes */
        if ( ! ep->open )
                goto ignore;

        /* Record USB errors against the network device */
        if ( rc != 0 ) {
                DBGC ( axge, "AXGE %p bulk IN failed: %s\n",
                       axge, strerror ( rc ) );
                goto error;
        }

        /* Sanity check */
        if ( iob_len ( iobuf ) < sizeof ( *ftr ) ) {
                DBGC ( axge, "AXGE %p underlength bulk IN:\n", axge );
                DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                rc = -EINVAL;
                goto error;
        }

        /* Parse ftr, strip ftr and descriptors */
        iob_unput ( iobuf, sizeof ( *ftr ) );
        ftr = ( iobuf->data + iob_len ( iobuf ) );
        count = le16_to_cpu ( ftr->count );
        if ( count == 0 ) {
                DBGC ( axge, "AXGE %p zero-packet bulk IN:\n", axge );
                DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                goto ignore;
        }
        offset = le16_to_cpu ( ftr->offset );
        if ( ( iob_len ( iobuf ) < offset ) ||
             ( ( iob_len ( iobuf ) - offset ) < ( count * sizeof ( *desc ) ) )){
                DBGC ( axge, "AXGE %p malformed bulk IN footer:\n", axge );
                DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                rc = -EINVAL;
                goto error;
        }
        desc = ( iobuf->data + offset );
        iob_unput ( iobuf, ( iob_len ( iobuf ) - offset ) );

        /* Process packets */
        for ( ; count-- ; desc++ ) {

                /* Parse descriptor */
                len = ( le16_to_cpu ( desc->len_flags ) & AXGE_RX_LEN_MASK );
                padded_len = ( ( len + AXGE_RX_LEN_PAD_ALIGN - 1 ) &
                               ~( AXGE_RX_LEN_PAD_ALIGN - 1 ) );
                if ( iob_len ( iobuf ) < padded_len ) {
                        DBGC ( axge, "AXGE %p malformed bulk IN descriptor:\n",
                               axge );
                        DBGC_HDA ( axge, 0, iobuf->data, iob_len ( iobuf ) );
                        rc = -EINVAL;
                        goto error;
                }

                /* Check for previous dropped packets */
                if ( desc->len_flags & cpu_to_le16 ( AXGE_RX_CRC_ERROR ) )
                        netdev_rx_err ( netdev, NULL, -EIO );
                if ( desc->len_flags & cpu_to_le16 ( AXGE_RX_DROP_ERROR ) )
                        netdev_rx_err ( netdev, NULL, -ENOBUFS );

                /* Allocate new I/O buffer, if applicable */
                if ( count ) {

                        /* More packets remain: allocate a new buffer */
                        pkt = alloc_iob ( AXGE_IN_RESERVE + len );
                        if ( ! pkt ) {
                                /* Record error and continue */
                                netdev_rx_err ( netdev, NULL, -ENOMEM );
                                iob_pull ( iobuf, padded_len );
                                continue;
                        }
                        iob_reserve ( pkt, AXGE_IN_RESERVE );
                        memcpy ( iob_put ( pkt, len ), iobuf->data, len );
                        iob_pull ( iobuf, padded_len );

                } else {

                        /* This is the last (or only) packet: use this buffer */
                        iob_unput ( iobuf, ( padded_len - len ) );
                        pkt = iob_disown ( iobuf );
                }

                /* Hand off to network stack */
                netdev_rx ( netdev, iob_disown ( pkt ) );
        }

        assert ( iobuf == NULL );
        profile_stop ( &axge_in_profiler );
        return;

 error:
        netdev_rx_err ( netdev, iob_disown ( iobuf ), rc );
 ignore:
        free_iob ( iobuf );
}

References alloc_iob(), assert(), AXGE_IN_RESERVE, AXGE_RX_CRC_ERROR, AXGE_RX_DROP_ERROR, AXGE_RX_LEN_MASK, AXGE_RX_LEN_PAD_ALIGN, container_of, axge_rx_footer::count, count, cpu_to_le16, io_buffer::data, DBGC, DBGC_HDA, desc, EINVAL, EIO, ENOBUFS, ENOMEM, error, free_iob(), usbnet_device::in, iob_disown, iob_len(), iob_pull, iob_put, iob_reserve, iob_unput, le16_to_cpu, len, memcpy(), netdev, axge_device::netdev, netdev_rx(), netdev_rx_err(), NULL, offset, axge_rx_footer::offset, usb_endpoint::open, profile_start(), profile_stop(), rc, strerror(), and axge_device::usbnet.

axge_out_transmit()

static int axge_out_transmit ( struct axge_device *  axge, struct io_buffer *  iobuf  )

static

Transmit packet.

Parameters

asix	AXGE device
iobuf	I/O buffer

Return values

rc	Return status code

Definition at line 471 of file axge.c.

                                                         {
        struct axge_tx_header *hdr;
        size_t len = iob_len ( iobuf );
        int rc;

        /* Profile transmissions */
        profile_start ( &axge_out_profiler );

        /* Prepend header */
        if ( ( rc = iob_ensure_headroom ( iobuf, sizeof ( *hdr ) ) ) != 0 )
                return rc;
        hdr = iob_push ( iobuf, sizeof ( *hdr ) );
        hdr->len = cpu_to_le32 ( len );
        hdr->wtf = 0;

        /* Enqueue I/O buffer */
        if ( ( rc = usb_stream ( &axge->usbnet.out, iobuf, 0 ) ) != 0 )
                return rc;

        profile_stop ( &axge_out_profiler );
        return 0;
}

References cpu_to_le32, hdr, iob_ensure_headroom(), iob_len(), iob_push, len, usbnet_device::out, profile_start(), profile_stop(), rc, usb_stream(), and axge_device::usbnet.

Referenced by axge_transmit().

axge_out_complete()

static void axge_out_complete ( struct usb_endpoint *  ep, struct io_buffer *  iobuf, int  rc  )

static

Complete bulk OUT transfer.

Parameters

ep	USB endpoint
iobuf	I/O buffer
rc	Completion status code

Definition at line 502 of file axge.c.

                                                                  {
        struct axge_device *axge = container_of ( ep, struct axge_device,
                                                  usbnet.out );
        struct net_device *netdev = axge->netdev;

        /* Report TX completion */
        netdev_tx_complete_err ( netdev, iobuf, rc );
}

References container_of, netdev, axge_device::netdev, netdev_tx_complete_err(), usbnet_device::out, rc, and axge_device::usbnet.

axge_open()

static int axge_open ( struct net_device *  netdev )

static

Open network device.

Parameters

netdev

Network device

Return values

rc	Return status code

Definition at line 530 of file axge.c.

                                                   {
        struct axge_device *axge = netdev->priv;
        uint16_t rcr;
        int rc;

        /* Reapply device configuration to avoid transaction errors */
        if ( ( rc = usb_set_configuration ( axge->usb, axge->config ) ) != 0 ) {
                DBGC ( axge, "AXGE %p could not set configuration: %s\n",
                       axge, strerror ( rc ) );
                goto err_set_configuration;
        }

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

        /* Set MAC address */
        if ( ( rc = axge_write_register ( axge, AXGE_NIDR,
                                          netdev->ll_addr, ETH_ALEN ) ) !=0){
                DBGC ( axge, "AXGE %p could not set MAC address: %s\n",
                       axge, strerror ( rc ) );
                goto err_write_mac;
        }

        /* Enable receiver */
        rcr = cpu_to_le16 ( AXGE_RCR_PRO | AXGE_RCR_AMALL |
                            AXGE_RCR_AB | AXGE_RCR_SO );
        if ( ( rc = axge_write_word ( axge, AXGE_RCR, rcr ) ) != 0 ) {
                DBGC ( axge, "AXGE %p could not write RCR: %s\n",
                       axge, strerror ( rc ) );
                goto err_write_rcr;
        }

        /* Update link status */
        if ( ( rc = axge_check_link ( axge ) ) != 0 )
                goto err_check_link;

        return 0;

 err_check_link:
        axge_write_word ( axge, AXGE_RCR, 0 );
 err_write_rcr:
 err_write_mac:
        usbnet_close ( &axge->usbnet );
 err_open:
 err_set_configuration:
        return rc;
}

References axge_check_link(), AXGE_NIDR, AXGE_RCR, AXGE_RCR_AB, AXGE_RCR_AMALL, AXGE_RCR_PRO, AXGE_RCR_SO, axge_write_register(), axge_write_word(), axge_device::config, cpu_to_le16, DBGC, ETH_ALEN, net_device::ll_addr, netdev, net_device::priv, rc, strerror(), axge_device::usb, usb_set_configuration(), axge_device::usbnet, usbnet_close(), and usbnet_open().

axge_close()

static void axge_close ( struct net_device *  netdev )

static

Close network device.

Parameters

netdev

Network device

Definition at line 587 of file axge.c.

                                                     {
        struct axge_device *axge = netdev->priv;

        /* Disable receiver */
        axge_write_word ( axge, AXGE_RCR, 0 );

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

References AXGE_RCR, axge_write_word(), netdev, net_device::priv, axge_device::usbnet, and usbnet_close().

axge_transmit()

static int axge_transmit ( struct net_device *  netdev, struct io_buffer *  iobuf  )

static

Transmit packet.

Parameters

netdev	Network device
iobuf	I/O buffer

Return values

rc	Return status code

Definition at line 604 of file axge.c.

                                                     {
        struct axge_device *axge = netdev->priv;
        int rc;

        /* Transmit packet */
        if ( ( rc = axge_out_transmit ( axge, iobuf ) ) != 0 )
                return rc;

        return 0;
}

References axge_out_transmit(), netdev, net_device::priv, and rc.

axge_poll()

static void axge_poll ( struct net_device *  netdev )

static

Poll for completed and received packets.

Parameters

netdev

Network device

Definition at line 621 of file axge.c.

                                                    {
        struct axge_device *axge = netdev->priv;
        int rc;

        /* Poll USB bus */
        usb_poll ( axge->bus );

        /* Refill endpoints */
        if ( ( rc = usbnet_refill ( &axge->usbnet ) ) != 0 )
                netdev_rx_err ( netdev, NULL, rc );

        /* Update link state, if applicable */
        if ( axge->check_link ) {
                if ( ( rc = axge_check_link ( axge ) ) == 0 ) {
                        axge->check_link = 0;
                } else {
                        netdev_rx_err ( netdev, NULL, rc );
                }
        }
}

References axge_check_link(), axge_device::bus, axge_device::check_link, netdev, netdev_rx_err(), NULL, net_device::priv, rc, usb_poll(), axge_device::usbnet, and usbnet_refill().

axge_probe()

static int axge_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 664 of file axge.c.

                                                                      {
        struct usb_device *usb = func->usb;
        struct net_device *netdev;
        struct axge_device *axge;
        uint16_t epprcr;
        uint8_t csr;
        int rc;

        /* Allocate and initialise structure */
        netdev = alloc_etherdev ( sizeof ( *axge ) );
        if ( ! netdev ) {
                rc = -ENOMEM;
                goto err_alloc;
        }
        netdev_init ( netdev, &axge_operations );
        netdev->dev = &func->dev;
        axge = netdev->priv;
        memset ( axge, 0, sizeof ( *axge ) );
        axge->usb = usb;
        axge->bus = usb->port->hub->bus;
        axge->netdev = netdev;
        axge->config = config->config;
        usbnet_init ( &axge->usbnet, func, &axge_intr_operations,
                      &axge_in_operations, &axge_out_operations );
        usb_refill_init ( &axge->usbnet.intr, 0, 0, AXGE_INTR_MAX_FILL );
        usb_refill_init ( &axge->usbnet.in, AXGE_IN_RESERVE,
                          AXGE_IN_MTU, AXGE_IN_MAX_FILL );
        DBGC ( axge, "AXGE %p on %s\n", axge, func->name );

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

        /* Fetch MAC address */
        if ( ( rc = axge_read_register ( axge, AXGE_NIDR, netdev->hw_addr,
                                         ETH_ALEN ) ) != 0 ) {
                DBGC ( axge, "AXGE %p could not fetch MAC address: %s\n",
                       axge, strerror ( rc ) );
                goto err_read_mac;
        }

        /* Power up PHY */
        if ( ( rc = axge_write_word ( axge, AXGE_EPPRCR, 0 ) ) != 0 ) {
                DBGC ( axge, "AXGE %p could not write EPPRCR: %s\n",
                       axge, strerror ( rc ) );
                goto err_write_epprcr_off;
        }
        epprcr = cpu_to_le16 ( AXGE_EPPRCR_IPRL );
        if ( ( rc = axge_write_word ( axge, AXGE_EPPRCR, epprcr ) ) != 0){
                DBGC ( axge, "AXGE %p could not write EPPRCR: %s\n",
                       axge, strerror ( rc ) );
                goto err_write_epprcr_on;
        }
        mdelay ( AXGE_EPPRCR_DELAY_MS );

        /* Select clocks */
        csr = ( AXGE_CSR_BCS | AXGE_CSR_ACS );
        if ( ( rc = axge_write_byte ( axge, AXGE_CSR, csr ) ) != 0){
                DBGC ( axge, "AXGE %p could not write CSR: %s\n",
                       axge, strerror ( rc ) );
                goto err_write_csr;
        }
        mdelay ( AXGE_CSR_DELAY_MS );

        /* Configure bulk IN pipeline */
        if ( ( rc = axge_write_register ( axge, AXGE_BICR, &axge_bicr,
                                          sizeof ( axge_bicr ) ) ) != 0 ){
                DBGC ( axge, "AXGE %p could not write BICR: %s\n",
                       axge, strerror ( rc ) );
                goto err_write_bicr;
        }

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

        /* Update link status */
        if ( ( rc = axge_check_link ( axge ) ) != 0 )
                goto err_check_link;

        usb_func_set_drvdata ( func, axge );
        return 0;

 err_check_link:
        unregister_netdev ( netdev );
 err_register:
 err_write_bicr:
 err_write_csr:
 err_write_epprcr_on:
 err_write_epprcr_off:
 err_read_mac:
 err_describe:
        netdev_nullify ( netdev );
        netdev_put ( netdev );
 err_alloc:
        return rc;
}

References alloc_etherdev(), axge_bicr, AXGE_BICR, axge_check_link(), AXGE_CSR, AXGE_CSR_ACS, AXGE_CSR_BCS, AXGE_CSR_DELAY_MS, AXGE_EPPRCR, AXGE_EPPRCR_DELAY_MS, AXGE_EPPRCR_IPRL, AXGE_IN_MAX_FILL, AXGE_IN_MTU, axge_in_operations, AXGE_IN_RESERVE, AXGE_INTR_MAX_FILL, axge_intr_operations, AXGE_NIDR, axge_operations, axge_out_operations, axge_read_register(), axge_write_byte(), axge_write_register(), axge_write_word(), axge_device::bus, usb_hub::bus, axge_device::config, cpu_to_le16, DBGC, net_device::dev, usb_function::dev, ENOMEM, ETH_ALEN, usb_port::hub, net_device::hw_addr, usbnet_device::in, usbnet_device::intr, mdelay(), memset(), usb_function::name, netdev, axge_device::netdev, netdev_init(), netdev_nullify(), netdev_put(), usb_device::port, net_device::priv, rc, register_netdev(), strerror(), unregister_netdev(), axge_device::usb, usb_function::usb, usb_func_set_drvdata(), usb_refill_init(), axge_device::usbnet, usbnet_describe(), and usbnet_init().

axge_remove()

static void axge_remove ( struct usb_function *  func )

static

Remove device.

Parameters

func	USB function

Definition at line 771 of file axge.c.

                                                      {
        struct axge_device *axge = usb_func_get_drvdata ( func );
        struct net_device *netdev = axge->netdev;

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

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

Variable Documentation

__profiler

struct profiler axge_out_profiler __profiler

static

Initial value:

=
        { .name = "axge.intr" }

Interrupt completion profiler.

Bulk OUT profiler.

Bulk IN completion profiler.

Definition at line 48 of file axge.c.

axge_bicr

struct axge_bulk_in_control axge_bicr

static

Initial value:

= {
        .ctrl = 7,
        .timer = cpu_to_le16 ( 0 ),
        .size = 0,
        .ifg = 0,
}

Default bulk IN configuration.

The Linux and FreeBSD drivers have set of magic constants which are chosen based on both the Ethernet and USB link speeds.

Experimentation shows that setting the "timer" value to zero seems to prevent the device from ever coalescing multiple packets into a single bulk IN transfer. This allows us to get away with using a 2kB receive I/O buffer and a zerocopy receive path.

Definition at line 69 of file axge.c.

Referenced by axge_probe().

axge_intr_operations

struct usb_endpoint_driver_operations axge_intr_operations

static

Initial value:

= {
        .complete = axge_intr_complete,
}

Interrupt endpoint operations.

Definition at line 329 of file axge.c.

Referenced by axge_probe().

axge_in_operations

struct usb_endpoint_driver_operations axge_in_operations

static

Initial value:

= {
        .complete = axge_in_complete,
}

Bulk IN endpoint operations.

Definition at line 460 of file axge.c.

Referenced by axge_probe().

axge_out_operations

struct usb_endpoint_driver_operations axge_out_operations

static

Initial value:

= {
        .complete = axge_out_complete,
}

Bulk OUT endpoint operations.

Definition at line 513 of file axge.c.

Referenced by axge_probe().

axge_operations

struct net_device_operations axge_operations

static

Initial value:

= {
        .open           = axge_open,
        .close          = axge_close,
        .transmit       = axge_transmit,
        .poll           = axge_poll,
}

AXGE network device operations.

Definition at line 643 of file axge.c.

Referenced by axge_probe().

axge_ids

struct usb_device_id axge_ids[]

static

AXGE device IDs.

Definition at line 781 of file axge.c.

__usb_driver

struct usb_driver axge_driver __usb_driver

Initial value:

= {
        .ids = axge_ids,
        .id_count = ( sizeof ( axge_ids ) / sizeof ( axge_ids[0] ) ),
        .class = USB_CLASS_ID ( USB_ANY_ID, USB_ANY_ID, USB_ANY_ID ),
        .score = USB_SCORE_NORMAL,
        .probe = axge_probe,
        .remove = axge_remove,
}

AXGE driver.

Definition at line 815 of file axge.c.