Power Manager Interfaces. More...

#include <MacTypes.h>
#include <MixedMode.h>
#include <Multiprocessing.h>
#include <NameRegistry.h>
#include <MacErrors.h>

Data Structures
struct	DevicePowerInfo

struct	PowerSummary

struct	ActivityInfo

struct	BatteryInfo

struct	SleepQRec

struct	HDQueueElement

struct	PMgrQueueElement

struct	BatteryTimeRec

struct	WakeupTime

struct	StartupTime

struct	PowerSourceParamBlock

Macros
#define	NewPowerHandlerUPP(userRoutine)

#define	DisposePowerHandlerUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	InvokePowerHandlerUPP(message, param, refCon, regEntryID, userUPP)

#define	NewPowerHandlerProc(userRoutine) NewPowerHandlerUPP(userRoutine)

#define	CallPowerHandlerProc(userRoutine, message, param, refCon, regEntryID) InvokePowerHandlerUPP(message, param, refCon, regEntryID, userRoutine)

#define	kIdleQueueDeviceType "idle-queue"

#define	NewSleepQUPP(userRoutine)

#define	NewHDSpindownUPP(userRoutine)

#define	NewPMgrStateChangeUPP(userRoutine)

#define	DisposeSleepQUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeHDSpindownUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposePMgrStateChangeUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	InvokeSleepQUPP(message, qRecPtr, userUPP)

#define	InvokeHDSpindownUPP(theElement, userUPP) CALL_ONE_PARAMETER_UPP((userUPP), uppHDSpindownProcInfo, (theElement))

#define	InvokePMgrStateChangeUPP(theElement, stateBits, userUPP)

#define	NewSleepQProc(userRoutine) NewSleepQUPP(userRoutine)

#define	NewHDSpindownProc(userRoutine) NewHDSpindownUPP(userRoutine)

#define	NewPMgrStateChangeProc(userRoutine) NewPMgrStateChangeUPP(userRoutine)

#define	CallSleepQProc(userRoutine, message, qRecPtr) InvokeSleepQUPP(message, qRecPtr, userRoutine)

#define	CallHDSpindownProc(userRoutine, theElement) InvokeHDSpindownUPP(theElement, userRoutine)

#define	CallPMgrStateChangeProc(userRoutine, theElement, stateBits) InvokePMgrStateChangeUPP(theElement, stateBits, userRoutine)

Typedefs
typedef UInt32	PowerLevel

typedef void *	param

typedef void UInt32	refCon

typedef void UInt32 RegEntryID *	regEntryID

typedef struct DevicePowerInfo	DevicePowerInfo

typedef struct PowerSummary	PowerSummary

typedef struct ActivityInfo	ActivityInfo

typedef struct BatteryInfo	BatteryInfo

typedef SInt8	ModemByte

typedef SInt8	BatteryByte

typedef SInt8	SoundMixerByte

typedef long	PMResultCode

typedef struct SleepQRec	SleepQRec

typedef SleepQRec *	SleepQRecPtr

typedef struct HDQueueElement	HDQueueElement

typedef struct PMgrQueueElement	PMgrQueueElement

typedef long	stateBits

typedef struct BatteryTimeRec	BatteryTimeRec

typedef struct WakeupTime	WakeupTime

typedef struct StartupTime	StartupTime

typedef SInt16	PowerSourceID

typedef struct PowerSourceParamBlock	PowerSourceParamBlock

typedef PowerSourceParamBlock *	PowerSourceParamBlockPtr

Enumerations
enum	{ modemOnBit = 0 , ringWakeUpBit = 2 , modemInstalledBit = 3 , ringDetectBit = 4 , modemOnHookBit = 5 }

enum	{ modemOnMask = 0x01 , ringWakeUpMask = 0x04 , modemInstalledMask = 0x08 , ringDetectMask = 0x10 , modemOnHookMask = 0x20 }

enum	{ chargerConnBit = 0 , hiChargeBit = 1 , chargeOverFlowBit = 2 , batteryDeadBit = 3 , batteryLowBit = 4 , connChangedBit = 5 }

enum	{ chargerConnMask = 0x01 , hiChargeMask = 0x02 , chargeOverFlowMask = 0x04 , batteryDeadMask = 0x08 , batteryLowMask = 0x10 , connChangedMask = 0x20 }

enum	{ MediaBaySndEnBit = 0 , PCISndEnBit = 1 , ZVSndEnBit = 2 , PCCardSndEnBit = 3 }

enum	{ MediaBaySndEnMask = 0x01 , PCISndEnMask = 0x02 , ZVSndEnMask = 0x04 , PCCardSndEnMask = 0x08 }

enum	{ kSleepRequest = 1 , kSleepDemand = 2 , kSleepWakeUp = 3 , kSleepRevoke = 4 , kSleepUnlock = 4 , kSleepDeny = 5 , kSleepNow = 6 , kDozeDemand = 7 , kDozeWakeUp = 8 , kDozeRequest = 9 , kEnterStandby = 10 , kEnterRun = 11 , kSuspendRequest = 12 , kSuspendDemand = 13 , kSuspendRevoke = 14 , kSuspendWakeUp = 15 , kGetPowerLevel = 16 , kSetPowerLevel = 17 , kDeviceInitiatedWake = 18 , kWakeToDoze = 19 , kDozeToFullWakeUp = 20 , kGetPowerInfo = 21 , kGetWakeOnNetInfo = 22 , kSuspendWakeToDoze = 23 , kEnterIdle = 24 , kStillIdle = 25 , kExitIdle = 26 }

