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
29#ifndef _IOKIT_IODMACONTROLLER_H
30#define _IOKIT_IODMACONTROLLER_H
31
32#include <IOKit/IODMACommand.h>
33#include <IOKit/IODMAEventSource.h>
34#include <IOKit/IOService.h>
35
36class IODMAEventSource;
37
38class IODMAController : public IOService
39{
40  OSDeclareAbstractStructors(IODMAController);
41
42  friend class IODMAEventSource;
43
44 private:
45  IOService       *_provider;
46  const OSSymbol  *_dmaControllerName;
47
48 protected:
49  virtual void registerDMAController(IOOptionBits options = 0);
50  virtual IOReturn initDMAChannel(IOService *provider, IODMAEventSource *dmaES, UInt32 *dmaIndex, UInt32 reqIndex) = 0;
51  virtual IOReturn startDMACommand(UInt32 dmaIndex, IODMACommand *dmaCommand, IODirection direction,
52				   IOByteCount byteCount = 0, IOByteCount byteOffset = 0) = 0;
53  virtual IOReturn stopDMACommand(UInt32 dmaIndex, bool flush = false, uint64_t timeout = UINT64_MAX) = 0;
54  virtual void completeDMACommand(IODMAEventSource *dmaES, IODMACommand *dmaCommand);
55  virtual void notifyDMACommand(IODMAEventSource *dmaES, IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
56  virtual IOReturn queryDMACommand(UInt32 dmaIndex, IODMACommand **dmaCommand, IOByteCount *transferCount, bool waitForIdle = false) = 0;
57  virtual IOByteCount getFIFODepth(UInt32 dmaIndex, IODirection direction) = 0;
58  virtual IOReturn setFIFODepth(UInt32 dmaIndex, IOByteCount depth) = 0;
59  virtual IOByteCount validFIFODepth(UInt32 dmaIndex, IOByteCount depth, IODirection direction) = 0;
60  virtual IOReturn setDMAConfig(UInt32 dmaIndex, IOService *provider, UInt32 reqIndex) = 0;
61  virtual bool validDMAConfig(UInt32 dmaIndex, IOService *provider, UInt32 reqIndex) = 0;
62
63 public:
64  static const OSSymbol *createControllerName(UInt32 phandle);
65  static IODMAController *getController(IOService *provider, UInt32 dmaIndex);
66
67  virtual bool start(IOService *provider);
68};
69
70
71#endif /* _IOKIT_IODMACONTROLLER_H */
72