1*27b03b36SApple OSS Distributions /* 2*27b03b36SApple OSS Distributions * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved. 3*27b03b36SApple OSS Distributions * 4*27b03b36SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*27b03b36SApple OSS Distributions * 6*27b03b36SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*27b03b36SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*27b03b36SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*27b03b36SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*27b03b36SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*27b03b36SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*27b03b36SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*27b03b36SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*27b03b36SApple OSS Distributions * 15*27b03b36SApple OSS Distributions * Please obtain a copy of the License at 16*27b03b36SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*27b03b36SApple OSS Distributions * 18*27b03b36SApple OSS Distributions * The Original Code and all software distributed under the License are 19*27b03b36SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*27b03b36SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*27b03b36SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*27b03b36SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*27b03b36SApple OSS Distributions * Please see the License for the specific language governing rights and 24*27b03b36SApple OSS Distributions * limitations under the License. 25*27b03b36SApple OSS Distributions * 26*27b03b36SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*27b03b36SApple OSS Distributions */ 28*27b03b36SApple OSS Distributions 29*27b03b36SApple OSS Distributions #ifndef _IOKIT_IODMACONTROLLER_H 30*27b03b36SApple OSS Distributions #define _IOKIT_IODMACONTROLLER_H 31*27b03b36SApple OSS Distributions 32*27b03b36SApple OSS Distributions #include <IOKit/IODMACommand.h> 33*27b03b36SApple OSS Distributions #include <IOKit/IODMAEventSource.h> 34*27b03b36SApple OSS Distributions #include <IOKit/IOService.h> 35*27b03b36SApple OSS Distributions #include <libkern/c++/OSPtr.h> 36*27b03b36SApple OSS Distributions 37*27b03b36SApple OSS Distributions class IODMAEventSource; 38*27b03b36SApple OSS Distributions 39*27b03b36SApple OSS Distributions class IODMAController : public IOService 40*27b03b36SApple OSS Distributions { 41*27b03b36SApple OSS Distributions OSDeclareAbstractStructors(IODMAController); 42*27b03b36SApple OSS Distributions 43*27b03b36SApple OSS Distributions friend class IODMAEventSource; 44*27b03b36SApple OSS Distributions 45*27b03b36SApple OSS Distributions private: 46*27b03b36SApple OSS Distributions IOService *_provider; 47*27b03b36SApple OSS Distributions OSPtr<const OSSymbol> _dmaControllerName; 48*27b03b36SApple OSS Distributions 49*27b03b36SApple OSS Distributions protected: 50*27b03b36SApple OSS Distributions virtual void registerDMAController(IOOptionBits options = 0); 51*27b03b36SApple OSS Distributions virtual IOReturn initDMAChannel(IOService *provider, IODMAEventSource *dmaES, UInt32 *dmaIndex, UInt32 reqIndex) = 0; 52*27b03b36SApple OSS Distributions virtual IOReturn startDMACommand(UInt32 dmaIndex, IODMACommand *dmaCommand, IODirection direction, 53*27b03b36SApple OSS Distributions IOByteCount byteCount = 0, IOByteCount byteOffset = 0) = 0; 54*27b03b36SApple OSS Distributions virtual IOReturn stopDMACommand(UInt32 dmaIndex, bool flush = false, uint64_t timeout = UINT64_MAX) = 0; 55*27b03b36SApple OSS Distributions virtual void completeDMACommand(IODMAEventSource *dmaES, IODMACommand *dmaCommand); 56*27b03b36SApple OSS Distributions virtual void notifyDMACommand(IODMAEventSource *dmaES, IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp); 57*27b03b36SApple OSS Distributions virtual IOReturn queryDMACommand(UInt32 dmaIndex, IODMACommand **dmaCommand, IOByteCount *transferCount, bool waitForIdle = false) = 0; 58*27b03b36SApple OSS Distributions virtual IOByteCount getFIFODepth(UInt32 dmaIndex, IODirection direction) = 0; 59*27b03b36SApple OSS Distributions virtual IOReturn setFIFODepth(UInt32 dmaIndex, IOByteCount depth) = 0; 60*27b03b36SApple OSS Distributions virtual IOByteCount validFIFODepth(UInt32 dmaIndex, IOByteCount depth, IODirection direction) = 0; 61*27b03b36SApple OSS Distributions virtual IOReturn setFrameSize(UInt32 dmaIndex, UInt8 byteCount) = 0; 62*27b03b36SApple OSS Distributions virtual IOReturn setDMAConfig(UInt32 dmaIndex, IOService *provider, UInt32 reqIndex) = 0; 63*27b03b36SApple OSS Distributions virtual bool validDMAConfig(UInt32 dmaIndex, IOService *provider, UInt32 reqIndex) = 0; 64*27b03b36SApple OSS Distributions 65*27b03b36SApple OSS Distributions public: 66*27b03b36SApple OSS Distributions static OSPtr<const OSSymbol> createControllerName(UInt32 phandle); 67*27b03b36SApple OSS Distributions static IODMAController *getController(IOService *provider, UInt32 dmaIndex); 68*27b03b36SApple OSS Distributions 69*27b03b36SApple OSS Distributions virtual bool start(IOService *provider) APPLE_KEXT_OVERRIDE; 70*27b03b36SApple OSS Distributions }; 71*27b03b36SApple OSS Distributions 72*27b03b36SApple OSS Distributions 73*27b03b36SApple OSS Distributions #endif /* _IOKIT_IODMACONTROLLER_H */ 74