enum	{ sleepRequest = kSleepRequest , sleepDemand = kSleepDemand , sleepWakeUp = kSleepWakeUp , sleepRevoke = kSleepRevoke , sleepUnlock = kSleepUnlock , sleepDeny = kSleepDeny , sleepNow = kSleepNow , dozeDemand = kDozeDemand , dozeWakeUp = kDozeWakeUp , dozeRequest = kDozeRequest , enterStandby = kEnterStandby , enterRun = kEnterRun , suspendRequestMsg = kSuspendRequest , suspendDemandMsg = kSuspendDemand , suspendRevokeMsg = kSuspendRevoke , suspendWakeUpMsg = kSuspendWakeUp , getPowerLevel = kGetPowerLevel , setPowerLevel = kSetPowerLevel }

enum	{ kPMDevicePowerLevel_On = 0 , kPMDevicePowerLevel_D1 = 1 , kPMDevicePowerLevel_D2 = 2 , kPMDevicePowerLevel_Off = 3 }

enum	{ uppPowerHandlerProcInfo = 0x00003FF0 }

enum	{ kUseDefaultMinimumWakeTime = 0 , kPowerSummaryVersion = 1 , kDevicePowerInfoVersion = 1 }

enum	{ kPCIPowerOffAllowed = (1L << 0) }

enum	{ kDevicePCIPowerOffAllowed , kDeviceSupportsPMIS , kDeviceCanAssertPMEDuringSleep , kDeviceUsesCommonLogicPower = (1L << 3) , kDeviceDriverPresent = (1L << 4) , kDeviceDriverSupportsPowerMgt }

enum	{ noCalls = 1 , noRequest = 2 , slpQType = 16 , sleepQType = 16 }

enum	{ kAEMacPowerMgtEvt = FOUR_CHAR_CODE('pmgt') , kAEMacToWake = FOUR_CHAR_CODE('wake') , kAEMacLowPowerSaveData = FOUR_CHAR_CODE('pmsd') , kAEMacEmergencySleep = FOUR_CHAR_CODE('emsl') , kAEMacEmergencyShutdown = FOUR_CHAR_CODE('emsd') }

enum	{ kDeviceDidNotWakeMachine = 0 , kDeviceRequestsFullWake , kDeviceRequestsWakeToDoze }

enum	{ hasWakeupTimer = 0 , hasSharedModemPort = 1 , hasProcessorCycling = 2 , mustProcessorCycle = 3 , hasReducedSpeed = 4 , dynamicSpeedChange = 5 , hasSCSIDiskMode = 6 , canGetBatteryTime = 7 , canWakeupOnRing = 8 , hasDimmingSupport , hasStartupTimer = 10 , hasChargeNotification = 11 , hasDimSuspendSupport , hasWakeOnNetActivity = 13 , hasWakeOnLid = 14 , canPowerOffPCIBus , hasDeepSleep = 16 , hasSleep = 17 , supportsServerModeAPIs , supportsUPSIntegration , hasAggressiveIdling , supportsIdleQueue = 21 }

enum	{ hasInternalModem = 0 , intModemRingDetect = 1 , intModemOffHook = 2 , intModemRingWakeEnb = 3 , extModemSelected = 4 , modemSetBit = 15 }

enum	{ batteryInstalled = 7 , batteryCharging = 6 , chargerConnected = 5 , upsConnected = 4 , upsIsPowerSource = 3 }

enum	{ HDPwrQType = 0x4844 , PMgrStateQType = 0x504D }

enum	{ pmSleepTimeoutChanged = 0 , pmSleepEnableChanged = 1 , pmHardDiskTimeoutChanged = 2 , pmHardDiskSpindownChanged = 3 , pmDimmingTimeoutChanged = 4 , pmDimmingEnableChanged = 5 , pmDiskModeAddressChanged = 6 , pmProcessorCyclingChanged = 7 , pmProcessorSpeedChanged = 8 , pmWakeupTimerChanged = 9 , pmStartupTimerChanged = 10 , pmHardDiskPowerRemovedbyUser = 11 , pmChargeStatusChanged = 12 , pmPowerLevelChanged = 13 , pmWakeOnNetActivityChanged = 14 }

enum	{ pmSleepTimeoutChangedMask = (1 << pmSleepTimeoutChanged) , pmSleepEnableChangedMask = (1 << pmSleepEnableChanged) , pmHardDiskTimeoutChangedMask = (1 << pmHardDiskTimeoutChanged) , pmHardDiskSpindownChangedMask = (1 << pmHardDiskSpindownChanged) , pmDimmingTimeoutChangedMask = (1 << pmDimmingTimeoutChanged) , pmDimmingEnableChangedMask = (1 << pmDimmingEnableChanged) , pmDiskModeAddressChangedMask = (1 << pmDiskModeAddressChanged) , pmProcessorCyclingChangedMask = (1 << pmProcessorCyclingChanged) , pmProcessorSpeedChangedMask = (1 << pmProcessorSpeedChanged) , pmWakeupTimerChangedMask = (1 << pmWakeupTimerChanged) , pmStartupTimerChangedMask = (1 << pmStartupTimerChanged) , pmHardDiskPowerRemovedbyUserMask = (1 << pmHardDiskPowerRemovedbyUser) , pmChargeStatusChangedMask = (1 << pmChargeStatusChanged) , pmPowerLevelChangedMask = (1 << pmPowerLevelChanged) , pmWakeOnNetActivityChangedMask = (1 << pmWakeOnNetActivityChanged) }

enum	{ OverallAct = 0 , UsrActivity = 1 , NetActivity = 2 , HDActivity , IdleActivity = 4 }

enum	{ kMediaModeOn = 0 , kMediaModeStandBy = 1 , kMediaModeSuspend = 2 , kMediaModeOff = 3 }

