1/*
2 * Copyright (c) 1998-2002 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 _IOKIT_IOFIREWIREPOWERMANAGER_H
24#define _IOKIT_IOFIREWIREPOWERMANAGER_H
25
26#include <IOKit/firewire/IOFireWireFamilyCommon.h>
27
28#include <libkern/c++/OSObject.h>
29#include <IOKit/IOReturn.h>
30
31class IOFireWireController;
32
33/*! @class IOFireWirePowerManager
34*/
35
36class IOFireWirePowerManager : public OSObject
37{
38    OSDeclareAbstractStructors(IOFireWirePowerManager);
39
40protected:
41
42/*! @struct ExpansionData
43    @discussion This structure will be used to expand the capablilties of the class in the future.
44    */
45    struct ExpansionData { };
46
47/*! @var reserved
48    Reserved for future use.  (Internal use only)  */
49    ExpansionData *reserved;
50
51	IOFireWireController *	fControl;
52
53	UInt32		fMaximumDeciwatts;
54	UInt32		fAllocatedDeciwatts;
55
56public:
57	static IOFireWirePowerManager * createWithController( IOFireWireController * controller );
58
59	virtual bool initWithController( IOFireWireController * controller );
60
61	virtual void setMaximumDeciwatts( UInt32 deciwatts );
62	virtual IOReturn allocateDeciwatts( UInt32 deciwatts );
63	virtual void deallocateDeciwatts( UInt32 deciwatts );
64
65private:
66    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 0);
67    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 1);
68    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 2);
69    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 3);
70    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 4);
71    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 5);
72    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 6);
73    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 7);
74    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 8);
75    OSMetaClassDeclareReservedUnused(IOFireWirePowerManager, 9);
76};
77
78#endif