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