enum	{ kMediaPowerCSCode = 70 }

enum	{ kHDQueuePostBit = 0 , kHDQueuePostMask = (1 << kHDQueuePostBit) }

enum	{ kVersionOnePowerSource = 1 , kVersionTwoPowerSource = 2 , kCurrentPowerSourceVersion = kVersionTwoPowerSource }

enum	{ bSourceIsBattery = 0 , bSourceIsAC = 1 , bSourceCanBeCharged = 2 , bSourceIsUPS = 3 , bSourceProvidesWarnLevels , kSourceIsBatteryMask = (1 << bSourceIsBattery) , kSourceIsACMask = (1 << bSourceIsAC) , kSourceCanBeChargedMask = (1 << bSourceCanBeCharged) , kSourceIsUPSMask = (1 << bSourceIsUPS) , kSourceProvidesWarnLevelsMask = (1 << bSourceProvidesWarnLevels) }

enum	{ bSourceIsAvailable = 0 , bSourceIsCharging = 1 , bChargerIsAttached = 2 , kSourceIsAvailableMask = (1 << bSourceIsAvailable) , kSourceIsChargingMask = (1 << bSourceIsCharging) , kChargerIsAttachedMask = (1 << bChargerIsAttached) }

enum	{ kCapacityIsActual = 0 , kCapacityIsPercentOfMax }

enum	{ kConfigSupportsWakeOnNetBit = 0 , kWakeOnNetAdminAccessesBit = 1 , kWakeOnAllNetAccessesBit = 2 , kUnmountServersBeforeSleepingBit = 3 , kConfigSupportsWakeOnNetMask = (1 << kConfigSupportsWakeOnNetBit) , kWakeOnNetAdminAccessesMask = (1 << kWakeOnNetAdminAccessesBit) , kWakeOnAllNetAccessesMask = (1 << kWakeOnAllNetAccessesBit) , kUnmountServersBeforeSleepingMask = (1 << kUnmountServersBeforeSleepingBit) }

enum	{ kCurrentCapacityIsActualValue , kCurrentCapacityIsPercentOfMax }

enum	{ uppSleepQProcInfo = 0x00131832 }

enum	{ uppHDSpindownProcInfo = 0x000000C0 }

enum	{ uppPMgrStateChangeProcInfo = 0x000003C0 }

