git.saurik.com Git - apple/xnu.git/blob

1 /*

4 *

5 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

6 *

7 * This file contains Original Code and/or Modifications of Original Code

8 * as defined in and that are subject to the Apple Public Source License

9 * Version 2.0 (the 'License'). You may not use this file except in

10 * compliance with the License. The rights granted to you under the License

11 * may not be used to create, or enable the creation or redistribution of,

12 * unlawful or unlicensed copies of an Apple operating system, or to

13 * circumvent, violate, or enable the circumvention or violation of, any

14 * terms of an Apple operating system software license agreement.

15 *

16 * Please obtain a copy of the License at

17 * http://www.opensource.apple.com/apsl/ and read it before using this file.

18 *

19 * The Original Code and all software distributed under the License are

20 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

21 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,

22 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

23 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.

24 * Please see the License for the specific language governing rights and

25 * limitations under the License.

26 *

27 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

28 */

30 #ifndef _IOKIT_IONVRAM_H

31 #define _IOKIT_IONVRAM_H

33 #ifdef __cplusplus

34 #include <libkern/c++/OSPtr.h>

35 #include <IOKit/IOKitKeys.h>

36 #include <IOKit/IOService.h>

37 #include <IOKit/IODeviceTreeSupport.h>

38 #include <IOKit/nvram/IONVRAMController.h>

39 #endif /* __cplusplus */

40 #include <uuid/uuid.h>

42 #define kIODTNVRAMOFPartitionName "common"

43 #define kIODTNVRAMXPRAMPartitionName "APL,MacOS75"

44 #define kIODTNVRAMPanicInfoPartitonName "APL,OSXPanic"

45 #define kIODTNVRAMFreePartitionName "wwwwwwwwwwww"

46 #define kIODTNVRAMSystemPartitionName "secure"

48 #define MIN_SYNC_NOW_INTERVAL 15*60 /* Minimum 15 Minutes interval mandated */

50 enum IONVRAMVariableType {

51 kOFVariableTypeBoolean = 1,

52 kOFVariableTypeNumber,

53 kOFVariableTypeString,

54 kOFVariableTypeData

55 };

57 enum IONVRAMOperation {

58 kIONVRAMOperationRead,

59 kIONVRAMOperationWrite,

60 kIONVRAMOperationDelete,

61 kIONVRAMOperationObliterate,

62 kIONVRAMOperationReset

63 };

65 enum {

66 // Deprecated but still used in AppleEFIRuntime for now

67 kOFVariablePermRootOnly = 0,

68 kOFVariablePermUserRead,

69 kOFVariablePermUserWrite,

70 kOFVariablePermKernelOnly

71 };

73 #ifdef __cplusplus

75 class IODTNVRAMVariables;

77 class IODTNVRAM : public IOService

