1 /* 2 * Copyright (c) 2004 Apple Computer, Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 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 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 29 #include <stdint.h> 30 #include <IOKit/IOHibernatePrivate.h> 31 32 #ifdef __cplusplus 33 34 35 enum { kIOHibernateAESKeySize = 16 }; /* bytes */ 36 37 // srcBuffer has to be big enough for a source page, the WKDM 38 // compressed output, and a scratch page needed by WKDM 39 #define HIBERNATION_SRC_BUFFER_SIZE (2 * page_size + WKdm_SCRATCH_BUF_SIZE_INTERNAL) 40 41 struct IOHibernateVars { 42 hibernate_page_list_t * page_list; 43 hibernate_page_list_t * page_list_wired; 44 hibernate_page_list_t * page_list_pal; 45 class IOBufferMemoryDescriptor * ioBuffer; 46 class IOBufferMemoryDescriptor * srcBuffer; 47 class IOBufferMemoryDescriptor * handoffBuffer; 48 class IOMemoryDescriptor * previewBuffer; 49 OSData * previewData; 50 OSObject * saveBootDevice; 51 52 struct IOPolledFileIOVars * fileVars; 53 uint64_t fileMinSize; 54 uint64_t fileMaxSize; 55 vm_offset_t videoMapping; 56 vm_size_t videoAllocSize; 57 vm_size_t videoMapSize; 58 uint8_t * consoleMapping; 59 uint8_t haveFastBoot; 60 uint8_t saveBootAudioVolume; 61 uint8_t hwEncrypt; 62 uint8_t wiredCryptKey[kIOHibernateAESKeySize]; 63 uint8_t cryptKey[kIOHibernateAESKeySize]; 64 size_t volumeCryptKeySize; 65 uint8_t volumeCryptKey[64]; 66 }; 67 typedef struct IOHibernateVars IOHibernateVars; 68 69 #endif /* __cplusplus */ 70 71 enum{ 72 kIOHibernateTagSignature = 0x53000000, 73 kIOHibernateTagLength = 0x00007fff, 74 }; 75 76 #ifdef __cplusplus 77 extern "C" 78 #endif /* __cplusplus */ 79 uint32_t 80 hibernate_sum_page(uint8_t *buf, uint32_t ppnum); 81 82 #if defined(__i386__) || defined(__x86_64__) 83 extern vm_offset_t segHIBB; 84 extern unsigned long segSizeHIB; 85 #elif defined(__arm64__) 86 extern vm_offset_t sectHIBTEXTB; 87 extern unsigned long sectSizeHIBTEXT; 88 #endif 89 90 extern ppnum_t gIOHibernateHandoffPages[]; 91 extern const uint32_t gIOHibernateHandoffPageCount; 92 93 // max address that can fit in a ppnum_t 94 #define IO_MAX_PAGE_ADDR (((uint64_t) UINT_MAX) << PAGE_SHIFT) 95 // atop() returning ppnum_t 96 #define atop_64_ppnum(x) ((ppnum_t)((uint64_t)(x) >> PAGE_SHIFT)) 97