/* * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved. * * @APPLE_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. 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_LICENSE_HEADER_END@ */ /* * * IOCDBCommand.h * */ #ifndef _IOCDBCOMMAND_H #define _IOCDBCOMMAND_H #include <IOKit/IOCommand.h> #include <IOKit/IOMemoryDescriptor.h> #include "CDBCommand.h" typedef void (*CallbackFn)(void *target, void *refcon ); class IOCDBDevice; class IOCDBCommand : public IOCommand { OSDeclareAbstractStructors(IOCDBCommand) /*------------------Methods provided to IOCDBCommand users -------------------------*/ public: /* * Set/Get IOMemoryDescriptor object to I/O data buffer or sense data buffer. */ virtual void setPointers( IOMemoryDescriptor *desc, UInt32 transferCount, bool isWrite, bool isSense = false ) = 0; virtual void getPointers( IOMemoryDescriptor **desc, UInt32 *transferCount, bool *isWrite, bool isSense = false ) = 0; /* * Set/Get command timeout (mS) */ virtual void setTimeout( UInt32 timeoutmS ) = 0; virtual UInt32 getTimeout() = 0; /* * Set async callback routine. Specifying no parameters indicates synchronous call. */ virtual void setCallback( void *target = 0, CallbackFn callback = 0, void *refcon = 0 ) = 0; /* * Set/Get CDB information. (Generic CDB version) */ virtual void setCDB( CDBInfo *cdbInfo ) = 0; virtual void getCDB( CDBInfo *cdbInfo ) = 0; /* * Get CDB results. (Generic CDB version) */ virtual IOReturn getResults( CDBResults *cdbResults ) = 0; /* * Get CDB Device this command is directed to. */ virtual IOCDBDevice *getDevice( IOCDBDevice *deviceType ) = 0; #define kIOCDBDevice ((IOCDBDevice *)0) /* * Command verbs */ virtual bool execute( UInt32 *sequenceNumber = 0 ) = 0; virtual void abort( UInt32 sequenceNumber ) = 0; virtual void complete() = 0; /* * Get pointers to client and command data. */ virtual void *getCommandData() = 0; virtual void *getClientData() = 0; /* * Get unique sequence number assigned to command. */ virtual UInt32 getSequenceNumber() = 0; }; #endif