iokit/IOKit/IOCommandQueue.h

   1 /*
   2  * Copyright (c) 1998-2019 Apple 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 #include <libkern/c++/OSPtr.h>
  44
  45 class IOCommandQueue;
  46
  47 typedef void (*IOCommandQueueAction)
  48 (OSObject *, void *field0, void *field1, void *field2, void *field3);
  49
  50 class IOCommandQueue : public IOEventSource
  51 {
  52         OSDeclareDefaultStructors(IOCommandQueue);
  53
  54 protected:
  55         static const int kIOCQDefaultSize = 128;
  56
  57         void *queue;
  58         IOLock *producerLock;
  59         semaphore_port_t producerSema;
  60         int producerIndex, consumerIndex;
  61         int size;
  62
  63         virtual void free() APPLE_KEXT_OVERRIDE;
  64
  65         virtual bool checkForWork() APPLE_KEXT_OVERRIDE;
  66
  67 public:
  68         static OSPtr<IOCommandQueue> commandQueue(OSObject *inOwner,
  69             IOCommandQueueAction inAction = NULL,
  70             int inSize = kIOCQDefaultSize)
  71         APPLE_KEXT_DEPRECATED;
  72         virtual bool init(OSObject *inOwner,
  73             IOCommandQueueAction inAction = NULL,
  74             int inSize = kIOCQDefaultSize)
  75         APPLE_KEXT_DEPRECATED;
  76
  77         virtual kern_return_t enqueueCommand(bool gotoSleep = true,
  78             void *field0 = NULL, void *field1 = NULL,
  79             void *field2 = NULL, void *field3 = NULL)
  80         APPLE_KEXT_DEPRECATED;
  81
  82 // WARNING:  This function can only be safely called from the appropriate
  83 // work loop context.  You should check IOWorkLoop::onThread is true.
  84 //
  85 // For each entry in the commandQueue call the target/action.
  86 // Lockout all new entries to the queue while iterating.
  87 // If the input fields are zero then the queue's owner/action will be used.
  88         virtual int performAndFlush(OSObject *target = NULL,
  89             IOCommandQueueAction inAction = NULL)
  90         APPLE_KEXT_DEPRECATED;
  91 };
  92
  93 #endif /* !_IOKIT_IOCOMMANDQUEUE_H */