[apple/xnu.git] / iokit / IOKit / IOPlatformExpert.h

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * 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. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * 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_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved. 
 *
 * HISTORY
 *
 */


#ifndef _IOKIT_IOPLATFORMEXPERT_H
#define _IOKIT_IOPLATFORMEXPERT_H

#ifdef __cplusplus
#include <IOKit/IOLib.h>
#include <IOKit/IOService.h>
#include <IOKit/IOInterrupts.h>
#include <IOKit/IOInterruptController.h>

extern "C" {
#endif

#include <libkern/OSTypes.h>

typedef enum {
    kCoprocessorVersionNone    =   0x00000000,
    kCoprocessorVersion1       =   0x00010000,
    kCoprocessorVersion2       =   0x00020000,
} coprocessor_type_t;


extern boolean_t PEGetMachineName( char * name, int maxLength );
extern boolean_t PEGetModelName( char * name, int maxLength );
extern int PEGetPlatformEpoch( void );

enum {
  kPEHaltCPU,
  kPERestartCPU,
  kPEHangCPU,
  kPEUPSDelayHaltCPU,
  kPEPanicRestartCPU,
  kPEPanicSync,
  kPEPagingOff,
  kPEPanicBegin,
  kPEPanicEnd,
  kPEPanicDiskShutdown
};
extern int (*PE_halt_restart)(unsigned int type);
extern int PEHaltRestart(unsigned int type);

#ifdef XNU_KERNEL_PRIVATE
enum {
	kIOSystemShutdownNotificationStageProcessExit = 0,
	kIOSystemShutdownNotificationStageRootUnmount = 1,
};
extern void IOSystemShutdownNotification(int stage);
#endif /* XNU_KERNEL_PRIVATE */

// Save the Panic Info.  Returns the number of bytes saved.
extern UInt32 PESavePanicInfo(UInt8 *buffer, UInt32 length);
extern void PESavePanicInfoAction(void *buffer, UInt32 offset, UInt32 length);

/* 
 * SMC requires that all data is flushed in multiples of 16 bytes at 16 byte
 * boundaries.
 */
#define PANIC_FLUSH_BOUNDARY 16

extern long PEGetGMTTimeOfDay( void );
extern void PESetGMTTimeOfDay( long secs );
extern void PEGetUTCTimeOfDay( clock_sec_t * secs, clock_usec_t * usecs );
extern void PESetUTCTimeOfDay( clock_sec_t secs, clock_usec_t usecs );

/* unless it's a "well-known" property, these will read/write out the value as raw data */

extern boolean_t PEWriteNVRAMBooleanProperty(const char *symbol, boolean_t value);
extern boolean_t PEWriteNVRAMProperty(const char *symbol, const void *value, const unsigned int len);

extern boolean_t PEReadNVRAMProperty(const char *symbol, void *value, unsigned int *len);

extern boolean_t PERemoveNVRAMProperty(const char *symbol);

extern coprocessor_type_t PEGetCoprocessorVersion( void );

#ifdef __cplusplus
} /* extern "C" */

#define kIOPlatformMapperPresentKey "IOPlatformMapperPresent"


extern OSSymbol *               gPlatformInterruptControllerName;

extern const OSSymbol *		gIOPlatformSleepActionKey;
extern const OSSymbol *		gIOPlatformWakeActionKey;
extern const OSSymbol *		gIOPlatformQuiesceActionKey;
extern const OSSymbol *		gIOPlatformActiveActionKey;
extern const OSSymbol *		gIOPlatformHaltRestartActionKey;
extern const OSSymbol *		gIOPlatformPanicActionKey;

class IORangeAllocator;
class IONVRAMController;
class IOPMrootDomain;

class IOPlatformExpert : public IOService
{
    OSDeclareDefaultStructors(IOPlatformExpert);

private:
    long _peBootROMType;
    long _peChipSetType;
    long _peMachineType;

protected:
    IOPMrootDomain * root;
    int _pePMFeatures;
    int _pePrivPMFeatures;
    int _peNumBatteriesSupported;
    OSArray  * thePowerTree;

