BMacEnet.cpp   [plain text]

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1998-1999 by Apple Computer, Inc., All rights reserved.
 *
 * Hardware independent (relatively) code for the BMac Ethernet Controller 
 *
 * HISTORY
 *
 * dd-mmm-yy	 
 *	Created.
 *
 * Dec 10, 1998		jliu
 *  Converted to IOKit/C++.
 */

#include "BMacEnet.h"
#include "BMacEnetPrivate.h"

#include <IOKit/IORegistryEntry.h>
#include <IOKit/IODeviceTreeSupport.h>
#include <IOKit/platform/AppleMacIODevice.h>
#include <IOKit/assert.h>

// #define DEBUG_JOE	1

//------------------------------------------------------------------------

#define super IOEthernetController

OSDefineMetaClassAndStructors( BMacEnet, IOEthernetController )

//------------------------------------------------------------------------

#define PROVIDER_DEV	0
#define	PROVIDER_DMA_TX	1
#define	PROVIDER_DMA_RX	2

/*
 * Public Instance Methods
 */

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

bool BMacEnet::init( OSDictionary* properties )
{
    if ( super::init(properties) == false )
        return false;

	/*
	 * Initialize my ivars.
	 */
	phyId             = 0xff;
	phyMIIDelay       = MII_DEFAULT_DELAY;
	sromAddressBits   = 6;
	enetAddressOffset = 20;
	phyStatusPrev     = 0;

	return true;
}

