[apple/xnu.git] / iokit / IOKit / scsi / scsi-parallel / IOSCSIParallelDevice.h

/*
 * Copyright (c) 1998-2000 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@
 */
/*
 *
 *	IOSCSIParallelDevice.h
 *
 *
 *	Methods in this header provide information about the SCSI device 
 *      the device client driver is submitting the SCSICommand(s) to.
 *
 * 	Note: SCSICommand(s) are allocated and freed by methods in this class. 
 *            The remaining methods to setup and submit SCSICommands are defined in
 *            IOSCSICommand.h
 */
 
#ifndef _IOSCSIPARALLELDEVICE_H
#define _IOSCSIPARALLELDEVICE_H

class IOSCSIParallelController;
 
class IOSCSIParallelDevice : public IOSCSIDevice
{
    OSDeclareDefaultStructors(IOSCSIParallelDevice)
    
    friend class IOSCSIParallelCommand;
    friend class IOSCSIParallelController;

/*------------------Methods provided to IOCDBDevice clients-----------------------*/
public:

    /*
     * Allocate a CDB Command
     */
     IOCDBCommand 		*allocCommand( IOCDBDevice *deviceType, UInt32 clientDataSize = 0 );

    /*
     * Abort all outstanding commands on this device
     */
     void			abort();
    
    /*
     * Reset device (also aborts all outstanding commands)
     */
     void			reset();

    /*
     * Obtain information about this device
     */
     void			getInquiryData( void    *inquiryBuffer, 
                                                UInt32  inquiryBufSize, 
                                                UInt32  *inquiryDataSize );

/*------------------Additional methods provided to IOSCSIDevice clients-----------------------*/
public:
    /*
     * Allocate a SCSICommand
     */
     IOSCSIParallelCommand	*allocCommand( IOSCSIParallelDevice *deviceType, UInt32 clientDataSize = 0 );

    /*
     * Target management commands
     */
     bool                	setTargetParms( SCSITargetParms *targetParms );
     void               	getTargetParms( SCSITargetParms *targetParms );

    /* 
     * Lun management commands
     */
     bool			setLunParms( SCSILunParms *lunParms );
     void			getLunParms( SCSILunParms *lunParms );

    /* 
     * Queue management commands
     */
    void			holdQueue( UInt32 queueType );
    void			releaseQueue( UInt32 queueType );
    void			flushQueue( UInt32 queueType, IOReturn rc );
    void			notifyIdle(  void *target = 0, CallbackFn callback = 0, void *refcon = 0 );

    /* 
     *
     */
     IOWorkLoop			*getWorkLoop() const; 

/*------------------Methods private to the IOSCSIDevice class----------------*/
public:
    bool			open(  IOService *forClient, IOOptionBits options = 0, void *arg = 0 );
    void			close( IOService *forClient, IOOptionBits options = 0 );
    IOReturn 			message( UInt32 clientMsg, IOService *forProvider, void *forArg = 0 );
    bool 			init( IOSCSIParallelController *forController, SCSITargetLun forTargetLun );
    void			free();

    bool 			matchPropertyTable( OSDictionary * table );
    IOService 			*matchLocation( IOService * client );

    IOSCSICommand		*allocCommand( IOSCSIDevice *deviceType, UInt32 clientDataSize = 0 );

private:
    void			submitCommand(  UInt32 cmdType, IOSCSIParallelCommand *scsiCmd, UInt32 cmdSequenceNumber = 0 );
    void 			receiveCommand( UInt32 cmdType, IOSCSIParallelCommand *scsiCmd, UInt32 cmdSequenceNumber, void *p3 );

    IOReturn	 		probeTargetLun();
    bool			checkCmdQueEnabled();
    void			setupTarget();

    void 			dispatchRequest();
    bool			dispatch( UInt32 *dispatchAction );

    void			abortAllCommands( SCSICommandType abortCmdType );

    IOSCSIParallelCommand       *findCommandWithNexus( UInt32 tagValue );

    void			abortCommand( IOSCSIParallelCommand *scsiCmd, UInt32 cmdSequenceNumber );
    void      	          	completeCommand( IOSCSIParallelCommand *cmd );

    void			checkIdleNotify();

