iokit/Kernel/IOHibernateInternal.h

   1 /*
   2  * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30
  31 #include <stdint.h>
  32
  33 #ifdef __cplusplus
  34
  35 enum { kIOHibernateAESKeySize = 128 };  /* bits */
  36
  37 struct IOHibernateVars
  38 {
  39     hibernate_page_list_t *             page_list;
  40     hibernate_page_list_t *             page_list_wired;
  41     class IOBufferMemoryDescriptor *    ioBuffer;
  42     class IOBufferMemoryDescriptor *    srcBuffer;
  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;
  52     uint8_t                             haveFastBoot;
  53     uint8_t                             saveBootAudioVolume;
  54     uint8_t                             wiredCryptKey[kIOHibernateAESKeySize / 8];
  55     uint8_t                             cryptKey[kIOHibernateAESKeySize / 8];
  56 };
  57 typedef struct IOHibernateVars IOHibernateVars;
  58
  59
  60 struct IOPolledFileIOVars
  61 {
  62     struct kern_direct_file_io_ref_t *  fileRef;
  63     class OSArray *                     pollers;
  64     IOByteCount                         blockSize;
  65     uint8_t *                           buffer;
  66     IOByteCount                         bufferSize;
  67     IOByteCount                         bufferLimit;
  68     IOByteCount                         bufferOffset;
  69     IOByteCount                         bufferHalf;
  70     IOByteCount                         extentRemaining;
  71     IOByteCount                         lastRead;
  72     uint64_t                            block0;
  73     uint64_t                            position;
  74     uint64_t                            extentPosition;
  75     uint64_t                            encryptStart;
  76     IOPolledFileExtent *                extentMap;
  77     IOPolledFileExtent *                currentExtent;
  78     bool                                io;
  79     IOReturn                            ioStatus;
  80 };
  81 typedef struct IOPolledFileIOVars IOPolledFileIOVars;
  82
  83 #endif          /* __cplusplus */
  84
  85 enum
  86 {
  87     kIOHibernateTagSignature = 0x53000000,
  88     kIOHibernateTagLength    = 0x00001fff,
  89 };
  90
  91 #ifdef __cplusplus
  92 extern "C"
  93 #endif          /* __cplusplus */
  94 uint32_t
  95 hibernate_sum(uint8_t *buf, int32_t len);
  96
  97 extern vm_offset_t sectHIBB;
  98 extern int         sectSizeHIB;
  99 extern vm_offset_t sectDATAB;
 100 extern int         sectSizeDATA;
 101
 102 extern vm_offset_t gIOHibernateWakeMap;     // ppnum
 103 extern vm_size_t   gIOHibernateWakeMapSize;
 104