1/* 2 * Copyright (c) 2004 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#ifndef _IOPOLLEDINTERFACE_H_ 30#define _IOPOLLEDINTERFACE_H_ 31 32#include <libkern/c++/OSObject.h> 33#include <IOKit/IOMemoryDescriptor.h> 34 35#define kIOPolledInterfaceSupportKey "IOPolledInterface" 36#define kIOPolledInterfaceActiveKey "IOPolledInterfaceActive" 37 38enum 39{ 40 kIOPolledPreflightState = 1, 41 kIOPolledBeforeSleepState = 2, 42 kIOPolledAfterSleepState = 3, 43 kIOPolledPostflightState = 4 44}; 45 46enum 47{ 48 kIOPolledWrite = 1, 49 kIOPolledRead = 2 50}; 51 52typedef void (*IOPolledCompletionAction)( void * target, 53 void * parameter, 54 IOReturn status, 55 uint64_t actualByteCount); 56struct IOPolledCompletion 57{ 58 void * target; 59 IOPolledCompletionAction action; 60 void * parameter; 61}; 62 63class IOPolledInterface : public OSObject 64{ 65 OSDeclareAbstractStructors(IOPolledInterface); 66 67protected: 68 struct ExpansionData { }; 69 ExpansionData * reserved; 70 71public: 72 virtual IOReturn probe(IOService * target) = 0; 73 74 virtual IOReturn open( IOOptionBits state, IOMemoryDescriptor * buffer) = 0; 75 virtual IOReturn close(IOOptionBits state) = 0; 76 77 virtual IOReturn startIO(uint32_t operation, 78 uint32_t bufferOffset, 79 uint64_t deviceOffset, 80 uint64_t length, 81 IOPolledCompletion completion) = 0; 82 83 virtual IOReturn checkForWork(void) = 0; 84 85 static IOReturn checkAllForWork(void); 86 87 OSMetaClassDeclareReservedUnused(IOPolledInterface, 0); 88 OSMetaClassDeclareReservedUnused(IOPolledInterface, 1); 89 OSMetaClassDeclareReservedUnused(IOPolledInterface, 2); 90 OSMetaClassDeclareReservedUnused(IOPolledInterface, 3); 91 OSMetaClassDeclareReservedUnused(IOPolledInterface, 4); 92 OSMetaClassDeclareReservedUnused(IOPolledInterface, 5); 93 OSMetaClassDeclareReservedUnused(IOPolledInterface, 6); 94 OSMetaClassDeclareReservedUnused(IOPolledInterface, 7); 95 OSMetaClassDeclareReservedUnused(IOPolledInterface, 8); 96 OSMetaClassDeclareReservedUnused(IOPolledInterface, 9); 97 OSMetaClassDeclareReservedUnused(IOPolledInterface, 10); 98 OSMetaClassDeclareReservedUnused(IOPolledInterface, 11); 99 OSMetaClassDeclareReservedUnused(IOPolledInterface, 12); 100 OSMetaClassDeclareReservedUnused(IOPolledInterface, 13); 101 OSMetaClassDeclareReservedUnused(IOPolledInterface, 14); 102 OSMetaClassDeclareReservedUnused(IOPolledInterface, 15); 103}; 104 105#endif /* _IOPOLLEDINTERFACE_H_ */ 106