iokit/IOKit/IOCommandQueue.h

   1 /*
   2  * Copyright (c) 1998-2000 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 Copyright (c) 1998 Apple Computer, Inc.  All rights reserved.
  30
  31 HISTORY
  32     1998-7-13   Godfrey van der Linden(gvdl)
  33         Created.
  34     1998-10-30  Godfrey van der Linden(gvdl)
  35         Converted to C++
  36     1999-9-22   Godfrey van der Linden(gvdl)
  37         Deprecated
  38 ]*/
  39 #ifndef _IOKIT_IOCOMMANDQUEUE_H
  40 #define _IOKIT_IOCOMMANDQUEUE_H
  41
  42 #include <IOKit/IOEventSource.h>
  43
  44 class IOCommandQueue;
  45
  46 typedef void (*IOCommandQueueAction)
  47     (OSObject *, void *field0, void *field1, void *field2, void *field3);
  48
  49 class IOCommandQueue : public IOEventSource
  50 {
  51     OSDeclareDefaultStructors(IOCommandQueue)
  52
  53 protected:
  54     static const int kIOCQDefaultSize = 128;
  55
  56     void *queue;
  57     IOLock *producerLock;
  58     semaphore_port_t producerSema;
  59     int producerIndex, consumerIndex;
  60     int size;
  61
  62     virtual void free() APPLE_KEXT_OVERRIDE;
  63
  64     virtual bool checkForWork() APPLE_KEXT_OVERRIDE;
  65
  66 public:
  67     static IOCommandQueue *commandQueue(OSObject *inOwner,
  68                                         IOCommandQueueAction inAction = 0,
  69                                         int inSize = kIOCQDefaultSize)
  70         APPLE_KEXT_DEPRECATED;
  71     virtual bool init(OSObject *inOwner,
  72                       IOCommandQueueAction inAction = 0,
  73                       int inSize = kIOCQDefaultSize)
  74         APPLE_KEXT_DEPRECATED;
  75
  76     virtual kern_return_t enqueueCommand(bool gotoSleep = true,
  77                                          void *field0 = 0, void *field1 = 0,
  78                                          void *field2 = 0, void *field3 = 0)
  79         APPLE_KEXT_DEPRECATED;
  80
  81     // WARNING:  This function can only be safely called from the appropriate
  82     // work loop context.  You should check IOWorkLoop::onThread is true.
  83     //
  84     // For each entry in the commandQueue call the target/action.
  85     // Lockout all new entries to the queue while iterating.
  86     // If the input fields are zero then the queue's owner/action will be used.
  87     virtual int performAndFlush(OSObject *target = 0,
  88                                 IOCommandQueueAction inAction = 0)
  89         APPLE_KEXT_DEPRECATED;
  90 };
  91
  92 #endif /* !_IOKIT_IOCOMMANDQUEUE_H */