mii.h File Reference

Media Independent Interface. More...

#include <mii.h>
#include <ipxe/netdevice.h>

Go to the source code of this file.

Data Structures
struct	mii_operations
	MII interface operations. More...
struct	mii_interface
	An MII interface. More...
struct	mii_device
	An MII device. More...

Macros
#define	MII_RESET_MAX_WAIT_MS   500
	Maximum time to wait for a reset, in milliseconds. More...
#define	MII_MAX_PHY_ADDRESS   31
	Maximum PHY address. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static void	mdio_init (struct mii_interface *mdio, struct mii_operations *op)
	Initialise MII interface. More...
static void	mii_init (struct mii_device *mii, struct mii_interface *mdio, unsigned int address)
	Initialise MII device. More...
static int	mii_read (struct mii_device *mii, unsigned int reg)
	Read from MII register. More...
static int	mii_write (struct mii_device *mii, unsigned int reg, unsigned int data)
	Write to MII register. More...
static void	mii_dump (struct mii_device *mii)
	Dump MII registers (for debugging) More...
int	mii_restart (struct mii_device *mii)
	Restart autonegotiation. More...
int	mii_reset (struct mii_device *mii)
	Reset MII device. More...
int	mii_check_link (struct mii_device *mii, struct net_device *netdev)
	Update link status via MII. More...
int	mii_find (struct mii_device *mii)
	Find PHY address. More...

Detailed Description

Media Independent Interface.

Definition in file mii.h.

Macro Definition Documentation

MII_RESET_MAX_WAIT_MS

#define MII_RESET_MAX_WAIT_MS   500

Maximum time to wait for a reset, in milliseconds.

Definition at line 143 of file mii.h.

MII_MAX_PHY_ADDRESS

#define MII_MAX_PHY_ADDRESS   31

Maximum PHY address.

Definition at line 146 of file mii.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

mdio_init()

static void mdio_init ( struct mii_interface *  mdio, struct mii_operations *  op  )

inlinestatic

Initialise MII interface.

Parameters

mdio	MII interface
op	MII interface operations

Definition at line 64 of file mii.h.

                                                                    {
        mdio->op = op;
}

References mii_interface::op, and op.

Referenced by cgem_probe(), init_mii_bit_basher(), rdc_probe(), realtek_probe(), rhine_probe(), and velocity_probe().

mii_init()

static void mii_init ( struct mii_device *  mii, struct mii_interface *  mdio, unsigned int  address  )

inlinestatic

Initialise MII device.

Parameters

mii	MII device
mdio	MII interface
address	PHY address

Definition at line 76 of file mii.h.

                                  {
        mii->mdio = mdio;
        mii->address = address;
}

References address, and mii.

Referenced by cgem_probe(), icplus_probe(), rdc_probe(), realtek_probe(), rhine_probe(), and velocity_probe().

mii_read()

static int mii_read ( struct mii_device *  mii, unsigned int  reg  )

inlinestatic

Read from MII register.

Parameters

mii	MII device
reg	Register address

Return values

data	Data read, or negative error

Definition at line 90 of file mii.h.

                                                      {
        struct mii_interface *mdio = mii->mdio;

        return mdio->op->read ( mdio, mii->address, reg );
}

References mii, mii_interface::op, mii_operations::read, and reg.

Referenced by mii_dump().

mii_write()

static int mii_write ( struct mii_device *  mii, unsigned int  reg, unsigned int  data  )

inlinestatic

Write to MII register.

Parameters

mii	MII device
reg	Register address
data	Data to write

Return values

rc	Return status code

Definition at line 105 of file mii.h.

                                                                          {
        struct mii_interface *mdio = mii->mdio;

        return mdio->op->write ( mdio, mii->address, reg, data );
}

References data, mii, mii_interface::op, reg, and mii_operations::write.

Referenced by icplus_init_phy(), mii_reset(), mii_restart(), realtek_phy_reset(), realtek_phy_speed(), smscusb_mii_check_link(), smscusb_mii_open(), and velocity_set_link().

mii_dump()

static void mii_dump ( struct mii_device *  mii )

inlinestatic

Dump MII registers (for debugging)

Parameters

mii	MII device

Definition at line 117 of file mii.h.

                                    {
        unsigned int i;
        int data;

        /* Do nothing unless debug output is enabled */
        if ( ! DBG_LOG )
                return;

        /* Dump basic MII register set */
        for ( i = 0 ; i < 16 ; i++ ) {
                if ( ( i % 8 ) == 0 ) {
                        DBGC ( mii, "MII %p registers %02x-%02x:",
                               mii, i, ( i + 7 ) );
                }
                data = mii_read ( mii, i );
                if ( data >= 0 ) {
                        DBGC ( mii, " %04x", data );
                } else {
                        DBGC ( mii, " XXXX" );
                }
                if ( ( i % 8 ) == 7 )
                        DBGC ( mii, "\n" );
        }
}

References data, DBG_LOG, DBGC, mii, and mii_read().

Referenced by realtek_check_link().

mii_restart()

int mii_restart

