| 1 | /*␊ |
| 2 | * Copyright (c) 1998-2002 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 | * Copyright (c) 1999-2002 Apple Computer, Inc. All rights reserved.␊ |
| 24 | *␊ |
| 25 | * HISTORY␊ |
| 26 | *␊ |
| 27 | */␊ |
| 28 | ␊ |
| 29 | ␊ |
| 30 | #ifndef _IOKIT_IOFWDCLPROGRAM_H␊ |
| 31 | #define _IOKIT_IOFWDCLPROGRAM_H␊ |
| 32 | ␊ |
| 33 | #include <libkern/c++/OSObject.h>␊ |
| 34 | #include <IOKit/firewire/IOFireWireFamilyCommon.h>␊ |
| 35 | #include <IOKit/firewire/IOFireWireBus.h>␊ |
| 36 | #include <IOKit/IOMemoryCursor.h>␊ |
| 37 | ␊ |
| 38 | /*! @class IODCLProgram␊ |
| 39 | */␊ |
| 40 | class IODCLProgram : public OSObject␊ |
| 41 | {␊ |
| 42 | OSDeclareAbstractStructors(IODCLProgram)␊ |
| 43 | ␊ |
| 44 | ␉private :␉␊ |
| 45 | ␉␊ |
| 46 | ␉␉void * ␉␉␉␉␉␉reserved0 ;//fDCLTaskToKernel;␊ |
| 47 | ␉␉void * ␉␉␉␉␉␉reserved1 ;//fDataTaskToKernel;␊ |
| 48 | ␉␉void *␉␉ ␉␉␉␉reserved2 ;//fDataBase;␊ |
| 49 | ␉␉void *␉␉ ␉␉␉␉reserved3 ;//␉␉IOMemoryDescriptor *␉␉fDCLDesc;␊ |
| 50 | ␉␉IOMemoryMap *␉␉␉␉fBufferMem ;␊ |
| 51 | ␉␉void *␉␉ ␉␉␉␉reserved5 ;//␉␉IOMemoryCursor *␉␉␉fDataCursor;␊ |
| 52 | ␊ |
| 53 | ␉protected:␊ |
| 54 | ␉␊ |
| 55 | ␉/*! @struct ExpansionData␊ |
| 56 | ␉␉@discussion This structure will be used to expand the capablilties of the class in the future.␊ |
| 57 | ␉␉*/ ␊ |
| 58 | ␉␉struct ExpansionData ␊ |
| 59 | ␉␉{␊ |
| 60 | ␉␉␉IOFWIsochResourceFlags␉␉resourceFlags ;␊ |
| 61 | ␉␉};␊ |
| 62 | ␉␉␊ |
| 63 | ␉/*! @var reserved␊ |
| 64 | ␉␉Reserved for future use. (Internal use only) */␊ |
| 65 | ␉␉ExpansionData *␉␉␉␉␉fExpansionData ;␊ |
| 66 | ␉␊ |
| 67 | ␉public :␊ |
| 68 | ␉␊ |
| 69 | ␉␉virtual void␉␉␉setIsochResourceFlags ( IOFWIsochResourceFlags flags ) ;␉// formerly getPhysicalSegs()␊ |
| 70 | ␉␉IOFWIsochResourceFlags␉getIsochResourceFlags () const ;␊ |
| 71 | ␉␉␊ |
| 72 | ␉protected:␊ |
| 73 | ␉␊ |
| 74 | ␉␉virtual void ␉␉␉free () ;␊ |
| 75 | ␉␊ |
| 76 | ␉public:␊ |
| 77 | ␉␊ |
| 78 | ␉␉virtual bool ␉␉␉init ( IOFireWireBus::DCLTaskInfo * info = NULL ) ;␊ |
| 79 | ␉␉virtual IOReturn ␉␉allocateHW (␊ |
| 80 | ␉␉␉␉␉␉␉␉␉␉IOFWSpeed ␉␉␉speed, ␊ |
| 81 | ␉␉␉␉␉␉␉␉␉␉UInt32 ␉␉␉␉chan) = 0;␊ |
| 82 | ␉␉virtual IOReturn ␉␉releaseHW () = 0;␊ |
| 83 | ␉␉virtual IOReturn ␉␉compile (␊ |
| 84 | ␉␉␉␉␉␉␉␉␉␉IOFWSpeed ␉␉␉speed, ␊ |
| 85 | ␉␉␉␉␉␉␉␉␉␉UInt32 ␉␉␉␉chan) = 0;␊ |
| 86 | ␉␉virtual IOReturn ␉␉notify (␊ |
| 87 | ␉␉␉␉␉␉␉␉␉␉␉␉IOFWDCLNotificationType␉␉notificationType,␊ |
| 88 | ␉␉␉␉␉␉␉␉␉␉␉␉DCLCommand ** ␉␉␉␉dclCommandList, ␊ |
| 89 | ␉␉␉␉␉␉␉␉␉␉␉␉UInt32 ␉␉␉␉␉␉numDCLCommands ) = 0;␊ |
| 90 | ␉␉virtual IOReturn ␉␉start () = 0;␊ |
| 91 | ␉␉virtual void ␉␉␉stop () = 0;␊ |
| 92 | ␉␉virtual IOReturn ␉␉pause ();␊ |
| 93 | ␉␉virtual IOReturn ␉␉resume ();␊ |
| 94 | ␉␉␉␉␊ |
| 95 | ␉␉virtual void␉␉␉setForceStopProc( ␊ |
| 96 | ␉␉␉␉␉␉␉␉␉␉␉␉IOFWIsochChannel::ForceStopNotificationProc proc, ␊ |
| 97 | ␉␉␉␉␉␉␉␉␉␉␉␉void * ␉␉␉␉␉␉refCon,␊ |
| 98 | ␉␉␉␉␉␉␉␉␉␉␉␉IOFWIsochChannel *␉␉␉channel ) ;␊ |
| 99 | ␉protected :␊ |
| 100 | ␉␊ |
| 101 | ␉␉void␉␉␉␉␉generateBufferMap( DCLCommand * program ) ;␊ |
| 102 | ␉␉IOReturn␉␉␉␉virtualToPhysical( ␊ |
| 103 | ␉␉␉␉␉␉␉␉␉␉␉␉IOVirtualRange␉␉␉␉␉␉ranges[], ␊ |
| 104 | ␉␉␉␉␉␉␉␉␉␉␉␉unsigned␉␉␉␉␉␉␉rangeCount, ␊ |
| 105 | ␉␉␉␉␉␉␉␉␉␉␉␉IOMemoryCursor::IOPhysicalSegment␉outSegments[], ␊ |
| 106 | ␉␉␉␉␉␉␉␉␉␉␉␉unsigned &␉␉␉␉␉␉␉outPhysicalSegmentCount, ␊ |
| 107 | ␉␉␉␉␉␉␉␉␉␉␉␉unsigned␉␉␉␉␉␉␉maxSegments ) ;␊ |
| 108 | ␊ |
| 109 | ␉public :␊ |
| 110 | ␉␊ |
| 111 | ␉␉IOMemoryMap *␉␉␉getBufferMap() const ;␊ |
| 112 | ␊ |
| 113 | ␉public :␊ |
| 114 | ␉␊ |
| 115 | ␉␉// close/open isoch workloop gate...␊ |
| 116 | ␉␉// clients should not need to call these.␊ |
| 117 | ␉␉virtual void␉␉␉closeGate() = 0 ;␊ |
| 118 | ␉␉virtual void␉␉␉openGate() = 0 ;␊ |
| 119 | ␊ |
| 120 | ␉␉virtual IOReturn␉␉synchronizeWithIO() = 0 ;␊ |
| 121 | ␉␉␊ |
| 122 | ␉private:␊ |
| 123 | ␉␊ |
| 124 | ␉␉OSMetaClassDeclareReservedUsed(IODCLProgram, 0);␊ |
| 125 | ␉␉OSMetaClassDeclareReservedUsed(IODCLProgram, 1);␊ |
| 126 | ␉␉OSMetaClassDeclareReservedUnused(IODCLProgram, 2);␊ |
| 127 | ␉␉OSMetaClassDeclareReservedUnused(IODCLProgram, 3);␊ |
| 128 | ␉␉OSMetaClassDeclareReservedUnused(IODCLProgram, 4);␊ |
| 129 | ␉␊ |
| 130 | };␊ |
| 131 | ␊ |
| 132 | #endif /* ! _IOKIT_IOFWDCLPROGRAM_H */␊ |
| 133 | ␊ |
| 134 | |