78 {

79 OSDeclareDefaultStructors(IODTNVRAM);

81 private:

82 friend class IODTNVRAMVariables;

84 IONVRAMController *_nvramController;

85 OSPtr<const OSSymbol> _registryPropertiesKey;

86 UInt8 *_nvramImage;

87 IORWLock *_variableLock;

88 IOLock *_controllerLock;

89 UInt32 _commonPartitionOffset;

90 UInt32 _commonPartitionSize;

91 UInt8 *_commonImage;

92 IODTNVRAMVariables *_commonService;

93 OSPtr<OSDictionary> _commonDict;

94 UInt32 _systemPartitionOffset;

95 UInt32 _systemPartitionSize;

96 UInt8 *_systemImage;

97 IODTNVRAMVariables *_systemService;

98 OSPtr<OSDictionary> _systemDict;

99 OSPtr<OSDictionary> _nvramPartitionOffsets;

100 OSPtr<OSDictionary> _nvramPartitionLengths;

101 bool _systemPanicked;

102 SInt32 _lastDeviceSync;

103 bool _freshInterval;

104 bool _isProxied;

105 UInt32 _nvramSize;

106

         virtual UInt8 calculatePartitionChecksum(UInt8 *partitionHeader);

         virtual IOReturn initVariables(void);

         virtual UInt32 getOFVariableType(const char *propName) const;

         virtual UInt32 getOFVariableType(const OSSymbol *propSymbol) const;

         virtual UInt32 getOFVariablePerm(const char *propName) const;

         virtual UInt32 getOFVariablePerm(const OSSymbol *propSymbol) const;

         virtual bool getOWVariableInfo(UInt32 variableNumber, const OSSymbol **propSymbol,

114 UInt32 *propType, UInt32 *propOffset);

         virtual bool convertPropToObject(UInt8 *propName, UInt32 propNameLength,

116 UInt8 *propData, UInt32 propDataLength,

117 LIBKERN_RETURNS_RETAINED const OSSymbol **propSymbol,

118 LIBKERN_RETURNS_RETAINED OSObject **propObject);

         bool convertPropToObject(UInt8 *propName, UInt32 propNameLength,

120 UInt8 *propData, UInt32 propDataLength,

121 OSSharedPtr<const OSSymbol>& propSymbol,

122 OSSharedPtr<OSObject>& propObject);

         virtual bool convertObjectToProp(UInt8 *buffer, UInt32 *length,

             const OSSymbol *propSymbol, OSObject *propObject);

         virtual UInt16 generateOWChecksum(UInt8 *buffer);

         virtual bool validateOWChecksum(UInt8 *buffer);

         virtual void updateOWBootArgs(const OSSymbol *key, OSObject *value);

         virtual bool searchNVRAMProperty(struct IONVRAMDescriptor *hdr,

129 UInt32 *where);

130

         virtual IOReturn readNVRAMPropertyType0(IORegistryEntry *entry,

132 const OSSymbol **name,

133 OSData **value);

         virtual IOReturn writeNVRAMPropertyType0(IORegistryEntry *entry,

135 const OSSymbol *name,

136 OSData * value);

137

         virtual OSPtr<OSData> unescapeBytesToData(const UInt8 *bytes, UInt32 length);

         virtual OSPtr<OSData> escapeDataToData(OSData * value);

140

         virtual IOReturn readNVRAMPropertyType1(IORegistryEntry *entry,

142 const OSSymbol **name,

143 OSData **value);

         virtual IOReturn writeNVRAMPropertyType1(IORegistryEntry *entry,

145 const OSSymbol *name,

146 OSData *value);

147

148 UInt32 getNVRAMSize(void);

         void initNVRAMImage(void);

         void initProxyData(void);

151 IOReturn serializeVariables(void);

         IOReturn setPropertyInternal(const OSSymbol *aKey, OSObject *anObject);

         IOReturn removePropertyInternal(const OSSymbol *aKey);

         IOReturn chooseDictionary(IONVRAMOperation operation, const uuid_t *varGuid,

             const char *variableName, OSDictionary **dict) const;

         IOReturn flushDict(const uuid_t *guid, IONVRAMOperation op);

         bool handleSpecialVariables(const char *name, const uuid_t *guid, const OSObject *obj, IOReturn *error);

         OSSharedPtr<OSObject> copyPropertyWithGUIDAndName(const uuid_t *guid, const char *name) const;

         IOReturn removePropertyWithGUIDAndName(const uuid_t *guid, const char *name);

         IOReturn setPropertyWithGUIDAndName(const uuid_t *guid, const char *name, OSObject *anObject);

161

162 public:

         virtual bool init(IORegistryEntry *old, const IORegistryPlane *plane) APPLE_KEXT_OVERRIDE;

164

         virtual void registerNVRAMController(IONVRAMController *nvram);

166

         virtual void sync(void);

         virtual IOReturn syncOFVariables(void);

169

         virtual bool serializeProperties(OSSerialize *s) const APPLE_KEXT_OVERRIDE;

         virtual OSPtr<OSObject> copyProperty(const OSSymbol *aKey) const APPLE_KEXT_OVERRIDE;

         virtual OSPtr<OSObject> copyProperty(const char *aKey) const APPLE_KEXT_OVERRIDE;

         virtual OSObject *getProperty(const OSSymbol *aKey) const APPLE_KEXT_OVERRIDE;

         virtual OSObject *getProperty(const char *aKey) const APPLE_KEXT_OVERRIDE;

         virtual bool setProperty(const OSSymbol *aKey, OSObject *anObject) APPLE_KEXT_OVERRIDE;

         virtual void removeProperty(const OSSymbol *aKey) APPLE_KEXT_OVERRIDE;

         virtual IOReturn setProperties(OSObject *properties) APPLE_KEXT_OVERRIDE;

178

         virtual IOReturn readXPRAM(IOByteCount offset, UInt8 *buffer,

180 IOByteCount length);

         virtual IOReturn writeXPRAM(IOByteCount offset, UInt8 *buffer,

182 IOByteCount length);

183

         virtual IOReturn readNVRAMProperty(IORegistryEntry *entry,

185 const OSSymbol **name,

186 OSData **value);

         virtual IOReturn writeNVRAMProperty(IORegistryEntry *entry,

188 const OSSymbol *name,

189 OSData *value);

190

         virtual OSDictionary *getNVRAMPartitions(void);

192

         virtual IOReturn readNVRAMPartition(const OSSymbol *partitionID,

194 IOByteCount offset, UInt8 *buffer,

195 IOByteCount length);

196

         virtual IOReturn writeNVRAMPartition(const OSSymbol *partitionID,

198 IOByteCount offset, UInt8 *buffer,

199 IOByteCount length);

200

         virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);

         virtual bool safeToSync(void);

         void syncInternal(bool rateLimit);

204 };

205

206 #endif /* __cplusplus */

207

208 #endif /* !_IOKIT_IONVRAM_H */