osfmk/ppc/commpage/commpage.h

   1 /*
   2  * Copyright (c) 2003 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 _PPC_COMMPAGE_H
  32 #define _PPC_COMMPAGE_H
  33
  34 #ifndef __ASSEMBLER__
  35 #include <stdint.h>
  36 #endif /* __ASSEMBLER__ */
  37
  38
  39 /* Special check bits for the compage_descriptor "special" field. */
  40
  41 #define kCommPageDCBA           0x0001                  // this routine uses DCBA, map to NOP if not appropriate
  42 #define kCommPageSYNC           0x0002                  // this routine uses SYNC, LWSYNC, or EIEIO, map to NOP if UP
  43 #define kCommPageISYNC          0x0004                  // this routine uses ISYNC, map to NOP if UP
  44 #define kCommPageMTCRF          0x0008                  // set bit 11 in MTCRF if only 1 cr specified
  45
  46 #define kPort32to64                     0x1000                  // written for 32-bit, must port to 64-bit
  47 #define kCommPage64                     0x2000                  // this routine is useable in 64-bit mode
  48 #define kCommPage32                     0x4000                  // this routine is useable in 32-bit mode
  49 #define kCommPageBoth           (kCommPage32+kCommPage64)
  50
  51
  52 #ifdef  __ASSEMBLER__
  53
  54 #define COMMPAGE_DESCRIPTOR(label,address,must,cant,special)    \
  55     .globl  EXT(label)  @\
  56 LEXT(label)     @\
  57     .short      label-. @\
  58     .short      .-label-2       @\
  59     .short      address @\
  60     .short      special @\
  61     .long       must    @\
  62     .long       cant
  63
  64
  65 #else /* __ASSEMBLER__ */
  66
  67 /* Each potential commpage routine is described by one of these.
  68  * Note that the COMMPAGE_DESCRIPTOR macro (above), used in
  69  * assembly language, must agree with this.
  70  */
  71
  72 typedef struct  commpage_descriptor     {
  73     short       code_offset;                                    // offset to code from this descriptor
  74     short       code_length;                                    // length in bytes
  75     short       commpage_address;                               // put at this address (_COMM_PAGE_BCOPY etc)
  76     short       special;                                                // special handling bits for DCBA and SYNC etc
  77     long        musthave;                                               // _cpu_capability bits we must have
  78     long        canthave;                                               // _cpu_capability bits we can't have
  79 } commpage_descriptor;
  80
  81
  82 extern  char    *commPagePtr32;                         // virt address of 32-bit commpage in kernel map
  83 extern  char    *commPagePtr64;                         // virt address of 64-bit commpage in kernel map
  84
  85
  86 extern  void    commpage_set_timestamp(uint64_t tbr,uint32_t secs,uint32_t usecs,uint32_t ticks_per_sec);
  87 extern  int             commpage_time_dcba( void );
  88
  89 #endif  /* __ASSEMBLER__ */
  90
  91 #endif /* _PPC_COMMPAGE_H */