    bool       searchingForAdditionalParents;
    OSNumber * multipleParentKeyValue;
    int        numInstancesRegistered;

    struct ExpansionData { };
    ExpansionData *iope_reserved __unused;

    virtual void setBootROMType(long peBootROMType);
    virtual void setChipSetType(long peChipSetType);
    virtual void setMachineType(long peMachineType);

    virtual bool CheckSubTree (OSArray * inSubTree, IOService * theNub, IOService * theDevice, OSDictionary * theParent);
    virtual bool RegisterServiceInTree (IOService * theService, OSDictionary * theTreeNode, OSDictionary * theTreeParentNode, IOService * theProvider);

    virtual void PMInstantiatePowerDomains ( void );

public:
    virtual bool attach( IOService * provider ) APPLE_KEXT_OVERRIDE;
    virtual bool start( IOService * provider ) APPLE_KEXT_OVERRIDE;
    virtual bool configure( IOService * provider );
    virtual IOService * createNub( OSDictionary * from );

    virtual bool compareNubName( const IOService * nub, OSString * name,
				 OSString ** matched = 0 ) const;
    virtual IOReturn getNubResources( IOService * nub );

    virtual long getBootROMType(void);
    virtual long getChipSetType(void);
    virtual long getMachineType(void);

    virtual bool getModelName( char * name, int maxLength );
    virtual bool getMachineName( char * name, int maxLength );

    virtual int haltRestart(unsigned int type);
    virtual void sleepKernel(void);

    virtual long getGMTTimeOfDay( void );
    virtual void setGMTTimeOfDay( long secs );

    virtual IOReturn getConsoleInfo( PE_Video * consoleInfo );
    virtual IOReturn setConsoleInfo( PE_Video * consoleInfo, unsigned int op );

    virtual void registerNVRAMController( IONVRAMController * nvram );

    virtual IOReturn registerInterruptController(OSSymbol *name, IOInterruptController *interruptController);
    virtual IOInterruptController *lookUpInterruptController(OSSymbol *name);
    virtual void setCPUInterruptProperties(IOService *service);
    virtual bool atInterruptLevel(void);

    virtual IOReturn callPlatformFunction(const OSSymbol *functionName,
					  bool waitForFunction,
					  void *param1, void *param2,
					  void *param3, void *param4) APPLE_KEXT_OVERRIDE;

    virtual IORangeAllocator * getPhysicalRangeAllocator(void);

    virtual bool platformAdjustService(IOService *service);

    virtual void PMRegisterDevice(IOService * theNub, IOService * theDevice);
    virtual void PMLog ( const char *,unsigned long, unsigned long, unsigned long );

    virtual bool hasPMFeature (unsigned long featureMask);
    virtual bool hasPrivPMFeature (unsigned long privFeatureMask);
    virtual int  numBatteriesSupported (void);

    virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);

    virtual OSString* createSystemSerialNumberString(OSData* myProperty);

    virtual IOReturn deregisterInterruptController(OSSymbol *name);

    virtual void getUTCTimeOfDay( clock_sec_t * secs, clock_nsec_t * nsecs );
    virtual void setUTCTimeOfDay( clock_sec_t secs, clock_nsec_t nsecs );

    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  0);
    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  1);
    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  2);
    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  3);
    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  4);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  5);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  6);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  7);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  8);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  9);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert, 10);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert, 11);
};

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

class IODTNVRAM;

class IODTPlatformExpert : public IOPlatformExpert
{
    OSDeclareAbstractStructors(IODTPlatformExpert);

private:
    IODTNVRAM *dtNVRAM;

    struct ExpansionData { };
    ExpansionData *iodtpe_reserved;

public:
    virtual IOService * probe(	IOService * 	provider,
				SInt32 	  *	score ) APPLE_KEXT_OVERRIDE;
    virtual bool configure( IOService * provider ) APPLE_KEXT_OVERRIDE;

