osfmk/i386/commpage/commpage.h

   1 /*
   2  * Copyright (c) 2003-2006 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 #ifndef _I386_COMMPAGE_H
  32 #define _I386_COMMPAGE_H
  33
  34 #ifndef __ASSEMBLER__
  35 #include <stdint.h>
  36 #endif /* __ASSEMBLER__ */
  37
  38 /* The following macro is used to generate the 64-bit commpage address for a given
  39  * routine, based on its 32-bit address.  This is used in the kernel to compile
  40  * the 64-bit commpage.  Since the kernel is a 32-bit object, cpu_capabilities.h
  41  * only defines the 32-bit address.
  42  */
  43 #define _COMM_PAGE_32_TO_64( ADDRESS )  ( ADDRESS + _COMM_PAGE64_START_ADDRESS - _COMM_PAGE32_START_ADDRESS )
  44
  45
  46 #ifdef  __ASSEMBLER__
  47
  48 #define COMMPAGE_DESCRIPTOR(label,address,must,cant)    \
  49 L ## label ## _end:                                     ;\
  50 .const_data                                             ;\
  51 L ## label ## _size = L ## label ## _end - L ## label   ;\
  52 .private_extern _commpage_ ## label                     ;\
  53 _commpage_ ## label ## :                                ;\
  54     .long       L ## label                              ;\
  55     .long       L ## label ## _size                     ;\
  56     .long       address                                 ;\
  57     .long       must                                    ;\
  58     .long       cant                                    ;\
  59 .text
  60
  61 #else /* __ASSEMBLER__ */
  62
  63 /* Each potential commpage routine is described by one of these.
  64  * Note that the COMMPAGE_DESCRIPTOR macro (above), used in
  65  * assembly language, must agree with this.
  66  */
  67
  68 typedef struct  commpage_descriptor     {
  69     void        *code_address;                                  // address of code
  70     long        code_length;                                    // length in bytes
  71     long        commpage_address;                               // put at this address (_COMM_PAGE_BCOPY etc)
  72     long        musthave;                                       // _cpu_capability bits we must have
  73     long        canthave;                                       // _cpu_capability bits we can't have
  74 } commpage_descriptor;
  75
  76
  77 extern  char    *commPagePtr32;                         // virt address of 32-bit commpage in kernel map
  78 extern  char    *commPagePtr64;                         // ...and of 64-bit commpage
  79
  80 extern  void    _commpage_set_timestamp(uint64_t abstime, uint64_t secs);
  81 #define commpage_set_timestamp(x, y, z)         _commpage_set_timestamp((x), (y))
  82
  83 extern  void    commpage_set_nanotime(uint64_t tsc_base, uint64_t ns_base, uint32_t scale, uint32_t shift);
  84
  85 #include <kern/page_decrypt.h>
  86
  87 #endif  /* __ASSEMBLER__ */
  88
  89 #endif /* _I386_COMMPAGE_H */