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

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

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

enum {
  kPEHaltCPU,
  kPERestartCPU,
  kPEHangCPU
};
extern int (*PE_halt_restart)(unsigned int type);
extern int PEHaltRestart(unsigned int type);

// Save the Panic Info.  Returns the number of bytes saved.
extern unsigned long PESavePanicInfo(unsigned char *buffer, unsigned long  length);

extern long PEGetGMTTimeOfDay( void );
extern void PESetGMTTimeOfDay( long secs );
  
#ifdef __cplusplus
} /* extern "C" */

extern OSSymbol * gPlatformInterruptControllerName;

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 *reserved;

    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 );
    virtual bool start( IOService * provider );
    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);

    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);

    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  0);

    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  1);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  2);
    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  3);
    OSMetaClassDeclareReservedUnused(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 *reserved;

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

    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;

    virtual IOReturn getNubResources( IOService * nub );

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

    virtual int haltRestart(unsigned int type);

    /* 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);

    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 *reserved;

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

    virtual IOWorkLoop *getWorkLoop() const;

    virtual void free();

    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 *reserved;

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

    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	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* Copyright (c) 1998 Apple Computer, Inc. All rights reserved.
	27	*
	28	* HISTORY
	29	*
	30	*/
	31
	32
	33	#ifndef _IOKIT_IOPLATFORMEXPERT_H
	34	#define _IOKIT_IOPLATFORMEXPERT_H
	35
	36	#ifdef __cplusplus
	37	#include <IOKit/IOLib.h>
	38	#include <IOKit/IOService.h>
	39	#include <IOKit/IOInterrupts.h>
	40	#include <IOKit/IOInterruptController.h>
	41
	42	extern "C" {
	43	#endif
	44
	45	extern boolean_t PEGetMachineName( char * name, int maxLength );
	46	extern boolean_t PEGetModelName( char * name, int maxLength );
	47	extern int PEGetPlatformEpoch( void );
	48
	49	enum {
	50	kPEHaltCPU,
9bccf70c A	51	kPERestartCPU,
9bccf70c A	52	kPEHangCPU
1c79356b A	53	};
	54	extern int (*PE_halt_restart)(unsigned int type);
	55	extern int PEHaltRestart(unsigned int type);
	56
9bccf70c A	57	// Save the Panic Info. Returns the number of bytes saved.
	58	extern unsigned long PESavePanicInfo(unsigned char *buffer, unsigned long length);
	59
1c79356b A	60	extern long PEGetGMTTimeOfDay( void );
	61	extern void PESetGMTTimeOfDay( long secs );
	62
	63	#ifdef __cplusplus
	64	} /* extern "C" */
	65
	66	extern OSSymbol * gPlatformInterruptControllerName;
	67
	68	class IORangeAllocator;
	69	class IONVRAMController;
	70	class IOPMrootDomain;
	71
	72	class IOPlatformExpert : public IOService
	73	{
	74	OSDeclareDefaultStructors(IOPlatformExpert);
	75
	76	private:
	77	long _peBootROMType;
	78	long _peChipSetType;
	79	long _peMachineType;
	80
	81	protected:
	82	IOPMrootDomain * root;
	83	int _pePMFeatures;
	84	int _pePrivPMFeatures;
	85	int _peNumBatteriesSupported;
	86	OSArray * thePowerTree;
	87
	88	bool searchingForAdditionalParents;
	89	OSNumber * multipleParentKeyValue;
	90	int numInstancesRegistered;
	91
	92	struct ExpansionData { };
	93	ExpansionData *reserved;
	94
	95	virtual void setBootROMType(long peBootROMType);
	96	virtual void setChipSetType(long peChipSetType);
	97	virtual void setMachineType(long peMachineType);
	98
	99	virtual bool CheckSubTree (OSArray * inSubTree, IOService * theNub, IOService * theDevice, OSDictionary * theParent);
	100	virtual bool RegisterServiceInTree (IOService * theService, OSDictionary * theTreeNode, OSDictionary * theTreeParentNode, IOService * theProvider);
	101
	102	virtual void PMInstantiatePowerDomains ( void );
	103
	104	public:
	105	virtual bool attach( IOService * provider );
	106	virtual bool start( IOService * provider );
	107	virtual bool configure( IOService * provider );
	108	virtual IOService * createNub( OSDictionary * from );
	109
	110	virtual bool compareNubName( const IOService * nub, OSString * name,
	111	OSString ** matched = 0 ) const;
	112	virtual IOReturn getNubResources( IOService * nub );
	113
	114	virtual long getBootROMType(void);
	115	virtual long getChipSetType(void);
	116	virtual long getMachineType(void);
	117
	118	virtual bool getModelName( char * name, int maxLength );
	119	virtual bool getMachineName( char * name, int maxLength );
	120
	121	virtual int haltRestart(unsigned int type);
	122	virtual void sleepKernel(void);
	123
124	virtual long getGMTTimeOfDay( void );
125	virtual void setGMTTimeOfDay( long secs );
126
127	virtual IOReturn getConsoleInfo( PE_Video * consoleInfo );
128	virtual IOReturn setConsoleInfo( PE_Video * consoleInfo, unsigned int op );
129
130	virtual void registerNVRAMController( IONVRAMController * nvram );
131
132	virtual IOReturn registerInterruptController(OSSymbol name, IOInterruptController interruptController);
133	virtual IOInterruptController lookUpInterruptController(OSSymbol name);
134	virtual void setCPUInterruptProperties(IOService *service);
135	virtual bool atInterruptLevel(void);
136
137	virtual IOReturn callPlatformFunction(const OSSymbol *functionName,
138	bool waitForFunction,
139	void param1, void param2,
140	void param3, void param4);
141
142	virtual IORangeAllocator * getPhysicalRangeAllocator(void);
143
144	virtual bool platformAdjustService(IOService *service);
145
146	virtual void PMRegisterDevice(IOService * theNub, IOService * theDevice);
147	virtual void PMLog ( const char *,unsigned long, unsigned long, unsigned long );
148
149	virtual bool hasPMFeature (unsigned long featureMask);
150	virtual bool hasPrivPMFeature (unsigned long privFeatureMask);
151	virtual int numBatteriesSupported (void);
152
9bccf70c A	153	virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
	154
	155	OSMetaClassDeclareReservedUsed(IOPlatformExpert, 0);
	156
1c79356b A	157	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 1);
	158	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 2);
	159	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 3);
	160	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 4);
	161	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 5);
	162	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 6);
	163	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 7);
	164	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 8);
	165	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 9);
	166	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 10);
	167	OSMetaClassDeclareReservedUnused(IOPlatformExpert, 11);
	168	};
	169
	170	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	171
	172	class IODTNVRAM;
	173
	174	class IODTPlatformExpert : public IOPlatformExpert
	175	{
	176	OSDeclareAbstractStructors(IODTPlatformExpert);
	177
	178	private:
	179	IODTNVRAM *dtNVRAM;
	180
	181	struct ExpansionData { };
	182	ExpansionData *reserved;
	183
	184	public:
	185	virtual IOService * probe( IOService * provider,
	186	SInt32 * score );
	187	virtual bool configure( IOService * provider );
	188
	189	virtual void processTopLevel( IORegistryEntry * root );
	190	virtual const char * deleteList( void ) = 0;
	191	virtual const char * excludeList( void ) = 0;
	192	virtual IOService * createNub( IORegistryEntry * from );
	193	virtual bool createNubs( IOService * parent, OSIterator * iter );
	194
	195	virtual bool compareNubName( const IOService * nub, OSString * name,
	196	OSString ** matched = 0 ) const;
	197
	198	virtual IOReturn getNubResources( IOService * nub );
	199
	200	virtual bool getModelName( char * name, int maxLength );
	201	virtual bool getMachineName( char * name, int maxLength );
	202
	203	virtual void registerNVRAMController( IONVRAMController * nvram );
	204
	205	virtual int haltRestart(unsigned int type);
	206
	207	/* virtual / IOReturn readXPRAM(IOByteCount offset, UInt8 buffer,
	208	IOByteCount length);
d52fe63f	209
1c79356b A	210	/* virtual / IOReturn writeXPRAM(IOByteCount offset, UInt8 buffer,
	211	IOByteCount length);
	212
	213	virtual IOReturn readNVRAMProperty(
	214	IORegistryEntry * entry,
	215	const OSSymbol name, OSData value );
	216
	217	virtual IOReturn writeNVRAMProperty(
	218	IORegistryEntry * entry,
	219	const OSSymbol * name, OSData * value );
	220
d52fe63f A	221	// This returns a dictionary describing all the NVRAM partitions.
	222	// The keys will be the partitionIDs of the form "0x52,nvram".
	223	// The values will be OSNumbers of the partition's byte count.
	224	/* virtual / OSDictionary getNVRAMPartitions(void);
	225
	226	/* virtual / IOReturn readNVRAMPartition(const OSSymbol partitionID,
	227	IOByteCount offset, UInt8 * buffer,
	228	IOByteCount length);
	229
	230	/* virtual / IOReturn writeNVRAMPartition(const OSSymbol partitionID,
	231	IOByteCount offset, UInt8 * buffer,
	232	IOByteCount length);
1c79356b	233
9bccf70c A	234	virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
9bccf70c A	235
1c79356b A	236	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 0);
	237	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 1);
	238	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 2);
	239	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 3);
	240	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 4);
	241	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 5);
	242	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 6);
	243	OSMetaClassDeclareReservedUnused(IODTPlatformExpert, 7);
	244	};
	245
	246	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	247
	248	/* generic root nub of service tree */
	249
	250	class IOPlatformExpertDevice : public IOService
	251	{
	252	OSDeclareDefaultStructors(IOPlatformExpertDevice)
	253
	254	private:
	255	IOWorkLoop *workLoop;
	256
	257	struct ExpansionData { };
	258	ExpansionData *reserved;
	259
	260	public:
	261	virtual bool initWithArgs( void * p1, void * p2,
	262	void * p3, void *p4 );
	263	virtual bool compareName( OSString * name, OSString ** matched = 0 ) const;
	264
	265	virtual IOWorkLoop *getWorkLoop() const;
	266
	267	virtual void free();
	268
	269	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 0);
	270	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 1);
	271	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 2);
	272	OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice, 3);
	273	};
	274
	275	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
	276
	277	/* generic nub for motherboard devices */
	278
	279	class IOPlatformDevice : public IOService
	280	{
	281	OSDeclareDefaultStructors(IOPlatformDevice)
	282
	283	struct ExpansionData { };
	284	ExpansionData *reserved;
	285
	286	public:
	287	virtual bool compareName( OSString * name, OSString ** matched = 0 ) const;
	288	virtual IOService * matchLocation( IOService * client );
	289	virtual IOReturn getResources( void );
	290
	291	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 0);
	292	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 1);
	293	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 2);
	294	OSMetaClassDeclareReservedUnused(IOPlatformDevice, 3);
	295	};
	296
	297	#endif /* __cplusplus */
	298
	299	#endif /* ! _IOKIT_IOPLATFORMEXPERT_H */