bool BMacEnet::start(IOService * provider)
{
	AppleMacIODevice *nub = OSDynamicCast(AppleMacIODevice, provider);
	IOInterruptEventSource *intES;

	if (!nub || !super::start(provider))
		return false;

	transmitQueue = OSDynamicCast(IOGatedOutputQueue, getOutputQueue());
	if (!transmitQueue) {
		IOLog( "BMacEnet::start: output queue initialization failed\n" );
		return false;
	}
	transmitQueue->retain();

	// Allocate debug queue. This stores packets retired from the TX ring
	// by the polling routine. We cannot call freePacket() or m_free() within
	// the debugger context.
	//
	// The capacity of the queue is set at maximum to prevent the queue from
	// calling m_free() due to over-capacity. But we don't expect the size
	// of the queue to grow too large.
	//
	debugQueue = IOPacketQueue::withCapacity((UInt) -1);
	if (!debugQueue)
		return false;

	// Allocate a IOMbufBigMemoryCursor instance. Currently, the maximum
	// number of segments is set to 2. The maximum length for each segment
	// is set to the maximum ethernet frame size (plus padding).

	mbufCursor = IOMbufBigMemoryCursor::withSpecification(NETWORK_BUFSIZE, 2);
	if (!mbufCursor) {
		IOLog( "BMacEnet::start: IOMbufBigMemoryCursor allocation failure\n" );
		return false;
	}

	//
	// Our provider is the nub representing the BMacEnet hardware
	// controller. We will query it for our resource information.
	//

	for (int i = 0; i < MEMORY_MAP_HEATHROW_INDEX; i++) {
		IOMemoryMap *		map;
		
		map = provider->mapDeviceMemoryWithIndex(i);
		if (!map)
			return false;
#ifdef DEBUG_JOE
		IOLog("map %d: Phys:%08x Virt:%08x len:%d\n",
			i,
			(unsigned) map->getPhysicalAddress(),
			(unsigned) map->getVirtualAddress(),
			(unsigned) map->getLength());
#endif DEBUG_JOE

		switch (i) {
			case MEMORY_MAP_ENET_INDEX:
				ioBaseEnet = (IOPPCAddress) map->getVirtualAddress();
				break;
			
			case MEMORY_MAP_TXDMA_INDEX:
				ioBaseEnetTxDMA = (IODBDMAChannelRegisters *)
					map->getVirtualAddress();
				break;
			
			case MEMORY_MAP_RXDMA_INDEX:
				ioBaseEnetRxDMA = (IODBDMAChannelRegisters *)
					map->getVirtualAddress();
				break;
		}
		
		maps[i] = map;
	}

#ifdef DEBUG_JOE
	IOLog("ioBaseEnet:      0x%08x\n", ioBaseEnet);
	IOLog("ioBaseEnetTxDMA: 0x%08x\n", ioBaseEnetTxDMA);
	IOLog("ioBaseEnetRxDMA: 0x%08x\n", ioBaseEnetRxDMA);
#endif DEBUG_JOE

	//
	// We need to get the I/O address for the Heathrow controller.
	// We ask the provider (bmac) for its device tree parent.
	//
	IOService *heathrow;
	if (!(heathrow = OSDynamicCast(IOService,
                            provider->getParentEntry( gIODTPlane ))))
		return false;

	// Check whether the hardware is susceptible to the broken unicast
	// filter problem.
	//
	OSData * devIDData;
	devIDData = OSDynamicCast(OSData, heathrow->getProperty("device-id"));

	if (devIDData) {
		useUnicastFilter = ( *((UInt32 *) devIDData->getBytesNoCopy()) ==
                             0x10 );
		if (useUnicastFilter)
			IOLog("%s: Enabling workaround for broken unicast filter\n", 
				getName());
	}

	IOMemoryMap *		map = heathrow->mapDeviceMemoryWithIndex(0);
	if (map)
	{
#ifdef DEBUG_JOE
		IOLog("Heathrow: Phys:%08x Virt:%08x len:%d\n",
			(unsigned) map->getPhysicalAddress(),
			(unsigned) map->getVirtualAddress(),
			(unsigned) map->getLength());
#endif DEBUG_JOE
		ioBaseHeathrow = (IOPPCAddress) map->getVirtualAddress();
		
		maps[MEMORY_MAP_HEATHROW_INDEX] = map;
	}
	else {
		return false;
	}

	//
	// Get a reference to the IOWorkLoop in our superclass.
	//
	IOWorkLoop * myWorkLoop = getWorkLoop();
	assert(myWorkLoop);

		// Allocate three IOInterruptEventSources:

	rxIntSrc = IOInterruptEventSource::interruptEventSource(
					this,
					(IOInterruptEventAction)&BMacEnet::interruptOccurred,
					provider,
					PROVIDER_DMA_RX );
	if ( !rxIntSrc || (myWorkLoop->addEventSource( rxIntSrc ) != kIOReturnSuccess) )
	{
		IOLog( "BMacEnet::start - rxIntSrc init failure\n" );
		return false;
	}

	intES = IOInterruptEventSource::interruptEventSource(
					this,
					(IOInterruptEventAction)&BMacEnet::interruptOccurred,
					provider,
					PROVIDER_DMA_TX );
	if ( intES )
	{
		bool res = (myWorkLoop->addEventSource( intES ) != kIOReturnSuccess );
		intES->release();
		if ( res )
		{
			IOLog( "BMacEnet::start -  PROVIDER_DMA_TX add failure\n" );
			return false;
		}
	}
	else
	{
		IOLog( "BMacEnet::start - PROVIDER_DMA_TX init failure\n" );
		return false;
	}

	intES = IOInterruptEventSource::interruptEventSource(
					this,
					(IOInterruptEventAction)&BMacEnet::interruptOccurred,
					provider,
					PROVIDER_DEV );
	if ( intES )
	{
	    bool res = (myWorkLoop->addEventSource( intES ) != kIOReturnSuccess);
	    intES->release();
	    if ( res )
		{
			IOLog( "BMacEnet::start - PROVIDER_DEV add failure\n" );
			return false;
	    }
	}
	else
	{
		IOLog( "BMacEnet::start - PROVIDER_DEV init failure\n" );
		return false;
	}

	timerSrc = IOTimerEventSource::timerEventSource(
					this,
					(IOTimerEventSource::Action)&BMacEnet::timerPopped );
	if ( !timerSrc || (myWorkLoop->addEventSource( timerSrc ) != kIOReturnSuccess) )
	{
		IOLog( "BMacEnet::start - timerSrc init failure\n" );
		return false;
	}

	txDebuggerPkt = allocatePacket( NETWORK_BUFSIZE );
	if ( !txDebuggerPkt )
	{	IOLog( "BMacEnet::start: Couldn't allocate KDB buffer\n" );
		return false;
	}
	txDebuggerPkt->m_next = 0;

#if 0
	// Enable the interrupt event sources. The hardware interrupts
	// sources remain disabled until _resetAndEnable(true) is called.
	//
	// myWorkLoop->enableAllInterrupts();
#endif

	// Perform a hardware reset.
	//
    if ( !_resetAndEnable(false) ) 
    {
		return false;
    }

	// Cache my MAC address.
	//
	getHardwareAddress(&myAddress);

	// Allocate memory for ring buffers.
	//
    if (_allocateMemory() == false) 
    {
		return false;
    }

    // Create a table of supported media types.
    //
    if ( !createMediumTables() )
		return false;

	// Attach an IOEthernetInterface client.
	//
	if ( !attachInterface((IONetworkInterface **) &networkInterface, false) )
		return false;

	// Attach a kernel debugger client.
	//
	attachDebuggerClient(&debugger);

    // Ready to service interface requests.
    //
    networkInterface->registerService();

	return true;
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

void BMacEnet::free()
{
    UInt i;
    
    // Cannot call _resetAndEnable() since start() may not
    // have been successful. It is not required anyway,
    // since the nubs will disable the controller when they
    // are terminated.
    //
	// _resetAndEnable(false);

	if (debugger)
		debugger->release();

	if (getWorkLoop())
		getWorkLoop()->disableAllEventSources();

	if (timerSrc)
		timerSrc->release();

	if (rxIntSrc)
		rxIntSrc->release();

	if (txDebuggerPkt)
		freePacket(txDebuggerPkt);

	if (transmitQueue)
		transmitQueue->release();

	if (debugQueue)
		debugQueue->release();

    if (networkInterface)
		networkInterface->release();

	if (mbufCursor)
		mbufCursor->release();

    if ( mediumDict )
        mediumDict->release();

    for (i = 0; i < rxMaxCommand; i++)
    	if (rxMbuf[i]) freePacket(rxMbuf[i]);

    for (i = 0; i < txMaxCommand; i++)
    	if ( txMbuf[i] && (txMbuf[i] != txDebuggerPkt) ) freePacket(txMbuf[i]);

	for (i = 0; i < MEMORY_MAP_COUNT; i++)
		if (maps[i]) maps[i]->release();

	if ( dmaCommandsDesc )
	{	dmaCommandsDesc->complete(  kIODirectionOutIn );
		dmaCommandsDesc->release();
		dmaCommandsDesc = 0;
	}

	if ( dmaCommands )
	{
		IOFreeContiguous( dmaCommands, dmaCommandsSize );
		dmaCommands = 0;
	}

    if ( workLoop )
    {
        workLoop->release();
        workLoop = 0;
    }

	super::free();
	return;
}/* end free */


/*-------------------------------------------------------------------------
 * Override IONetworkController::createWorkLoop() method and create
 * a workloop.
 *
 *-------------------------------------------------------------------------*/

bool BMacEnet::createWorkLoop()
{
    workLoop = IOWorkLoop::workLoop();

    return ( workLoop != 0 );
}

/*-------------------------------------------------------------------------
 * Override IOService::getWorkLoop() method to return our workloop.
 *
 *
 *-------------------------------------------------------------------------*/

IOWorkLoop * BMacEnet::getWorkLoop() const
{
    return workLoop;
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

void BMacEnet::interruptOccurred( OSObject *me, IOInterruptEventSource *src, int /*count*/ )
{
	((BMacEnet*)me)->handleInterrupt( src );
	return;
}/* end interruptOccurred */


void BMacEnet::handleInterrupt( IOInterruptEventSource *src )
{
	bool doFlushQueue = false;
	bool doService    = false;

	reserveDebuggerLock();

    statReg = ReadBigMacRegister( ioBaseEnet, kSTAT );

	if (src == rxIntSrc) {	
		KERNEL_DEBUG(DBG_BMAC_RXIRQ | DBG_FUNC_START, 0, 0, 0, 0, 0 );		
		doFlushQueue = _receiveInterruptOccurred();	
		KERNEL_DEBUG(DBG_BMAC_RXIRQ | DBG_FUNC_END,   0, 0, 0, 0, 0 );	
	}
	else {			
      /*
       * On the transmit side, we use the chipset interrupt. Using the
	   * transmit DMA interrupt (or having multiple transmit DMA entries)
	   * would allows us to send the next frame to the chipset prior the 
	   * transmit fifo going empty. 
       * However, this aggrevates a BMac chipset bug where the next frame going
	   * out gets corrupted (first two bytes lost) if the chipset had to retry 
	   * the previous frame.
       */ 
        txWDInterrupts++;
        KERNEL_DEBUG(DBG_BMAC_TXIRQ | DBG_FUNC_START, 0, 0, 0, 0, 0 );
		doService = _transmitInterruptOccurred();
        KERNEL_DEBUG(DBG_BMAC_TXIRQ | DBG_FUNC_END,   0, 0, 0, 0, 0 );
	}

	releaseDebuggerLock();

	/*
	 * Submit all received packets queued up by _receiveInterruptOccurred()
	 * to the network stack. The up call is performed without holding the
	 * debugger lock.
	 */
	if ( doFlushQueue )
		networkInterface->flushInputQueue();

	/*
	 * Unstall the output queue if some space was made available.
	 */
	if ( doService && netifEnabled )
		transmitQueue->service();
	return;
}/* end handleInterrupt */


/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

UInt32 BMacEnet::outputPacket(struct mbuf * pkt, void * param)
{
	u_int32_t	i;
	UInt32      ret = kIOReturnOutputSuccess;

    KERNEL_DEBUG(DBG_BMAC_TXQUEUE | DBG_FUNC_NONE, (int) pkt,
		(int) pkt->m_pkthdr.len, 0, 0, 0 );

    /*
     * Hold the debugger lock so the debugger can't interrupt us
     */
	reserveDebuggerLock();
 
    do
    {
		/* 
		 * Preliminary sanity checks
		 */
		assert( pkt && netifEnabled );

#if 0
		/*
		 * Remove any completed packets from the Tx ring 
		 */
		if ( chipId >= kCHIPID_PaddingtonXmitStreaming )
		{
			_transmitInterruptOccurred(); 
		}
#endif

		i = txCommandTail + 1;
		if ( i >= txMaxCommand ) i = 0;
		if ( i == txCommandHead )
		{
			/*
			 * Ring buffer is full. Disable the dequeueing process.
			 * We reenable it when an entry is made available by the
			 * transmit interrupt handler, or if a timeout occurs.
			 */
			ret = kIOReturnOutputStall;
			continue;
		}

		/*
		 * If there is space on the Tx ring, add the packet directly to the
		 * ring.
		 */
		_transmitPacket(pkt);
    }
    while ( 0 );

	releaseDebuggerLock();

	return ret;
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

bool BMacEnet::_resetAndEnable(bool enable)
{
	bool ret = true;

//	reserveDebuggerLock();

	ready = false;

	if (timerSrc) timerSrc->cancelTimeout();

	_disableAdapterInterrupts();
	if (getWorkLoop()) getWorkLoop()->disableAllInterrupts();

    if (enable)
    {
        phyId = 0xff;
    }

	_resetChip();

    // Initialize the link status.

    phyStatusPrev = 0;
    setLinkStatus( 0, 0 );

	while (enable)
	{
		if (!_initRxRing() || !_initTxRing())	
		{
			ret = false;
			break;
		}

		if ( phyId != 0xff )
		{
			miiInitializePHY(phyId);
		}

		if (_initChip() == false)
		{
			ret = false;
			break;
		}

		_startChip();

		timerSrc->setTimeoutMS(WATCHDOG_TIMER_MS);

		if (getWorkLoop()) getWorkLoop()->enableAllInterrupts();
		_enableAdapterInterrupts();

		ready = true;

		_sendDummyPacket();

        monitorLinkStatus( true );

		break;
	}
	
//	releaseDebuggerLock();

    return ret;
}/* end _resetAndEnable */


void BMacEnet::dropPower()
{	volatile UInt32		*heathrowFCR;
	UInt32				fcrValue;


	heathrowFCR	= (UInt32*)((UInt8*)ioBaseHeathrow + kHeathrowFCR);
	fcrValue	= OSReadSwapInt32( heathrowFCR, 0 );
	fcrValue   &= ~(kEnetEnabledBits | kResetEnetCell);
	OSWriteSwapInt32( heathrowFCR, 0, fcrValue );
	eieio();
	return;
}/* end dropPower */


/*-------------------------------------------------------------------------
 * Grab a pointer to the statistics counters.
 *
 *
 *-------------------------------------------------------------------------*/

bool BMacEnet::configureInterface( IONetworkInterface * netif )
{
    IONetworkData * nd;

    if ( super::configureInterface( netif ) == false )
        return false;

    /*
     * Grab a pointer to the statistics structure in the interface.
     */
    nd = netif->getNetworkData( kIONetworkStatsKey );

    if ( !nd || !(netStats = (IONetworkStats *) nd->getBuffer()) )
    {
        IOLog( "BMacEnet::start: invalid network statistics\n" );
        return false;
    }

    return true;
}

/*-------------------------------------------------------------------------
 * Called by IOEthernetInterface client to enable the controller.
 * This method is always called while running on the default workloop
 * thread.
 *-------------------------------------------------------------------------*/

IOReturn BMacEnet::enable(IONetworkInterface * netif)
{
	// If an interface client has previously enabled us,
	// and we know there can only be one interface client
	// for this driver, then simply return true.
	//
	if ( netifEnabled )
    {
		IOLog( "BMacEnet::enable: already enabled\n" );
		return kIOReturnSuccess;
	}

	if ( (ready == false) && !_resetAndEnable(true) )
		return kIOReturnIOError;

	// Record the interface as an active client.
	//
	netifEnabled = true;

	// Start our IOOutputQueue object.
	//
	transmitQueue->setCapacity(TRANSMIT_QUEUE_SIZE);
	transmitQueue->start();

	return kIOReturnSuccess;
}

/*-------------------------------------------------------------------------
 * Called by IOEthernetInterface client to disable the controller.
 * This method is always called while running on the default workloop
 * thread.
 *-------------------------------------------------------------------------*/
 
IOReturn BMacEnet::disable(IONetworkInterface * /*netif*/)
{
	// Disable our IOOutputQueue object. This will prevent the
	// outputPacket() method from being called.
	//
	transmitQueue->stop();

	// Flush all packets currently in the output queue.
	//
	transmitQueue->setCapacity(0);
	transmitQueue->flush();

	// If we have no active clients, then disable the controller.
	//
	if ( debugEnabled == false )
    {
		_resetAndEnable( false );
		dropPower();
    }

	netifEnabled = false;

	return kIOReturnSuccess;
}

/*-------------------------------------------------------------------------
 * This method is called by our debugger client to bring up the controller
 * just before the controller is registered as the debugger device. The
 * debugger client is attached in response to the attachDebuggerClient()
 * call.
 *
 * This method is always called while running on the default workloop
 * thread.
 *-------------------------------------------------------------------------*/

IOReturn BMacEnet::enable(IOKernelDebugger *debugger)
{
	// Enable hardware and make it ready to support the debugger client.
	//
	if ( (ready == false) && !_resetAndEnable(true) )
    {
		return kIOReturnIOError;
    }

	// Record the debugger as an active client of ours.
	//
	debugEnabled = true;

	return kIOReturnSuccess;
}

/*-------------------------------------------------------------------------
 * This method is called by our debugger client to stop the controller.
 * The debugger will call this method when we issue a detachDebuggerClient().
 *
 * This method is always called while running on the default workloop
 * thread.
 *-------------------------------------------------------------------------*/

IOReturn BMacEnet::disable(IOKernelDebugger * /*debugger*/)
{
	debugEnabled = false;
        
	// If we have no active clients, then disable the controller.
	//
	if ( netifEnabled == false )
    {
		_resetAndEnable( false );
		dropPower();
    }

	return kIOReturnSuccess;
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

void BMacEnet::timerPopped( OSObject *me, IOTimerEventSource* /*timer*/ )
{
	((BMacEnet*)me)->handleTimerPop();
	return;
}/* end timerPopped */


void BMacEnet::handleTimerPop()
{
    u_int32_t       dmaStatus;
	bool            doFlushQueue = false;
	bool            doService    = false;

    if ( ready == false )
    {
        return;
    }

	// IOLog( "BMacEnet::handleTimerPop: watchdog timer\n" );

	reserveDebuggerLock();
	
    /*
     * Check for DMA shutdown on receive channel
     */
    dmaStatus = IOGetDBDMAChannelStatus( ioBaseEnetRxDMA );
    if ( !(dmaStatus & kdbdmaActive) )
    {
#if 0
		IOLog( "BMacEnet::handleTimerPop: Timeout check - RxHead = %d RxTail = %d\n", 
			rxCommandHead, rxCommandTail );

      IOLog( "BMacEnet::handleTimerPop: Rx Commands = %08x(p) Rx DMA Ptr = %08x(p)\n", rxDMACommandsPhys, IOGetDBDMACommandPtr(ioBaseEnetRxDMA) ); 
      [self _dumpDesc:(void *)rxDMACommands Size:rxMaxCommand * sizeof(enet_dma_cmd_t)];
#endif

		doFlushQueue = _receiveInterruptOccurred();
	}

    /*
     * If there are pending entries on the Tx ring
     */
    if ( txCommandHead != txCommandTail )
    {
		/* 
		 * If we did not service the Tx ring during the last timeout interval,
		 * then force servicing of the Tx ring
		 */
		if ( txWDInterrupts == 0 )
		{
			if ( txWDCount++ > 0 )
			{
				if (_transmitInterruptOccurred() == false)
				{
#if 0
					IOLog( "BMacEnet::handleTimerPop: Timeout check - TxHead = %d TxTail = %d\n", 
						txCommandHead, txCommandTail);
#endif
					_restartTransmitter();
				}
				doService = true;
			}
		}
		else
		{
			txWDInterrupts   = 0;
			txWDCount        = 0;
		}
	}
    else
	{
		txWDInterrupts   = 0;
		txWDCount        = 0;
	}

    // Poll link status periodically.

    monitorLinkStatus();

	// Clean-up after the debugger if the debugger was active.
	//
	if ( debugTxPoll )
	{
		debugQueue->flush();
		debugTxPoll = false;
		doService   = true;
	}

    releaseDebuggerLock();

	/*
	 * Submit all received packets queued up by _receiveInterruptOccurred()
	 * to the network stack. This call is performed without holding the
	 * debugger lock.
	 */
	if ( doFlushQueue )
	{
		networkInterface->flushInputQueue();
	}

	/*
	 * Make sure the output queue is not stalled.
	 */
	if ( doService && netifEnabled )
	{
		transmitQueue->service();
	}

	timerSrc->setTimeoutMS( WATCHDOG_TIMER_MS );	/* Restart the watchdog timer	*/
	return;
}/* end handleTimerPop */


/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

void BMacEnet::monitorLinkStatus( bool firstPoll )
{
    u_int16_t    phyStatus;
    u_int16_t    phyReg;
    u_int16_t    phyStatusChange;
	bool         fullDuplex;
    bool         reportLinkStatus = false;
    UInt32       linkSpeed;
    UInt32       linkStatus;

    if ( phyId == 0xff ) 
    {
        // For implementations without a PHY, query the link status bit from
        // the transceiver control register (kXCVRIF).
        
        phyStatus = ReadBigMacRegister(ioBaseEnet, kXCVRIF);

        if ( ( ( phyStatus ^ phyStatusPrev ) & kLinkStatus ) || firstPoll )
        {
            linkStatus       = kIONetworkLinkValid;
            linkSpeed        = 0;
            fullDuplex       = false;
            reportLinkStatus = true;

            if ( ( phyStatus & kLinkStatus ) == 0 )
            {
                linkSpeed   = 10;
                linkStatus |= kIONetworkLinkActive;
            }

            phyStatusPrev = phyStatus;
        }
    }
    else if ( miiReadWord(&phyStatus, MII_STATUS, phyId) == true )
    {
        phyStatusChange = ( phyStatusPrev ^ phyStatus ) &
                          ( MII_STATUS_LINK_STATUS |
                            MII_STATUS_NEGOTIATION_COMPLETE);

        if ( phyStatusChange || firstPoll )
        {
            if ( firstPoll )
            {
                // For the initial link status poll, wait a bit, then
                // re-read the status register to clear any latched bits.
                // Why wait? Well, the debugger can kick in shortly after
                // this function returns, and we want the duplex setting
                // on the MAC to match the PHY.

                miiWaitForAutoNegotiation( phyId );
                miiReadWord(&phyStatus, MII_STATUS, phyId);
                miiReadWord(&phyStatus, MII_STATUS, phyId);
            }

            if ( (phyStatus & MII_STATUS_LINK_STATUS) &&
                 (firstPoll || (phyStatus & MII_STATUS_NEGOTIATION_COMPLETE)) )
            {
                if ( (phyType & MII_ST10040_MASK) == MII_ST10040_ID )
                {
                    miiReadWord(&phyReg, MII_ST10040_CHIPST, phyId);
                    linkSpeed  = (phyReg & MII_ST10040_CHIPST_SPEED) ?
                                      100 : 10;
                    fullDuplex = (phyReg & MII_ST10040_CHIPST_DUPLEX) ?
                                      true : false;
                }
                else if ( (phyType & MII_DP83843_MASK) == MII_DP83843_ID )
                {
                    miiReadWord(&phyReg, MII_DP83843_PHYSTS, phyId);
                    linkSpeed  = (phyReg & MII_DP83843_PHYSTS_SPEED10) ?
                                      10 : 100;
                    fullDuplex = (phyReg & MII_DP83843_PHYSTS_DUPLEX) ?
                                      true : false;
                }
                else
                {
                    linkSpeed  = 0;
                    fullDuplex = false;
                }

                if ( fullDuplex != isFullDuplex )
                {							
                    _setDuplexMode(fullDuplex);
                }

                linkStatus = kIONetworkLinkActive | kIONetworkLinkValid;
            }
            else
            {
                linkStatus = kIONetworkLinkValid;
                linkSpeed  = 0;
                fullDuplex = false;
            }

            reportLinkStatus = true;
            phyStatusPrev = phyStatus;
        }
    }
    
    if ( reportLinkStatus )
    {
        IONetworkMedium	* medium;
        IOMediumType      mediumType;

        switch ( linkSpeed )
        {
            case 10:
                mediumType  = kIOMediumEthernet10BaseT;
                mediumType |= (fullDuplex == true) ?
                                kIOMediumOptionFullDuplex :
                                kIOMediumOptionHalfDuplex;
                break;
            case 100:
                mediumType  = kIOMediumEthernet100BaseTX;
                mediumType |= (fullDuplex == true) ?
                                kIOMediumOptionFullDuplex :
                                kIOMediumOptionHalfDuplex;
                break;
            default:
                mediumType  = kIOMediumEthernetNone;
                break;
        }

        medium = IONetworkMedium::getMediumWithType(mediumDict, mediumType);
        
        setLinkStatus( linkStatus, medium, linkSpeed * 1000000 );
        
        if ( linkStatus & kIONetworkLinkActive )
            IOLog( "BMacEnet::monitorLinkStatus: Link up at %ld Mbps - %s Duplex\n",
                   linkSpeed, (fullDuplex) ? "Full" : "Half" );
        else
            IOLog( "BMacEnet::monitorLinkStatus: Link down\n" );
    }
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

const OSString * BMacEnet::newVendorString() const
{
	return OSString::withCString("Apple");
}

const OSString * BMacEnet::newModelString() const
{
	return OSString::withCString("BMac");
}

const OSString * BMacEnet::newRevisionString() const
{
	return OSString::withCString("");
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

IOReturn BMacEnet::setPromiscuousMode(IOEnetPromiscuousMode mode)
{
    u_int16_t		rxCFGVal;
    
	reserveDebuggerLock();

    /*
     * Turn off the receiver and wait for the chipset to acknowledge
     */
    rxCFGVal = ReadBigMacRegister(ioBaseEnet, kRXCFG);
    WriteBigMacRegister(ioBaseEnet, kRXCFG, rxCFGVal & ~kRxMACEnable );
    while( ReadBigMacRegister(ioBaseEnet, kRXCFG) & kRxMACEnable )
		;

    /*
     * Set or reset promiscuous mode and restore receiver state
     */
	if (mode == kIOEnetPromiscuousModeOff) {
		rxCFGVal &= ~kRxPromiscEnable;
		isPromiscuous = false;
	}
	else {
		rxCFGVal |= kRxPromiscEnable;
		isPromiscuous = true;
	}

    WriteBigMacRegister( ioBaseEnet, kRXCFG, rxCFGVal );		

	releaseDebuggerLock();
    
    return kIOReturnSuccess;
}

IOReturn BMacEnet::setMulticastMode(IOEnetMulticastMode mode)
{
	multicastEnabled = (mode == kIOEnetMulticastModeOff) ? false : true;

	return kIOReturnSuccess;
}

IOReturn BMacEnet::setMulticastList(IOEthernetAddress *addrs, UInt32 count)
{
	reserveDebuggerLock();
	_resetHashTableMask();
	for (UInt32 i = 0; i < count; i++) {
		_addToHashTableMask(addrs->bytes);
		addrs++;
	}
	_updateBMacHashTableMask();
	releaseDebuggerLock();
	return kIOReturnSuccess;
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

static struct MediumTable
{
    UInt32	type;
    UInt32	speed;
} 
mediumTable[] =
{
    { kIOMediumEthernetNone                                  ,    0    },
    { kIOMediumEthernetAuto                                  ,    0    },
    { kIOMediumEthernet10BaseT    | kIOMediumOptionHalfDuplex,	  10   },
    { kIOMediumEthernet10BaseT    | kIOMediumOptionFullDuplex,	  10   },
    { kIOMediumEthernet100BaseTX  | kIOMediumOptionHalfDuplex,	  100  },
    { kIOMediumEthernet100BaseTX  | kIOMediumOptionFullDuplex,	  100  },
};


bool BMacEnet::createMediumTables()
{
    IONetworkMedium		*medium;
    UInt32			i;

    mediumDict = OSDictionary::withCapacity( sizeof(mediumTable)/sizeof(mediumTable[0]) );
    if ( mediumDict == 0 ) return false;

    for ( i=0; i < sizeof(mediumTable)/sizeof(mediumTable[0]); i++ )
    {
        medium = IONetworkMedium::medium( mediumTable[i].type, mediumTable[i].speed );
        if ( medium != 0 ) 
        {  
            IONetworkMedium::addMedium( mediumDict, medium );
            medium->release();
        }
    }

    if ( publishMediumDictionary( mediumDict ) != true ) 
    {
        return false;
    }

    medium = IONetworkMedium::getMediumWithType( mediumDict,
                                                 kIOMediumEthernetAuto );

    setCurrentMedium( medium );

    return true;    
}

/*-------------------------------------------------------------------------
 *
 *
 *
 *-------------------------------------------------------------------------*/

/*
 * Kernel Debugger Support 
 */
void BMacEnet::sendPacket( void * pkt, UInt32 pkt_len )
{
	_sendPacket(pkt, pkt_len);
}

void BMacEnet::receivePacket( void *   pkt,
                              UInt32 * pkt_len,
                              UInt32   timeout )
{
    _receivePacket(pkt, (UInt *) pkt_len, timeout);
}

/*
 * Create a WorkLoop serialized output queue object.
 */
IOOutputQueue * BMacEnet::createOutputQueue()
{
	return IOGatedOutputQueue::withTarget( this,
	                                       getWorkLoop(), 
	                                       TRANSMIT_QUEUE_SIZE );
}

/*
 * Power management methods. 
 */

IOReturn BMacEnet::registerWithPolicyMaker(IOService * policyMaker)
{
#define number_of_power_states 2

    static IOPMPowerState ourPowerStates[number_of_power_states] = {
        {1,0,0,0,0,0,0,0,0,0,0,0},
        {1,IOPMDeviceUsable,IOPMPowerOn,IOPMPowerOn,0,0,0,0,0,0,0,0}
        };

    currentPowerState = 1;

    return policyMaker->registerPowerDriver( this,
                                             ourPowerStates,
                                             number_of_power_states );
}

IOReturn BMacEnet::setPowerState( unsigned long powerStateOrdinal,
                                  IOService *   whatDevice )
{
    IOReturn ret = IOPMAckImplied;

    // kprintf( "BMacEnet::setPowerState: setPowerState %d\n", powerStateOrdinal );

    if ( currentPowerState == powerStateOrdinal )
        return IOPMAckImplied;

    switch ( powerStateOrdinal )
    {
        case 0:
            kprintf( "BMacEnet::setPowerState: powering off\n" );
            currentPowerState = powerStateOrdinal;
            break;

        case 1:
            kprintf( "BMacEnet::setPowerState: powering on\n" );
            currentPowerState = powerStateOrdinal;
            break;

        default:
            ret = IOPMNoSuchState;
            break;
    }

    return ret;
}