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