xnu-4570.20.62.tar.gz

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

diff --git a/iokit/IOKit/IOPlatformExpert.h b/iokit/IOKit/IOPlatformExpert.h
index 05d6e2d1963a58ae1087605a66e7886ae478c7c6..f66f8da1f70f15d978685a2fdf2bee86738ce412 100644 (file)
--- a/iokit/IOKit/IOPlatformExpert.h
+++ b/iokit/IOKit/IOPlatformExpert.h
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved. 
  */
 /*
  * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved. 


@@ -39,24 +45,59 @@
 extern "C" {
 #endif
 
 extern "C" {
 #endif
 

+#include <libkern/OSTypes.h>
+

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

-  kPERestartCPU
+  kPERestartCPU,
+  kPEHangCPU,
+  kPEUPSDelayHaltCPU,
+  kPEPanicRestartCPU,
+  kPEPanicSync,
+  kPEPagingOff,
+  kPEPanicBegin,
+  kPEPanicEnd,
+  kPEPanicDiskShutdown

 };
 extern int (*PE_halt_restart)(unsigned int type);
 extern int PEHaltRestart(unsigned int type);
 
 };
 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 UInt32 PESavePanicInfo(UInt8 *buffer, UInt32 length);
+extern void PESavePanicInfoAction(void *buffer, size_t length);
+

 extern long PEGetGMTTimeOfDay( void );
 extern void PESetGMTTimeOfDay( long secs );
 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);
+

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

-extern OSSymbol * gPlatformInterruptControllerName;
+#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 IORangeAllocator;
 class IONVRAMController;


@@ -95,8 +136,8 @@ protected:
     virtual void PMInstantiatePowerDomains ( void );
 
 public:
     virtual void PMInstantiatePowerDomains ( void );
 
 public:

-    virtual bool attach( IOService * provider );
-    virtual bool start( IOService * provider );
+    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 configure( IOService * provider );
     virtual IOService * createNub( OSDictionary * from );
 


@@ -130,7 +171,7 @@ public:
     virtual IOReturn callPlatformFunction(const OSSymbol *functionName,
                                          bool waitForFunction,
                                          void *param1, void *param2,
     virtual IOReturn callPlatformFunction(const OSSymbol *functionName,
                                          bool waitForFunction,
                                          void *param1, void *param2,

-                                         void *param3, void *param4);
+                                         void *param3, void *param4) APPLE_KEXT_OVERRIDE;

 
     virtual IORangeAllocator * getPhysicalRangeAllocator(void);
 
 
     virtual IORangeAllocator * getPhysicalRangeAllocator(void);
 


@@ -143,11 +184,20 @@ public:
     virtual bool hasPrivPMFeature (unsigned long privFeatureMask);
     virtual int  numBatteriesSupported (void);
 
     virtual bool hasPrivPMFeature (unsigned long privFeatureMask);
     virtual int  numBatteriesSupported (void);
 

-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  0);
-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  1);
-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  2);
-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  3);
-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  4);
+    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,  5);
     OSMetaClassDeclareReservedUnused(IOPlatformExpert,  6);
     OSMetaClassDeclareReservedUnused(IOPlatformExpert,  7);


@@ -173,8 +223,8 @@ private:
 
 public:
     virtual IOService * probe( IOService *     provider,
 
 public:
     virtual IOService * probe( IOService *     provider,

-                               SInt32    *     score );
-    virtual bool configure( 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 void processTopLevel( IORegistryEntry * root );
     virtual const char * deleteList( void ) = 0;


@@ -183,19 +233,20 @@ public:
     virtual bool createNubs( IOService * parent, OSIterator * iter );
 
     virtual bool compareNubName( const IOService * nub, OSString * name,
     virtual bool createNubs( IOService * parent, OSIterator * iter );
 
     virtual bool compareNubName( const IOService * nub, OSString * name,

-                                OSString ** matched = 0 ) const;
+                                OSString ** matched = 0 ) const APPLE_KEXT_OVERRIDE;

 
 

-    virtual IOReturn getNubResources( IOService * nub );
+    virtual IOReturn getNubResources( IOService * nub ) APPLE_KEXT_OVERRIDE;

 
 

-    virtual bool getModelName( char * name, int maxLength );
-    virtual bool getMachineName( char * name, int maxLength );
+    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 );
+    virtual void registerNVRAMController( IONVRAMController * nvram ) APPLE_KEXT_OVERRIDE;

 
 

-    virtual int haltRestart(unsigned int type);
+    virtual int haltRestart(unsigned int type) APPLE_KEXT_OVERRIDE;

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

+

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


@@ -207,6 +258,21 @@ public:
        IORegistryEntry * entry,
        const OSSymbol * name, OSData * value );
 
        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,  0);
     OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  1);


@@ -235,11 +301,17 @@ private:
 public:
     virtual bool initWithArgs( void * p1, void * p2,
                                        void * p3, void *p4 );
 public:
     virtual bool initWithArgs( void * p1, void * p2,
                                        void * p3, void *p4 );

-    virtual bool compareName( OSString * name, OSString ** matched = 0 ) const;
+    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 IOWorkLoop *getWorkLoop() const;
+    virtual IOReturn newUserClient( task_t owningTask, void * securityID,
+                                    UInt32 type,  OSDictionary * properties,
+                                    IOUserClient ** handler) APPLE_KEXT_OVERRIDE;

 
 

-    virtual void free();

 
     OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  0);
     OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  1);
 
     OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  0);
     OSMetaClassDeclareReservedUnused(IOPlatformExpertDevice,  1);


@@ -259,9 +331,9 @@ class IOPlatformDevice : public IOService
     ExpansionData *reserved;
 
 public:
     ExpansionData *reserved;
 
 public:

-    virtual bool compareName( OSString * name, OSString ** matched = 0 ) const;
-    virtual IOService * matchLocation( IOService * client );
-    virtual IOReturn getResources( void );
+    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,  0);
     OSMetaClassDeclareReservedUnused(IOPlatformDevice,  1);