Functions
typedef	CALLBACK_API (OSStatus, PowerHandlerProcPtr)(UInt32 message

typedef	STACK_UPP_TYPE (PowerHandlerProcPtr) PowerHandlerUPP

PowerHandlerUPP	NewPowerHandlerUPP (PowerHandlerProcPtr userRoutine)

void	DisposePowerHandlerUPP (PowerHandlerUPP userUPP)

OSStatus	InvokePowerHandlerUPP (UInt32 message, void param, UInt32 refCon, RegEntryID regEntryID, PowerHandlerUPP userUPP)

typedef	CALLBACK_API_REGISTER68K (long, SleepQProcPtr,(long message, SleepQRecPtr qRecPtr))

typedef	CALLBACK_API (void, HDSpindownProcPtr)(HDQueueElement *theElement)

typedef	CALLBACK_API (void, PMgrStateChangeProcPtr)(PMgrQueueElement *theElement

typedef	REGISTER_UPP_TYPE (SleepQProcPtr) SleepQUPP

typedef	STACK_UPP_TYPE (HDSpindownProcPtr) HDSpindownUPP

typedef	STACK_UPP_TYPE (PMgrStateChangeProcPtr) PMgrStateChangeUPP

OSErr	DisableWUTime (void)
	Disable the wakeup timer. More...

OSErr	SetWUTime (long wuTime)
	Set and enable the wakeup timer. More...

OSErr	GetWUTime (long wuTime, Byte wuFlag)
	Get the current wakeup time settings. More...

OSErr	BatteryStatus (Byte status, Byte power)
	Get status of battery charger and voltage level. More...

OSErr	ModemStatus (Byte *status)
	Get information about Mac Portable internal modem. More...

long	IdleUpdate (void)
	Reset the activity timer. More...

long	GetCPUSpeed (void)
	Return the current effective clock speed of the CPU. More...

void	EnableIdle (void)
	Enable the Idle state. More...

void	DisableIdle (void)
	Disable the Idle state. More...

void	SleepQInstall (SleepQRecPtr qRecPtr)
	Add an entry to the sleep queue. More...

void	SleepQRemove (SleepQRecPtr qRecPtr)
	Remove an entry from the sleep queue. More...

void	AOn (void)
	Switch on power to the SCC and the -5 volt supply. More...

void	AOnIgnoreModem (void)
	Switch on power to SCC, -5 volt supply and serial driver chips. More...

void	BOn (void)
	Switch on power to SCC, -5 volt supply and serial driver chips. More...

void	AOff (void)
	Switch off power to SCC and -5 volt supply if portB not in use. More...

void	BOff (void)
	Switch off power to SCC and -5 volt supply if portA not in use. More...

short	PMSelectorCount (void)

UInt32	PMFeatures (void)

UInt8	GetSleepTimeout (void)

void	SetSleepTimeout (UInt8 timeout)

UInt8	GetHardDiskTimeout (void)

void	SetHardDiskTimeout (UInt8 timeout)

Boolean	HardDiskPowered (void)

void	SpinDownHardDisk (void)

Boolean	IsSpindownDisabled (void)

void	SetSpindownDisable (Boolean setDisable)

OSErr	HardDiskQInstall (HDQueueElement *theElement)

OSErr	HardDiskQRemove (HDQueueElement *theElement)

void	GetScaledBatteryInfo (short whichBattery, BatteryInfo *theInfo)

void	AutoSleepControl (Boolean enableSleep)

UInt32	GetIntModemInfo (void)

void	SetIntModemState (short theState)

short	MaximumProcessorSpeed (void)

short	MinimumProcessorSpeed (void)

short	CurrentProcessorSpeed (void)

Boolean	FullProcessorSpeed (void)

Boolean	SetProcessorSpeed (Boolean fullSpeed)

short	GetSCSIDiskModeAddress (void)

void	SetSCSIDiskModeAddress (short scsiAddress)

void	GetWakeupTimer (WakeupTime *theTime)

void	SetWakeupTimer (WakeupTime *theTime)

Boolean	IsProcessorCyclingEnabled (void)

void	EnableProcessorCycling (Boolean enable)

short	BatteryCount (void)

Fixed	GetBatteryVoltage (short whichBattery)

void	GetBatteryTimes (short whichBattery, BatteryTimeRec *theTimes)

UInt8	GetDimmingTimeout (void)

void	SetDimmingTimeout (UInt8 timeout)

void	DimmingControl (Boolean enableSleep)

Boolean	IsDimmingControlDisabled (void)

Boolean	IsAutoSlpControlDisabled (void)

OSErr	PMgrStateQInstall (PMgrQueueElement *theElement)

OSErr	PMgrStateQRemove (PMgrQueueElement *theElement)

OSErr	UpdateSystemActivity (UInt8 activity)

OSErr	DelaySystemIdle (void)

OSErr	GetStartupTimer (StartupTime *theTime)

OSErr	SetStartupTimer (StartupTime *theTime)

OSErr	GetLastActivity (ActivityInfo *theActivity)

OSErr	GetSoundMixerState (SoundMixerByte *theSoundMixerByte)

OSErr	SetSoundMixerState (SoundMixerByte *theSoundMixerByte)

Boolean	GetDimSuspendState (void)

void	SetDimSuspendState (Boolean dimSuspendState)

SInt32	GetCoreProcessorTemperature (MPCpuID inCpuID)

OptionBits	GetWakeOnNetworkOptions (void)

void	SetWakeOnNetworkOptions (OptionBits inOptions)

OSStatus	AddPowerSource (PowerSourceParamBlock *ioPowerSource)

OSStatus	RemovePowerSource (PowerSourceID inSourceID)

OSStatus	UpdatePowerSource (PowerSourceParamBlock *ioSource)

Boolean	IsServerModeEnabled (void)

void	EnableServerMode (Boolean inEnable)

UInt32	NumBatteriesInstalled (void)

Boolean	IsPCIPowerOffDisabled (void)

void	EnablePCIPowerOff (Boolean inEnable)

OSStatus	AddDevicePowerHandler (RegEntryIDPtr regEntryID, PowerHandlerProcPtr handler, UInt32 refCon, char *deviceType)

OSStatus	RemoveDevicePowerHandler (RegEntryIDPtr regEntryID)

OSStatus	RemoveDevicePowerHandlerForProc (PowerHandlerProcPtr proc)

OSStatus	GetDevicePowerLevel (RegEntryIDPtr regEntryID, PowerLevel *devicePowerLevel)

OSStatus	SetDevicePowerLevel (RegEntryIDPtr regEntryID, PowerLevel devicePowerLevel)

SleepQUPP	NewSleepQUPP (SleepQProcPtr userRoutine)

HDSpindownUPP	NewHDSpindownUPP (HDSpindownProcPtr userRoutine)

PMgrStateChangeUPP	NewPMgrStateChangeUPP (PMgrStateChangeProcPtr userRoutine)

void	DisposeSleepQUPP (SleepQUPP userUPP)

void	DisposeHDSpindownUPP (HDSpindownUPP userUPP)

void	DisposePMgrStateChangeUPP (PMgrStateChangeUPP userUPP)

long	InvokeSleepQUPP (long message, SleepQRecPtr qRecPtr, SleepQUPP userUPP)

void	InvokeHDSpindownUPP (HDQueueElement *theElement, HDSpindownUPP userUPP)

void	InvokePMgrStateChangeUPP (PMgrQueueElement *theElement, long stateBits, PMgrStateChangeUPP userUPP)

Detailed Description

Power Manager Interfaces.

Introduced In: Mac OS 9

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1990-2001 by Apple Computer, Inc. All rights reserved

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ InvokePMgrStateChangeUPP

#define InvokePMgrStateChangeUPP	(	theElement,
		stateBits,
		userUPP
	)

Value:

CALL_TWO_PARAMETER_UPP((userUPP), uppPMgrStateChangeProcInfo, (theElement), \

(stateBits))

◆ InvokePowerHandlerUPP

#define InvokePowerHandlerUPP	(	message,
		param,
		refCon,
		regEntryID,
		userUPP
	)

Value:

  (OSStatus)                                                                 \
      CALL_FOUR_PARAMETER_UPP((userUPP), uppPowerHandlerProcInfo, (message), \
                              (param), (refCon), (regEntryID))

◆ InvokeSleepQUPP

#define InvokeSleepQUPP	(	message,
		qRecPtr,
		userUPP
	)

Value:

(long)CALL_TWO_PARAMETER_UPP((userUPP), uppSleepQProcInfo, (message), \

(qRecPtr))

◆ kIdleQueueDeviceType

#define kIdleQueueDeviceType "idle-queue"

Use kIdleQueueDeviceType as the deviceType argument to AddDevicePowerHandler() to get the handler into the idle queue instead of the device sleep queue.

◆ NewHDSpindownUPP

#define NewHDSpindownUPP ( userRoutine )

Value:

