this repo has no description
1/*
2 * Copyright (c) 2000 Apple Computer, 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/*
29 * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
30 *
31 * DRI: Josh de Cesare
32 *
33 */
34
35#ifndef _IOKIT_CPU_H
36#define _IOKIT_CPU_H
37
38extern "C" {
39#include <machine/machine_routines.h>
40#include <pexpert/pexpert.h>
41}
42
43#include <IOKit/IOService.h>
44#include <IOKit/IOInterruptController.h>
45
46enum {
47 kIOCPUStateUnregistered = 0,
48 kIOCPUStateUninitalized,
49 kIOCPUStateStopped,
50 kIOCPUStateRunning,
51 kIOCPUStateCount
52};
53
54class IOCPUInterruptController;
55
56extern IOCPUInterruptController *gIOCPUInterruptController;
57
58class IOCPU : public IOService
59{
60 OSDeclareAbstractStructors(IOCPU);
61
62private:
63 OSArray *_cpuGroup;
64 UInt32 _cpuNumber;
65 UInt32 _cpuState;
66
67protected:
68 IOService *cpuNub;
69 processor_t machProcessor;
70 ipi_handler_t ipi_handler;
71
72 struct ExpansionData { };
73 ExpansionData *reserved;
74
75 virtual void setCPUNumber(UInt32 cpuNumber);
76 virtual void setCPUState(UInt32 cpuState);
77
78public:
79 static void initCPUs(void);
80
81 virtual bool start(IOService *provider) APPLE_KEXT_OVERRIDE;
82 virtual OSObject *getProperty(const OSSymbol *aKey) const APPLE_KEXT_OVERRIDE;
83 virtual bool setProperty(const OSSymbol *aKey, OSObject *anObject) APPLE_KEXT_OVERRIDE;
84 virtual bool serializeProperties(OSSerialize *serialize) const APPLE_KEXT_OVERRIDE;
85 virtual IOReturn setProperties(OSObject *properties) APPLE_KEXT_OVERRIDE;
86 virtual void initCPU(bool boot) = 0;
87 virtual void quiesceCPU(void) = 0;
88 virtual kern_return_t startCPU(vm_offset_t start_paddr,
89 vm_offset_t arg_paddr) = 0;
90 virtual void haltCPU(void) = 0;
91 virtual void signalCPU(IOCPU *target);
92 virtual void signalCPUDeferred(IOCPU * target);
93 virtual void signalCPUCancel(IOCPU * target);
94 virtual void enableCPUTimeBase(bool enable);
95
96 virtual UInt32 getCPUNumber(void);
97 virtual UInt32 getCPUState(void);
98 virtual OSArray *getCPUGroup(void);
99 virtual UInt32 getCPUGroupSize(void);
100 virtual processor_t getMachProcessor(void);
101
102 virtual const OSSymbol *getCPUName(void) = 0;
103
104 OSMetaClassDeclareReservedUnused(IOCPU, 0);
105 OSMetaClassDeclareReservedUnused(IOCPU, 1);
106 OSMetaClassDeclareReservedUnused(IOCPU, 2);
107 OSMetaClassDeclareReservedUnused(IOCPU, 3);
108 OSMetaClassDeclareReservedUnused(IOCPU, 4);
109 OSMetaClassDeclareReservedUnused(IOCPU, 5);
110 OSMetaClassDeclareReservedUnused(IOCPU, 6);
111 OSMetaClassDeclareReservedUnused(IOCPU, 7);
112};
113
114void IOCPUSleepKernel(void);
115extern "C" kern_return_t IOCPURunPlatformQuiesceActions(void);
116extern "C" kern_return_t IOCPURunPlatformActiveActions(void);
117extern "C" kern_return_t IOCPURunPlatformHaltRestartActions(uint32_t message);
118extern "C" kern_return_t IOCPURunPlatformPanicActions(uint32_t message);
119
120class IOCPUInterruptController : public IOInterruptController
121{
122 OSDeclareDefaultStructors(IOCPUInterruptController);
123
124private:
125 int enabledCPUs;
126
127protected:
128 int numCPUs;
129 IOCPU **cpus;
130
131 struct ExpansionData { };
132 ExpansionData *reserved;
133
134public:
135 virtual IOReturn initCPUInterruptController(int sources);
136 virtual void registerCPUInterruptController(void);
137 virtual void setCPUInterruptProperties(IOService *service);
138 virtual void enableCPUInterrupt(IOCPU *cpu);
139
140 virtual IOReturn registerInterrupt(IOService *nub, int source,
141 void *target,
142 IOInterruptHandler handler,
143 void *refCon) APPLE_KEXT_OVERRIDE;
144
145 virtual IOReturn getInterruptType(IOService *nub, int source,
146 int *interruptType) APPLE_KEXT_OVERRIDE;
147
148 virtual IOReturn enableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
149 virtual IOReturn disableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
150 virtual IOReturn causeInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
151
152 virtual IOReturn handleInterrupt(void *refCon, IOService *nub,
153 int source) APPLE_KEXT_OVERRIDE;
154
155 OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 0);
156 OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 1);
157 OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 2);
158 OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 3);
159 OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 4);
160 OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 5);
161};
162
163#endif /* ! _IOKIT_CPU_H */