(

struct mii_device *

mii

)

Restart autonegotiation.

Parameters

mii	MII device

Return values

rc	Return status code

Definition at line 44 of file mii.c.

                                           {
        int bmcr;
        int rc;

        /* Read BMCR */
        bmcr = mii_read ( mii, MII_BMCR );
        if ( bmcr < 0 ) {
                rc = bmcr;
                DBGC ( mii, "MII %p could not read BMCR: %s\n",
                       mii, strerror ( rc ) );
                return rc;
        }

        /* Enable and restart autonegotiation */
        bmcr |= ( BMCR_ANENABLE | BMCR_ANRESTART );
        if ( ( rc = mii_write ( mii, MII_BMCR, bmcr ) ) != 0 ) {
                DBGC ( mii, "MII %p could not write BMCR: %s\n",
                       mii, strerror ( rc ) );
                return rc;
        }

        DBGC ( mii, "MII %p restarted autonegotiation\n", mii );
        return 0;
}

References BMCR_ANENABLE, BMCR_ANRESTART, DBGC, mii, MII_BMCR, mii_read(), mii_write(), rc, and strerror().

Referenced by mii_reset(), and realtek_phy_reset().

mii_reset()

int mii_reset

(

struct mii_device *

mii

)

Reset MII device.

Parameters

mii	MII device

Return values

rc	Return status code

Definition at line 75 of file mii.c.

                                         {
        unsigned int i;
        int bmcr;
        int rc;

        /* Power-up, enable autonegotiation and initiate reset */
        if ( ( rc = mii_write ( mii, MII_BMCR,
                                ( BMCR_RESET | BMCR_ANENABLE ) ) ) != 0 ) {
                DBGC ( mii, "MII %p could not write BMCR: %s\n",
                       mii, strerror ( rc ) );
                return rc;
        }

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

                /* Check if reset has completed */
                bmcr = mii_read ( mii, MII_BMCR );
                if ( bmcr < 0 ) {
                        rc = bmcr;
                        DBGC ( mii, "MII %p could not read BMCR: %s\n",
                               mii, strerror ( rc ) );
                        return rc;
                }

                /* If reset is not complete, delay 1ms and retry */
                if ( bmcr & BMCR_RESET ) {
                        mdelay ( 1 );
                        continue;
                }

                /* Force autonegotation on again, in case it was
                 * cleared by the reset.
                 */
                if ( ( rc = mii_restart ( mii ) ) != 0 )
                        return rc;

                DBGC ( mii, "MII %p reset after %dms\n", mii, i );
                return 0;
        }

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

References BMCR_ANENABLE, BMCR_RESET, DBGC, ETIMEDOUT, mdelay(), mii, MII_BMCR, mii_read(), MII_RESET_MAX_WAIT_MS, mii_restart(), mii_write(), rc, and strerror().

Referenced by cgem_init_phy(), icplus_init_phy(), rdc_init_phy(), realtek_phy_reset(), rhine_probe(), and velocity_probe().

mii_check_link()

int mii_check_link	(	struct mii_device *	mii,
		struct net_device *	netdev
	)

Update link status via MII.

Parameters

mii	MII device
netdev	Network device

Return values

rc	Return status code

Definition at line 127 of file mii.c.

                                                                         {
        int bmsr;
        int link;
        int rc;

        /* Read BMSR */
        bmsr = mii_read ( mii, MII_BMSR );
        if ( bmsr < 0 ) {
                rc = bmsr;
                return rc;
        }

        /* Report link status */
        link = ( bmsr & BMSR_LSTATUS );
        DBGC ( mii, "MII %p link %s (BMSR %#04x)\n",
               mii, ( link ? "up" : "down" ), bmsr );
        if ( link ) {
                netdev_link_up ( netdev );
        } else {
                netdev_link_down ( netdev );
        }

        return 0;
}

References BMSR_LSTATUS, DBGC, link, mii, MII_BMSR, mii_read(), netdev, netdev_link_down(), netdev_link_up(), and rc.

Referenced by cgem_check_link(), rdc_check_link(), and smscusb_mii_check_link().

mii_find()

int mii_find

(

struct mii_device *

mii

)

Find PHY address.

Parameters

mii	MII device

Return values

rc	Return status code

Definition at line 158 of file mii.c.

                                        {
        unsigned int address;
        int id;

        /* Try all possible PHY addresses */
        for ( address = 0 ; address <= MII_MAX_PHY_ADDRESS ; address++ ) {
                mii->address = address;
                id = mii_read ( mii, MII_PHYSID1 );
                if ( ( id > 0x0000 ) && ( id < 0xffff ) ) {
                        DBGC ( mii, "MII %p found PHY at address %d\n",
                               mii, address );
                        return 0;
                }
        }

        DBGC ( mii, "MII %p failed to find an address\n", mii );
        return -ENOENT;
}

References address, DBGC, ENOENT, id, mii, MII_MAX_PHY_ADDRESS, MII_PHYSID1, and mii_read().

Referenced by cgem_init_phy(), icplus_init_phy(), and rdc_init_phy().