(HDSpindownUPP) NewRoutineDescriptor( \

(ProcPtr)(userRoutine), uppHDSpindownProcInfo, GetCurrentArchitecture())

NewRoutineDescriptor

UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

◆ NewPMgrStateChangeUPP

#define NewPMgrStateChangeUPP ( userRoutine )

Value:

  (PMgrStateChangeUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppPMgrStateChangeProcInfo, \
                           GetCurrentArchitecture())

◆ NewPowerHandlerUPP

#define NewPowerHandlerUPP ( userRoutine )

Value:

  (PowerHandlerUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppPowerHandlerProcInfo, \
                           GetCurrentArchitecture())

◆ NewSleepQUPP

#define NewSleepQUPP ( userRoutine )

Value:

(SleepQUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppSleepQProcInfo, \

GetCurrentArchitecture())

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

These are result values returned by a Power Handler when queries by the Power Mgr if the device which that Power Handler represents woke the machine.

Function Documentation

◆ AddDevicePowerHandler()

OSStatus AddDevicePowerHandler	(	RegEntryIDPtr	regEntryID,
		PowerHandlerProcPtr	handler,
		UInt32	refCon,
		char *	deviceType
	)

AddDevicePowerHandler()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ AddPowerSource()

OSStatus AddPowerSource ( PowerSourceParamBlock * ioPowerSource )

AddPowerSource()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ AOff()

void AOff ( void )

Switch off power to SCC and -5 volt supply if portB not in use.

The AOff procedure always switches off power to the SCC and the -5 volt
supply if serial port B is not in use. If the internal modem is installed,
connected to port A, and switched on, this procedure switches off power to the
modem. If any of these conditions are not met, it switches off power to the serial
driver chips, unless they are being used by port B.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ AOn()

void AOn ( void )

Switch on power to the SCC and the -5 volt supply.

The AOn procedure always switches on power to the SCC and the -5 volt
supply. If the internal modem is installed and is connected to port A, this
procedure also switches on power to the modem. If either of these conditions is
not met, the AOn procedure switches on power to the serial driver chips.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ AOnIgnoreModem()

void AOnIgnoreModem ( void )

Switch on power to SCC, -5 volt supply and serial driver chips.

The AOnIgnoreModem procedure switches on power to the SCC, the -5 volt
supply, and the serial driver chips. This procedure does not switch on power to
the internal modem, even if the user has used the Portable control panel to
select the modem.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ AutoSleepControl()

void AutoSleepControl ( Boolean enableSleep )

AutoSleepControl()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ BatteryCount()

short BatteryCount ( void )

BatteryCount()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ BatteryStatus()

OSErr BatteryStatus	(	Byte *	status,
		Byte *	power
	)

Get status of battery charger and voltage level.

The BatteryStatus function returns the status of the battery charger and
the voltage level of the battery. The bits in the Status parameter are defined as
follows:
BitMeaning
7Reserved.
6Reserved.
5The charger connection has or has not changed state. If 1, the charger
has been recently connected or disconnected.
4The battery warning. If 1, the battery voltage is low.
3The dead battery indicator. This bit is always 0.
2The hicharge counter overflow. If 1, the hicharge counter has
overflowed.
1The charge rate. If 1, the battery is charging at the hicharge rate.
0The charger is or is not connected. If 1, the charger is connected.
The Power Manager monitors the voltage level of the internal battery and
warns the user when the voltage drops below a threshold value stored in
parameter RAM. If the voltage continues to drop and falls below another, lower
value stored in parameter RAM, the Power Manager puts the computer into
the sleep state. The Power Manager provides a function that allows you to
read the state of charge of the battery and the status of the battery charger.
You can use the constants shown Power Mgr Data to check the values of
these bits.
Use the following formula to calculate the battery voltage, where Power is
the value of the Power parameter returned by this function:
voltage = ((Power/100) + 5.12) volts
Due to the nature of lead-acid batteries, the battery power remaining is
difficult to measure accurately. Temperature, load, and other factors can alter
the measured voltage by 30 percent or more. The Power Manager takes as
many of these factors into account as possible, but the voltage measurement can
still be in error by up to 10 percent. The measurement is most accurate when
the Macintosh Portable has been in the sleep state for at least 30 minutes.
When the battery charger is connected to a Macintosh Portable computer with
a low battery, the battery is charged at the hicharge rate (1.5 amps) until
battery voltage reaches 7.2 volts. The Power Manager has a counter (the
hicharge counter ) that measures the time required to raise the battery
voltage to this level.
After the 7.2 volt level is reached, the power management circuits maintain
the hicharge connection until the hicharge counter counts down to 0. This

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ BOff()

void BOff ( void )

Switch off power to SCC and -5 volt supply if portA not in use.

The BOff procedure switches off power to the SCC and the -5 volt supply if
serial port A is not in use. If the internal modem is installed, connected to port
B, and switched on, this procedure switches off power to the modem. Otherwise,
the BOff procedure switches off power to the serial driver chips, unless they
are being used by port A.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ BOn()

void BOn ( void )

Switch on power to SCC, -5 volt supply and serial driver chips.

The BOn procedure always switches on power to the SCC, the -5 volt supply,
and the serial driver chips.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ CurrentProcessorSpeed()

short CurrentProcessorSpeed ( void )

CurrentProcessorSpeed()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DelaySystemIdle()

OSErr DelaySystemIdle ( void )

DelaySystemIdle()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DimmingControl()

void DimmingControl ( Boolean enableSleep )

DimmingControl()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisableIdle()

void DisableIdle ( void )

Disable the Idle state.

The DisableIdle procedure disables the idle state, even if the user has used
the Portable control panel to enable the idle state. Every call to the
DisableIdle procedure must be balanced by a call to the EnableIdle
procedure before the idle state is reenabled.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisableWUTime()