    virtual void processTopLevel( IORegistryEntry * root );
    virtual const char * deleteList( void ) = 0;
    virtual const char * excludeList( void ) = 0;
    virtual IOService * createNub( IORegistryEntry * from );
    virtual bool createNubs( IOService * parent, OSIterator * iter );

    virtual bool compareNubName( const IOService * nub, OSString * name,
				 OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;

    virtual IOReturn getNubResources( IOService * nub ) APPLE_KEXT_OVERRIDE;

    virtual bool getModelName( char * name, int maxLength ) APPLE_KEXT_OVERRIDE;
    virtual bool getMachineName( char * name, int maxLength ) APPLE_KEXT_OVERRIDE;
    
    virtual void registerNVRAMController( IONVRAMController * nvram ) APPLE_KEXT_OVERRIDE;

    virtual int haltRestart(unsigned int type) APPLE_KEXT_OVERRIDE;

    /* virtual */ IOReturn readXPRAM(IOByteCount offset, UInt8 * buffer,
				     IOByteCount length);

    /* virtual */ IOReturn writeXPRAM(IOByteCount offset, UInt8 * buffer,
				      IOByteCount length);

    virtual IOReturn readNVRAMProperty(
	IORegistryEntry * entry,
	const OSSymbol ** name, OSData ** value );

    virtual IOReturn writeNVRAMProperty(
	IORegistryEntry * entry,
	const OSSymbol * name, OSData * value );

    // This returns a dictionary describing all the NVRAM partitions.
    // The keys will be the partitionIDs of the form "0x52,nvram".
    // The values will be OSNumbers of the partition's byte count.
    /* virtual */ OSDictionary *getNVRAMPartitions(void);

    /* virtual */ IOReturn readNVRAMPartition(const OSSymbol * partitionID,
					      IOByteCount offset, UInt8 * buffer,
					      IOByteCount length);

    /* virtual */ IOReturn writeNVRAMPartition(const OSSymbol * partitionID,
					       IOByteCount offset, UInt8 * buffer,
					       IOByteCount length);

    virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length) APPLE_KEXT_OVERRIDE;
    virtual OSString* createSystemSerialNumberString(OSData* myProperty) APPLE_KEXT_OVERRIDE;

    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  0);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  1);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  2);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  3);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  4);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  5);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  6);
    OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  7);
};

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/* generic root nub of service tree */

class IOPlatformExpertDevice : public IOService
{
    OSDeclareDefaultStructors(IOPlatformExpertDevice)

private:
    IOWorkLoop *workLoop;

    struct ExpansionData { };
    ExpansionData *ioped_reserved __unused;

public:
    virtual bool initWithArgs( void * p1, void * p2,
					void * p3, void *p4 );
    virtual bool compareName( OSString * name, OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;

    virtual IOWorkLoop *getWorkLoop() const APPLE_KEXT_OVERRIDE;
    virtual IOReturn setProperties( OSObject * properties ) APPLE_KEXT_OVERRIDE;

    virtual void free() APPLE_KEXT_OVERRIDE;

    virtual IOReturn newUserClient( task_t owningTask, void * securityID,
                                    UInt32 type,  OSDictionary * properties,
                                    IOUserClient ** handler) APPLE_KEXT_OVERRIDE;


    OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  0);
    OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  1);
    OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  2);
    OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  3);
};

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/* generic nub for motherboard devices */

class IOPlatformDevice : public IOService
{
    OSDeclareDefaultStructors(IOPlatformDevice)

