[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;
    hibernate_page_list_t *		page_list_pal;
    class IOBufferMemoryDescriptor *    ioBuffer;
    class IOBufferMemoryDescriptor *    srcBuffer;
    class IOBufferMemoryDescriptor *    handoffBuffer;
    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 *				consoleMapping;
    uint8_t				haveFastBoot;
    uint8_t				saveBootAudioVolume;
    uint8_t				wiredCryptKey[kIOHibernateAESKeySize / 8];
    uint8_t				cryptKey[kIOHibernateAESKeySize / 8];
    uint8_t				volumeCryptKey[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;
    IOByteCount				readEnd;
    uint32_t                            flags;
    uint64_t				block0;
    uint64_t				position;
    uint64_t				extentPosition;
    uint64_t				encryptStart;
    uint64_t				encryptEnd;
    uint64_t                            cryptBytes;
    AbsoluteTime                        cryptTime;
    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_page(uint8_t *buf, uint32_t ppnum);

extern vm_offset_t sectHIBB;
extern unsigned long sectSizeHIB;
extern vm_offset_t sectDATAB;
extern unsigned long sectSizeDATA;
#if defined(__i386__) || defined(__x86_64__)
extern vm_offset_t sectINITPTB;
#endif

extern ppnum_t gIOHibernateHandoffPages[];
extern uint32_t gIOHibernateHandoffPageCount;
Commit	Line	Data
3a60a9f5 A	1	/*
	2	* Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
3a60a9f5	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@
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;
6d2010ae	39	hibernate_page_list_t * page_list_pal;
3a60a9f5 A	40	class IOBufferMemoryDescriptor * ioBuffer;
3a60a9f5 A	41	class IOBufferMemoryDescriptor * srcBuffer;
6d2010ae	42	class IOBufferMemoryDescriptor * handoffBuffer;
3a60a9f5 A	43	class IOMemoryDescriptor * previewBuffer;
	44	OSData * previewData;
	45	OSData * fileExtents;
	46	OSObject * saveBootDevice;
	47
	48	struct IOPolledFileIOVars * fileVars;
	49	vm_offset_t videoMapping;
	50	vm_size_t videoAllocSize;
	51	vm_size_t videoMapSize;
2d21ac55	52	uint8_t * consoleMapping;
3a60a9f5 A	53	uint8_t haveFastBoot;
	54	uint8_t saveBootAudioVolume;
	55	uint8_t wiredCryptKey[kIOHibernateAESKeySize / 8];
	56	uint8_t cryptKey[kIOHibernateAESKeySize / 8];
6d2010ae	57	uint8_t volumeCryptKey[kIOHibernateAESKeySize / 8];
3a60a9f5 A	58	};
	59	typedef struct IOHibernateVars IOHibernateVars;
	60
	61
	62	struct IOPolledFileIOVars
	63	{
	64	struct kern_direct_file_io_ref_t * fileRef;
	65	class OSArray * pollers;
	66	IOByteCount blockSize;
	67	uint8_t * buffer;
	68	IOByteCount bufferSize;
	69	IOByteCount bufferLimit;
	70	IOByteCount bufferOffset;
	71	IOByteCount bufferHalf;
	72	IOByteCount extentRemaining;
	73	IOByteCount lastRead;
6d2010ae A	74	IOByteCount readEnd;
6d2010ae A	75	uint32_t flags;
3a60a9f5 A	76	uint64_t block0;
	77	uint64_t position;
	78	uint64_t extentPosition;
	79	uint64_t encryptStart;
0b4c1975	80	uint64_t encryptEnd;
6d2010ae A	81	uint64_t cryptBytes;
6d2010ae A	82	AbsoluteTime cryptTime;
3a60a9f5 A	83	IOPolledFileExtent * extentMap;
	84	IOPolledFileExtent * currentExtent;
	85	bool io;
	86	IOReturn ioStatus;
	87	};
	88	typedef struct IOPolledFileIOVars IOPolledFileIOVars;
	89
	90	#endif /* __cplusplus */
	91
	92	enum
	93	{
	94	kIOHibernateTagSignature = 0x53000000,
	95	kIOHibernateTagLength = 0x00001fff,
	96	};
	97
	98	#ifdef __cplusplus
	99	extern "C"
	100	#endif /* __cplusplus */
	101	uint32_t
0b4c1975	102	hibernate_sum_page(uint8_t *buf, uint32_t ppnum);
3a60a9f5 A	103
3a60a9f5 A	104	extern vm_offset_t sectHIBB;
b0d623f7	105	extern unsigned long sectSizeHIB;
3a60a9f5	106	extern vm_offset_t sectDATAB;
b0d623f7 A	107	extern unsigned long sectSizeDATA;
	108	#if defined(__i386__) \|\| defined(__x86_64__)
	109	extern vm_offset_t sectINITPTB;
	110	#endif
3a60a9f5	111
6d2010ae A	112	extern ppnum_t gIOHibernateHandoffPages[];
6d2010ae A	113	extern uint32_t gIOHibernateHandoffPageCount;