xnu-1456.1.26.tar.gz

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

diff --git a/iokit/IOKit/IOPlatformExpert.h b/iokit/IOKit/IOPlatformExpert.h
index 05d6e2d1963a58ae1087605a66e7886ae478c7c6..f75a3e3ab834d388d0bcfbab6713be900327d8a6 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.
  *
- * @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,
- * 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. 
@@ -39,24 +45,41 @@
 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,
-  kPERestartCPU
+  kPERestartCPU,
+  kPEHangCPU,
+  kPEUPSDelayHaltCPU,
+  kPEPanicRestartCPU,
+  kPEPanicSync
 };
 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 long PEGetGMTTimeOfDay( void );
 extern void PESetGMTTimeOfDay( long secs );
   
 #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;
 
 class IORangeAllocator;
 class IONVRAMController;
@@ -143,8 +166,12 @@ public:
     virtual bool hasPrivPMFeature (unsigned long privFeatureMask);
     virtual int  numBatteriesSupported (void);
 
-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  0);
-    OSMetaClassDeclareReservedUnused(IOPlatformExpert,  1);
+    virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
+
+    virtual OSString* createSystemSerialNumberString(OSData* myProperty);
+    
+    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  0);
+    OSMetaClassDeclareReservedUsed(IOPlatformExpert,  1);
     OSMetaClassDeclareReservedUnused(IOPlatformExpert,  2);
     OSMetaClassDeclareReservedUnused(IOPlatformExpert,  3);
     OSMetaClassDeclareReservedUnused(IOPlatformExpert,  4);
@@ -196,6 +223,7 @@ public:
 
     /* virtual */ IOReturn readXPRAM(IOByteCount offset, UInt8 * buffer,
                                     IOByteCount length);
+
     /* virtual */ IOReturn writeXPRAM(IOByteCount offset, UInt8 * buffer,
                                      IOByteCount length);
 
@@ -207,6 +235,21 @@ public:
        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);
+    virtual OSString* createSystemSerialNumberString(OSData* myProperty);
 
     OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  0);
     OSMetaClassDeclareReservedUnused(IODTPlatformExpert,  1);
@@ -238,6 +281,7 @@ public:
     virtual bool compareName( OSString * name, OSString ** matched = 0 ) const;
 
     virtual IOWorkLoop *getWorkLoop() const;
+    virtual IOReturn setProperties( OSObject * properties );
 
     virtual void free();