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

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @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
 * limitations under the License.
 * 
 * @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,
  kIODTNVRAMNameRegistrySize = 0x0400
};

enum {
  kOFVariableTypeBoolean = 1,
  kOFVariableTypeNumber,
  kOFVariableTypeString,
  kOFVariableTypeData
};

enum {
  kOFVariablePermRootOnly = 0,
  kOFVariablePermUserRead,
  kOFVariablePermUserWrite,
  kOFVariablePermKernelOnly
};

#ifdef __cplusplus

class IODTNVRAM : public IOService
{
  OSDeclareDefaultStructors(IODTNVRAM);
  
private:
  IONVRAMController *_nvramController;
  const OSSymbol    *_registryPropertiesKey;
  UInt8             *_nvramImage;
  bool              _nvramImageDirty;
  UInt32            _ofPartitionOffset;
  UInt32            _ofPartitionSize;
  UInt8             *_ofImage;
  bool              _ofImageDirty;
  OSDictionary      *_ofDict;
  OSDictionary      *_nvramPartitionOffsets;
  OSDictionary      *_nvramPartitionLengths;
  UInt32            _xpramPartitionOffset;
  UInt32            _xpramPartitionSize;
  UInt8             *_xpramImage;
  UInt32            _nrPartitionOffset;
  UInt32            _nrPartitionSize;
  UInt8             *_nrImage;
  UInt32            _piPartitionOffset;
  UInt32            _piPartitionSize;
  UInt8             *_piImage;
  bool              _systemPaniced;
  SInt32            _lastDeviceSync;
  bool              _freshInterval;
  
  virtual UInt8 calculatePartitionChecksum(UInt8 *partitionHeader);
  virtual IOReturn initOFVariables(void);
public:
  virtual IOReturn syncOFVariables(void);
private:
  virtual UInt32 getOFVariableType(const OSSymbol *propSymbol) const;
  virtual UInt32 getOFVariablePerm(const OSSymbol *propSymbol) const;
  virtual bool getOWVariableInfo(UInt32 variableNumber, const OSSymbol **propSymbol,
				 UInt32 *propType, UInt32 *propOffset);
  virtual bool convertPropToObject(UInt8 *propName, UInt32 propNameLength,
				   UInt8 *propData, UInt32 propDataLength,
				   const OSSymbol **propSymbol,
				   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,
				   UInt32 *where);
  
  virtual IOReturn readNVRAMPropertyType0(IORegistryEntry *entry,
					  const OSSymbol **name,
					  OSData **value);
  virtual IOReturn writeNVRAMPropertyType0(IORegistryEntry *entry,
					   const OSSymbol *name,
					   OSData * value);
  
  virtual OSData *unescapeBytesToData(const UInt8 *bytes, UInt32 length);
  virtual OSData *escapeDataToData(OSData * value);

  virtual IOReturn readNVRAMPropertyType1(IORegistryEntry *entry,
					  const OSSymbol **name,
					  OSData **value);
  virtual IOReturn writeNVRAMPropertyType1(IORegistryEntry *entry,
					   const OSSymbol *name,
					   OSData *value);
  
public:
  virtual bool init(IORegistryEntry *old, const IORegistryPlane *plane);
  
  virtual void registerNVRAMController(IONVRAMController *nvram);
  
  virtual void sync(void);
  
  virtual bool serializeProperties(OSSerialize *s) const;
  virtual OSObject *getProperty(const OSSymbol *aKey) const;
  virtual OSObject *getProperty(const char *aKey) const;
  virtual bool setProperty(const OSSymbol *aKey, OSObject *anObject);
  virtual void removeProperty(const OSSymbol *aKey);
  virtual IOReturn setProperties(OSObject *properties);
  
  virtual IOReturn readXPRAM(IOByteCount offset, UInt8 *buffer,
			     IOByteCount length);
  virtual IOReturn writeXPRAM(IOByteCount offset, UInt8 *buffer,
			      IOByteCount length);
  