    void			executeCommandDone(  IOSCSIParallelCommand *scsiCmd );
    void			executeReqSenseDone( IOSCSIParallelCommand *scsiCmd );
    void 			abortCommandDone(    IOSCSIParallelCommand *scsiCmd );
    void			cancelCommandDone(   IOSCSIParallelCommand *scsiCmd );
    void			finishCommand(       IOSCSIParallelCommand *scsiCmd );

    OSDictionary 		*createProperties();
    bool 			addToRegistry( OSDictionary *propTable, OSObject *regObj, char *key, bool doRelease = true );
    void 			stripBlanks( char *d, char *s, UInt32 l );

    bool			checkDeviceQueue( UInt32 *dispatchAction );
    void			checkNegotiate( IOSCSIParallelCommand *scsiCmd );
    bool			checkTag( IOSCSIParallelCommand *scsiCmd );
    bool			checkReqSense();
    bool			checkAbortQueue();
    void			checkCancelQueue();

    void			negotiationComplete();

    bool 			allocTag( UInt32 *tagId );
    void 			freeTag( UInt32 tagId );
    
    void			timer();
    
    void			resetOccurred( SCSIClientMessage clientMsg );
    void			resetComplete();

    void			rescheduleCommand( IOSCSIParallelCommand *scsiCmd );

    void 			addCommand( queue_head_t *list, IOSCSIParallelCommand *scsiCmd );
    void 			stackCommand( queue_head_t *list, IOSCSIParallelCommand *scsiCmd );
    void 			deleteCommand( queue_head_t *list, IOSCSIParallelCommand *scsiCmd, IOReturn rc = kIOReturnSuccess );
    IOSCSIParallelCommand 	*checkCommand( queue_head_t *list );
    IOSCSIParallelCommand 	*getCommand( queue_head_t *list );
    void 			moveCommand(    queue_head_t 		*fromList, 
						queue_head_t 		*toList, 
						IOSCSIParallelCommand 	*scsiCmd, 
						IOReturn 		rc = kIOReturnSuccess );
    void 			moveAllCommands( queue_head_t *fromList, queue_head_t *toList, IOReturn rc = kIOReturnSuccess );
    bool 			findCommand( queue_head_t *list, IOSCSIParallelCommand *findScsiCmd );
    void 			purgeAllCommands( queue_head_t *list, IOReturn rc );

private:
    queue_chain_t		nextDevice;

    SCSITargetLun		targetLun;
    
    SCSITarget			*target;

    IOSCSIParallelController	*controller;
    IOCommandGate               *deviceGate;    

    IOService			*client;
    IORWLock *			clientSem;

    queue_head_t	      	deviceList;
    queue_head_t		bypassList;
    queue_head_t		activeList;
    queue_head_t		abortList;
    queue_head_t		cancelList;
    
    SCSICommandType		abortCmdPending;

    UInt32			reqSenseState;
    UInt32			abortState;
    UInt32			cancelState;
    UInt32			negotiateState;
    
    IOSCSIParallelCommand	*reqSenseOrigCmd;

    IOSCSIParallelCommand	*reqSenseCmd;
    IOSCSIParallelCommand	*abortCmd;
    IOSCSIParallelCommand	*cancelCmd;
    IOSCSIParallelCommand       *probeCmd;

    bool			normalQHeld;
    bool			bypassQHeld;

    bool			idleNotifyActive;
    CallbackFn			idleNotifyCallback;
    void			*idleNotifyTarget;
    void			*idleNotifyRefcon;    

    UInt32			commandCount;
    UInt32			commandLimit;
    UInt32			commandLimitSave;

    bool			disableDisconnect;

    bool			lunAllocated;

    OSNumber			*regObjTransferPeriod;
    OSNumber			*regObjTransferOffset;
    OSNumber			*regObjTransferWidth;
    OSNumber			*regObjTransferOptions;
    OSNumber			*regObjCmdQueue;

    UInt32			*tagArray;

    SCSILunParms		lunParmsNew;
    
    SCSIInquiry			*inquiryData;
    UInt32			inquiryDataSize;

    void			*devicePrivateData;
};

#define kIOSCSIParallelDevice	((IOSCSIParallelDevice *)0)

