RackMac3_1_CPUFanCtrlLoop.cpp   [plain text]


/*
 * Copyright (c) 2002-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 2003-2004 Apple Computer, Inc.  All rights reserved.
 *
 *  File: $Id: RackMac3_1_CPUFanCtrlLoop.cpp,v 1.9 2004/09/27 17:46:59 jlehrer Exp $
 */


#include "IOPlatformPluginDefs.h"
#include "IOPlatformPluginSymbols.h"
#include "RackMac3_1_PlatformPlugin.h"
#include "IOPlatformSensor.h"
#include "RackMac3_1_CPUFanCtrlLoop.h"

#define super IOPlatformPIDCtrlLoop
OSDefineMetaClassAndStructors(RackMac3_1_CPUFanCtrlLoop, IOPlatformPIDCtrlLoop)

extern RackMac3_1_PlatformPlugin * RM31Plugin;
extern const OSSymbol * gRM31DIMMFanCtrlLoopTarget;
extern const OSSymbol * gRM31EnableSlewing;

bool RackMac3_1_CPUFanCtrlLoop::init( void )
{
    if (!super::init()) return(false);

    secondOutputControl = NULL;
    thirdOutputControl = NULL;

    tempHistory[0].sensValue = tempHistory[1].sensValue = 0;
    tempIndex = 0;

    secondsAtMaxCooling = 0;

    return(true);
}

void RackMac3_1_CPUFanCtrlLoop::free( void )
{
    if (secondOutputControl) { secondOutputControl->release(); secondOutputControl = NULL; }

    if (thirdOutputControl) { thirdOutputControl->release(); thirdOutputControl = NULL; }

    super::free();
}

