iokit/IOKit/IOPolledInterface.h

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