1/*
2 * Copyright (c) 2005 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
29#ifndef _IOKIT_IODMAEVENTSOURCE_H
30#define _IOKIT_IODMAEVENTSOURCE_H
31
32#include <libkern/c++/OSPtr.h>
33#include <IOKit/IOService.h>
34#include <IOKit/IODMACommand.h>
35#include <IOKit/IODMAController.h>
36#include <IOKit/IOEventSource.h>
37
38class IODMAController;
39
40class IODMAEventSource : public IOEventSource
41{
42 OSDeclareDefaultStructors(IODMAEventSource);
43
44 friend class IODMAController;
45
46public:
47 typedef void (*Action)(OSObject *owner, IODMAEventSource *dmaES, IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
48#define IODMAEventAction IODMAEventSource::Action
49
50protected:
51 virtual void completeDMACommand(IODMACommand *dmaCommand);
52 virtual void notifyDMACommand(IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
53
54public:
55 static OSPtr<IODMAEventSource> dmaEventSource(OSObject *owner,
56 IOService *provider,
57 Action completion = NULL,
58 Action notification = NULL,
59 UInt32 dmaIndex = 0);
60
61 virtual IOReturn startDMACommand(IODMACommand *dmaCommand, IODirection direction, IOByteCount byteCount = 0, IOByteCount byteOffset = 0);
62 virtual IOReturn stopDMACommand(bool flush = false, uint64_t timeout = UINT64_MAX);
63
64 virtual IOReturn queryDMACommand(IODMACommand **dmaCommand, IOByteCount *transferCount, bool waitForIdle = false);
65
66 virtual IOByteCount getFIFODepth(IODirection direction = kIODirectionNone);
67 virtual IOReturn setFIFODepth(IOByteCount depth);
68 virtual IOByteCount validFIFODepth(IOByteCount depth, IODirection direction);
69
70 virtual IOReturn setFrameSize(UInt8 byteCount);
71
72 virtual IOReturn setDMAConfig(UInt32 dmaIndex);
73 virtual bool validDMAConfig(UInt32 dmaIndex);
74
75private:
76 IOService *dmaProvider;
77 OSPtr<IODMAController> dmaController;
78 UInt32 dmaIndex;
79 queue_head_t dmaCommandsCompleted;
80 IOSimpleLock *dmaCommandsCompletedLock;
81 Action dmaCompletionAction;
82 Action dmaNotificationAction;
83 bool dmaSynchBusy;
84
85 virtual bool init(OSObject *owner,
86 IOService *provider,
87 Action completion = NULL,
88 Action notification = NULL,
89 UInt32 dmaIndex = 0);
90 virtual bool checkForWork(void) APPLE_KEXT_OVERRIDE;
91 virtual void free(void) APPLE_KEXT_OVERRIDE;
92};
93
94#endif /* _IOKIT_IODMAEVENTSOURCE_H */
95