1*e7776783SApple OSS Distributions /* 2*e7776783SApple OSS Distributions * Copyright (c) 1998-2019 Apple Inc. All rights reserved. 3*e7776783SApple OSS Distributions * 4*e7776783SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*e7776783SApple OSS Distributions * 6*e7776783SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*e7776783SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*e7776783SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*e7776783SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*e7776783SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*e7776783SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*e7776783SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*e7776783SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*e7776783SApple OSS Distributions * 15*e7776783SApple OSS Distributions * Please obtain a copy of the License at 16*e7776783SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*e7776783SApple OSS Distributions * 18*e7776783SApple OSS Distributions * The Original Code and all software distributed under the License are 19*e7776783SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*e7776783SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*e7776783SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*e7776783SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*e7776783SApple OSS Distributions * Please see the License for the specific language governing rights and 24*e7776783SApple OSS Distributions * limitations under the License. 25*e7776783SApple OSS Distributions * 26*e7776783SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*e7776783SApple OSS Distributions */ 28*e7776783SApple OSS Distributions /* 29*e7776783SApple OSS Distributions * Copyright (c) 1998 Apple Computer, Inc. All rights reserved. 30*e7776783SApple OSS Distributions * 31*e7776783SApple OSS Distributions * HISTORY 32*e7776783SApple OSS Distributions * 1998-7-13 Godfrey van der Linden(gvdl) 33*e7776783SApple OSS Distributions * Created. 34*e7776783SApple OSS Distributions * 1998-10-30 Godfrey van der Linden(gvdl) 35*e7776783SApple OSS Distributions * Converted to C++ 36*e7776783SApple OSS Distributions * 1999-9-22 Godfrey van der Linden(gvdl) 37*e7776783SApple OSS Distributions * Deprecated 38*e7776783SApple OSS Distributions * ]*/ 39*e7776783SApple OSS Distributions #ifndef _IOKIT_IOCOMMANDQUEUE_H 40*e7776783SApple OSS Distributions #define _IOKIT_IOCOMMANDQUEUE_H 41*e7776783SApple OSS Distributions 42*e7776783SApple OSS Distributions #include <IOKit/IOEventSource.h> 43*e7776783SApple OSS Distributions #include <libkern/c++/OSPtr.h> 44*e7776783SApple OSS Distributions 45*e7776783SApple OSS Distributions class IOCommandQueue; 46*e7776783SApple OSS Distributions 47*e7776783SApple OSS Distributions typedef void (*IOCommandQueueAction) 48*e7776783SApple OSS Distributions (OSObject *, void *field0, void *field1, void *field2, void *field3); 49*e7776783SApple OSS Distributions 50*e7776783SApple OSS Distributions class IOCommandQueue : public IOEventSource 51*e7776783SApple OSS Distributions { 52*e7776783SApple OSS Distributions OSDeclareDefaultStructors(IOCommandQueue); 53*e7776783SApple OSS Distributions 54*e7776783SApple OSS Distributions protected: 55*e7776783SApple OSS Distributions static const int kIOCQDefaultSize = 128; 56*e7776783SApple OSS Distributions 57*e7776783SApple OSS Distributions void *queue; 58*e7776783SApple OSS Distributions IOLock *producerLock; 59*e7776783SApple OSS Distributions semaphore_port_t producerSema; 60*e7776783SApple OSS Distributions int producerIndex, consumerIndex; 61*e7776783SApple OSS Distributions int size; 62*e7776783SApple OSS Distributions 63*e7776783SApple OSS Distributions virtual void free() APPLE_KEXT_OVERRIDE; 64*e7776783SApple OSS Distributions 65*e7776783SApple OSS Distributions virtual bool checkForWork() APPLE_KEXT_OVERRIDE; 66*e7776783SApple OSS Distributions 67*e7776783SApple OSS Distributions public: 68*e7776783SApple OSS Distributions static OSPtr<IOCommandQueue> commandQueue(OSObject *inOwner, 69*e7776783SApple OSS Distributions IOCommandQueueAction inAction = NULL, 70*e7776783SApple OSS Distributions int inSize = kIOCQDefaultSize) 71*e7776783SApple OSS Distributions APPLE_KEXT_DEPRECATED; 72*e7776783SApple OSS Distributions virtual bool init(OSObject *inOwner, 73*e7776783SApple OSS Distributions IOCommandQueueAction inAction = NULL, 74*e7776783SApple OSS Distributions int inSize = kIOCQDefaultSize) 75*e7776783SApple OSS Distributions APPLE_KEXT_DEPRECATED; 76*e7776783SApple OSS Distributions 77*e7776783SApple OSS Distributions virtual kern_return_t enqueueCommand(bool gotoSleep = true, 78*e7776783SApple OSS Distributions void *field0 = NULL, void *field1 = NULL, 79*e7776783SApple OSS Distributions void *field2 = NULL, void *field3 = NULL) 80*e7776783SApple OSS Distributions APPLE_KEXT_DEPRECATED; 81*e7776783SApple OSS Distributions 82*e7776783SApple OSS Distributions // WARNING: This function can only be safely called from the appropriate 83*e7776783SApple OSS Distributions // work loop context. You should check IOWorkLoop::onThread is true. 84*e7776783SApple OSS Distributions // 85*e7776783SApple OSS Distributions // For each entry in the commandQueue call the target/action. 86*e7776783SApple OSS Distributions // Lockout all new entries to the queue while iterating. 87*e7776783SApple OSS Distributions // If the input fields are zero then the queue's owner/action will be used. 88*e7776783SApple OSS Distributions virtual int performAndFlush(OSObject *target = NULL, 89*e7776783SApple OSS Distributions IOCommandQueueAction inAction = NULL) 90*e7776783SApple OSS Distributions APPLE_KEXT_DEPRECATED; 91*e7776783SApple OSS Distributions }; 92*e7776783SApple OSS Distributions 93*e7776783SApple OSS Distributions #endif /* !_IOKIT_IOCOMMANDQUEUE_H */ 94