[apple/xnu.git] / iokit / Kernel / IOHibernateInternal.h

/*
 * Copyright (c) 2004 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@
 */

#include <stdint.h>

#ifdef __cplusplus

enum { kIOHibernateAESKeySize = 128 };	/* bits */

struct IOHibernateVars
{
    hibernate_page_list_t *		page_list;
    hibernate_page_list_t *		page_list_wired;
    class IOBufferMemoryDescriptor *    ioBuffer;
    class IOBufferMemoryDescriptor *    srcBuffer;
    class IOMemoryDescriptor *          previewBuffer;
    OSData *          			previewData;
    OSData *		 		fileExtents;
    OSObject *				saveBootDevice;

    struct IOPolledFileIOVars *		fileVars;
    vm_offset_t				videoMapping;
    vm_size_t				videoAllocSize;
    vm_size_t				videoMapSize;
    uint8_t				haveFastBoot;
    uint8_t				saveBootAudioVolume;
    uint8_t				wiredCryptKey[kIOHibernateAESKeySize / 8];
    uint8_t				cryptKey[kIOHibernateAESKeySize / 8];
};
typedef struct IOHibernateVars IOHibernateVars;


struct IOPolledFileIOVars
{
    struct kern_direct_file_io_ref_t *	fileRef;
    class OSArray *			pollers;
    IOByteCount				blockSize;
    uint8_t *  				buffer;
    IOByteCount 			bufferSize;
    IOByteCount 			bufferLimit;
    IOByteCount 			bufferOffset;
    IOByteCount 			bufferHalf;
    IOByteCount				extentRemaining;
    IOByteCount				lastRead;
    uint64_t				block0;
    uint64_t				position;
    uint64_t				extentPosition;
    uint64_t				encryptStart;
    IOPolledFileExtent * 		extentMap;
    IOPolledFileExtent * 		currentExtent;
    bool				io;
    IOReturn				ioStatus;
};
typedef struct IOPolledFileIOVars IOPolledFileIOVars;

#endif		/* __cplusplus */

enum
{
    kIOHibernateTagSignature = 0x53000000,
    kIOHibernateTagLength    = 0x00001fff,
};

#ifdef __cplusplus
extern "C"
#endif		/* __cplusplus */
uint32_t
hibernate_sum(uint8_t *buf, int32_t len);

extern vm_offset_t sectHIBB;
extern int         sectSizeHIB;
extern vm_offset_t sectDATAB;
extern int         sectSizeDATA;

extern vm_offset_t gIOHibernateWakeMap;	    // ppnum
extern vm_size_t   gIOHibernateWakeMapSize;
Commit	Line	Data
3a60a9f5 A	1	/*
	2	* Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
3a60a9f5	5	*
8f6c56a5 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.
	14	*
	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
3a60a9f5 A	27	*/
	28
	29	#include <stdint.h>
	30
	31	#ifdef __cplusplus
	32
	33	enum { kIOHibernateAESKeySize = 128 }; /* bits */
	34
	35	struct IOHibernateVars
	36	{
	37	hibernate_page_list_t * page_list;
	38	hibernate_page_list_t * page_list_wired;
	39	class IOBufferMemoryDescriptor * ioBuffer;
	40	class IOBufferMemoryDescriptor * srcBuffer;
	41	class IOMemoryDescriptor * previewBuffer;
	42	OSData * previewData;
	43	OSData * fileExtents;
	44	OSObject * saveBootDevice;
	45
	46	struct IOPolledFileIOVars * fileVars;
	47	vm_offset_t videoMapping;
	48	vm_size_t videoAllocSize;
	49	vm_size_t videoMapSize;
	50	uint8_t haveFastBoot;
	51	uint8_t saveBootAudioVolume;
	52	uint8_t wiredCryptKey[kIOHibernateAESKeySize / 8];
	53	uint8_t cryptKey[kIOHibernateAESKeySize / 8];
	54	};
	55	typedef struct IOHibernateVars IOHibernateVars;
	56
	57
	58	struct IOPolledFileIOVars
	59	{
	60	struct kern_direct_file_io_ref_t * fileRef;
	61	class OSArray * pollers;
	62	IOByteCount blockSize;
	63	uint8_t * buffer;
	64	IOByteCount bufferSize;
	65	IOByteCount bufferLimit;
	66	IOByteCount bufferOffset;
	67	IOByteCount bufferHalf;
	68	IOByteCount extentRemaining;
	69	IOByteCount lastRead;
	70	uint64_t block0;
	71	uint64_t position;
	72	uint64_t extentPosition;
	73	uint64_t encryptStart;
	74	IOPolledFileExtent * extentMap;
	75	IOPolledFileExtent * currentExtent;
	76	bool io;
	77	IOReturn ioStatus;
	78	};
	79	typedef struct IOPolledFileIOVars IOPolledFileIOVars;
	80
	81	#endif /* __cplusplus */
	82
	83	enum
	84	{
	85	kIOHibernateTagSignature = 0x53000000,
	86	kIOHibernateTagLength = 0x00001fff,
	87	};
	88
	89	#ifdef __cplusplus
	90	extern "C"
91	#endif /* __cplusplus */
92	uint32_t
93	hibernate_sum(uint8_t *buf, int32_t len);
94
95	extern vm_offset_t sectHIBB;
96	extern int sectSizeHIB;
97	extern vm_offset_t sectDATAB;
98	extern int sectSizeDATA;
99
89b3af67 A	100	extern vm_offset_t gIOHibernateWakeMap; // ppnum
	101	extern vm_size_t gIOHibernateWakeMapSize;
	102