iokit/IOKit/storage/IODVDBlockStorageDevice.h

   1 /*
   2  * Copyright (c) 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  /* This class is the protocol for generic DVD functionality, independent of
  23  * the physical connection protocol (e.g. SCSI, ATA, USB).
  24  *
  25  * The APIs are the union of CDRO APIs and all
  26  * necessary new low-level DVD APIs.
  27  *
  28  * A subclass implements relay methods that translate our requests into
  29  * calls to a protocol- and device-specific provider.
  30  */
  31
  32 #ifndef _IODVDBLOCKSTORAGEDEVICE_H
  33 #define _IODVDBLOCKSTORAGEDEVICE_H
  34
  35 #include <IOKit/IOTypes.h>
  36 #include <IOKit/storage/IOCDBlockStorageDevice.h>
  37 #include <IOKit/storage/IODVDTypes.h>
  38
  39 /* Property used for matching, so the generic driver gets the nub it wants. */
  40 #define kIOBlockStorageDeviceTypeDVD    "DVD"
  41
  42 class IOMemoryDescriptor;
  43
  44 class IODVDBlockStorageDevice : public IOCDBlockStorageDevice {
  45
  46     OSDeclareAbstractStructors(IODVDBlockStorageDevice)
  47
  48 protected:
  49
  50     struct ExpansionData { /* */ };
  51     ExpansionData * _expansionData;
  52
  53 public:
  54
  55     /* Overrides from IORegistryEntry */
  56
  57     virtual bool        init(OSDictionary * properties);
  58
  59     /* New APIs for DVD */
  60
  61     virtual IOReturn    reportKey(IOMemoryDescriptor *buffer,const DVDKeyClass keyClass,
  62                                         const UInt32 lba,const UInt8 agid,const DVDKeyFormat keyFormat) = 0;
  63     virtual IOReturn    sendKey(IOMemoryDescriptor *buffer,const DVDKeyClass keyClass,
  64                                         const UInt8 agid,const DVDKeyFormat keyFormat)                  = 0;
  65
  66     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  0);
  67     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  1);
  68     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  2);
  69     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  3);
  70     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  4);
  71     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  5);
  72     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  6);
  73     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  7);
  74     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  8);
  75     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice,  9);
  76     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 10);
  77     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 11);
  78     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 12);
  79     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 13);
  80     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 14);
  81     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 15);
  82     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 16);
  83     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 17);
  84     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 18);
  85     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 19);
  86     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 20);
  87     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 21);
  88     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 22);
  89     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 23);
  90     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 24);
  91     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 25);
  92     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 26);
  93     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 27);
  94     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 28);
  95     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 29);
  96     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 30);
  97     OSMetaClassDeclareReservedUnused(IODVDBlockStorageDevice, 31);
  98 };
  99 #endif