iokit/IOKit/cdb/IOCDBDevice.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  *
  24  *      IOCDBDevice.h
  25  *
  26  *
  27  *
  28  *      Note: CDBCommand(s) are allocated and freed by methods in this class.
  29  *            The remaining methods to setup and submit CDBCommands are defined in
  30  *            IOCDBCommand.h
  31  */
  32 #ifndef _IOCDBDEVICE_H
  33 #define _IOCDBDEVICE_H
  34
  35 class IOCDBCommand;
  36
  37 class IOCDBDevice : public IOService
  38 {
  39     OSDeclareAbstractStructors(IOCDBDevice)
  40
  41 /*------------------Methods provided to IOCDBDevice clients-----------------------*/
  42 public:
  43     /*
  44      * Allocate a CDB Command
  45      */
  46     virtual IOCDBCommand        *allocCommand( IOCDBDevice *deviceType, UInt32 clientDataSize = 0 ) = 0;
  47
  48     /*
  49      * Abort all outstanding commands on this device
  50      */
  51     virtual void                abort() = 0;
  52
  53     /*
  54      * Reset device (also aborts all outstanding commands)
  55      */
  56     virtual void                reset() = 0;
  57
  58     /*
  59      * Obtain information about this device
  60      */
  61     virtual void                getInquiryData( void    *inquiryBuffer,
  62                                                 UInt32  inquiryBufSize,
  63                                                 UInt32  *inquiryDataSize ) = 0;
  64 };
  65
  66 #define kIOCDBDevice            ((IOCDBDevice *)0)
  67
  68
  69 #endif