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