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