[apple/xnu.git] / iokit / IOKit / IOCPU.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code 
 * as defined in and that are subject to the Apple Public Source License 
 * Version 2.0 (the 'License'). You may not use this file except in 
 * compliance with the License.  The rights granted to you under the 
 * License may not be used to create, or enable the creation or 
 * redistribution of, unlawful or unlicensed copies of an Apple operating 
 * system, or to circumvent, violate, or enable the circumvention or 
 * violation of, any terms of an Apple operating system software license 
 * agreement.
 *
 * Please obtain a copy of the License at 
 * http://www.opensource.apple.com/apsl/ and read it before using this 
 * file.
 *
 * The Original Code and all software distributed under the License are 
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
 * Please see the License for the specific language governing rights and 
 * limitations under the License.
 *
 * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
 */
/*
 * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
 *
 *  DRI: Josh de Cesare
 *
 */

#ifndef _IOKIT_CPU_H
#define _IOKIT_CPU_H

extern "C" {
#include <machine/machine_routines.h>
#include <pexpert/pexpert.h>
}

#include <IOKit/IOService.h>
#include <IOKit/IOInterruptController.h>

enum {
  kIOCPUStateUnregistered = 0,
  kIOCPUStateUninitalized,
  kIOCPUStateStopped,
  kIOCPUStateRunning,
  kIOCPUStateCount
};

class IOCPUInterruptController;

extern IOCPUInterruptController *gIOCPUInterruptController;

class IOCPU : public IOService
{
  OSDeclareAbstractStructors(IOCPU);
  
private:
  OSArray                *_cpuGroup;
  UInt32                 _cpuNumber;
  UInt32                 _cpuState;
  
protected:
  IOService              *cpuNub;
  processor_t            machProcessor;
  ipi_handler_t          ipi_handler;

  struct ExpansionData { };
  ExpansionData *reserved;

  virtual void           setCPUNumber(UInt32 cpuNumber);
  virtual void           setCPUState(UInt32 cpuState);
  
public:
  static  void           initCPUs(void);
  
  virtual bool           start(IOService *provider);
  virtual OSObject       *getProperty(const OSSymbol *aKey) const;
  virtual bool           setProperty(const OSSymbol *aKey, OSObject *anObject);
  virtual bool           serializeProperties(OSSerialize *serialize) const;
  virtual IOReturn       setProperties(OSObject *properties);
  virtual void           initCPU(bool boot) = 0;
  virtual void           quiesceCPU(void) = 0;
  virtual kern_return_t  startCPU(vm_offset_t start_paddr,
				  vm_offset_t arg_paddr) = 0;
  virtual void           haltCPU(void) = 0;
  virtual void           signalCPU(IOCPU *target);
  virtual void           enableCPUTimeBase(bool enable);
  
  virtual UInt32         getCPUNumber(void);
  virtual UInt32         getCPUState(void);
  virtual OSArray        *getCPUGroup(void);
  virtual UInt32         getCPUGroupSize(void);
  virtual processor_t    getMachProcessor(void);
  
  virtual const OSSymbol *getCPUName(void) = 0;

  OSMetaClassDeclareReservedUnused(IOCPU, 0);
  OSMetaClassDeclareReservedUnused(IOCPU, 1);
  OSMetaClassDeclareReservedUnused(IOCPU, 2);
  OSMetaClassDeclareReservedUnused(IOCPU, 3);
  OSMetaClassDeclareReservedUnused(IOCPU, 4);
  OSMetaClassDeclareReservedUnused(IOCPU, 5);
  OSMetaClassDeclareReservedUnused(IOCPU, 6);
  OSMetaClassDeclareReservedUnused(IOCPU, 7);
};

void IOCPUSleepKernel(void);


class IOCPUInterruptController : public IOInterruptController
{
  OSDeclareDefaultStructors(IOCPUInterruptController);
  
private:
  int   enabledCPUs;
  
protected:  
  int   numCPUs;
  IOCPU **cpus;
  
  struct ExpansionData { };
  ExpansionData *reserved;

public:
  virtual IOReturn initCPUInterruptController(int sources);
  virtual void     registerCPUInterruptController(void);
  virtual void     setCPUInterruptProperties(IOService *service);
  virtual void     enableCPUInterrupt(IOCPU *cpu);
  
  virtual IOReturn registerInterrupt(IOService *nub, int source,
				     void *target,
				     IOInterruptHandler handler,
				     void *refCon);
  
  virtual IOReturn getInterruptType(IOService *nub, int source,
				    int *interruptType);
  
  virtual IOReturn enableInterrupt(IOService *nub, int source);
  virtual IOReturn disableInterrupt(IOService *nub, int source);
  virtual IOReturn causeInterrupt(IOService *nub, int source);
  
  virtual IOReturn handleInterrupt(void *refCon, IOService *nub,
				   int source);

  OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 0);
  OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 1);
  OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 2);
  OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 3);
  OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 4);
  OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 5);
};

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