osfmk/i386/pal_hibernate.h

   1 /*
   2  * Copyright (c) 2010 Apple 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  * i386/x86_64 specific definitions for hibernation platform abstraction layer.
  30  */
  31
  32 #ifndef _I386_PAL_HIBERNATE_H
  33 #define _I386_PAL_HIBERNATE_H
  34
  35 __BEGIN_DECLS
  36
  37 #define HIB_MAP_SIZE    (2*I386_LPGBYTES)
  38 #define DEST_COPY_AREA  (4*GB - HIB_MAP_SIZE) /*4GB - 2*2m */
  39 #define SRC_COPY_AREA   (DEST_COPY_AREA - HIB_MAP_SIZE)
  40 #define COPY_PAGE_AREA  (SRC_COPY_AREA  - HIB_MAP_SIZE)
  41 #define BITMAP_AREA     (COPY_PAGE_AREA - HIB_MAP_SIZE)
  42 #define IMAGE_AREA      (BITMAP_AREA    - HIB_MAP_SIZE)
  43 #define IMAGE2_AREA     (IMAGE_AREA     - HIB_MAP_SIZE)
  44 #define SCRATCH_AREA    (IMAGE2_AREA    - HIB_MAP_SIZE)
  45 #define WKDM_AREA       (SCRATCH_AREA   - HIB_MAP_SIZE)
  46
  47 #define HIB_BASE segHIBB
  48 #define HIB_ENTRYPOINT acpi_wake_prot_entry
  49
  50 /*!
  51  * @typedef     pal_hib_map_type_t
  52  * @discussion  Parameter to pal_hib_map used to signify which memory region to map.
  53  */
  54 typedef uintptr_t pal_hib_map_type_t;
  55
  56 /*!
  57  * @struct      pal_hib_ctx
  58  * @discussion  x86_64-specific PAL context; see pal_hib_ctx_t for details.
  59  */
  60 struct pal_hib_ctx {
  61         char reserved;
  62 };
  63
  64 __END_DECLS
  65
  66 #endif /* _I386_PAL_HIBERNATE_H */