osfmk/ppc/commpage/commpage.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22
  23 #ifndef _PPC_COMMPAGE_H
  24 #define _PPC_COMMPAGE_H
  25
  26 #ifndef __ASSEMBLER__
  27 #include <stdint.h>
  28 #endif /* __ASSEMBLER__ */
  29
  30
  31 /* Special check bits for the compage_descriptor "special" field. */
  32
  33 #define kCommPageDCBA           0x0001                  // this routine uses DCBA, map to NOP if not appropriate
  34 #define kCommPageSYNC           0x0002                  // this routine uses SYNC, LWSYNC, or EIEIO, map to NOP if UP
  35 #define kCommPageISYNC          0x0004                  // this routine uses ISYNC, map to NOP if UP
  36 #define kCommPageMTCRF          0x0008                  // set bit 11 in MTCRF if only 1 cr specified
  37
  38 #define kPort32to64                     0x1000                  // written for 32-bit, must port to 64-bit
  39 #define kCommPage64                     0x2000                  // this routine is useable in 64-bit mode
  40 #define kCommPage32                     0x4000                  // this routine is useable in 32-bit mode
  41 #define kCommPageBoth           (kCommPage32+kCommPage64)
  42
  43
  44 #ifdef  __ASSEMBLER__
  45
  46 #define COMMPAGE_DESCRIPTOR(label,address,must,cant,special)    \
  47     .globl  EXT(label)  @\
  48 LEXT(label)     @\
  49     .short      label-. @\
  50     .short      .-label-2       @\
  51     .short      address @\
  52     .short      special @\
  53     .long       must    @\
  54     .long       cant
  55
  56
  57 #else /* __ASSEMBLER__ */
  58
  59 /* Each potential commpage routine is described by one of these.
  60  * Note that the COMMPAGE_DESCRIPTOR macro (above), used in
  61  * assembly language, must agree with this.
  62  */
  63
  64 typedef struct  commpage_descriptor     {
  65     short       code_offset;                                    // offset to code from this descriptor
  66     short       code_length;                                    // length in bytes
  67     short       commpage_address;                               // put at this address (_COMM_PAGE_BCOPY etc)
  68     short       special;                                                // special handling bits for DCBA and SYNC etc
  69     long        musthave;                                               // _cpu_capability bits we must have
  70     long        canthave;                                               // _cpu_capability bits we can't have
  71 } commpage_descriptor;
  72
  73
  74 extern  char    *commPagePtr32;                         // virt address of 32-bit commpage in kernel map
  75 extern  char    *commPagePtr64;                         // virt address of 64-bit commpage in kernel map
  76
  77
  78 extern  void    commpage_set_timestamp(uint64_t tbr,uint32_t secs,uint32_t usecs,uint32_t ticks_per_sec);
  79 extern  int             commpage_time_dcba( void );
  80
  81 #endif  /* __ASSEMBLER__ */
  82
  83 #endif /* _PPC_COMMPAGE_H */