1/*
2 * Copyright (c) 2002-2007 Apple Inc. All rights reserved.
3 *
4 * @APPLE_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. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24#ifndef __IOKIT_SCSI_PARALLEL_TIMER_H__
25#define __IOKIT_SCSI_PARALLEL_TIMER_H__
26
27
28//-----------------------------------------------------------------------------
29//	Includes
30//-----------------------------------------------------------------------------
31
32// General IOKit includes
33#include <IOKit/IOWorkLoop.h>
34#include <IOKit/IOTimerEventSource.h>
35
36// SCSI Parallel Family includes
37#include "SCSIParallelTask.h"
38
39
40//-----------------------------------------------------------------------------
41//	Constants
42//-----------------------------------------------------------------------------
43
44#define kTimeoutValueNone	0
45
46
47//-----------------------------------------------------------------------------
48//	Class Declarations
49//-----------------------------------------------------------------------------
50
51class SCSIParallelTimer : public IOTimerEventSource
52{
53
54	OSDeclareDefaultStructors ( SCSIParallelTimer )
55
56public:
57
58	static SCSIParallelTimer *
59	CreateTimerEventSource ( OSObject * owner, Action action = 0 );
60
61	bool				Init ( OSObject * owner, Action action );
62
63	void 				Enable ( void );
64	void 				Disable ( void );
65	void 				CancelTimeout ( void );
66	bool				Rearm ( void );
67	void				BeginTimeoutContext ( void );
68	void				EndTimeoutContext ( void );
69
70	IOReturn 			SetTimeout (
71							SCSIParallelTaskIdentifier	taskIdentifier,
72						  	UInt32					 	timeoutInMS = kTimeoutValueNone );
73
74	void				RemoveTask (
75							SCSIParallelTaskIdentifier	taskIdentifier );
76
77	SCSIParallelTaskIdentifier	GetExpiredTask ( void );
78
79
80protected:
81
82	inline static SInt32	CompareDeadlines ( AbsoluteTime time1, AbsoluteTime time2 );
83	AbsoluteTime			GetDeadline ( SCSIParallelTask * task );
84	UInt32					GetTimeoutDuration ( SCSIParallelTask * task );
85
86
87private:
88
89	queue_head_t			fListHead;
90	bool					fHandlingTimeout;
91
92};
93
94
95#endif	/* __IOKIT_SCSI_PARALLEL_TIMER_H__ */