xref: /xnu-12377.81.4/iokit/IOKit/IOSyncer.h (revision 043036a2b3718f7f0be807e2870f8f47d3fa0796)
1*043036a2SApple OSS Distributions /*
2*043036a2SApple OSS Distributions  * Copyright (c) 1998-2019 Apple Inc. All rights reserved.
3*043036a2SApple OSS Distributions  *
4*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*043036a2SApple OSS Distributions  *
6*043036a2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*043036a2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*043036a2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*043036a2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*043036a2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*043036a2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*043036a2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*043036a2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*043036a2SApple OSS Distributions  *
15*043036a2SApple OSS Distributions  * Please obtain a copy of the License at
16*043036a2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*043036a2SApple OSS Distributions  *
18*043036a2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*043036a2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*043036a2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*043036a2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*043036a2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*043036a2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*043036a2SApple OSS Distributions  * limitations under the License.
25*043036a2SApple OSS Distributions  *
26*043036a2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*043036a2SApple OSS Distributions  */
28*043036a2SApple OSS Distributions #ifndef _IOSYNCER_H
29*043036a2SApple OSS Distributions #define _IOSYNCER_H
30*043036a2SApple OSS Distributions 
31*043036a2SApple OSS Distributions #include <libkern/c++/OSObject.h>
32*043036a2SApple OSS Distributions #include <IOKit/IOTypes.h>
33*043036a2SApple OSS Distributions #include <IOKit/IOLocks.h>
34*043036a2SApple OSS Distributions 
35*043036a2SApple OSS Distributions class IOSyncer : public OSObject
36*043036a2SApple OSS Distributions {
37*043036a2SApple OSS Distributions 	OSDeclareDefaultStructors(IOSyncer);
38*043036a2SApple OSS Distributions 
39*043036a2SApple OSS Distributions private:
40*043036a2SApple OSS Distributions // The spin lock that is used to guard the 'threadMustStop' variable.
41*043036a2SApple OSS Distributions 	IOSimpleLock *guardLock;
42*043036a2SApple OSS Distributions 	volatile bool threadMustStop;
43*043036a2SApple OSS Distributions 	IOReturn fResult;
44*043036a2SApple OSS Distributions 	virtual void free() APPLE_KEXT_OVERRIDE;
45*043036a2SApple OSS Distributions 	virtual void privateSignal();
46*043036a2SApple OSS Distributions 
47*043036a2SApple OSS Distributions public:
48*043036a2SApple OSS Distributions 
49*043036a2SApple OSS Distributions 	static IOSyncer * create(bool twoRetains = true)
50*043036a2SApple OSS Distributions 	APPLE_KEXT_DEPRECATED;
51*043036a2SApple OSS Distributions 
52*043036a2SApple OSS Distributions 	virtual bool init(bool twoRetains)
53*043036a2SApple OSS Distributions 	APPLE_KEXT_DEPRECATED;
54*043036a2SApple OSS Distributions 	virtual void reinit()
55*043036a2SApple OSS Distributions 	APPLE_KEXT_DEPRECATED;
56*043036a2SApple OSS Distributions 	virtual IOReturn wait(bool autoRelease = true)
57*043036a2SApple OSS Distributions 	APPLE_KEXT_DEPRECATED;
58*043036a2SApple OSS Distributions 	virtual void signal(IOReturn res = kIOReturnSuccess,
59*043036a2SApple OSS Distributions 	    bool autoRelease = true)
60*043036a2SApple OSS Distributions 	APPLE_KEXT_DEPRECATED;
61*043036a2SApple OSS Distributions };
62*043036a2SApple OSS Distributions 
63*043036a2SApple OSS Distributions #endif /* !_IOSYNCER */
64