osfmk/arm64/hibernate_ppl_hmac.h

   1 /*
   2  * Copyright (c) 2019 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 #ifndef _ARM64_HIBERNATE_PPL_HMAC_H_
  29 #define _ARM64_HIBERNATE_PPL_HMAC_H_
  30
  31 #include <sys/cdefs.h>
  32 #include <stdint.h>
  33 #include <stdbool.h>
  34 #include <libkern/crypto/sha2.h>
  35 #include <mach/vm_types.h>
  36 #include <arm64/ppl/ppl_hib.h>
  37 #include <IOKit/IOHibernatePrivate.h>
  38
  39 #define HMAC_HASH_SIZE 48
  40
  41 __BEGIN_DECLS
  42
  43 kern_return_t ppl_hmac_init(void);
  44 void ppl_hmac_reset(bool wired_pages);
  45 void ppl_hmac_hibernate_begin(void);
  46 void ppl_hmac_hibernate_end(void);
  47 vm_address_t ppl_hmac_get_reg_base(void);
  48 int ppl_hmac_update_and_compress_page(ppnum_t pageNumber, void **uncompressed, void *compressed);
  49 void ppl_hmac_final(uint8_t *output, size_t outputLen);
  50 void ppl_hmac_fetch_hibseg_and_info(/* out */ void *buffer,
  51     /* in */ uint64_t bufferLen,
  52     /* out */ IOHibernateHibSegInfo *info);
  53 void ppl_hmac_compute_rorgn_hmac(void);
  54 void ppl_hmac_finalize_image(const void *header, size_t headerLen, uint8_t *hmac, size_t hmacLen);
  55 void ppl_hmac_get_io_ranges(const ppl_hib_io_range **io_ranges, uint16_t *num_io_ranges);
  56
  57 __END_DECLS
  58
  59 #endif /* _ARM64_HIBERNATE_PPL_HMAC_H_ */