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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_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	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
37839358 A	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.
1c79356b	11	*
37839358 A	12	* This Original Code and all software distributed under the License are
37839358 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
37839358 A	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.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
	24	*
	25	* DRI: Josh de Cesare
	26	*
	27	*/
	28
	29	#ifndef _IOKIT_CPU_H
	30	#define _IOKIT_CPU_H
	31
	32	extern "C" {
	33	#include <machine/machine_routines.h>
	34	#include <pexpert/pexpert.h>
	35	}
	36
	37	#include <IOKit/IOService.h>
	38	#include <IOKit/IOInterruptController.h>
	39
	40	enum {
	41	kIOCPUStateUnregistered = 0,
	42	kIOCPUStateUninitalized,
	43	kIOCPUStateStopped,
	44	kIOCPUStateRunning,
	45	kIOCPUStateCount
	46	};
	47
	48	class IOCPUInterruptController;
	49
	50	extern IOCPUInterruptController *gIOCPUInterruptController;
	51
	52	class IOCPU : public IOService
	53	{
	54	OSDeclareAbstractStructors(IOCPU);
	55
	56	private:
	57	OSArray *_cpuGroup;
	58	UInt32 _cpuNumber;
	59	UInt32 _cpuState;
	60
	61	protected:
	62	IOService *cpuNub;
	63	processor_t machProcessor;
	64	ipi_handler_t ipi_handler;
	65
	66	struct ExpansionData { };
	67	ExpansionData *reserved;
	68
	69	virtual void setCPUNumber(UInt32 cpuNumber);
	70	virtual void setCPUState(UInt32 cpuState);
	71
	72	public:
	73	static void initCPUs(void);
	74
	75	virtual bool start(IOService *provider);
91447636 A	76	virtual OSObject getProperty(const OSSymbol aKey) const;
	77	virtual bool setProperty(const OSSymbol aKey, OSObject anObject);
	78	virtual bool serializeProperties(OSSerialize *serialize) const;
1c79356b A	79	virtual IOReturn setProperties(OSObject *properties);
	80	virtual void initCPU(bool boot) = 0;
	81	virtual void quiesceCPU(void) = 0;
	82	virtual kern_return_t startCPU(vm_offset_t start_paddr,
	83	vm_offset_t arg_paddr) = 0;
	84	virtual void haltCPU(void) = 0;
	85	virtual void signalCPU(IOCPU *target);
	86	virtual void enableCPUTimeBase(bool enable);
	87
	88	virtual UInt32 getCPUNumber(void);
	89	virtual UInt32 getCPUState(void);
	90	virtual OSArray *getCPUGroup(void);
	91	virtual UInt32 getCPUGroupSize(void);
	92	virtual processor_t getMachProcessor(void);
	93
	94	virtual const OSSymbol *getCPUName(void) = 0;
	95
	96	OSMetaClassDeclareReservedUnused(IOCPU, 0);
	97	OSMetaClassDeclareReservedUnused(IOCPU, 1);
	98	OSMetaClassDeclareReservedUnused(IOCPU, 2);
	99	OSMetaClassDeclareReservedUnused(IOCPU, 3);
	100	OSMetaClassDeclareReservedUnused(IOCPU, 4);
	101	OSMetaClassDeclareReservedUnused(IOCPU, 5);
	102	OSMetaClassDeclareReservedUnused(IOCPU, 6);
	103	OSMetaClassDeclareReservedUnused(IOCPU, 7);
	104	};
	105
	106	void IOCPUSleepKernel(void);
	107
	108
	109	class IOCPUInterruptController : public IOInterruptController
	110	{
	111	OSDeclareDefaultStructors(IOCPUInterruptController);
	112
	113	private:
	114	int enabledCPUs;
	115
	116	protected:
	117	int numCPUs;
	118	IOCPU **cpus;
	119
	120	struct ExpansionData { };
	121	ExpansionData *reserved;
	122
	123	public:
	124	virtual IOReturn initCPUInterruptController(int sources);
	125	virtual void registerCPUInterruptController(void);
	126	virtual void setCPUInterruptProperties(IOService *service);
	127	virtual void enableCPUInterrupt(IOCPU *cpu);
	128
	129	virtual IOReturn registerInterrupt(IOService *nub, int source,
	130	void *target,
	131	IOInterruptHandler handler,
	132	void *refCon);
	133
	134	virtual IOReturn getInterruptType(IOService *nub, int source,
	135	int *interruptType);
	136
	137	virtual IOReturn enableInterrupt(IOService *nub, int source);
	138	virtual IOReturn disableInterrupt(IOService *nub, int source);
	139	virtual IOReturn causeInterrupt(IOService *nub, int source);
	140
	141	virtual IOReturn handleInterrupt(void refCon, IOService nub,
	142	int source);
143
144	OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 0);
145	OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 1);
146	OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 2);
147	OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 3);
148	OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 4);
149	OSMetaClassDeclareReservedUnused(IOCPUInterruptController, 5);
150	};
151
152	#endif /* ! _IOKIT_CPU_H */