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