xnu-2782.10.72.tar.gz

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

diff --git a/iokit/IOKit/IONVRAM.h b/iokit/IOKit/IONVRAM.h
index b83e7840054d2ea5ee6841730a56f1f59dd96bf1..37d4ef4d3d1b6dad129c7e5ef2afac24e556e950 100644 (file)
--- a/iokit/IOKit/IONVRAM.h
+++ b/iokit/IOKit/IONVRAM.h
@@ -1,47 +1,49 @@
 /*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2006 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2007-2012 Apple Inc. All rights reserved.
  *
- * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
+ * @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 
+ * 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_LICENSE_OSREFERENCE_HEADER_END@
+ * 
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 #ifndef _IOKIT_IONVRAM_H
 #define _IOKIT_IONVRAM_H
 
+#ifdef __cplusplus
 #include <IOKit/IOKitKeys.h>
 #include <IOKit/IOService.h>
 #include <IOKit/IODeviceTreeSupport.h>
 #include <IOKit/nvram/IONVRAMController.h>
-
+#endif /* __cplusplus */
 
 #define kIODTNVRAMOFPartitionName       "common"
 #define kIODTNVRAMXPRAMPartitionName    "APL,MacOS75"
 #define kIODTNVRAMPanicInfoPartitonName "APL,OSXPanic"
 #define kIODTNVRAMFreePartitionName     "wwwwwwwwwwww"
 
+#define MIN_SYNC_NOW_INTERVAL 15*60 /* Minimum 15 Minutes interval mandated */
+
 enum {
   kIODTNVRAMImageSize        = 0x2000,
   kIODTNVRAMXPRAMSize        = 0x0100,
@@ -58,9 +60,12 @@ enum {
 enum {
   kOFVariablePermRootOnly = 0,
   kOFVariablePermUserRead,
-  kOFVariablePermUserWrite
+  kOFVariablePermUserWrite,
+  kOFVariablePermKernelOnly
 };
 
+#ifdef __cplusplus
+
 class IODTNVRAM : public IOService
 {
   OSDeclareDefaultStructors(IODTNVRAM);
@@ -77,16 +82,19 @@ private:
   OSDictionary      *_ofDict;
   OSDictionary      *_nvramPartitionOffsets;
   OSDictionary      *_nvramPartitionLengths;
-  UInt32            _xpramPartitionOffset;
-  UInt32            _xpramPartitionSize;
-  UInt8             *_xpramImage;
-  UInt32            _nrPartitionOffset;
-  UInt32            _nrPartitionSize;
-  UInt8             *_nrImage;
+  UInt32            _resv0 __unused;
+  UInt32            _resv1 __unused;
+  IOLock            *_ofLock;
+  UInt32            _resv2 __unused;
+  UInt32            _resv3 __unused;
+  UInt8             *_resv4 __unused;
   UInt32            _piPartitionOffset;
   UInt32            _piPartitionSize;
   UInt8             *_piImage;
   bool              _systemPaniced;
+  SInt32            _lastDeviceSync;
+  bool              _freshInterval;
+  bool              _isProxied;
   
   virtual UInt8 calculatePartitionChecksum(UInt8 *partitionHeader);
   virtual IOReturn initOFVariables(void);
@@ -126,6 +134,9 @@ private:
                                           const OSSymbol *name,
                                           OSData *value);
   
+  void initNVRAMImage(void);
+  void initProxyData(void);
+  
 public:
   virtual bool init(IORegistryEntry *old, const IORegistryPlane *plane);
   
@@ -134,6 +145,8 @@ public:
   virtual void sync(void);
   
   virtual bool serializeProperties(OSSerialize *s) const;
+  virtual OSObject *copyProperty(const OSSymbol *aKey) const;
+  virtual OSObject *copyProperty(const char *aKey) const;
   virtual OSObject *getProperty(const OSSymbol *aKey) const;
   virtual OSObject *getProperty(const char *aKey) const;
   virtual bool setProperty(const OSSymbol *aKey, OSObject *anObject);
@@ -163,6 +176,9 @@ public:
                                       IOByteCount length);  
   
   virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
+  virtual bool safeToSync(void);
 };
 
+#endif /* __cplusplus */
+
 #endif /* !_IOKIT_IONVRAM_H */