1/* 2 * Copyright (c) 2005 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_IODMAEVENTSOURCE_H 30#define _IOKIT_IODMAEVENTSOURCE_H 31 32#include <IOKit/IOService.h> 33#include <IOKit/IODMACommand.h> 34#include <IOKit/IODMAController.h> 35#include <IOKit/IOEventSource.h> 36 37class IODMAController; 38 39class IODMAEventSource : public IOEventSource 40{ 41 OSDeclareDefaultStructors(IODMAEventSource); 42 43 friend class IODMAController; 44 45 public: 46 typedef void (*Action)(OSObject *owner, IODMAEventSource *dmaES, IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp); 47#define IODMAEventAction IODMAEventSource::Action 48 49 protected: 50 virtual void completeDMACommand(IODMACommand *dmaCommand); 51 virtual void notifyDMACommand(IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp); 52 53 public: 54 static IODMAEventSource *dmaEventSource(OSObject *owner, 55 IOService *provider, 56 Action completion = 0, 57 Action notification = 0, 58 UInt32 dmaIndex = 0); 59 60 virtual IOReturn startDMACommand(IODMACommand *dmaCommand, IODirection direction, IOByteCount byteCount = 0, IOByteCount byteOffset = 0); 61 virtual IOReturn stopDMACommand(bool flush = false, uint64_t timeout = UINT64_MAX); 62 63 virtual IOReturn queryDMACommand(IODMACommand **dmaCommand, IOByteCount *transferCount, bool waitForIdle = false); 64 65 virtual IOByteCount getFIFODepth(IODirection direction = kIODirectionNone); 66 virtual IOReturn setFIFODepth(IOByteCount depth); 67 virtual IOByteCount validFIFODepth(IOByteCount depth, IODirection direction); 68 69 virtual IOReturn setDMAConfig(UInt32 dmaIndex); 70 virtual bool validDMAConfig(UInt32 dmaIndex); 71 72 private: 73 IOService *dmaProvider; 74 IODMAController *dmaController; 75 UInt32 dmaIndex; 76 queue_head_t dmaCommandsCompleted; 77 IOSimpleLock *dmaCommandsCompletedLock; 78 Action dmaCompletionAction; 79 Action dmaNotificationAction; 80 bool dmaSynchBusy; 81 82 virtual bool init(OSObject *owner, 83 IOService *provider, 84 Action completion = 0, 85 Action notification = 0, 86 UInt32 dmaIndex = 0); 87 virtual bool checkForWork(void); 88 virtual void free(void); 89}; 90 91#endif /* _IOKIT_IODMAEVENTSOURCE_H */ 92