    struct ExpansionData { };
    ExpansionData *iopd_reserved;

public:
    virtual bool compareName( OSString * name, OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;
    virtual IOService * matchLocation( IOService * client ) APPLE_KEXT_OVERRIDE;
    virtual IOReturn getResources( void ) APPLE_KEXT_OVERRIDE;

    OSMetaClassDeclareReservedUnused(IOPlatformDevice,  0);
    OSMetaClassDeclareReservedUnused(IOPlatformDevice,  1);
    OSMetaClassDeclareReservedUnused(IOPlatformDevice,  2);
    OSMetaClassDeclareReservedUnused(IOPlatformDevice,  3);
};

#endif /* __cplusplus */

#endif /* ! _IOKIT_IOPLATFORMEXPERT_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Copyright (c) 1998 Apple Computer, Inc. All rights reserved.
	30	*
	31	* HISTORY
	32	*
	33	*/
	34
	35
	36	#ifndef _IOKIT_IOPLATFORMEXPERT_H
	37	#define _IOKIT_IOPLATFORMEXPERT_H
	38
	39	#ifdef __cplusplus
	40	#include <IOKit/IOLib.h>
	41	#include <IOKit/IOService.h>
	42	#include <IOKit/IOInterrupts.h>
	43	#include <IOKit/IOInterruptController.h>
	44
	45	extern "C" {
	46	#endif
	47
b0d623f7 A	48	#include <libkern/OSTypes.h>
b0d623f7 A	49
5c9f4661 A	50	typedef enum {
	51	kCoprocessorVersionNone = 0x00000000,
	52	kCoprocessorVersion1 = 0x00010000,
	53	kCoprocessorVersion2 = 0x00020000,
	54	} coprocessor_type_t;
	55
	56
1c79356b A	57	extern boolean_t PEGetMachineName( char * name, int maxLength );
	58	extern boolean_t PEGetModelName( char * name, int maxLength );
	59	extern int PEGetPlatformEpoch( void );
	60
	61	enum {
	62	kPEHaltCPU,
9bccf70c	63	kPERestartCPU,
0c530ab8	64	kPEHangCPU,
2d21ac55 A	65	kPEUPSDelayHaltCPU,
2d21ac55 A	66	kPEPanicRestartCPU,
6d2010ae	67	kPEPanicSync,
5ba3f43e A	68	kPEPagingOff,
5ba3f43e A	69	kPEPanicBegin,
cc8bc92a A	70	kPEPanicEnd,
cc8bc92a A	71	kPEPanicDiskShutdown
1c79356b A	72	};
	73	extern int (*PE_halt_restart)(unsigned int type);
	74	extern int PEHaltRestart(unsigned int type);
	75
a39ff7e2 A	76	#ifdef XNU_KERNEL_PRIVATE
	77	enum {
	78	kIOSystemShutdownNotificationStageProcessExit = 0,
	79	kIOSystemShutdownNotificationStageRootUnmount = 1,
	80	};
	81	extern void IOSystemShutdownNotification(int stage);
	82	#endif /* XNU_KERNEL_PRIVATE */
	83
9bccf70c	84	// Save the Panic Info. Returns the number of bytes saved.
b0d623f7	85	extern UInt32 PESavePanicInfo(UInt8 *buffer, UInt32 length);
5c9f4661 A	86	extern void PESavePanicInfoAction(void *buffer, UInt32 offset, UInt32 length);
	87
	88	/*
	89	* SMC requires that all data is flushed in multiples of 16 bytes at 16 byte
	90	* boundaries.
	91	*/
	92	#define PANIC_FLUSH_BOUNDARY 16
9bccf70c	93
1c79356b A	94	extern long PEGetGMTTimeOfDay( void );
1c79356b A	95	extern void PESetGMTTimeOfDay( long secs );
fe8ab488 A	96	extern void PEGetUTCTimeOfDay( clock_sec_t * secs, clock_usec_t * usecs );
	97	extern void PESetUTCTimeOfDay( clock_sec_t secs, clock_usec_t usecs );
	98
6d2010ae A	99	/* unless it's a "well-known" property, these will read/write out the value as raw data */
6d2010ae A	100
3e170ce0	101	extern boolean_t PEWriteNVRAMBooleanProperty(const char *symbol, boolean_t value);
6d2010ae A	102	extern boolean_t PEWriteNVRAMProperty(const char symbol, const void value, const unsigned int len);
	103
	104	extern boolean_t PEReadNVRAMProperty(const char symbol, void value, unsigned int *len);
	105
39236c6e A	106	extern boolean_t PERemoveNVRAMProperty(const char *symbol);
39236c6e A	107
5c9f4661 A	108	extern coprocessor_type_t PEGetCoprocessorVersion( void );
5c9f4661 A	109
1c79356b A	110	#ifdef __cplusplus
	111	} /* extern "C" */
	112
55e303ae A	113	#define kIOPlatformMapperPresentKey "IOPlatformMapperPresent"
55e303ae A	114
2d21ac55	115
5c9f4661 A	116
5c9f4661 A	117
2d21ac55 A	118	extern OSSymbol * gPlatformInterruptControllerName;
	119
	120	extern const OSSymbol * gIOPlatformSleepActionKey;
	121	extern const OSSymbol * gIOPlatformWakeActionKey;
	122	extern const OSSymbol * gIOPlatformQuiesceActionKey;
	123	extern const OSSymbol * gIOPlatformActiveActionKey;
fe8ab488	124	extern const OSSymbol * gIOPlatformHaltRestartActionKey;
3e170ce0	125	extern const OSSymbol * gIOPlatformPanicActionKey;
1c79356b A	126
	127	class IORangeAllocator;
	128	class IONVRAMController;
	129	class IOPMrootDomain;
	130
	131	class IOPlatformExpert : public IOService
	132	{
	133	OSDeclareDefaultStructors(IOPlatformExpert);
	134
	135	private:
	136	long _peBootROMType;
	137	long _peChipSetType;
	138	long _peMachineType;
	139
	140	protected:
	141	IOPMrootDomain * root;
	142	int _pePMFeatures;
	143	int _pePrivPMFeatures;
	144	int _peNumBatteriesSupported;
	145	OSArray * thePowerTree;
	146
	147	bool searchingForAdditionalParents;
	148	OSNumber * multipleParentKeyValue;
	149	int numInstancesRegistered;
	150
	151	struct ExpansionData { };
a39ff7e2	152	ExpansionData *iope_reserved __unused;
1c79356b A	153
	154	virtual void setBootROMType(long peBootROMType);
	155	virtual void setChipSetType(long peChipSetType);
	156	virtual void setMachineType(long peMachineType);
	157
	158	virtual bool CheckSubTree (OSArray * inSubTree, IOService * theNub, IOService * theDevice, OSDictionary * theParent);
	159	virtual bool RegisterServiceInTree (IOService * theService, OSDictionary * theTreeNode, OSDictionary * theTreeParentNode, IOService * theProvider);
	160
	161	virtual void PMInstantiatePowerDomains ( void );
	162
	163	public:
3e170ce0 A	164	virtual bool attach( IOService * provider ) APPLE_KEXT_OVERRIDE;
3e170ce0 A	165	virtual bool start( IOService * provider ) APPLE_KEXT_OVERRIDE;
1c79356b A	166	virtual bool configure( IOService * provider );
	167	virtual IOService * createNub( OSDictionary * from );
	168
	169	virtual bool compareNubName( const IOService * nub, OSString * name,
	170	OSString ** matched = 0 ) const;
	171	virtual IOReturn getNubResources( IOService * nub );
	172
	173	virtual long getBootROMType(void);
	174	virtual long getChipSetType(void);
	175	virtual long getMachineType(void);
	176
	177	virtual bool getModelName( char * name, int maxLength );
	178	virtual bool getMachineName( char * name, int maxLength );
	179
	180	virtual int haltRestart(unsigned int type);
	181	virtual void sleepKernel(void);
	182
	183	virtual long getGMTTimeOfDay( void );
	184	virtual void setGMTTimeOfDay( long secs );
	185
	186	virtual IOReturn getConsoleInfo( PE_Video * consoleInfo );
	187	virtual IOReturn setConsoleInfo( PE_Video * consoleInfo, unsigned int op );
	188
	189	virtual void registerNVRAMController( IONVRAMController * nvram );
	190
	191	virtual IOReturn registerInterruptController(OSSymbol name, IOInterruptController interruptController);
	192	virtual IOInterruptController lookUpInterruptController(OSSymbol name);
	193	virtual void setCPUInterruptProperties(IOService *service);
	194	virtual bool atInterruptLevel(void);
	195
	196	virtual IOReturn callPlatformFunction(const OSSymbol *functionName,
	197	bool waitForFunction,
	198	void param1, void param2,
3e170ce0	199	void param3, void param4) APPLE_KEXT_OVERRIDE;
1c79356b A	200
	201	virtual IORangeAllocator * getPhysicalRangeAllocator(void);
	202
	203	virtual bool platformAdjustService(IOService *service);
	204
	205	virtual void PMRegisterDevice(IOService * theNub, IOService * theDevice);
	206	virtual void PMLog ( const char *,unsigned long, unsigned long, unsigned long );
	207
	208	virtual bool hasPMFeature (unsigned long featureMask);
	209	virtual bool hasPrivPMFeature (unsigned long privFeatureMask);
	210	virtual int numBatteriesSupported (void);
	211
9bccf70c A	212	virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
9bccf70c A	213
55e303ae	214	virtual OSString* createSystemSerialNumberString(OSData* myProperty);
fe8ab488 A	215
	216	virtual IOReturn deregisterInterruptController(OSSymbol *name);
	217
	218	virtual void getUTCTimeOfDay( clock_sec_t * secs, clock_nsec_t * nsecs );
	219	virtual void setUTCTimeOfDay( clock_sec_t secs, clock_nsec_t nsecs );
	220
9bccf70c	221	OSMetaClassDeclareReservedUsed(IOPlatformExpert, 0);
55e303ae	222	OSMetaClassDeclareReservedUsed(IOPlatformExpert, 1);
fe8ab488 A	223	OSMetaClassDeclareReservedUsed(IOPlatformExpert, 2);
	224	OSMetaClassDeclareReservedUsed(IOPlatformExpert, 3);
	225	OSMetaClassDeclareReservedUsed(IOPlatformExpert, 4);
1c79356b A	226	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 5);
	227	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 6);
	228	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 7);
	229	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 8);
	230	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 9);
	231	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 10);
	232	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 11);
	233	};
	234
	235	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	236
	237	class IODTNVRAM;
	238
	239	class IODTPlatformExpert : public IOPlatformExpert
	240	{
	241	OSDeclareAbstractStructors(IODTPlatformExpert);
	242
	243	private:
	244	IODTNVRAM *dtNVRAM;
	245
	246	struct ExpansionData { };
a39ff7e2	247	ExpansionData *iodtpe_reserved;
1c79356b A	248
	249	public:
	250	virtual IOService * probe( IOService * provider,
3e170ce0 A	251	SInt32 * score ) APPLE_KEXT_OVERRIDE;
3e170ce0 A	252	virtual bool configure( IOService * provider ) APPLE_KEXT_OVERRIDE;
1c79356b A	253
	254	virtual void processTopLevel( IORegistryEntry * root );
	255	virtual const char * deleteList( void ) = 0;
	256	virtual const char * excludeList( void ) = 0;
	257	virtual IOService * createNub( IORegistryEntry * from );
	258	virtual bool createNubs( IOService * parent, OSIterator * iter );
	259
	260	virtual bool compareNubName( const IOService * nub, OSString * name,
3e170ce0	261	OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;
1c79356b	262
3e170ce0	263	virtual IOReturn getNubResources( IOService * nub ) APPLE_KEXT_OVERRIDE;
1c79356b	264
3e170ce0 A	265	virtual bool getModelName( char * name, int maxLength ) APPLE_KEXT_OVERRIDE;
3e170ce0 A	266	virtual bool getMachineName( char * name, int maxLength ) APPLE_KEXT_OVERRIDE;
1c79356b	267
3e170ce0	268	virtual void registerNVRAMController( IONVRAMController * nvram ) APPLE_KEXT_OVERRIDE;
1c79356b	269
3e170ce0	270	virtual int haltRestart(unsigned int type) APPLE_KEXT_OVERRIDE;
1c79356b A	271
	272	/* virtual / IOReturn readXPRAM(IOByteCount offset, UInt8 buffer,
	273	IOByteCount length);
d52fe63f	274
1c79356b A	275	/* virtual / IOReturn writeXPRAM(IOByteCount offset, UInt8 buffer,
	276	IOByteCount length);
	277
	278	virtual IOReturn readNVRAMProperty(
	279	IORegistryEntry * entry,
	280	const OSSymbol name, OSData value );
	281
	282	virtual IOReturn writeNVRAMProperty(
	283	IORegistryEntry * entry,
	284	const OSSymbol * name, OSData * value );
	285
d52fe63f A	286	// This returns a dictionary describing all the NVRAM partitions.
	287	// The keys will be the partitionIDs of the form "0x52,nvram".
	288	// The values will be OSNumbers of the partition's byte count.
	289	/* virtual / OSDictionary getNVRAMPartitions(void);
	290
	291	/* virtual / IOReturn readNVRAMPartition(const OSSymbol partitionID,
	292	IOByteCount offset, UInt8 * buffer,
	293	IOByteCount length);
	294
	295	/* virtual / IOReturn writeNVRAMPartition(const OSSymbol partitionID,
	296	IOByteCount offset, UInt8 * buffer,
	297	IOByteCount length);
1c79356b	298
3e170ce0 A	299	virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length) APPLE_KEXT_OVERRIDE;
3e170ce0 A	300	virtual OSString* createSystemSerialNumberString(OSData* myProperty) APPLE_KEXT_OVERRIDE;
9bccf70c	301
1c79356b A	302	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 0);
	303	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 1);
	304	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 2);
	305	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 3);
	306	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 4);
	307	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 5);
	308	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 6);
	309	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 7);
	310	};
	311
	312	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	313
	314	/* generic root nub of service tree */
	315
	316	class IOPlatformExpertDevice : public IOService
	317	{
	318	OSDeclareDefaultStructors(IOPlatformExpertDevice)
	319
	320	private:
	321	IOWorkLoop *workLoop;
	322
	323	struct ExpansionData { };
a39ff7e2	324	ExpansionData *ioped_reserved __unused;
1c79356b A	325
	326	public:
	327	virtual bool initWithArgs( void * p1, void * p2,
	328	void * p3, void *p4 );
3e170ce0 A	329	virtual bool compareName( OSString * name, OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;
	330
	331	virtual IOWorkLoop *getWorkLoop() const APPLE_KEXT_OVERRIDE;
	332	virtual IOReturn setProperties( OSObject * properties ) APPLE_KEXT_OVERRIDE;
	333
	334	virtual void free() APPLE_KEXT_OVERRIDE;
1c79356b	335
3e170ce0 A	336	virtual IOReturn newUserClient( task_t owningTask, void * securityID,
	337	UInt32 type, OSDictionary * properties,
	338	IOUserClient ** handler) APPLE_KEXT_OVERRIDE;
1c79356b	339
1c79356b A	340
	341	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 0);
	342	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 1);
	343	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 2);
	344	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 3);
	345	};
	346
	347	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	348
	349	/* generic nub for motherboard devices */
	350
	351	class IOPlatformDevice : public IOService
	352	{
	353	OSDeclareDefaultStructors(IOPlatformDevice)
	354
	355	struct ExpansionData { };
a39ff7e2	356	ExpansionData *iopd_reserved;
1c79356b A	357
1c79356b A	358	public:
3e170ce0 A	359	virtual bool compareName( OSString * name, OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;
	360	virtual IOService * matchLocation( IOService * client ) APPLE_KEXT_OVERRIDE;
	361	virtual IOReturn getResources( void ) APPLE_KEXT_OVERRIDE;
1c79356b A	362
	363	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 0);
	364	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 1);
	365	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 2);
	366	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 3);
	367	};
	368
	369	#endif /* __cplusplus */
	370
	371	#endif /* ! _IOKIT_IOPLATFORMEXPERT_H */