#endif
Commit	Line	Data
1c79356b A	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	* IOSCSIParallelDevice.h
	25	*
	26	*
	27	* Methods in this header provide information about the SCSI device
	28	* the device client driver is submitting the SCSICommand(s) to.
	29	*
	30	* Note: SCSICommand(s) are allocated and freed by methods in this class.
	31	* The remaining methods to setup and submit SCSICommands are defined in
	32	* IOSCSICommand.h
	33	*/
	34
	35	#ifndef _IOSCSIPARALLELDEVICE_H
	36	#define _IOSCSIPARALLELDEVICE_H
	37
	38	class IOSCSIParallelController;
	39
	40	class IOSCSIParallelDevice : public IOSCSIDevice
	41	{
	42	OSDeclareDefaultStructors(IOSCSIParallelDevice)
	43
	44	friend class IOSCSIParallelCommand;
	45	friend class IOSCSIParallelController;
	46
	47	/------------------Methods provided to IOCDBDevice clients-----------------------/
	48	public:
	49
	50	/*
	51	* Allocate a CDB Command
	52	*/
	53	IOCDBCommand allocCommand( IOCDBDevice deviceType, UInt32 clientDataSize = 0 );
	54
	55	/*
	56	* Abort all outstanding commands on this device
	57	*/
	58	void abort();
	59
	60	/*
	61	* Reset device (also aborts all outstanding commands)
	62	*/
	63	void reset();
	64
65	/*
66	* Obtain information about this device
67	*/
68	void getInquiryData( void *inquiryBuffer,
69	UInt32 inquiryBufSize,
70	UInt32 *inquiryDataSize );
71
72	/------------------Additional methods provided to IOSCSIDevice clients-----------------------/
73	public:
74	/*
75	* Allocate a SCSICommand
76	*/
77	IOSCSIParallelCommand allocCommand( IOSCSIParallelDevice deviceType, UInt32 clientDataSize = 0 );
78
79	/*
80	* Target management commands
81	*/
82	bool setTargetParms( SCSITargetParms *targetParms );
83	void getTargetParms( SCSITargetParms *targetParms );
84
85	/*
86	* Lun management commands
87	*/
88	bool setLunParms( SCSILunParms *lunParms );
89	void getLunParms( SCSILunParms *lunParms );
90
91	/*
92	* Queue management commands
93	*/
94	void holdQueue( UInt32 queueType );
95	void releaseQueue( UInt32 queueType );
96	void flushQueue( UInt32 queueType, IOReturn rc );
97	void notifyIdle( void target = 0, CallbackFn callback = 0, void refcon = 0 );
98
99	/*
100	*
101	*/
102	IOWorkLoop *getWorkLoop() const;
103
104	/------------------Methods private to the IOSCSIDevice class----------------/
105	public:
106	bool open( IOService forClient, IOOptionBits options = 0, void arg = 0 );
107	void close( IOService *forClient, IOOptionBits options = 0 );
108	IOReturn message( UInt32 clientMsg, IOService forProvider, void forArg = 0 );
109	bool init( IOSCSIParallelController *forController, SCSITargetLun forTargetLun );
110	void free();
111
112	bool matchPropertyTable( OSDictionary * table );
113	IOService matchLocation( IOService client );
114
115	IOSCSICommand allocCommand( IOSCSIDevice deviceType, UInt32 clientDataSize = 0 );
116
117	private:
118	void submitCommand( UInt32 cmdType, IOSCSIParallelCommand *scsiCmd, UInt32 cmdSequenceNumber = 0 );
119	void receiveCommand( UInt32 cmdType, IOSCSIParallelCommand scsiCmd, UInt32 cmdSequenceNumber, void p3 );
120
121	IOReturn probeTargetLun();
122	bool checkCmdQueEnabled();
123	void setupTarget();
124
125	void dispatchRequest();
126	bool dispatch( UInt32 *dispatchAction );
127
128	void abortAllCommands( SCSICommandType abortCmdType );
129
130	IOSCSIParallelCommand *findCommandWithNexus( UInt32 tagValue );
131
132	void abortCommand( IOSCSIParallelCommand *scsiCmd, UInt32 cmdSequenceNumber );
133	void completeCommand( IOSCSIParallelCommand *cmd );
134
135	void checkIdleNotify();
136
137	void executeCommandDone( IOSCSIParallelCommand *scsiCmd );
138	void executeReqSenseDone( IOSCSIParallelCommand *scsiCmd );
139	void abortCommandDone( IOSCSIParallelCommand *scsiCmd );
140	void cancelCommandDone( IOSCSIParallelCommand *scsiCmd );
141	void finishCommand( IOSCSIParallelCommand *scsiCmd );
142
143	OSDictionary *createProperties();
144	bool addToRegistry( OSDictionary propTable, OSObject regObj, char *key, bool doRelease = true );
145	void stripBlanks( char d, char s, UInt32 l );
146
147	bool checkDeviceQueue( UInt32 *dispatchAction );
148	void checkNegotiate( IOSCSIParallelCommand *scsiCmd );
149	bool checkTag( IOSCSIParallelCommand *scsiCmd );
150	bool checkReqSense();
151	bool checkAbortQueue();
152	void checkCancelQueue();
153
154	void negotiationComplete();
155
156	bool allocTag( UInt32 *tagId );
157	void freeTag( UInt32 tagId );
158
159	void timer();
160
161	void resetOccurred( SCSIClientMessage clientMsg );
162	void resetComplete();
163
164	void rescheduleCommand( IOSCSIParallelCommand *scsiCmd );
165
166	void addCommand( queue_head_t list, IOSCSIParallelCommand scsiCmd );
167	void stackCommand( queue_head_t list, IOSCSIParallelCommand scsiCmd );
168	void deleteCommand( queue_head_t list, IOSCSIParallelCommand scsiCmd, IOReturn rc = kIOReturnSuccess );
169	IOSCSIParallelCommand checkCommand( queue_head_t list );
170	IOSCSIParallelCommand getCommand( queue_head_t list );
171	void moveCommand( queue_head_t *fromList,
172	queue_head_t *toList,
173	IOSCSIParallelCommand *scsiCmd,
174	IOReturn rc = kIOReturnSuccess );
175	void moveAllCommands( queue_head_t fromList, queue_head_t toList, IOReturn rc = kIOReturnSuccess );
176	bool findCommand( queue_head_t list, IOSCSIParallelCommand findScsiCmd );
177	void purgeAllCommands( queue_head_t *list, IOReturn rc );
178
179	private:
180	queue_chain_t nextDevice;
181
182	SCSITargetLun targetLun;
183
184	SCSITarget *target;
185
186	IOSCSIParallelController *controller;
187	IOCommandGate *deviceGate;
188
189	IOService *client;
190	IORWLock * clientSem;
191
192	queue_head_t deviceList;
193	queue_head_t bypassList;
194	queue_head_t activeList;
195	queue_head_t abortList;
196	queue_head_t cancelList;
197
198	SCSICommandType abortCmdPending;
199
200	UInt32 reqSenseState;
201	UInt32 abortState;
202	UInt32 cancelState;
203	UInt32 negotiateState;
204
205	IOSCSIParallelCommand *reqSenseOrigCmd;
206
207	IOSCSIParallelCommand *reqSenseCmd;
208	IOSCSIParallelCommand *abortCmd;
209	IOSCSIParallelCommand *cancelCmd;
210	IOSCSIParallelCommand *probeCmd;
211
212	bool normalQHeld;
213	bool bypassQHeld;
214
215	bool idleNotifyActive;
216	CallbackFn idleNotifyCallback;
217	void *idleNotifyTarget;
218	void *idleNotifyRefcon;
219
220	UInt32 commandCount;
221	UInt32 commandLimit;
222	UInt32 commandLimitSave;
223
224	bool disableDisconnect;
225
226	bool lunAllocated;
227
228	OSNumber *regObjTransferPeriod;
229	OSNumber *regObjTransferOffset;
230	OSNumber *regObjTransferWidth;
231	OSNumber *regObjTransferOptions;
232	OSNumber *regObjCmdQueue;
233
234	UInt32 *tagArray;
235
236	SCSILunParms lunParmsNew;
237
238	SCSIInquiry *inquiryData;
239	UInt32 inquiryDataSize;
240
241	void *devicePrivateData;
242	};
243
244	#define kIOSCSIParallelDevice ((IOSCSIParallelDevice *)0)
245
246	#endif