OSErr DisableWUTime ( void )

Disable the wakeup timer.

The DisableWUTime function disables the wakeup timer. You must set a
new wakeup time to reenable the wakeup timer.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisposeHDSpindownUPP()

void DisposeHDSpindownUPP ( HDSpindownUPP userUPP )

DisposeHDSpindownUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisposePMgrStateChangeUPP()

void DisposePMgrStateChangeUPP ( PMgrStateChangeUPP userUPP )

DisposePMgrStateChangeUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ DisposePowerHandlerUPP()

void DisposePowerHandlerUPP ( PowerHandlerUPP userUPP )

DisposePowerHandlerUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeSleepQUPP()

void DisposeSleepQUPP ( SleepQUPP userUPP )

DisposeSleepQUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ EnableIdle()

void EnableIdle ( void )

Enable the Idle state.

The EnableIdle procedure cancels the effect of a call to the DisableIdle
procedure. A call to the EnableIdle procedure enables the idle state only if the
user has not used the Portable control panel to disable the idle state and if
every call to the DisableIdle procedure has been balanced by a call to the
EnableIdle procedure.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ EnablePCIPowerOff()

void EnablePCIPowerOff ( Boolean inEnable )

EnablePCIPowerOff()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ EnableProcessorCycling()

void EnableProcessorCycling ( Boolean enable )

EnableProcessorCycling()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ EnableServerMode()

void EnableServerMode ( Boolean inEnable )

EnableServerMode()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ FullProcessorSpeed()

Boolean FullProcessorSpeed ( void )

FullProcessorSpeed()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetBatteryTimes()

void GetBatteryTimes	(	short	whichBattery,
		BatteryTimeRec *	theTimes
	)

GetBatteryTimes()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetBatteryVoltage()

Fixed GetBatteryVoltage ( short whichBattery )

GetBatteryVoltage()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetCoreProcessorTemperature()

SInt32 GetCoreProcessorTemperature ( MPCpuID inCpuID )

GetCoreProcessorTemperature()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ GetCPUSpeed()

long GetCPUSpeed ( void )

Return the current effective clock speed of the CPU.

The GetCPUSpeed function returns the current effective clock speed of the
CPU. The only values that are returned by this function are 1 and 16,
indicating the clock speed in megahertz.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetDevicePowerLevel()

OSStatus GetDevicePowerLevel	(	RegEntryIDPtr	regEntryID,
		PowerLevel *	devicePowerLevel
	)

GetDevicePowerLevel()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ GetDimmingTimeout()

UInt8 GetDimmingTimeout ( void )

GetDimmingTimeout()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetDimSuspendState()

Boolean GetDimSuspendState ( void )

GetDimSuspendState()

Non-Carbon CFM: in PowerMgrLib 1.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetHardDiskTimeout()

UInt8 GetHardDiskTimeout ( void )

GetHardDiskTimeout()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetIntModemInfo()

UInt32 GetIntModemInfo ( void )

GetIntModemInfo()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetLastActivity()

OSErr GetLastActivity ( ActivityInfo * theActivity )

GetLastActivity()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetScaledBatteryInfo()

void GetScaledBatteryInfo	(	short	whichBattery,
		BatteryInfo *	theInfo
	)

GetScaledBatteryInfo()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetSCSIDiskModeAddress()

short GetSCSIDiskModeAddress ( void )

GetSCSIDiskModeAddress()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetSleepTimeout()

UInt8 GetSleepTimeout ( void )

GetSleepTimeout()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetSoundMixerState()

OSErr GetSoundMixerState ( SoundMixerByte * theSoundMixerByte )

GetSoundMixerState()

Non-Carbon CFM: in PowerMgrLib 1.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetStartupTimer()

OSErr GetStartupTimer ( StartupTime * theTime )

GetStartupTimer()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetWakeOnNetworkOptions()

OptionBits GetWakeOnNetworkOptions ( void )

GetWakeOnNetworkOptions()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ GetWakeupTimer()

void GetWakeupTimer ( WakeupTime * theTime )

GetWakeupTimer()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ GetWUTime()

OSErr GetWUTime	(	long *	wuTime,
		Byte *	wuFlag
	)

Get the current wakeup time settings.

The GetWUTime function returns the current setting of the wakeup timer
and indicates whether the wakeup timer is enabled.
The value returned by the WUTime parameter is the current setting of the
wakeup timer specified as the number of seconds since midnight, January 1,
1904. If the low-order bit (bit 0) of the WUFlag parameter is set to 1, the
wakeup timer is enabled. The other bits in the WUFlag parameter are reserved.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ HardDiskPowered()

Boolean HardDiskPowered ( void )

HardDiskPowered()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ HardDiskQInstall()

OSErr HardDiskQInstall ( HDQueueElement * theElement )

HardDiskQInstall()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ HardDiskQRemove()

OSErr HardDiskQRemove ( HDQueueElement * theElement )

HardDiskQRemove()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ IdleUpdate()

long IdleUpdate ( void )

Reset the activity timer.

IdleUpdate is equivalent to the expression tickCount = Ticks;

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InvokeHDSpindownUPP()

void InvokeHDSpindownUPP	(	HDQueueElement *	theElement,
		HDSpindownUPP	userUPP
	)

InvokeHDSpindownUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InvokePMgrStateChangeUPP()

void InvokePMgrStateChangeUPP	(	PMgrQueueElement *	theElement,
		long	stateBits,
		PMgrStateChangeUPP	userUPP
	)

InvokePMgrStateChangeUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ InvokePowerHandlerUPP()

