xnu-4570.31.3.tar.gz

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

diff --git a/iokit/IOKit/IOPlatformExpert.h b/iokit/IOKit/IOPlatformExpert.h
index ff98488f733636062e95800eafb4f0dc1ff2fa88..63029bb1d85d5feebed58030559af285ccb10e9d 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,6 +45,15 @@
 extern "C" {
 #endif
 
 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 );
 extern boolean_t PEGetMachineName( char * name, int maxLength );
 extern boolean_t PEGetModelName( char * name, int maxLength );
 extern int PEGetPlatformEpoch( void );


@@ -47,23 +62,59 @@ enum {
   kPEHaltCPU,
   kPERestartCPU,
   kPEHangCPU,
   kPEHaltCPU,
   kPERestartCPU,
   kPEHangCPU,

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

 };
 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 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 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 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"
 
 #ifdef __cplusplus
 } /* extern "C" */
 
 #define kIOPlatformMapperPresentKey "IOPlatformMapperPresent"
 

-extern OSSymbol * gPlatformInterruptControllerName;
+
+
+
+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;


@@ -102,8 +153,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 );
 


@@ -137,7 +188,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);
 


@@ -153,12 +204,17 @@ public:
     virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
 
     virtual OSString* createSystemSerialNumberString(OSData* myProperty);
     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,  0);
     OSMetaClassDeclareReservedUsed(IOPlatformExpert,  1);

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


@@ -184,8 +240,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;


@@ -194,16 +250,16 @@ 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);


@@ -232,8 +288,8 @@ public:
                                               IOByteCount offset, UInt8 * buffer,
                                               IOByteCount length);
 
                                               IOByteCount offset, UInt8 * buffer,
                                               IOByteCount length);
 

-    virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
-    virtual OSString* createSystemSerialNumberString(OSData* myProperty);
+    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);


@@ -262,14 +318,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 IOWorkLoop *getWorkLoop() const;
+    virtual void free() APPLE_KEXT_OVERRIDE;

 
 

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

 
 

-    virtual bool attachToChild( IORegistryEntry * child,
-                                const IORegistryPlane * plane );

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


@@ -289,9 +348,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);