[apple/xnu.git] / iokit / IOKit / IODMAEventSource.h

/*
 * Copyright (c) 2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifndef _IOKIT_IODMAEVENTSOURCE_H
#define _IOKIT_IODMAEVENTSOURCE_H

#include <IOKit/IOService.h>
#include <IOKit/IODMACommand.h>
#include <IOKit/IODMAController.h>
#include <IOKit/IOEventSource.h>

class IODMAController;

class IODMAEventSource : public IOEventSource
{
  OSDeclareDefaultStructors(IODMAEventSource);
  
  friend class IODMAController;
  
 public:
  typedef void (*Action)(OSObject *owner, IODMAEventSource *dmaES, IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
#define IODMAEventAction IODMAEventSource::Action
  
 protected:
  virtual void completeDMACommand(IODMACommand *dmaCommand);
  virtual void notifyDMACommand(IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
  
 public:
  static IODMAEventSource *dmaEventSource(OSObject *owner,
					  IOService *provider,
					  Action completion = 0,
					  Action notification = 0,
					  UInt32 dmaIndex = 0);
  
  virtual IOReturn startDMACommand(IODMACommand *dmaCommand, IODirection direction, IOByteCount byteCount = 0, IOByteCount byteOffset = 0);
  virtual IOReturn stopDMACommand(bool flush = false, uint64_t timeout = UINT64_MAX);

  virtual IOReturn queryDMACommand(IODMACommand **dmaCommand, IOByteCount *transferCount, bool waitForIdle = false);

  virtual IOByteCount getFIFODepth(IODirection direction = kIODirectionNone);
  virtual IOReturn setFIFODepth(IOByteCount depth);
  virtual IOByteCount validFIFODepth(IOByteCount depth, IODirection direction);

  virtual IOReturn setFrameSize(UInt8 byteCount);

  virtual IOReturn setDMAConfig(UInt32 dmaIndex);
  virtual bool validDMAConfig(UInt32 dmaIndex);
  
 private:
  IOService       *dmaProvider;
  IODMAController *dmaController;
  UInt32          dmaIndex;
  queue_head_t    dmaCommandsCompleted;
  IOSimpleLock	  *dmaCommandsCompletedLock;
  Action          dmaCompletionAction;
  Action          dmaNotificationAction;
  bool            dmaSynchBusy;
  
  virtual bool init(OSObject *owner,
		    IOService *provider,
		    Action completion = 0,
		    Action notification = 0,
		    UInt32 dmaIndex = 0);
  virtual bool checkForWork(void) APPLE_KEXT_OVERRIDE;
  virtual void free(void) APPLE_KEXT_OVERRIDE;
};

#endif /* _IOKIT_IODMAEVENTSOURCE_H */
Commit	Line	Data
2d21ac55 A	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
cf7d32b8 A	37	class IODMAController;
cf7d32b8 A	38
2d21ac55 A	39	class IODMAEventSource : public IOEventSource
	40	{
	41	OSDeclareDefaultStructors(IODMAEventSource);
	42
	43	friend class IODMAController;
	44
	45	public:
39236c6e	46	typedef void (Action)(OSObject owner, IODMAEventSource dmaES, IODMACommand dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
2d21ac55 A	47	#define IODMAEventAction IODMAEventSource::Action
	48
	49	protected:
	50	virtual void completeDMACommand(IODMACommand *dmaCommand);
39236c6e	51	virtual void notifyDMACommand(IODMACommand *dmaCommand, IOReturn status, IOByteCount actualByteCount, AbsoluteTime timeStamp);
2d21ac55 A	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);
b0d623f7	61	virtual IOReturn stopDMACommand(bool flush = false, uint64_t timeout = UINT64_MAX);
39236c6e	62
2d21ac55	63	virtual IOReturn queryDMACommand(IODMACommand *dmaCommand, IOByteCount transferCount, bool waitForIdle = false);
39236c6e A	64
	65	virtual IOByteCount getFIFODepth(IODirection direction = kIODirectionNone);
	66	virtual IOReturn setFIFODepth(IOByteCount depth);
	67	virtual IOByteCount validFIFODepth(IOByteCount depth, IODirection direction);
	68
3e170ce0 A	69	virtual IOReturn setFrameSize(UInt8 byteCount);
3e170ce0 A	70
39236c6e A	71	virtual IOReturn setDMAConfig(UInt32 dmaIndex);
39236c6e A	72	virtual bool validDMAConfig(UInt32 dmaIndex);
2d21ac55 A	73
	74	private:
	75	IOService *dmaProvider;
	76	IODMAController *dmaController;
	77	UInt32 dmaIndex;
	78	queue_head_t dmaCommandsCompleted;
	79	IOSimpleLock *dmaCommandsCompletedLock;
	80	Action dmaCompletionAction;
	81	Action dmaNotificationAction;
	82	bool dmaSynchBusy;
	83
	84	virtual bool init(OSObject *owner,
	85	IOService *provider,
	86	Action completion = 0,
	87	Action notification = 0,
	88	UInt32 dmaIndex = 0);
3e170ce0 A	89	virtual bool checkForWork(void) APPLE_KEXT_OVERRIDE;
3e170ce0 A	90	virtual void free(void) APPLE_KEXT_OVERRIDE;
2d21ac55 A	91	};
	92
	93	#endif /* _IOKIT_IODMAEVENTSOURCE_H */