  virtual IOReturn readNVRAMProperty(IORegistryEntry *entry,
				     const OSSymbol **name,
				     OSData **value);
  virtual IOReturn writeNVRAMProperty(IORegistryEntry *entry,
				      const OSSymbol *name,
				      OSData *value);
  
  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 bool safeToSync(void);
};

#endif /* __cplusplus */

#endif /* !_IOKIT_IONVRAM_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28
	29	#ifndef _IOKIT_IONVRAM_H
	30	#define _IOKIT_IONVRAM_H
	31
6d2010ae	32	#ifdef __cplusplus
91447636	33	#include <IOKit/IOKitKeys.h>
1c79356b A	34	#include <IOKit/IOService.h>
	35	#include <IOKit/IODeviceTreeSupport.h>
	36	#include <IOKit/nvram/IONVRAMController.h>
6d2010ae	37	#endif /* __cplusplus */
d52fe63f A	38
	39	#define kIODTNVRAMOFPartitionName "common"
	40	#define kIODTNVRAMXPRAMPartitionName "APL,MacOS75"
9bccf70c	41	#define kIODTNVRAMPanicInfoPartitonName "APL,OSXPanic"
d52fe63f A	42	#define kIODTNVRAMFreePartitionName "wwwwwwwwwwww"
d52fe63f A	43
6d2010ae A	44	#define MIN_SYNC_NOW_INTERVAL 1560 / Minimum 15 Minutes interval mandated */
6d2010ae A	45
1c79356b A	46	enum {
	47	kIODTNVRAMImageSize = 0x2000,
	48	kIODTNVRAMXPRAMSize = 0x0100,
	49	kIODTNVRAMNameRegistrySize = 0x0400
	50	};
	51
	52	enum {
	53	kOFVariableTypeBoolean = 1,
	54	kOFVariableTypeNumber,
	55	kOFVariableTypeString,
	56	kOFVariableTypeData
	57	};
	58
	59	enum {
	60	kOFVariablePermRootOnly = 0,
	61	kOFVariablePermUserRead,
cf7d32b8 A	62	kOFVariablePermUserWrite,
cf7d32b8 A	63	kOFVariablePermKernelOnly
1c79356b A	64	};
1c79356b A	65
6d2010ae A	66	#ifdef __cplusplus
6d2010ae A	67
1c79356b A	68	class IODTNVRAM : public IOService
	69	{
	70	OSDeclareDefaultStructors(IODTNVRAM);
	71
	72	private:
	73	IONVRAMController *_nvramController;
	74	const OSSymbol *_registryPropertiesKey;
	75	UInt8 *_nvramImage;
	76	bool _nvramImageDirty;
	77	UInt32 _ofPartitionOffset;
	78	UInt32 _ofPartitionSize;
	79	UInt8 *_ofImage;
	80	bool _ofImageDirty;
	81	OSDictionary *_ofDict;
d52fe63f A	82	OSDictionary *_nvramPartitionOffsets;
d52fe63f A	83	OSDictionary *_nvramPartitionLengths;
1c79356b A	84	UInt32 _xpramPartitionOffset;
	85	UInt32 _xpramPartitionSize;
	86	UInt8 *_xpramImage;
	87	UInt32 _nrPartitionOffset;
	88	UInt32 _nrPartitionSize;
	89	UInt8 *_nrImage;
9bccf70c A	90	UInt32 _piPartitionOffset;
	91	UInt32 _piPartitionSize;
	92	UInt8 *_piImage;
	93	bool _systemPaniced;
6d2010ae A	94	SInt32 _lastDeviceSync;
6d2010ae A	95	bool _freshInterval;
1c79356b	96
9bccf70c	97	virtual UInt8 calculatePartitionChecksum(UInt8 *partitionHeader);
1c79356b	98	virtual IOReturn initOFVariables(void);
91447636	99	public:
1c79356b	100	virtual IOReturn syncOFVariables(void);
91447636	101	private:
1c79356b A	102	virtual UInt32 getOFVariableType(const OSSymbol *propSymbol) const;
	103	virtual UInt32 getOFVariablePerm(const OSSymbol *propSymbol) const;
	104	virtual bool getOWVariableInfo(UInt32 variableNumber, const OSSymbol **propSymbol,
	105	UInt32 propType, UInt32 propOffset);
	106	virtual bool convertPropToObject(UInt8 *propName, UInt32 propNameLength,
	107	UInt8 *propData, UInt32 propDataLength,
	108	const OSSymbol **propSymbol,
	109	OSObject **propObject);
	110	virtual bool convertObjectToProp(UInt8 buffer, UInt32 length,
	111	const OSSymbol propSymbol, OSObject propObject);
	112	virtual UInt16 generateOWChecksum(UInt8 *buffer);
	113	virtual bool validateOWChecksum(UInt8 *buffer);
	114	virtual void updateOWBootArgs(const OSSymbol key, OSObject value);
	115	virtual bool searchNVRAMProperty(struct IONVRAMDescriptor *hdr,
	116	UInt32 *where);
	117
	118	virtual IOReturn readNVRAMPropertyType0(IORegistryEntry *entry,
	119	const OSSymbol **name,
	120	OSData **value);
	121	virtual IOReturn writeNVRAMPropertyType0(IORegistryEntry *entry,
	122	const OSSymbol *name,
	123	OSData * value);
	124
91447636	125	virtual OSData unescapeBytesToData(const UInt8 bytes, UInt32 length);
1c79356b A	126	virtual OSData escapeDataToData(OSData value);
	127
	128	virtual IOReturn readNVRAMPropertyType1(IORegistryEntry *entry,
	129	const OSSymbol **name,
	130	OSData **value);
	131	virtual IOReturn writeNVRAMPropertyType1(IORegistryEntry *entry,
	132	const OSSymbol *name,
	133	OSData *value);
	134
	135	public:
	136	virtual bool init(IORegistryEntry old, const IORegistryPlane plane);
	137
	138	virtual void registerNVRAMController(IONVRAMController *nvram);
	139
	140	virtual void sync(void);
	141
91447636	142	virtual bool serializeProperties(OSSerialize *s) const;
1c79356b A	143	virtual OSObject getProperty(const OSSymbol aKey) const;
	144	virtual OSObject getProperty(const char aKey) const;
	145	virtual bool setProperty(const OSSymbol aKey, OSObject anObject);
91447636	146	virtual void removeProperty(const OSSymbol *aKey);
1c79356b A	147	virtual IOReturn setProperties(OSObject *properties);
	148
	149	virtual IOReturn readXPRAM(IOByteCount offset, UInt8 *buffer,
	150	IOByteCount length);
	151	virtual IOReturn writeXPRAM(IOByteCount offset, UInt8 *buffer,
	152	IOByteCount length);
	153
	154	virtual IOReturn readNVRAMProperty(IORegistryEntry *entry,
	155	const OSSymbol **name,
	156	OSData **value);
	157	virtual IOReturn writeNVRAMProperty(IORegistryEntry *entry,
	158	const OSSymbol *name,
	159	OSData *value);
d52fe63f A	160
	161	virtual OSDictionary *getNVRAMPartitions(void);
	162
	163	virtual IOReturn readNVRAMPartition(const OSSymbol *partitionID,
	164	IOByteCount offset, UInt8 *buffer,
	165	IOByteCount length);
	166
	167	virtual IOReturn writeNVRAMPartition(const OSSymbol *partitionID,
	168	IOByteCount offset, UInt8 *buffer,
	169	IOByteCount length);
9bccf70c A	170
9bccf70c A	171	virtual IOByteCount savePanicInfo(UInt8 *buffer, IOByteCount length);
6d2010ae	172	virtual bool safeToSync(void);
1c79356b A	173	};
1c79356b A	174
6d2010ae A	175	#endif /* __cplusplus */
6d2010ae A	176
1c79356b	177	#endif /* !_IOKIT_IONVRAM_H */