osfmk/kern/machine.h

   1 /*
   2  * Copyright (c) 2000-2004 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  * @OSF_COPYRIGHT@
  32  */
  33
  34 #ifndef _KERN_MACHINE_H_
  35 #define _KERN_MACHINE_H_
  36
  37 #include <mach/kern_return.h>
  38 #include <mach/processor_info.h>
  39 #include <kern/kern_types.h>
  40
  41 /*
  42  * Machine support declarations.
  43  */
  44
  45 extern void             processor_up(
  46                                         processor_t             processor);
  47
  48 extern void             processor_offline(
  49                                         processor_t             processor);
  50
  51 extern void             processor_start_thread(void);
  52
  53 /*
  54  * Must be implemented in machine dependent code.
  55  */
  56
  57 /* Initialize machine dependent ast code */
  58 extern void init_ast_check(
  59                                         processor_t         processor);
  60
  61 /* Cause check for ast */
  62 extern void cause_ast_check(
  63                                         processor_t         processor);
  64
  65 extern kern_return_t cpu_control(
  66                                         int                 slot_num,
  67                                         processor_info_t    info,
  68                                         unsigned int        count);
  69
  70 extern void     cpu_sleep(void);
  71
  72 extern kern_return_t cpu_start(
  73                                         int                 slot_num);
  74
  75 extern void cpu_exit_wait(
  76                                         int                 slot_num);
  77
  78 extern kern_return_t cpu_info(
  79                                         processor_flavor_t  flavor,
  80                                         int                 slot_num,
  81                                         processor_info_t    info,
  82                                         unsigned int        *count);
  83
  84 extern kern_return_t cpu_info_count(
  85                                         processor_flavor_t  flavor,
  86                                         unsigned int        *count);
  87
  88 extern thread_t         machine_processor_shutdown(
  89                                                 thread_t            thread,
  90                                                 void                (*doshutdown)(processor_t),
  91                                                 processor_t         processor);
  92
  93 extern void machine_idle(void);
  94
  95 extern void machine_signal_idle(
  96                                         processor_t         processor);
  97
  98 extern void halt_cpu(void);
  99
 100 extern void halt_all_cpus(
 101                                         boolean_t           reboot);
 102
 103 extern char *machine_boot_info(
 104                                         char                *buf,
 105                                         vm_size_t           buf_len);
 106
 107 /*
 108  * Machine-dependent routine to fill in an array with up to callstack_max
 109  * levels of return pc information.
 110  */
 111 extern void machine_callstack(
 112                                         natural_t           *buf,
 113                                         vm_size_t           callstack_max);
 114
 115 extern void consider_machine_collect(void);
 116
 117 #endif  /* _KERN_MACHINE_H_ */