OSStatus InvokePowerHandlerUPP	(	UInt32	message,
		void *	param,
		UInt32	refCon,
		RegEntryID *	regEntryID,
		PowerHandlerUPP	userUPP
	)

InvokePowerHandlerUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeSleepQUPP()

long InvokeSleepQUPP	(	long	message,
		SleepQRecPtr	qRecPtr,
		SleepQUPP	userUPP
	)

InvokeSleepQUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ IsAutoSlpControlDisabled()

Boolean IsAutoSlpControlDisabled ( void )

IsAutoSlpControlDisabled()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ IsDimmingControlDisabled()

Boolean IsDimmingControlDisabled ( void )

IsDimmingControlDisabled()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ IsPCIPowerOffDisabled()

Boolean IsPCIPowerOffDisabled ( void )

IsPCIPowerOffDisabled()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ IsProcessorCyclingEnabled()

Boolean IsProcessorCyclingEnabled ( void )

IsProcessorCyclingEnabled()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ IsServerModeEnabled()

Boolean IsServerModeEnabled ( void )

IsServerModeEnabled()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ IsSpindownDisabled()

Boolean IsSpindownDisabled ( void )

IsSpindownDisabled()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ MaximumProcessorSpeed()

short MaximumProcessorSpeed ( void )

MaximumProcessorSpeed()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ MinimumProcessorSpeed()

short MinimumProcessorSpeed ( void )

MinimumProcessorSpeed()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ ModemStatus()

OSErr ModemStatus ( Byte * status )

Get information about Mac Portable internal modem.

The ModemStatus function returns information about the internal modem in
the Macintosh Portable computer.
The bits in the Status parameter are defined as follows:
BitMeaning
7Reserved.
6Reserved.
5The modem is on or off hook. If 1, the modem is off hook.
4The ring-detect state. If 1, the modem has detected an incoming call.
3The modem is or is not installed. If 1, an internal modem is installed.
2The state of the ring-wakeup feature. If 1, the ring-wakeup feature
is enabled.
1Reserved; must always be set to 1.
0The modem's power is on or off. If 1, the modem is switched on.
You can use the constants shown in Power Mgr Data to check the values of
these bits.
The user can use the Portable control panel to enable or disable the
ring-wakeup feature. When the ring-wakeup feature is enabled and the
Macintosh Portable is in the sleep state, the Power Manager returns the
computer to the operating state when the modem receives an incoming call.
You can use the serial power control functions described in
Switching Serial Power On and Off to control power to the modem.
The modem indicates that it is off hook whenever it is busy sending or
receiving data or processing commands. The modem cannot receive an incoming
call when it is off hook.

Copyright: THINK Reference © 1991-1992 Symantec Corporation

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NewHDSpindownUPP()

HDSpindownUPP NewHDSpindownUPP ( HDSpindownProcPtr userRoutine )

NewHDSpindownUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NewPMgrStateChangeUPP()

PMgrStateChangeUPP NewPMgrStateChangeUPP ( PMgrStateChangeProcPtr userRoutine )

NewPMgrStateChangeUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NewPowerHandlerUPP()

PowerHandlerUPP NewPowerHandlerUPP ( PowerHandlerProcPtr userRoutine )

NewPowerHandlerUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewSleepQUPP()

SleepQUPP NewSleepQUPP ( SleepQProcPtr userRoutine )

NewSleepQUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ NumBatteriesInstalled()

UInt32 NumBatteriesInstalled ( void )

NumBatteriesInstalled is different from BatteryCount in that it indicates how many batteries are actually available at the time it is called (including UPS batteries). BatteryCount shows a static number of batteries a machine is capable of holding which does NOT include UPS batteries. So, while a desktop might show a BatteryCount of zero, its NumBatteriesInstalled value might be 1 or more if a UPS is attached. NumBatteriesInstalled()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ PMFeatures()

UInt32 PMFeatures ( void )

PMFeatures()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ PMgrStateQInstall()

OSErr PMgrStateQInstall ( PMgrQueueElement * theElement )

PMgrStateQInstall()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ PMgrStateQRemove()

OSErr PMgrStateQRemove ( PMgrQueueElement * theElement )

PMgrStateQRemove()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ PMSelectorCount()

short PMSelectorCount ( void )

PMSelectorCount()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ RemoveDevicePowerHandler()

OSStatus RemoveDevicePowerHandler ( RegEntryIDPtr regEntryID )

RemoveDevicePowerHandler()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ RemoveDevicePowerHandlerForProc()

OSStatus RemoveDevicePowerHandlerForProc ( PowerHandlerProcPtr proc )

RemoveDevicePowerHandlerForProc()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ RemovePowerSource()

OSStatus RemovePowerSource ( PowerSourceID inSourceID )

RemovePowerSource()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ SetDevicePowerLevel()

OSStatus SetDevicePowerLevel	(	RegEntryIDPtr	regEntryID,
		PowerLevel	devicePowerLevel
	)

SetDevicePowerLevel()

Non-Carbon CFM: in DriverServicesLib 1.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ SetDimmingTimeout()

void SetDimmingTimeout ( UInt8 timeout )

SetDimmingTimeout()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetDimSuspendState()

void SetDimSuspendState ( Boolean dimSuspendState )

SetDimSuspendState()

Non-Carbon CFM: in PowerMgrLib 1.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetHardDiskTimeout()

void SetHardDiskTimeout ( UInt8 timeout )

SetHardDiskTimeout()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetIntModemState()

void SetIntModemState ( short theState )

SetIntModemState()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetProcessorSpeed()

Boolean SetProcessorSpeed ( Boolean fullSpeed )

SetProcessorSpeed()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetSCSIDiskModeAddress()

void SetSCSIDiskModeAddress ( short scsiAddress )

SetSCSIDiskModeAddress()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetSleepTimeout()

void SetSleepTimeout ( UInt8 timeout )

SetSleepTimeout()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetSoundMixerState()

OSErr SetSoundMixerState ( SoundMixerByte * theSoundMixerByte )

SetSoundMixerState()

Non-Carbon CFM: in PowerMgrLib 1.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetSpindownDisable()

void SetSpindownDisable ( Boolean setDisable )

SetSpindownDisable()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetStartupTimer()

OSErr SetStartupTimer ( StartupTime * theTime )

SetStartupTimer()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetWakeOnNetworkOptions()

void SetWakeOnNetworkOptions ( OptionBits inOptions )

SetWakeOnNetworkOptions()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ SetWakeupTimer()

void SetWakeupTimer ( WakeupTime * theTime )

SetWakeupTimer()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SetWUTime()

OSErr SetWUTime ( long wuTime )

Set and enable the wakeup timer.

The SetWUTime function sets and enables the wakeup timer. When the
Macintosh Portable computer is in the sleep state, the Power Manager
updates the real-time clock and compares it to the wakeup timer once each
second. When the real-time clock and the wakeup timer have the same setting,
the Power Manager returns the Macintosh Portable to the operating state.
The WUTime parameter specifies the time at which the Power Manager
will return the Macintosh Portable to the operating state. You specify the time
as the number of seconds since midnight, January 1, 1904.
If the Macintosh Portable is not in the sleep state when the wakeup timer and
the real-time clock settings coincide, nothing happens. If you set the wakeup
timer to a time earlier than the current setting of the real-time clock, you
effectively disable the wakeup timer.

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SleepQInstall()

void SleepQInstall ( SleepQRecPtr qRecPtr )

Add an entry to the sleep queue.

You can use the SleepQInstall procedure to add an entry to the sleep queue,
and you can use the SleepQRemove procedure to remove an entry from the
sleep queue.
The qRecPtr parameter is a pointer to a sleep queue record that you must
provide.

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SleepQRemove()

void SleepQRemove ( SleepQRecPtr qRecPtr )

Remove an entry from the sleep queue.

You can use the SleepQRemove procedure to remove an entry from the sleep
queue and you can use the SleepQInstall procedure to add an entry to the
sleep queue.
The qRecPtr parameter is a pointer to the sleep queue record that you
provided when you added your routine to the sleep queue.

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ SpinDownHardDisk()

void SpinDownHardDisk ( void )

SpinDownHardDisk()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

◆ UpdatePowerSource()

OSStatus UpdatePowerSource ( PowerSourceParamBlock * ioSource )

UpdatePowerSource()

Non-Carbon CFM: in PowerMgrLib 2.0 and later

Carbon Lib: not available

Mac OS X: not available

◆ UpdateSystemActivity()

OSErr UpdateSystemActivity ( UInt8 activity )

UpdateSystemActivity()

Non-Carbon CFM: in PowerMgrLib 1.0 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ InvokePMgrStateChangeUPP

◆ InvokePowerHandlerUPP

◆ InvokeSleepQUPP

◆ kIdleQueueDeviceType

◆ NewHDSpindownUPP

◆ NewPMgrStateChangeUPP

◆ NewPowerHandlerUPP

◆ NewSleepQUPP

Enumeration Type Documentation

◆ anonymous enum

Function Documentation

◆ AddDevicePowerHandler()

◆ AddPowerSource()

◆ AOff()

◆ AOn()

◆ AOnIgnoreModem()

◆ AutoSleepControl()

◆ BatteryCount()

◆ BatteryStatus()

◆ BOff()

◆ BOn()

◆ CurrentProcessorSpeed()

◆ DelaySystemIdle()

◆ DimmingControl()

◆ DisableIdle()

◆ DisableWUTime()

◆ DisposeHDSpindownUPP()

◆ DisposePMgrStateChangeUPP()

◆ DisposePowerHandlerUPP()

◆ DisposeSleepQUPP()

◆ EnableIdle()

◆ EnablePCIPowerOff()

◆ EnableProcessorCycling()

◆ EnableServerMode()

◆ FullProcessorSpeed()

◆ GetBatteryTimes()

◆ GetBatteryVoltage()

◆ GetCoreProcessorTemperature()

◆ GetCPUSpeed()

◆ GetDevicePowerLevel()

◆ GetDimmingTimeout()

◆ GetDimSuspendState()

◆ GetHardDiskTimeout()

◆ GetIntModemInfo()

◆ GetLastActivity()

◆ GetScaledBatteryInfo()

◆ GetSCSIDiskModeAddress()

◆ GetSleepTimeout()

◆ GetSoundMixerState()

◆ GetStartupTimer()

◆ GetWakeOnNetworkOptions()

◆ GetWakeupTimer()

◆ GetWUTime()

◆ HardDiskPowered()

◆ HardDiskQInstall()

◆ HardDiskQRemove()

◆ IdleUpdate()

◆ InvokeHDSpindownUPP()

◆ InvokePMgrStateChangeUPP()

◆ InvokePowerHandlerUPP()

◆ InvokeSleepQUPP()

◆ IsAutoSlpControlDisabled()

◆ IsDimmingControlDisabled()

◆ IsPCIPowerOffDisabled()

◆ IsProcessorCyclingEnabled()

◆ IsServerModeEnabled()

◆ IsSpindownDisabled()

◆ MaximumProcessorSpeed()

◆ MinimumProcessorSpeed()

◆ ModemStatus()

◆ NewHDSpindownUPP()

◆ NewPMgrStateChangeUPP()

◆ NewPowerHandlerUPP()