[apple/xnu.git] / iokit / IOKit / IOCommandQueue.h

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
Copyright (c) 1998 Apple Computer, Inc.  All rights reserved.

HISTORY
    1998-7-13	Godfrey van der Linden(gvdl)
        Created.
    1998-10-30	Godfrey van der Linden(gvdl)
        Converted to C++
    1999-9-22	Godfrey van der Linden(gvdl)
	Deprecated
]*/
#ifndef _IOKIT_IOCOMMANDQUEUE_H
#define _IOKIT_IOCOMMANDQUEUE_H

#include <IOKit/IOEventSource.h>


#warning IOCommandQueue has been deprecated in favour of IOCommandGate and will be going away before too long.


class IOCommandQueue;

typedef void (*IOCommandQueueAction)
    (OSObject *, void *field0, void *field1, void *field2, void *field3);

class IOCommandQueue : public IOEventSource
{
    OSDeclareDefaultStructors(IOCommandQueue)

protected:
    static const int kIOCQDefaultSize = 128;

    void *queue;
    IOLock *producerLock;
    semaphore_port_t producerSema;
    int producerIndex, consumerIndex;
    int size;

    virtual void free();

    virtual bool checkForWork();

public:
    static IOCommandQueue *commandQueue(OSObject *inOwner,
                                        IOCommandQueueAction inAction = 0,
                                        int inSize = kIOCQDefaultSize);
    virtual bool init(OSObject *inOwner,
                      IOCommandQueueAction inAction = 0,
                      int inSize = kIOCQDefaultSize);

    virtual kern_return_t enqueueCommand(bool gotoSleep = true,
                                         void *field0 = 0, void *field1 = 0,
                                         void *field2 = 0, void *field3 = 0);

    // WARNING:  This function can only be safely called from the appropriate
    // work loop context.  You should check IOWorkLoop::onThread is true.
    //
    // For each entry in the commandQueue call the target/action.
    // Lockout all new entries to the queue while iterating.
    // If the input fields are zero then the queue's owner/action will be used.
    virtual int performAndFlush(OSObject *target = 0,
                                IOCommandQueueAction inAction = 0);
};

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