IOFWUserCommand.h   [plain text]

/*
 * Copyright (c) 1998-2001 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 *  IOFWUserCommand.h
 *  IOFireWireFamily
 *
 *  Created by noggin on Tue May 08 2001.
 *  Copyright (c) 2001 Apple Computer, Inc. All rights reserved.
 *
 */

#include <libkern/c++/OSObject.h>
#include <IOKit/firewire/IOFWCommand.h>
#include <IOKit/firewire/IOFireWireUserClient.h>

class IOFWUserCommand: public OSObject
{
	OSDeclareAbstractStructors(IOFWUserCommand)

 public:
	// --- IOKit constructors --------------------
	// --- with's --------------------------------
	static	IOFWUserCommand*	withSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient) ;

	// --- init's --------------------------------
	virtual bool				initWithSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient ) ;

	// --- free ----------------------------------										
	virtual void				free() ;
	virtual void				setAsyncReference(
										OSAsyncReference		inAsyncRef) ;	
	static void					asyncReadWriteCommandCompletion(
										void *					refcon, 
										IOReturn 				status, 
										IOFireWireNub *			device, 
										IOFWCommand *			fwCmd) ;
	virtual IOReturn			submit(
										FWUserCommandSubmitParams*	inParams,
										FWUserCommandSubmitResult*	outResult) = 0 ;
	virtual void				setRefCon(
										void*					inRefCon)
										{ fUserRefCon = inRefCon; }
	virtual void*				getRefCon() { return fUserRefCon; }
	
 protected:
	OSAsyncReference				fAsyncRef ;
	IOFWAsyncCommand*				fCommand ;
	const IOFireWireUserClient*		fUserClient ;
	IOMemoryDescriptor*				fMem ;
	void*							fUserRefCon ;
} ;

class IOFWUserReadCommand: public IOFWUserCommand
{
	OSDeclareDefaultStructors(IOFWUserReadCommand)

public:
	// --- init's --------------------------------
	virtual bool				initWithSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient ) ;

	// --- IOFWCommand methods -------------------
	virtual IOReturn			submit(
										FWUserCommandSubmitParams*	inParams,
										FWUserCommandSubmitResult*	outResult) ;
} ;

class IOFWUserReadQuadletCommand: public IOFWUserCommand
{
	OSDeclareDefaultStructors(IOFWUserReadQuadletCommand)

 public:
	// --- init's --------------------------------
	virtual bool				initWithSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient ) ;

	// --- free ----------------------------------										
	virtual void				free() ;
	
	// --- IOFWCommand methods -------------------
	virtual IOReturn			submit(
										FWUserCommandSubmitParams*	inParams,
										FWUserCommandSubmitResult*	outResult) ;
	static void					asyncReadQuadletCommandCompletion(
										void *					refcon, 
										IOReturn 				status, 
										IOFireWireNub *			device, 
										IOFWCommand *			fwCmd) ;
 protected:
	UInt32*		fQuads ;
	UInt32		fNumQuads ;
} ;

class IOFWUserWriteCommand: public IOFWUserCommand
{
	OSDeclareDefaultStructors(IOFWUserWriteCommand)

 public:
	// --- init's --------------------------------
	virtual bool				initWithSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient ) ;

	// --- IOFWCommand methods -------------------
	virtual IOReturn			submit(
										FWUserCommandSubmitParams*	inParams,
										FWUserCommandSubmitResult*	outResult) ;

} ;

class IOFWUserWriteQuadletCommand: public IOFWUserCommand
{
	OSDeclareDefaultStructors(IOFWUserWriteQuadletCommand)

 public:
	// --- init's --------------------------------
	virtual bool				initWithSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient ) ;

	// --- IOFWCommand methods -------------------
	virtual IOReturn			submit(
										FWUserCommandSubmitParams*	inParams,
										FWUserCommandSubmitResult*	outResult) ;

 protected:
	UInt32		fNumQuads ;
} ;

class IOFWUserCompareSwapCommand: public IOFWUserCommand
{
	OSDeclareDefaultStructors(IOFWUserCompareSwapCommand)

 public:
	// --- init's --------------------------------
	virtual bool				initWithSubmitParams(
										const FWUserCommandSubmitParams*	inParams,
										const IOFireWireUserClient*			inUserClient ) ;
	
	// --- IOFWCommand methods -------------------
	virtual IOReturn			submit(
										FWUserCommandSubmitParams*	inParams,
										FWUserCommandSubmitResult*	outResult) ;
 
  protected:
	IOByteCount		fSize ;
 } ;