IOReturn RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop( const OSDictionary *dict)
{
    IOReturn status;
    const OSArray * array;
    const OSNumber * num;

    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop ENTERED\n");

    // the cpu-id property tells me which cpu I'm related to
    num = OSDynamicCast(OSNumber, dict->getObject("cpu-id"));
    if (!num)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no cpu-id\n");
        return(kIOReturnError);
    }

    procID = num->unsigned32BitValue();

    // Choose a PID dataset
    if (!choosePIDDataset( dict ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop failed to choose PID dataset\n");
        return(kIOReturnError);
    }

    status = super::initPlatformCtrlLoop(dict);

    // the second control is the second CPU fan (index 1)
    if ((array = OSDynamicCast(OSArray, dict->getObject(kIOPPluginThermalControlIDsKey))) == NULL ||
        (secondOutputControl = platformPlugin->lookupControlByID( OSDynamicCast(OSNumber, array->getObject(1)) )) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no second control ID!!\n");
        return(kIOReturnError);
    }

    secondOutputControl->retain();
    addControl( secondOutputControl );

    // the third control is the third CPU fan (index 2)
    if ((array = OSDynamicCast(OSArray, dict->getObject(kIOPPluginThermalControlIDsKey))) == NULL ||
        (thirdOutputControl = platformPlugin->lookupControlByID( OSDynamicCast(OSNumber, array->getObject(2)) )) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no third control ID!!\n");
        return(kIOReturnError);
    }

    thirdOutputControl->retain();
    addControl( thirdOutputControl );

    if ((array = OSDynamicCast(OSArray, dict->getObject(kIOPPluginThermalSensorIDsKey))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no SensorIDArray\n");
        return(kIOReturnError);
    }

    // voltage sensor is at index 1 in the sensor-id array
    if ((voltageSensor = OSDynamicCast(IOPlatformSensor,
                    platformPlugin->lookupSensorByID( OSDynamicCast(OSNumber, array->getObject(1)) ))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no voltage sensor ID!!\n");
        return(kIOReturnError);
    }

    voltageSensor->retain();
    addSensor( voltageSensor );

    // current sensor is at index 2 in the sensor-id array
    if ((currentSensor = OSDynamicCast(IOPlatformSensor,
        platformPlugin->lookupSensorByID( OSDynamicCast(OSNumber, array->getObject(2)) ))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no current sensor ID!!\n");
        return(kIOReturnError);
    }

    currentSensor->retain();
    addSensor( currentSensor );

    // power sensor is at index 3 in the sensor-id array
    if ((powerSensor = OSDynamicCast(IOPlatformSensor,
        platformPlugin->lookupSensorByID( OSDynamicCast(OSNumber, array->getObject(3)) ))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no power sensor ID!!\n");
        return(kIOReturnError);
    }

    powerSensor->retain();
    addSensor( powerSensor );

#ifdef CTRLLOOP_DEBUG
    const OSNumber * slewID = OSNumber::withNumber( 0x10, 32 );
    if ((slewControl = platformPlugin->lookupControlByID( slewID )) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop no slew control!!\n");
        return(kIOReturnError);
    }
    slewID->release();
#endif

    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::initPlatformCtrlLoop FINISHED\n");

    return(status);
}

bool RackMac3_1_CPUFanCtrlLoop::choosePIDDataset( const OSDictionary * ctrlLoopDict )
{
    int i, count, cmp;
    const OSArray * tmp_array;
    OSArray * metaStateArray;
    OSDictionary * eepromDataset, * plistDataset = NULL, * chosenDataset;
    const OSData * binID, * plistBinID;

    if (!ctrlLoopDict) return(false);

    // get a pointer to the meta state array
    if ((metaStateArray = OSDynamicCast(OSArray, ctrlLoopDict->getObject(gIOPPluginThermalMetaStatesKey))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset failed to find meta state array\n");
        return(false);
    }

    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset proc %u ctrlLoopDict %08lX metaStateArray %08lX\n", procID,
    //		(UInt32) ctrlLoopDict, (UInt32) metaStateArray);

    // extract meta state data from IIC ROM
    if ((eepromDataset = fetchPIDDatasetFromROM()) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset failed to fetch EEPROM dataset\n");
        return(false);
    }

    if ((binID = OSDynamicCast(OSData, eepromDataset->getObject( kRM31ProcessorBinKey ))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset failed to fetch processor bin id\n");
        return(false);
    }

    // Search the plist for a dataset that matches this CPU's bin ID
    if ((tmp_array = OSDynamicCast(OSArray, ctrlLoopDict->getObject( kRM31CPUPIDDatasetsKey ))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset failed to fetch plist datasets\n");
        chosenDataset = eepromDataset;
        goto installChosenDataset;
    }

    count = tmp_array->getCount();

    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset proc %u count %d\n", procID, count);
    
    for (i=0; i<count; i++)
    {
        if ((plistDataset = OSDynamicCast(OSDictionary, tmp_array->getObject(i))) == NULL)
                continue;

        if ((plistBinID = OSDynamicCast(OSData, plistDataset->getObject( kRM31ProcessorBinKey ))) == NULL)
                continue;

        if (binID->isEqualTo(plistBinID))
                break;

        plistDataset = NULL;
    }

    if (plistDataset == NULL)
    {
        // since we don't have a valid parameter list in our plist, use the data fetched from the EEPROM
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset plist datasets don't match processor\n");
        chosenDataset = eepromDataset;
        goto installChosenDataset;
    }

    plistDataset->retain();

    // Compare versions of the eeprom and plist datasets.  Choose the one that's later, or use the
    // eeprom dataset if the versions are equal.
    cmp = comparePIDDatasetVersions( OSDynamicCast(OSData, eepromDataset->getObject(kRM31PIDDatasetVersionKey)),
                    OSDynamicCast(OSData, plistDataset->getObject(kRM31PIDDatasetVersionKey)) );

    if (cmp == -2)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset dataset version comparison failed\n");
        return(false);
    }
    else if (cmp == -1)
    {
        chosenDataset = plistDataset;
        goto installChosenDataset;
    }
    else // cmp == 0 || cmp == 1
    {
        chosenDataset = eepromDataset;
        goto installChosenDataset;
    }

installChosenDataset:
    CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::choosePIDDataset using %s\n",
                    chosenDataset == eepromDataset ? "EEPROM" : "PLIST");
    metaStateArray->replaceObject(0, chosenDataset);
    if (plistDataset) plistDataset->release();
    eepromDataset->release();
    return(true);
}

// Compares two PID dataset versions.  These are four bytes.  The format is as follows:
// 0xuuuabcld
// u = unused
// a = major
// b = minor
// c = very minor
// l = level (d, a, b, f)
// d = rev
//
// so 0x000100d9 is version 1.0.0d9.
//
// comparison procedure is to compare a, then b, then c, then l, then d
//
// this routine returns:
// -1 if v1 is less than v2
// 0 if v1 is equal to v2
// 1 if v1 is greater than v2
// -2 for error

#define MAJOR(x) (((x) & 0x000F0000) >> 16)
#define MINOR(x) (((x) & 0x0000F000) >> 12)
#define VERY_MINOR(x) (((x) & 0x00000F00) >> 8)
#define LEVEL(x) (((x) & 0x000000F0) >> 4)
#define REVISION(x) (((x) & 0x0000000F) >> 0)

int RackMac3_1_CPUFanCtrlLoop::comparePIDDatasetVersions( const OSData * v1, const OSData * v2 ) const
{
    UInt32 lv1, lv2, t1, t2;

    UInt8 levelLookup[] =
    { 	/* 0 */ 0xFF,
	/* 1 */ 0xFF,
	/* 2 */ 0xFF,
	/* 3 */ 0xFF,
	/* 4 */ 0xFF,
	/* 5 */ 0xFF,
	/* 6 */ 0xFF,
	/* 7 */ 0xFF,
	/* 8 */ 0xFF,
	/* 9 */ 0xFF,
	/* A */ 1,
	/* B */ 2,
	/* C */ 0xFF,
	/* D */ 0,
	/* E */ 4,
	/* F */ 3
    };

    if (v1 == NULL || v2 == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::comparePIDDatasetVersions bad args\n");
        return(-2);
    }

    lv1 = (*((UInt32 *) v1->getBytesNoCopy()) & 0x000FFFFF);
    lv2 = (*((UInt32 *) v2->getBytesNoCopy()) & 0x000FFFFF);

    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::comparePIDDatasetVersions %08lX %08lX\n", lv1, lv2);

    // check for equal
    if (lv1 == lv2) return(0);

    // compare major
    t1 = MAJOR(lv1);
    t2 = MAJOR(lv2);

    if (t1 < t2) return(-1);
    else if (t1 > t2) return(1);

    // compare minor
    t1 = MINOR(lv1);
    t2 = MINOR(lv2);

    if (t1 < t2) return(-1);
    else if (t1 > t2) return(1);

    // compare very minor
    t1 = VERY_MINOR(lv1);
    t2 = VERY_MINOR(lv2);

    if (t1 < t2) return(-1);
    else if (t1 > t2) return(1);

    // compare level : d=0, a=1, b=2, f=3
    t1 = (UInt32) levelLookup[LEVEL(lv1)];
    t2 = (UInt32) levelLookup[LEVEL(lv2)];

    if (t1 == 0xFF || t2 == 0xFF)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::comparePIDDatasetVersions invalid version\n");
        return(-2);
    }

    if (t1 < t2) return(-1);
    else if (t1 > t2) return(1);

    t1 = REVISION(lv1);
    t2 = REVISION(lv2);

    if (t1 < t2) return(-1);
    else if (t1 > t2) return(1);

    // if we're here, something is wrong.  The versions are not equal, but they're not greater
    // than or less than either?!?!
    CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::comparePIDDatasetVersions THIS SHOULDN'T HAPPEN\n");
    return(-2);
}
				

OSDictionary *RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM( void ) const
{
    OSDictionary * dataset;
    const OSSymbol * tmp_symbol;
    const OSData * tmp_osdata;
    const OSNumber * tmp_number;
    UInt8 tmp_bytebuf[4];

    if ((dataset = OSDictionary::withCapacity(14)) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to allocate dictionary\n");
        return(NULL);
    }

    // Flag the source of this dataset
    tmp_symbol = OSSymbol::withCString( kRM31PIDDatasetSourceIICROM );
    dataset->setObject( kRM31PIDDatasetSourceKey, tmp_symbol );
    tmp_symbol->release();

    // Get processor bin identifier
    if (!RM31Plugin->readProcROM( procID, 0x08, 3, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch processor bin ID\n");
        goto failReleaseDataset;
    }

    tmp_osdata = OSData::withBytes( tmp_bytebuf, 3 );
    dataset->setObject( kRM31ProcessorBinKey, tmp_osdata );
    tmp_osdata->release();

    // Get dataset version
    if (!RM31Plugin->readProcROM( procID, 0x04, 4, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch processor ROM version\n");
        goto failReleaseDataset;
    }

    tmp_osdata = OSData::withBytes( tmp_bytebuf, 4 );
    dataset->setObject( kRM31PIDDatasetVersionKey, tmp_osdata );
    tmp_osdata->release();

    // Proportional gain (G_p)
    if (!RM31Plugin->readProcROM( procID, 0x2C, 4, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch G_p\n");
        goto failReleaseDataset;
    }

    tmp_osdata = OSData::withBytes( tmp_bytebuf, 4 );
    dataset->setObject( kIOPPIDCtrlLoopProportionalGainKey, tmp_osdata );
    tmp_osdata->release();

    // Reset gain (G_r) -- this is actually used as the power integral gain
    if (!RM31Plugin->readProcROM( procID, 0x30, 4, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch G_r\n");
        goto failReleaseDataset;
    }

    tmp_osdata = OSData::withBytes( tmp_bytebuf, 4 );
    dataset->setObject( kIOPPIDCtrlLoopResetGainKey, tmp_osdata );
    tmp_osdata->release();

    // Derivative gain (G_d)
    if (!RM31Plugin->readProcROM( procID, 0x34, 4, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch G_d\n");
        goto failReleaseDataset;
    }

    tmp_osdata = OSData::withBytes( tmp_bytebuf, 4 );
    dataset->setObject( kIOPPIDCtrlLoopDerivativeGainKey, tmp_osdata );
    tmp_osdata->release();

    // Min output (RPM/PWM)
    if (!RM31Plugin->readProcROM( procID, 0x4C, 2, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch min output\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( *((UInt16 *) tmp_bytebuf), 16 );
    dataset->setObject( kIOPPIDCtrlLoopOutputMinKey, tmp_number );
    tmp_number->release();

    // Max output (RPM/PWM)
    if (!RM31Plugin->readProcROM( procID, 0x4E, 2, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch max output\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( *((UInt16 *) tmp_bytebuf), 16 );
    dataset->setObject( kIOPPIDCtrlLoopOutputMaxKey, tmp_number );
    tmp_number->release();

    // history length
    if (!RM31Plugin->readProcROM( procID, 0x2B, 1, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch history length\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( tmp_bytebuf[0], 8 );
    dataset->setObject( kIOPPIDCtrlLoopHistoryLenKey, tmp_number );
    tmp_number->release();

    // Target temperature
    if (!RM31Plugin->readProcROM( procID, 0x28, 1, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch target temp\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( ((UInt32)tmp_bytebuf[0]) << 16, 32 );
    dataset->setObject( kIOPPIDCtrlLoopInputTargetKey, tmp_number );
    tmp_number->release();

    // Max temperature
    if (!RM31Plugin->readProcROM( procID, 0x29, 1, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch max temp\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( ((UInt32)tmp_bytebuf[0]) << 16, 32 );
    dataset->setObject( kIOPPIDCtrlLoopInputMaxKey, tmp_number );
    tmp_number->release();

    // Max power
    if (!RM31Plugin->readProcROM( procID, 0x2A, 1, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch max power\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( ((UInt32)tmp_bytebuf[0]) << 16, 32 );
    dataset->setObject( kRM31MaxPowerKey, tmp_number );
    tmp_number->release();

    // Power adjustment
    if (!RM31Plugin->readProcROM( procID, 0x27, 1, tmp_bytebuf ))
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::fetchPIDDatasetFromROM failed to fetch max power adjustment\n");
        goto failReleaseDataset;
    }

    tmp_number = OSNumber::withNumber( ((UInt32)tmp_bytebuf[0]) << 16, 32 );
    dataset->setObject( kRM31MaxPowerAdjustmentKey, tmp_number );
    tmp_number->release();

    // The iteration interval is not stored in the ROM, it is always set to 1 second
    dataset->setObject( kIOPPIDCtrlLoopIntervalKey, gIOPPluginOne );

    return(dataset);

failReleaseDataset:
    dataset->release();
    return(NULL);
}

bool RackMac3_1_CPUFanCtrlLoop::updateMetaState( void )
{
    const OSArray * metaStateArray;
    const OSDictionary * metaStateDict;
    const OSNumber * newMetaState;

    // else if there is an overtemp condition, use meta-state 1
    // else if there is a forced meta state, use it
    // else, use meta-state 0

    if ((metaStateArray = OSDynamicCast(OSArray, infoDict->getObject(gIOPPluginThermalMetaStatesKey))) == NULL)
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState no meta state array\n");
        return(false);
    }

    // Check for overtemp condition
	if (platformPlugin->envArrayCondIsTrue(gIOPPluginEnvInternalOvertemp))
	{
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState Entering Overtemp Mode\n");

        if ((metaStateDict = OSDynamicCast(OSDictionary, metaStateArray->getObject(1))) != NULL &&
            (cacheMetaState( metaStateDict ) == true))
        {
            // successfully entered overtemp mode
            setMetaState( gIOPPluginOne );
            return(true);
        }
        else
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState Overtemp Mode Failed!\n");
        }
    }

    // Look for forced meta state
    if ((metaStateDict = OSDynamicCast(OSDictionary, infoDict->getObject(gIOPPluginForceCtrlLoopMetaStateKey))) != NULL)
    {
        if (cacheMetaState( metaStateDict ) == true)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState using forced meta state\n");
            newMetaState = OSNumber::withNumber( 0xFFFFFFFF, 32 );
            setMetaState( newMetaState );
            newMetaState->release();
            return(true);
        }
        else
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState forced meta state is invalid, removing...\n");
            infoDict->removeObject(gIOPPluginForceCtrlLoopMetaStateKey);
        }
    }

    // Use default "Normal" meta state
    if ((metaStateDict = OSDynamicCast(OSDictionary, metaStateArray->getObject(0))) != NULL && (cacheMetaState( metaStateDict ) == true))
    {
        //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState use meta state zero\n");
        setMetaState( gIOPPluginZero );
        return(true);
    }
    else
    {
        // can't find a valid meta state, nothing we can really do except log an error
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::updateMetaState no valid meta states!\n");
        return(false);
    }
}

bool RackMac3_1_CPUFanCtrlLoop::acquireSample( void )
{
	samplePoint * latest;
	SensorValue curValue;
	
	// Set up the temperature history
	if (tempIndex == 1)
		tempIndex = 0;
	else
		tempIndex = 1;
	
	// fetch the temperature reading
	curValue = getAggregateSensorValue();
	
	tempHistory[tempIndex].sensValue = curValue.sensValue;
	
	// move the top of the power array to the next spot -- it's circular
	if (latestSample == 0)
		latestSample = historyLen - 1;
	else
		latestSample -= 1;
	
	// get a pointer to the array element where we'll store this sample point
	latest = &historyArray[latestSample];
	
	// fetch the power reading
	// the power sensor is a "fake" logical sensor.  In order to get a good reading,
	// we have to update the current and power sensors first.
	voltageSensor->setCurrentValue( voltageSensor->forceAndFetchCurrentValue() );
	currentSensor->setCurrentValue( currentSensor->forceAndFetchCurrentValue() );
	
	// the cpu power sensor doesn't need a force update, its fetchCurrentValue() does all the
	// work (there's no IOHWSensor instance to send a message to since it's a fake sensor)
	curValue = powerSensor->fetchCurrentValue();
	powerSensor->setCurrentValue( curValue );
	
	// store the sample in the history
	latest->sample.sensValue = curValue.sensValue;
	
	// calculate the error term and store it
	latest->error.sensValue = powerMaxAdj.sensValue - latest->sample.sensValue;
	
	//CTRLLOOP_DLOG("*** SAMPLE *** InT: 0x%08lX Cur: 0x%08lX Error: 0x%08lX\n",
	//		inputTarget.sensValue, latest->sample.sensValue, latest->error.sensValue);
	
	return(true);
}

bool RackMac3_1_CPUFanCtrlLoop::cacheMetaState( const OSDictionary * metaState )
{
    const OSData * dataG_p, * dataG_d, * dataG_r;
    const OSNumber * numInterval, * numOverride, * numInputTarget, * numInputMax;
    const OSNumber * numOutputMin, * numOutputMax, * numHistLen, * numPowerMax, * numPowerAdj;
    //const OSNumber * tmpNumber;
    samplePoint * sample, * newHistoryArray;
    unsigned int i;
    UInt32 tempInterval, newHistoryLen;

    // cache the interval.  it is listed in seconds.
    if ((numInterval = OSDynamicCast(OSNumber, metaState->getObject("interval"))) != NULL)
    {
        tempInterval = numInterval->unsigned32BitValue();

        if ((tempInterval == 0) || (tempInterval > 300))
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state interval is out of bounds\n");
            goto failNoInterval;
        }
    }
    else
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state interval is absent\n");
        goto failNoInterval;
    }

    // if there is an output-override key, flag it.  Otherwise, look for the full
    // set of coefficients, setpoints and output bounds
    if ((numOverride = OSDynamicCast(OSNumber, metaState->getObject(kIOPPIDCtrlLoopOutputOverrideKey))) != NULL)
    {
        overrideActive = true;
        outputOverride = numOverride;
        outputOverride->retain();

        //CTRLLOOP_DLOG("*** PID CACHE *** Override: 0x%08lX\n", outputOverride->unsigned32BitValue());
    }
    else
    {
        // look for G_p, G_d, G_r, input-target, output-max, output-min
        if ((dataG_p = OSDynamicCast(OSData, metaState->getObject(kIOPPIDCtrlLoopProportionalGainKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no G_p\n");
            goto failFullSet;
        }

        if ((dataG_d = OSDynamicCast(OSData, metaState->getObject(kIOPPIDCtrlLoopDerivativeGainKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no G_d\n");
            goto failFullSet;
        }

        if ((dataG_r = OSDynamicCast(OSData, metaState->getObject(kIOPPIDCtrlLoopResetGainKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no G_r\n");
            goto failFullSet;
        }

        if ((numInputTarget = OSDynamicCast(OSNumber, metaState->getObject(kIOPPIDCtrlLoopInputTargetKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no intput-target\n");
            goto failFullSet;
        }

        if ((numInputMax = OSDynamicCast(OSNumber, metaState->getObject(kIOPPIDCtrlLoopInputMaxKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no input-max\n");
            goto failFullSet;
        }

        if ((numPowerMax = OSDynamicCast(OSNumber, metaState->getObject(kRM31MaxPowerKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no power-max\n");
            goto failFullSet;
        }

        if ((numPowerAdj = OSDynamicCast(OSNumber, metaState->getObject(kRM31MaxPowerAdjustmentKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no power-max-adjustment\n");
            goto failFullSet;
        }

        if ((numOutputMin = OSDynamicCast(OSNumber, metaState->getObject(kIOPPIDCtrlLoopOutputMinKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no output-min\n");
            goto failFullSet;
        }

        if ((numOutputMax = OSDynamicCast(OSNumber, metaState->getObject(kIOPPIDCtrlLoopOutputMaxKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no output-max\n");
            goto failFullSet;
        }

        if ((numHistLen = OSDynamicCast(OSNumber, metaState->getObject(kIOPPIDCtrlLoopHistoryLenKey))) == NULL)
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState meta state has no history-length\n");
            goto failFullSet;
        }

        overrideActive = false;
        if (outputOverride) { outputOverride->release(); outputOverride = NULL; }

        G_p = *((SInt32 *) dataG_p->getBytesNoCopy());
        G_d = *((SInt32 *) dataG_d->getBytesNoCopy());
        G_r = *((SInt32 *) dataG_r->getBytesNoCopy());

        inputTarget.sensValue = (SInt32)numInputTarget->unsigned32BitValue();
        inputMax.sensValue = (SInt32)numInputMax->unsigned32BitValue();

        powerMaxAdj.sensValue = ((SInt32) numPowerMax->unsigned32BitValue()) - ((SInt32) numPowerAdj->unsigned32BitValue());

        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::cacheMetaState powerMaxAdj: %ld\n",
            powerMaxAdj.sensValue >> 16);

        outputMin = numOutputMin->unsigned32BitValue();
        outputMax = numOutputMax->unsigned32BitValue();

        // resize the history array if necessary
        newHistoryLen = numHistLen->unsigned32BitValue();
        if (newHistoryLen == 0) newHistoryLen = 2;	// must be two or more in order to have a valid
                                                        // derivative term

        if (newHistoryLen != historyLen)
        {
            newHistoryArray = (samplePoint *) IOMalloc( sizeof(samplePoint) * newHistoryLen );
            bzero( newHistoryArray, sizeof(samplePoint) * newHistoryLen );

            // copy samples from the old array into the new
            for (i=0; i<historyLen && i<newHistoryLen; i++)
            {
                sample = sampleAtIndex(i);

                (&(newHistoryArray[i]))->sample.sensValue = sample->sample.sensValue;
                (&(newHistoryArray[i]))->error.sensValue = sample->error.sensValue;
            }

            IOFree( historyArray, sizeof(samplePoint) * historyLen );

            historyArray = newHistoryArray;
            historyLen = newHistoryLen;
            latestSample = 0;
        }

//		CTRLLOOP_DLOG("*** PID CACHE *** G_p: 0x%08lX G_d: 0x%08lX G_r: 0x%08lX\n"
//		              "***************** inT: 0x%08lX oMi: 0x%08lX oMa: 0x%08lX\n",
//					  G_p, G_d, G_r, inputTarget, outputMin, outputMax);
    }

    // set the interval
    intervalSec = tempInterval;
    clock_interval_to_absolutetime_interval(intervalSec, NSEC_PER_SEC, &interval);
//	CTRLLOOP_DLOG("***************** Interval: %u\n", intervalSec);

    return(true);

failFullSet:
failNoInterval:
    return(false);

}

ControlValue RackMac3_1_CPUFanCtrlLoop::calculateNewTarget( void ) const
{
    SInt32 pRaw, dRaw, rRaw;
    SInt64 accum, dProd, rProd, pProd;
    //UInt32 result, prevResult, scratch;
    SInt32 result;
    UInt32 newOutputMin;
	ControlValue newTarget;
    SensorValue adjInputTarget, sVal;
    const OSNumber * newDIMMFanCtrlLoopTarget;
	
    // if there is an output override, use it
    if (overrideActive)
    {
        CTRLLOOP_DLOG("*** PID *** Override Active\n");
        newTarget = outputOverride->unsigned32BitValue();
    }

    // apply the PID algorithm to choose a new control target value
    else
    {
        if (ctrlloopState == kIOPCtrlLoopFirstAdjustment)
        {
            result = 0;
        }
        else
        {
            // Calculate the adjusted target
            rRaw = calculateIntegralTerm().sensValue;
            // this is 12.20 * 16.16 => 28.36
            rProd = (SInt64)G_r * (SInt64)rRaw; 
            sVal.sensValue = (SInt32)((rProd >> 20) & 0xFFFFFFFF);
            sVal.sensValue = inputMax.sensValue - sVal.sensValue;

            adjInputTarget.sensValue = inputTarget.sensValue < sVal.sensValue ? inputTarget.sensValue : sVal.sensValue;

            // do the PID iteration
            result = (SInt32)outputControl->getTargetValue();

            // calculate the derivative term
            // apply the derivative gain
            // this is 12.20 * 16.16 => 28.36
            dRaw = calculateDerivativeTerm().sensValue;
            accum = dProd = (SInt64)G_d * (SInt64)dRaw;

            // calculate the reset term
            // apply the reset gain
            // this is 12.20 * 16.16 => 28.36
            //rRaw = calculateIntegralTerm().sensValue;
            //rProd = (SInt64)G_r * (SInt64)rRaw; 
            //accum += rProd;

            // calculate the proportional term
            // apply the proportional gain
            // this is 12.20 * 16.16 => 28.36
            pRaw = tempHistory[tempIndex].sensValue - adjInputTarget.sensValue;
            pProd = (SInt64)G_p * (SInt64)pRaw;
            accum += pProd;
            
            // truncate the fractional part
            accum >>= 36;

            //result = (UInt32)(accum < 0 ? 0 : (accum & 0xFFFFFFFF));
            result += (SInt32)accum;
        }

        newTarget = (UInt32)(result > 0) ? result : 0;
		
		// Determine min fan speed based on DIMM control loop
		newOutputMin = outputMin;
		newDIMMFanCtrlLoopTarget = OSDynamicCast(OSNumber, platformPlugin->getEnv(gRM31DIMMFanCtrlLoopTarget));
		if(newDIMMFanCtrlLoopTarget)
		{
			newOutputMin = newDIMMFanCtrlLoopTarget->unsigned32BitValue();

			if(newOutputMin < outputMin)
				newOutputMin = outputMin;
		}
		
        // apply the hard limits
        if (newTarget < newOutputMin)
            newTarget = newOutputMin;
        else if (newTarget > outputMax)
            newTarget = outputMax;

/*
#ifdef CTRLLOOP_DEBUG
        if (timerCallbackActive)
        {
            const OSString * tempDesc;
            const OSNumber * val;
            val = slewControl->fetchCurrentValue();
            slewControl->setCurrentValue( val );
            val->release();
#endif
            CTRLLOOP_DLOG
            (
                "%s"
                " powerSum=%08lX (%ld)"
                " G_power=%08lX"
                " powerProd=%016llX (%lld)"
                " Ttgt=%08lX (%ld)"
                " Tmax=%08lX (%ld)"
                " TtgtAdj=%08lX (%ld)"
                " T_cur=%08lX (%ld)"
                " T_err=%08lX (%ld)"
                " G_p=%08lX"
                " pProd=%016llX (%lld)"
                " dRaw=%08lX (%ld)"
                " G_d=%08lX"
                " dProd=%016llX (%lld)"
                " Res=%016llX"
                " Out=%lu"
                " Spd=%0u\n",
                (tempDesc = OSDynamicCast( OSString, infoDict->getObject(kIOPPluginThermalGenericDescKey))) != NULL ?
                    tempDesc->getCStringNoCopy() : "Unknown CtrlLoop",
                rRaw, rRaw >> 16,
                G_r,
                rProd, rProd >> 36,
                inputTarget.sensValue, inputTarget.sensValue >> 16,
                inputMax.sensValue, inputMax.sensValue >> 16,
                adjInputTarget.sensValue, adjInputTarget.sensValue >> 16,
                tempHistory[tempIndex].sensValue, tempHistory[tempIndex].sensValue >> 16,
                pRaw, pRaw >> 16,
                G_p,
                pProd, pProd >> 36,
                dRaw, dRaw >> 16,
                G_d,
                dProd, dProd >> 36,
                accum,
                uResult,
                slewControl->getCurrentValue()->unsigned8BitValue()
            );
#ifdef CTRLLOOP_DEBUG
        }
#endif
*/

    }

    return(newTarget);
}

SensorValue RackMac3_1_CPUFanCtrlLoop::calculateDerivativeTerm( void ) const
{
    int latest, previous;
    SensorValue result;

    latest = tempIndex;
    previous = tempIndex == 0 ? 1 : 0;

    // get the change in the error term over the latest inteval
    result.sensValue = tempHistory[latest].sensValue - tempHistory[previous].sensValue;

    // divide by the elapsed time to get the slope
    result.sensValue /= (SInt32)intervalSec;

    return(result);
}

void RackMac3_1_CPUFanCtrlLoop::deadlinePassed( void )
{
    bool deadlineAbsolute;
    bool didSetEnv = false;
    bool tMaxExceededNow, tMaxExceededNowCritical, tMaxExceededPreviously, maxCoolingApplied;
    SensorValue temperatureDiff;

    deadlineAbsolute = (ctrlloopState == kIOPCtrlLoopFirstAdjustment);

    timerCallbackActive = true;

    // sample the input
    if (!acquireSample())
    {
        CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::deadlinePassed FAILED TO ACQUIRE INPUT SAMPLE!!!\n");
    }

    // check to see if we've exceeded the critical temperature
    temperatureDiff.sensValue = tempHistory[tempIndex].sensValue - inputMax.sensValue;

    tMaxExceededPreviously = platformPlugin->envArrayCondIsTrueForObject(this, gRM31EnableSlewing);
    tMaxExceededNow = temperatureDiff.sensValue > 0;

    // if the CPU temperature is above T_max, then we may need to force the machine to sleep
    if (tMaxExceededNow)
    {
        // if tMaxExceededPreviously is true, we know that the internal overtemp flag was set
        // causing the CPU to slew slow
        maxCoolingApplied = (tMaxExceededPreviously &&
            outputControl->getTargetValue() >= outputMax);

        if (maxCoolingApplied)
        {
            secondsAtMaxCooling += intervalSec;
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::deadlinePassed secondsAtMaxCooling=%u\n",
                secondsAtMaxCooling);
        }

        // Check for forced sleep conditions
        // If CPU temperature is above (T_max + 8)
        // -OR-
        // CPU temperature is above (T_max) and max cooling has been applied for 30 seconds or more
        tMaxExceededNowCritical = temperatureDiff.sensValue >= kRM31CPUTempCriticalOffset;

        if (tMaxExceededNowCritical || secondsAtMaxCooling >= kRM31CPUMaxCoolingLimit)
        {
            IOLog("RackMac3,1 Thermal Manager: Thermal Runaway Detected: System Will Sleep\n");
            CTRLLOOP_DLOG("RackMac3,1 Thermal Manager: Thermal Runaway Detected: System Will Sleep\n");
            CTRLLOOP_DLOG("PM72 T_cur=%u, T_max=%u, tMaxExceededNowCritical=%s, secondsAtMaxCooling=%u\n",
                tempHistory[tempIndex].sensValue >> 16, inputMax.sensValue >> 16,
                tMaxExceededNowCritical ? "TRUE" : "FALSE", secondsAtMaxCooling);

            platformPlugin->coreDump();
            platformPlugin->sleepSystem();
        }
    }

    // set or clear the internal overtemp flag as needed.  If set, this causes the CPU to slew slow.
    if (tMaxExceededPreviously && !tMaxExceededNow)
    {
        secondsAtMaxCooling = 0;
        platformPlugin->setEnvArray(gRM31EnableSlewing, this, false);
        didSetEnv = true;
    }
    else if (tMaxExceededNow && !tMaxExceededPreviously)
    {
        platformPlugin->setEnvArray(gRM31EnableSlewing, this, true);
        didSetEnv = true;
    }

    // If we changed the environment, the platform plugin will invoke updateMetaState()
    // and adjustControls().  If not, then we just need to call adjustControls()
    if (!didSetEnv)
    {
        adjustControls();
    }

    // set the deadline
    if (deadlineAbsolute)
    {
        // this is the first time we're setting the deadline.  In order to better stagger
        // timer callbacks, offset the deadline by 100us * ctrlloopID.
        AbsoluteTime adjustedInterval;
        const OSNumber * id = getCtrlLoopID();

        // 100 * ctrlLoopID -> absolute time format
        clock_interval_to_absolutetime_interval(100 * id->unsigned32BitValue(), NSEC_PER_USEC, &adjustedInterval);

        // Add standard interval to produce adjusted interval
        ADD_ABSOLUTETIME( &adjustedInterval, &interval );

        clock_absolutetime_interval_to_deadline(adjustedInterval, &deadline);
    }
    else
    {
        ADD_ABSOLUTETIME(&deadline, &interval);
    }

    timerCallbackActive = false;
}

void RackMac3_1_CPUFanCtrlLoop::sendNewTarget( ControlValue newTarget )
{
    // If the new target value is different, send it to the control
    if (ctrlloopState == kIOPCtrlLoopFirstAdjustment ||
        ctrlloopState == kIOPCtrlLoopDidWake ||
        newTarget != outputControl->getTargetValue() )
    {
        if (outputControl->sendTargetValue( newTarget ))
        {
            outputControl->setTargetValue(newTarget);
            ctrlloopState = kIOPCtrlLoopAllRegistered;
        }
        else
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::sendNewTarget failed to send target value to first control\n");
        }

        if (secondOutputControl->sendTargetValue( newTarget ))
        {
            secondOutputControl->setTargetValue(newTarget);
            ctrlloopState = kIOPCtrlLoopAllRegistered;
        }
        else
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::sendNewTarget failed to send target value to second control\n");
        }

        if (thirdOutputControl->sendTargetValue( newTarget ))
        {
            thirdOutputControl->setTargetValue(newTarget);
            ctrlloopState = kIOPCtrlLoopAllRegistered;
        }
        else
        {
            CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::sendNewTarget failed to send target value to third control\n");
        }
    }
}

void RackMac3_1_CPUFanCtrlLoop::sensorRegistered( IOPlatformSensor * aSensor )
{
    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::sensorRegistered - entered\n");
    if( outputControl->isRegistered() == kOSBooleanTrue &&
		secondOutputControl->isRegistered() == kOSBooleanTrue &&
		thirdOutputControl->isRegistered() == kOSBooleanTrue &&
		inputSensor->isRegistered() == kOSBooleanTrue &&
        voltageSensor->isRegistered() == kOSBooleanTrue &&
        currentSensor->isRegistered() == kOSBooleanTrue )
    {
        //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::sensorRegistered allRegistered!\n");

        ctrlloopState = kIOPCtrlLoopFirstAdjustment;

        // set the deadline
        deadlinePassed();
    }
}

void RackMac3_1_CPUFanCtrlLoop::controlRegistered( IOPlatformControl * aControl )
{
    //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::controlRegistered - entered\n");
    
    if( outputControl->isRegistered() == kOSBooleanTrue &&
		secondOutputControl->isRegistered() == kOSBooleanTrue &&
		thirdOutputControl->isRegistered() == kOSBooleanTrue &&
		inputSensor->isRegistered() == kOSBooleanTrue &&
        voltageSensor->isRegistered() == kOSBooleanTrue &&
        currentSensor->isRegistered() == kOSBooleanTrue )
    {
        //CTRLLOOP_DLOG("RackMac3_1_CPUFanCtrlLoop::controlRegistered allRegistered!\n");

        ctrlloopState = kIOPCtrlLoopFirstAdjustment;

        // set the deadline
        deadlinePassed();
    }
}