121fc6a961860e65f67b18a9d99104e816444dec
[mirror/scst/.git] / scst / include / scsi_tgt.h
1 /*
2  *  include/scsi_tgt.h
3  *  
4  *  Copyright (C) 2004-2007 Vladislav Bolkhovitin <vst@vlnb.net>
5  *                 and Leonid Stoljar
6  *  
7  *  Main SCSI target mid-level include file.
8  * 
9  *  This program is free software; you can redistribute it and/or
10  *  modify it under the terms of the GNU General Public License
11  *  as published by the Free Software Foundation, version 2
12  *  of the License.
13  * 
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  *  GNU General Public License for more details.
18  */
19
20 #ifndef __SCST_H
21 #define __SCST_H
22
23 #include <linux/types.h>
24 #include <linux/version.h>
25 #include <linux/blkdev.h>
26 #include <linux/interrupt.h>
27 #include <linux/proc_fs.h>
28
29 #ifdef SCST_HIGHMEM
30 #include <asm/kmap_types.h>
31 #endif
32 #include <scsi/scsi_cmnd.h>
33 #include <scsi/scsi_device.h>
34 #include <scsi/scsi_eh.h>
35 #include <scsi/scsi.h>
36
37 #include <scst_const.h>
38
39 #ifndef DECLARE_MUTEX_LOCKED
40 #define DECLARE_MUTEX_LOCKED(name)      __DECLARE_SEMAPHORE_GENERIC(name, 0)
41 #endif
42
43 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
44 typedef _Bool bool;
45 #endif
46
47 /* Version numbers, the same as for the kernel */
48 #define SCST_VERSION_CODE 0x00090601
49 #define SCST_VERSION(a,b,c,d) (((a) << 24) + ((b) << 16) + ((c) << 8) + d)
50 #define SCST_VERSION_STRING "0.9.6-rc1"
51 #define SCST_INTERFACE_VERSION SCST_VERSION_STRING "$Revision$" SCST_CONST_VERSION
52
53 /*************************************************************
54  ** States of command processing state machine. At first, 
55  ** "active" states, then - "passive" ones. This is to have
56  ** more efficient generated code of the corresponding
57  ** "switch" statements.
58  *************************************************************/
59
60 /* Internal parsing */
61 #define SCST_CMD_STATE_PRE_PARSE     0
62
63 /* Dev handler's parse() is going to be called */
64 #define SCST_CMD_STATE_DEV_PARSE     1
65
66 /* Allocation of the cmd's data buffer */
67 #define SCST_CMD_STATE_PREPARE_SPACE 2
68
69 /* Target driver's rdy_to_xfer() is going to be called */
70 #define SCST_CMD_STATE_RDY_TO_XFER   3
71
72 /* Target driver's pre_exec() is going to be called */
73 #define SCST_CMD_STATE_TGT_PRE_EXEC  4
74
75 /* CDB is going to be sent to SCSI mid-level for execution */
76 #define SCST_CMD_STATE_SEND_TO_MIDLEV 5
77
78 /* Internal pos-exec checks */
79 #define SCST_CMD_STATE_PRE_DEV_DONE  6
80
81 /* Internal MODE SELECT pages related checks */
82 #define SCST_CMD_STATE_MODE_SELECT_CHECKS 7
83
84 /* Dev handler's dev_done() is going to be called */
85 #define SCST_CMD_STATE_DEV_DONE      8
86
87 /* Target driver's xmit_response() is going to be called */
88 #define SCST_CMD_STATE_PRE_XMIT_RESP 9
89
90 /* Target driver's xmit_response() is going to be called */
91 #define SCST_CMD_STATE_XMIT_RESP     10
92
93 /* The cmd finished */
94 #define SCST_CMD_STATE_FINISHED      11
95
96 #define SCST_CMD_STATE_LAST_ACTIVE   (SCST_CMD_STATE_FINISHED+100)
97
98
99 /* A cmd is created, but scst_cmd_init_done() not called */
100 #define SCST_CMD_STATE_INIT_WAIT     (SCST_CMD_STATE_LAST_ACTIVE+1)
101
102 /* LUN translation (cmd->tgt_dev assignment) */
103 #define SCST_CMD_STATE_INIT          (SCST_CMD_STATE_LAST_ACTIVE+2)
104
105 /* Allocation of the cmd's data buffer */
106 #define SCST_CMD_STATE_PREPROCESS_DONE (SCST_CMD_STATE_LAST_ACTIVE+3)
107
108 /* Waiting for data from the initiator (until scst_rx_data() called) */
109 #define SCST_CMD_STATE_DATA_WAIT     (SCST_CMD_STATE_LAST_ACTIVE+4)
110
111 /* Waiting for CDB's execution finish */
112 #define SCST_CMD_STATE_EXECUTING     (SCST_CMD_STATE_LAST_ACTIVE+5)
113
114 /* Waiting for response's transmission finish */
115 #define SCST_CMD_STATE_XMIT_WAIT     (SCST_CMD_STATE_LAST_ACTIVE+6)
116
117 /************************************************************* 
118  * Can be retuned instead of cmd's state by dev handlers' 
119  * functions, if the command's state should be set by default
120  *************************************************************/
121 #define SCST_CMD_STATE_DEFAULT        500
122
123 /************************************************************* 
124  * Can be retuned instead of cmd's state by dev handlers' 
125  * functions, if it is impossible to complete requested
126  * task in atomic context. The cmd will be restarted in thread 
127  * context.
128  *************************************************************/
129 #define SCST_CMD_STATE_NEED_THREAD_CTX 1000
130
131 /************************************************************* 
132  * Can be retuned instead of cmd's state by dev handlers' 
133  * parse function, if the cmd processing should be stopped
134  * for now. The cmd will be restarted by dev handlers itself.
135  *************************************************************/
136 #define SCST_CMD_STATE_STOP           1001
137
138 /*************************************************************
139  ** States of mgmt command processing state machine
140  *************************************************************/
141
142 /* LUN translation (mcmd->tgt_dev assignment) */
143 #define SCST_MGMT_CMD_STATE_INIT     0
144
145 /* Mgmt cmd is ready for processing */
146 #define SCST_MGMT_CMD_STATE_READY    1
147
148 /* Mgmt cmd is being executing */
149 #define SCST_MGMT_CMD_STATE_EXECUTING 2
150
151 /* Reservations are going to be cleared, if necessary */
152 #define SCST_MGMT_CMD_STATE_CHECK_NEXUS_LOSS 3
153
154 /* Target driver's task_mgmt_fn_done() is going to be called */
155 #define SCST_MGMT_CMD_STATE_DONE     4
156
157 /* The mcmd finished */
158 #define SCST_MGMT_CMD_STATE_FINISHED 5
159
160 /*************************************************************
161  ** Constants for "atomic" parameter of SCST's functions
162  *************************************************************/
163 #define SCST_NON_ATOMIC              0
164 #define SCST_ATOMIC                  1
165
166 /************************************************************* 
167  ** Values for pref_context parameter of scst_cmd_init_done() and 
168  ** scst_rx_data() 
169  *************************************************************/
170
171 /* 
172  * Direct cmd's processing (i.e. regular function calls in the current 
173  * context) sleeping is not allowed
174  */
175 #define SCST_CONTEXT_DIRECT_ATOMIC   0
176
177 /* 
178  * Direct cmd's processing (i.e. regular function calls in the current 
179  * context), sleeping is allowed, no restrictions
180  */
181 #define SCST_CONTEXT_DIRECT          1
182
183 /* Tasklet or thread context required for cmd's processing */
184 #define SCST_CONTEXT_TASKLET         2
185
186 /* Thread context required for cmd's processing */
187 #define SCST_CONTEXT_THREAD          3
188
189 /*
190  * SCST internal flag, which specifies that context is processable, i.e. the
191  * next command in the active list will be processed after the current one.
192  *
193  * Target drivers must never use it!!
194  */
195 #define SCST_CONTEXT_PROCESSABLE     0x100
196
197 /************************************************************* 
198  ** Values for status parameter of scst_rx_data() 
199  *************************************************************/
200
201 /* Success */
202 #define SCST_RX_STATUS_SUCCESS       0
203
204 /* 
205  * Data receiving finished with error, so set the sense and
206  * finish the command, including xmit_response() call
207  */
208 #define SCST_RX_STATUS_ERROR         1
209
210 /* 
211  * Data receiving finished with error and the sense is set,
212  * so finish the command, including xmit_response() call
213  */
214 #define SCST_RX_STATUS_ERROR_SENSE_SET 2
215
216 /* 
217  * Data receiving finished with fatal error, so finish the command,
218  * but don't call xmit_response()
219  */
220 #define SCST_RX_STATUS_ERROR_FATAL   3
221
222 /************************************************************* 
223  ** Values for status parameter of scst_restart_cmd() 
224  *************************************************************/
225
226 /* Success */
227 #define SCST_PREPROCESS_STATUS_SUCCESS       0
228
229 /* 
230  * Command's processing finished with error, so set the sense and
231  * finish the command, including xmit_response() call
232  */
233 #define SCST_PREPROCESS_STATUS_ERROR         1
234
235 /* 
236  * Command's processing finished with error and the sense is set,
237  * so finish the command, including xmit_response() call
238  */
239 #define SCST_PREPROCESS_STATUS_ERROR_SENSE_SET 2
240
241 /* 
242  * Command's processing finished with fatal error, so finish the command,
243  * but don't call xmit_response()
244  */
245 #define SCST_PREPROCESS_STATUS_ERROR_FATAL   3
246
247 /* Thread context requested */
248 #define SCST_PREPROCESS_STATUS_NEED_THREAD   4
249
250 /*************************************************************
251  ** Allowed return codes for xmit_response(), rdy_to_xfer(), 
252  ** report_aen() 
253  *************************************************************/
254
255 /* Success */
256 #define SCST_TGT_RES_SUCCESS         0
257
258 /* Internal device queue is full, retry again later */
259 #define SCST_TGT_RES_QUEUE_FULL      -1
260
261 /* 
262  * It is impossible to complete requested task in atomic context. 
263  * The cmd will be restarted in thread  context.
264  */
265 #define SCST_TGT_RES_NEED_THREAD_CTX -2
266
267 /* 
268  * Fatal error, if returned by xmit_response() the cmd will 
269  * be destroyed, if by any other function, xmit_response() 
270  * will be called with HARDWARE ERROR sense data
271  */
272 #define SCST_TGT_RES_FATAL_ERROR     -3
273
274 /*************************************************************
275  ** Allowed return codes for dev handler's exec()
276  *************************************************************/
277
278 /* The cmd is done, go to other ones */
279 #define SCST_EXEC_COMPLETED          0
280
281 /* The cmd should be sent to SCSI mid-level */
282 #define SCST_EXEC_NOT_COMPLETED      1
283
284 /* 
285  * Thread context is required to execute the command. 
286  * Exec() will be called again in the thread context.
287  */
288 #define SCST_EXEC_NEED_THREAD        2
289
290 /************************************************************* 
291  ** Default timeout for cmd's CDB execution 
292  ** by SCSI mid-level (cmd's "timeout" field).
293  *************************************************************/
294 #define SCST_DEFAULT_TIMEOUT         (30*HZ)
295
296 /*************************************************************
297  ** Flags of cmd->tgt_resp_flags
298  *************************************************************/
299
300 /* 
301  * Set if cmd is finished and there is status/sense to be sent. 
302  * The status should be not sent (i.e. the flag not set) if the 
303  * possibility to perform a command in "chunks" (i.e. with multiple 
304  * xmit_response()/rdy_to_xfer()) is used (not implemented and,
305  * probably, will never be).
306  */
307 #define SCST_TSC_FLAG_STATUS         0x2
308
309 /*************************************************************
310  ** Additional return code for dev handler's task_mgmt_fn()
311  *************************************************************/
312
313 /* Regular standard actions for the command should be done */
314 #define SCST_DEV_TM_NOT_COMPLETED     1
315
316 /************************************************************* 
317  ** Session initialization phases
318  *************************************************************/
319
320 /* Set if session is being initialized */
321 #define SCST_SESS_IPH_INITING        0
322
323 /* Set if the session is successfully initialized */
324 #define SCST_SESS_IPH_SUCCESS        1
325
326 /* Set if the session initialization failed */
327 #define SCST_SESS_IPH_FAILED         2
328
329 /* Set if session is initialized and ready */
330 #define SCST_SESS_IPH_READY          3
331
332 /************************************************************* 
333  ** Session shutdown phases
334  *************************************************************/
335
336 /* Set if session is initialized and ready */
337 #define SCST_SESS_SPH_READY          0
338
339 /* Set if session is on calling pre_unreg_sess() phase */
340 #define SCST_SESS_SPH_PRE_UNREG      1
341
342 /* Set if session is shutting down */
343 #define SCST_SESS_SPH_SHUTDOWN       2
344
345 /*************************************************************
346  ** Cmd's async (atomic) flags 
347  *************************************************************/
348
349 /* Set if the cmd is aborted and ABORTED sense will be sent as the result */
350 #define SCST_CMD_ABORTED                0
351
352 /* Set if the cmd is aborted by other initiator */
353 #define SCST_CMD_ABORTED_OTHER          1
354
355 /* Set if no response should be sent to the target about this cmd */
356 #define SCST_CMD_NO_RESP                2
357
358 /* Set if the cmd is dead and can be destroyed at any time */
359 #define SCST_CMD_CAN_BE_DESTROYED       3
360
361 /*************************************************************
362  ** Tgt_dev's flags (tgt_dev_flags)
363  *************************************************************/
364
365 /* Set if tgt_dev has Unit Attention sense */
366 #define SCST_TGT_DEV_UA_PENDING         0
367
368 /* Set if tgt_dev is RESERVED by another session */
369 #define SCST_TGT_DEV_RESERVED           1
370
371 /* Set if the corresponding context is atomic */
372 #define SCST_TGT_DEV_AFTER_INIT_WR_ATOMIC       5
373 #define SCST_TGT_DEV_AFTER_INIT_OTH_ATOMIC      6
374 #define SCST_TGT_DEV_AFTER_RESTART_WR_ATOMIC    7
375 #define SCST_TGT_DEV_AFTER_RESTART_OTH_ATOMIC   8
376 #define SCST_TGT_DEV_AFTER_RX_DATA_ATOMIC       9
377 #define SCST_TGT_DEV_AFTER_EXEC_ATOMIC          10
378
379 #ifdef DEBUG_TM
380 #define SCST_TGT_DEV_UNDER_TM_DBG       20
381 #endif
382
383 /*************************************************************
384  ** Name of the entry in /proc
385  *************************************************************/
386 #define SCST_PROC_ENTRY_NAME         "scsi_tgt"
387
388 /*************************************************************
389  ** Kernel cache creation helper
390  *************************************************************/
391 #ifndef KMEM_CACHE
392 #define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\
393         sizeof(struct __struct), __alignof__(struct __struct),\
394         (__flags), NULL, NULL)
395 #endif
396
397 /*************************************************************
398  *                     TYPES
399  *************************************************************/
400
401 struct scst_tgt;
402 struct scst_session;
403 struct scst_cmd;
404 struct scst_mgmt_cmd;
405 struct scst_device;
406 struct scst_tgt_dev;
407 struct scst_dev_type;
408 struct scst_acg;
409 struct scst_acg_dev;
410 struct scst_acn;
411
412 typedef uint64_t lun_t;
413
414 typedef enum dma_data_direction scst_data_direction;
415
416 enum scst_cdb_flags
417 {
418         SCST_TRANSFER_LEN_TYPE_FIXED = 0x01, /* must be equviv 1 (FIXED_BIT in cdb) */
419         SCST_SMALL_TIMEOUT = 0x02,
420         SCST_LONG_TIMEOUT = 0x04,
421         SCST_UNKNOWN_LENGTH = 0x08,
422         SCST_INFO_INVALID = 0x10,
423 };
424
425 /* 
426  * Scsi_Target_Template: defines what functions a target driver will
427  * have to provide in order to work with the target mid-level. 
428  * MUST HAVEs define functions that are expected to be in order to work. 
429  * OPTIONAL says that there is a choice.
430  * Also, pay attention to the fact that a command is BLOCKING or NON-BLOCKING.
431  * NON-BLOCKING means that a function returns immediately and will not wait
432  * for actual data transfer to finish. Blocking in such command could have 
433  * negative impact on overall system performance. If blocking is necessary, 
434  * it is worth to consider creating dedicated thread(s) in target driver, to 
435  * which the commands would be passed and which would perform blocking 
436  * operations instead of SCST.
437  * If the function allowed to sleep or not is determined by its last 
438  * argument, which is true, if sleeping is not allowed. In this case, 
439  * if the function requires sleeping, it  can return 
440  * SCST_TGT_RES_NEED_THREAD_CTX, and it will be recalled in the thread context,
441  * where sleeping is allowed.
442  */
443 struct scst_tgt_template
444 {
445         /* public: */
446
447         /* 
448          * SG tablesize allows to check whether scatter/gather can be used
449          * or not. 
450          */
451         int sg_tablesize;
452
453         /*
454          * True, if this target adapter uses unchecked DMA onto an ISA bus.
455          */
456         unsigned unchecked_isa_dma:1;
457
458         /*
459          * True, if this target adapter can benefit from using SG-vector
460          * clustering (i.e. smaller number of segments).
461          */
462         unsigned use_clustering:1;
463
464         /*
465          * True, if this target adapter doesn't support SG-vector clustering 
466          */
467         unsigned no_clustering:1;
468
469         /*
470          * True, if corresponding function supports execution in
471          * the atomic (non-sleeping) context
472          */
473         unsigned xmit_response_atomic:1;
474         unsigned rdy_to_xfer_atomic:1;
475         unsigned preprocessing_done_atomic:1;
476
477         /* True, if the template doesn't need the entry in /proc */
478         unsigned no_proc_entry:1;
479
480         /*
481          * This function is equivalent to the SCSI
482          * queuecommand. The target should transmit the response
483          * buffer and the status in the scst_cmd struct. 
484          * The expectation is that this executing this command is NON-BLOCKING. 
485          * 
486          * After the response is actually transmitted, the target 
487          * should call the scst_tgt_cmd_done() function of the 
488          * mid-level, which will allow it to free up the command.
489          * Returns one of the SCST_TGT_RES_* constants.
490          *
491          * Pay attention to "atomic" attribute of the cmd, which can be get
492          * by scst_cmd_atomic(): it is true if the function called in the
493          * atomic (non-sleeping) context.
494          *
495          * MUST HAVE
496          */
497         int (*xmit_response) (struct scst_cmd *cmd);
498
499         /*
500          * This function informs the driver that data
501          * buffer corresponding to the said command have now been
502          * allocated and it is OK to receive data for this command.
503          * This function is necessary because a SCSI target does not
504          * have any control over the commands it receives. Most lower
505          * level protocols have a corresponding function which informs
506          * the initiator that buffers have been allocated e.g., XFER_
507          * RDY in Fibre Channel. After the data is actually received
508          * the low-level driver needs to call scst_rx_data() in order to 
509          * continue processing this command.
510          * Returns one of the SCST_TGT_RES_* constants.
511          * This command is expected to be NON-BLOCKING.
512          *
513          * Pay attention to "atomic" attribute of the cmd, which can be get
514          * by scst_cmd_atomic(): it is true if the function called in the
515          * atomic (non-sleeping) context.
516          *
517          * OPTIONAL
518          */
519         int (*rdy_to_xfer) (struct scst_cmd *cmd);
520
521         /* 
522          * Called to notify the driver that the command is about to be freed.
523          * Necessary, because for aborted commands xmit_response() could not
524          * be called. Could be called on IRQ context.
525          *
526          * OPTIONAL
527          */
528         void (*on_free_cmd) (struct scst_cmd *cmd);
529
530         /*
531          * This function allows target driver to handle data buffer
532          * allocations on its own.
533          *
534          * Target driver doesn't have to always allocate buffer in this
535          * function, but if it decide to do it, it must check that
536          * scst_cmd_get_data_buff_alloced() returns 0, otherwise to avoid
537          * double buffer allocation and memory leaks alloc_data_buf() shall
538          * fail.
539          *
540          * Shall return 0 in case of success or < 0 (preferrably -ENOMEM)
541          * in case of error, or > 0 if the regular SCST allocation should be
542          * done. In case of returning successfully, scst_cmd->data_buf_alloced
543          * will be set by SCST.
544          *
545          * If allocation in atomic context - cf. scst_cmd_atomic() - is not
546          * desired or fails and consequently < 0 is returned, this function
547          * will be re-called in thread context.
548          *
549          * Please note that the driver will have to handle itself all relevant
550          * details such as scatterlist setup, highmem, freeing the allocated
551          * memory, etc.
552          *
553          * OPTIONAL.
554          */
555         int (*alloc_data_buf) (struct scst_cmd *cmd);
556
557         /*
558          * This function informs the driver that data
559          * buffer corresponding to the said command have now been
560          * allocated and other preprocessing tasks have been done.
561          * A target driver could need to do some actions at this stage.
562          * After the target driver done the needed actions, it shall call
563          * scst_restart_cmd() in order to continue processing this command.
564          *
565          * Called only if the cmd is queued using scst_cmd_init_stage1_done()
566          * instead of scst_cmd_init_done().
567          *
568          * Returns void, the result is expected to be returned using
569          * scst_restart_cmd().
570          *
571          * This command is expected to be NON-BLOCKING.
572          *
573          * Pay attention to "atomic" attribute of the cmd, which can be get
574          * by scst_cmd_atomic(): it is true if the function called in the
575          * atomic (non-sleeping) context.
576          *
577          * OPTIONAL.
578          */
579         void (*preprocessing_done) (struct scst_cmd *cmd);
580
581         /*
582          * This function informs the driver that the said command is about
583          * to be executed.
584          *
585          * Returns one of the SCST_PREPROCESS_* constants.
586          *
587          * This command is expected to be NON-BLOCKING.
588          *
589          * Pay attention to "atomic" attribute of the cmd, which can be get
590          * by scst_cmd_atomic(): it is true if the function called in the
591          * atomic (non-sleeping) context.
592          *
593          * OPTIONAL
594          */
595         int (*pre_exec) (struct scst_cmd *cmd);
596
597         /*
598          * This function informs the driver that a
599          * received task management function has been completed. This
600          * function is necessary because low-level protocols have some
601          * means of informing the initiator about the completion of a
602          * Task Management function. This function being called will
603          * signify that a Task Management function is completed as far
604          * as the mid-level is concerned. Any information that must be
605          * stored about the command is the responsibility of the low-
606          * level driver. No return value expected. 
607          * This function is expected to be NON-BLOCKING
608          *
609          * Called without any locks held from a thread context.
610          *
611          * MUST HAVE if the target supports ABORTs
612          */
613         void (*task_mgmt_fn_done) (struct scst_mgmt_cmd *mgmt_cmd);
614
615         /*
616          * This function should detect the target adapters that
617          * are present in the system. The function should return a value
618          * >= 0 to signify the number of detected target adapters. 
619          * A negative value should be returned whenever there is
620          * an error. 
621          *
622          * MUST HAVE
623          */
624         int (*detect) (struct scst_tgt_template *tgt_template);
625
626         /*
627          * This function should free up the resources allocated to the device. 
628          * The function should return 0 to indicate successful release 
629          * or a negative value if there are some issues with the release. 
630          * In the current version the return value is ignored.
631          *
632          * MUST HAVE
633          */
634         int (*release) (struct scst_tgt *tgt);
635
636         /*
637          * This function is used for Asynchronous Event Notification. 
638          * It is the responsibility of the driver to notify any/all
639          * initiators about the Asynchronous Event reported.
640          * Returns one of the SCST_TGT_RES_* constants.
641          * This command is expected to be NON-BLOCKING, but can sleep.
642          *
643          * MUST HAVE if low-level protocol supports AEN
644          *
645          * ToDo
646          */
647         int (*report_aen) (int mgmt_fn, const uint8_t *lun, int lun_len);
648
649         /*
650          * Those functions can be used to export the driver's statistics and
651          * other infos to the world outside the kernel as well as to get some
652          * management commands from it.
653          *
654          * OPTIONAL
655          */
656         int (*read_proc) (struct seq_file *seq, struct scst_tgt *tgt);
657         int (*write_proc) (char *buffer, char **start, off_t offset, 
658                 int length, int *eof, struct scst_tgt *tgt);
659
660         /* 
661          * Name of the template. Must be unique to identify
662          * the template. MUST HAVE
663          */
664         const char name[50];
665
666         /* 
667          * Number of additional threads to the pool of dedicated threads.
668          * Used if xmit_response() or rdy_to_xfer() is blocking.
669          * It is the target driver's duty to ensure that not more, than that
670          * number of threads, are blocked in those functions at any time.
671          */
672         int threads_num;
673
674         /* Private, must be inited to 0 by memset() */
675
676         /* List of targets per template, protected by scst_mutex */
677         struct list_head tgt_list;
678
679         /* List entry of global templates list */
680         struct list_head scst_template_list_entry;
681
682         /* The pointer to the /proc directory entry */
683         struct proc_dir_entry *proc_tgt_root;
684
685         /* Device number in /proc */
686         int proc_dev_num;
687 };
688
689 struct scst_dev_type
690 {
691         /* SCSI type of the supported device. MUST HAVE */
692         int type;
693
694         /*
695          * True, if corresponding function supports execution in
696          * the atomic (non-sleeping) context
697          */
698         unsigned parse_atomic:1;
699         unsigned exec_atomic:1;
700         unsigned dev_done_atomic:1;
701
702         /* Set, if no /proc files should be automatically created by SCST */
703         unsigned no_proc:1;
704
705         /* Set, if exec() is synchronous */
706         unsigned exec_sync:1;
707
708         /* 
709          * Called to parse CDB from the cmd and initialize 
710          * cmd->bufflen and cmd->data_direction (both - REQUIRED).
711          * Returns the command's next state or SCST_CMD_STATE_DEFAULT, 
712          * if the next default state should be used, or 
713          * SCST_CMD_STATE_NEED_THREAD_CTX if the function called in atomic 
714          * context, but requires sleeping, or SCST_CMD_STATE_STOP if the
715          * command should not be further processed for now. In the
716          * SCST_CMD_STATE_NEED_THREAD_CTX case the function 
717          * will be recalled in the thread context, where sleeping is allowed.
718          *
719          * Pay attention to "atomic" attribute of the cmd, which can be get
720          * by scst_cmd_atomic(): it is true if the function called in the
721          * atomic (non-sleeping) context.
722          *
723          * MUST HAVE
724          */
725         int (*parse) (struct scst_cmd *cmd);
726
727         /* 
728          * Called to execute CDB. Useful, for instance, to implement 
729          * data caching. The result of CDB execution is reported via 
730          * cmd->scst_cmd_done() callback.
731          * Returns: 
732          *  - SCST_EXEC_COMPLETED - the cmd is done, go to other ones
733          *  - SCST_EXEC_NEED_THREAD - thread context is required to execute
734          *    the command. Exec() will be called again in the thread context.
735          *  - SCST_EXEC_NOT_COMPLETED - the cmd should be sent to SCSI mid-level.
736          *
737          * Pay attention to "atomic" attribute of the cmd, which can be get
738          * by scst_cmd_atomic(): it is true if the function called in the
739          * atomic (non-sleeping) context.
740          *
741          * If this function provides sync execution, you must set above
742          * exec_sync flag and should consider to setup dedicated threads by
743          * setting threads_num > 0.
744          *
745          * !! If this function is implemented, scst_check_local_events() shall !!
746          * !! be called inside it just before the actual command's execution.  !!
747          *
748          * OPTIONAL, if not set, the commands will be sent directly to SCSI
749          * device.
750          */
751         int (*exec) (struct scst_cmd *cmd);
752
753         /* 
754          * Called to notify dev handler about the result of cmd execution
755          * and perform some post processing. Cmd's fields tgt_resp_flags and
756          * resp_data_len should be set by this function, but SCST offers good
757          * defaults.
758          * Returns the command's next state or SCST_CMD_STATE_DEFAULT, 
759          * if the next default state should be used, or 
760          * SCST_CMD_STATE_NEED_THREAD_CTX if the function called in atomic 
761          * context, but requires sleeping. In the last case, the function 
762          * will be recalled in the thread context, where sleeping is allowed.
763          *
764          * Pay attention to "atomic" attribute of the cmd, which can be get
765          * by scst_cmd_atomic(): it is true if the function called in the
766          * atomic (non-sleeping) context.
767          */
768         int (*dev_done) (struct scst_cmd *cmd);
769
770         /* 
771          * Called to notify dev hander that the command is about to be freed.
772          * Could be called on IRQ context.
773          */
774         void (*on_free_cmd) (struct scst_cmd *cmd);
775
776         /* 
777          * Called to execute a task management command. 
778          * Returns: 
779          *  - SCST_MGMT_STATUS_SUCCESS - the command is done with success,
780          *      no firther actions required
781          *  - The SCST_MGMT_STATUS_* error code if the command is failed and 
782          *      no firther actions required
783          *  - SCST_DEV_TM_NOT_COMPLETED - regular standard actions for the command
784          *      should be done
785          *
786          * Called without any locks held from a thread context.
787          */
788         int (*task_mgmt_fn) (struct scst_mgmt_cmd *mgmt_cmd, 
789                 struct scst_tgt_dev *tgt_dev);
790
791         /* 
792          * Called when new device is attaching to the dev handler
793          * Returns 0 on success, error code otherwise.
794          */
795         int (*attach) (struct scst_device *dev);
796
797         /* Called when new device is detaching from the dev handler */
798         void (*detach) (struct scst_device *dev);
799
800         /* 
801          * Called when new tgt_dev (session) is attaching to the dev handler.
802          * Returns 0 on success, error code otherwise.
803          */
804         int (*attach_tgt) (struct scst_tgt_dev *tgt_dev);
805
806         /* 
807          * Called when a session, corresponding to a tgt_dev, is about to be
808          * unregistered and the tgt_dev - detached. Supposed to be used to
809          * clean out "stalled" commands, which otherwise could prevent SCST
810          * from entering into the suspended activity state and, so,
811          * unregistering the device.
812          */
813         void (*pre_unreg_sess) (struct scst_tgt_dev *tgt_dev);
814
815         /* Called when tgt_dev (session) is detaching from the dev handler */
816         void (*detach_tgt) (struct scst_tgt_dev *tgt_dev);
817
818         /*
819          * Those functions can be used to export the handler's statistics and
820          * other infos to the world outside the kernel as well as to get some
821          * management commands from it.
822          *
823          * OPTIONAL
824          */
825         int (*read_proc) (struct seq_file *seq, struct scst_dev_type *dev_type);
826         int (*write_proc) (char *buffer, char **start, off_t offset,
827                 int length, int *eof, struct scst_dev_type *dev_type);
828
829         /* Name of the dev handler. Must be unique. MUST HAVE */
830         char name[15];
831
832         /*
833          * Number of dedicated threads. If 0 - no dedicated threads will 
834          * be created, if <0 - creation of dedicated threads is prohibited.
835          */
836         int threads_num;
837
838         struct module *module;
839
840         /* private: */
841
842         /* list entry in scst_dev_type_list */
843         struct list_head dev_type_list_entry;
844         
845         /* The pointer to the /proc directory entry */
846         struct proc_dir_entry *proc_dev_type_root;
847 };
848
849 struct scst_tgt
850 {
851         /* List of remote sessions per target, protected by scst_mutex */
852         struct list_head sess_list;
853
854         /* List entry of targets per template (tgts_list) */
855         struct list_head tgt_list_entry;
856
857         struct scst_tgt_template *tgtt; /* corresponding target template */
858
859         /* Used to wait until session finished to unregister */
860         wait_queue_head_t unreg_waitQ;
861
862         /* Device number in /proc */
863         int proc_num;
864
865         /*
866          * The following fields used to store and retry cmds if
867          * target's internal queue is full, so the target is unable to accept
868          * the cmd returning QUEUE FULL
869          */
870         atomic_t finished_cmds;
871         int retry_cmds;         /* protected by tgt_lock */
872         spinlock_t tgt_lock;
873         struct list_head retry_cmd_list; /* protected by tgt_lock */
874         struct timer_list retry_timer;
875         int retry_timer_active;
876
877         /*
878          * Maximum SG table size. Needed here, since different cards on the
879          * same target template can have different SG table limitations.
880          */
881         int sg_tablesize;
882
883         /* Used for storage of target driver private stuff */
884         void *tgt_priv;
885
886         /* Name on the default security group ("Default_target_name") */
887         char *default_group_name;
888 };
889
890 /* Hash size and hash fn for hash based lun translation */
891 #define TGT_DEV_HASH_SHIFT      5
892 #define TGT_DEV_HASH_SIZE       (1<<TGT_DEV_HASH_SHIFT)
893 #define HASH_VAL(_val)          (_val & (TGT_DEV_HASH_SIZE - 1))
894
895 struct scst_session
896 {
897         /*
898          * Initialization phase, one of SCST_SESS_IPH_* constants, protected by
899          * sess_list_lock
900          */
901         int init_phase;
902
903         atomic_t refcnt;                /* get/put counter */
904
905         /**************************************************************/
906
907         /* Alive commands for this session. ToDo: make it part of the common IO flow control */
908         atomic_t sess_cmd_count;                
909
910         spinlock_t sess_list_lock; /* protects search_cmd_list, etc */
911
912         /* 
913          * List of cmds in this session. Used to find a cmd in the
914          * session. Protected by sess_list_lock.
915          */
916         struct list_head search_cmd_list;
917
918         /*
919          * Hash list of tgt_dev's for this session, protected by scst_mutex
920          * and suspended activity
921          */
922         struct list_head sess_tgt_dev_list_hash[TGT_DEV_HASH_SIZE];
923
924         /* Access control for this session and list entry there */
925         struct scst_acg *acg;
926
927         /* List entry for the sessions list inside ACG */
928         struct list_head acg_sess_list_entry;
929
930         struct scst_tgt *tgt;   /* corresponding target */
931
932         /* Used for storage of target driver private stuff */
933         void *tgt_priv;
934
935         /* Name of attached initiator */
936         const char *initiator_name;
937
938         /* List entry of sessions per target */
939         struct list_head sess_list_entry;
940
941         /* List entry for the list that keeps session, waiting for the init */
942         struct list_head sess_init_list_entry;
943
944         /* List entry for the list that keeps session, waiting for the shutdown */
945         struct list_head sess_shut_list_entry;
946
947         /* 
948          * Lists of deffered during session initialization commands.
949          * Protected by sess_list_lock.
950          */
951         struct list_head init_deferred_cmd_list;
952         struct list_head init_deferred_mcmd_list;
953
954         /*
955          * Shutdown phase, one of SCST_SESS_SPH_* constants, unprotected.
956          * Async. relating to init_phase, must be a separate variable, because
957          * session could be unregistered before async. registration is finished.
958          */
959         unsigned long shut_phase;
960
961         /* Used if scst_unregister_session() called in wait mode */
962         struct completion *shutdown_compl;
963
964         /*
965          * Functions and data for user callbacks from scst_register_session()
966          * and scst_unregister_session()
967          */
968         void *reg_sess_data;
969         void (*init_result_fn) (struct scst_session *sess, void *data,
970                                 int result);
971         void (*unreg_done_fn) (struct scst_session *sess);
972         void (*unreg_cmds_done_fn) (struct scst_session *sess);
973
974 #ifdef MEASURE_LATENCY /* must be last */
975         spinlock_t meas_lock;
976         uint64_t scst_time, processing_time;
977         unsigned int processed_cmds;
978 #endif
979 };
980
981 struct scst_cmd_lists
982 {
983         spinlock_t cmd_list_lock;
984         struct list_head active_cmd_list;
985         wait_queue_head_t cmd_list_waitQ;
986         struct list_head lists_list_entry;
987 };
988
989 struct scst_cmd
990 {
991         /* List entry for below *_cmd_lists */
992         struct list_head cmd_list_entry;
993
994         /* Pointer to lists of commands with the lock */
995         struct scst_cmd_lists *cmd_lists;
996
997         atomic_t cmd_ref;
998
999         struct scst_session *sess;      /* corresponding session */
1000
1001         /* Cmd state, one of SCST_CMD_STATE_* constants */
1002         int state;
1003
1004         /*************************************************************
1005          ** Cmd's flags 
1006          *************************************************************/
1007         /* 
1008          * Set if expected_sn was incremented, i.e. cmd was sent to 
1009          * SCSI mid-level for execution
1010          */
1011         unsigned int sent_to_midlev:1;
1012
1013         /* Set if scst_local_exec() was already called for this cmd */
1014         unsigned int local_exec_done:1;
1015
1016         /* Set if the cmd's action is completed */
1017         unsigned int completed:1;
1018
1019         /* Set if we should ignore Unit Attention in scst_check_sense() */
1020         unsigned int ua_ignore:1;
1021
1022         /* Set if cmd is being processed in atomic context */
1023         unsigned int atomic:1;
1024
1025         /*
1026          * Set if the cmd is being processed in the processable context. See
1027          * comment for SCST_CONTEXT_PROCESSABLE for what it means.
1028          */
1029         unsigned int context_processable:1;
1030
1031         /* Set if cmd is internally generated */
1032         unsigned int internal:1;
1033
1034         /* Set if cmd is being retried */
1035         unsigned int retry:1;
1036
1037         /* Set if the device was blocked by scst_inc_on_dev_cmd() (for debug) */
1038         unsigned int inc_blocking:1;
1039
1040         /* Set if the device should be unblocked after cmd's finish */
1041         unsigned int needs_unblocking:1;
1042
1043         /* Set if scst_dec_on_dev_cmd() call is needed on the cmd's finish */
1044         unsigned int dec_on_dev_needed:1;
1045
1046         /*
1047          * Set if the target driver wants to alloc data buffers on its own.
1048          * In this case alloc_data_buf() must be provided in the target driver
1049          * template.
1050          */
1051         unsigned int data_buf_tgt_alloc:1;
1052
1053         /*
1054          * Set by SCST if the custom data buffer allocation by the target driver
1055          * succeeded.
1056          */
1057         unsigned int data_buf_alloced:1;
1058
1059         /* Set if the target driver called scst_set_expected() */
1060         unsigned int expected_values_set:1;
1061
1062         /*
1063          * Set if the cmd was delayed by task management debugging code.
1064          * Used only if DEBUG_TM is on.
1065          */
1066         unsigned int tm_dbg_delayed:1;
1067
1068         /*
1069          * Set if the cmd must be ignored by task management debugging code.
1070          * Used only if DEBUG_TM is on.
1071          */
1072         unsigned int tm_dbg_immut:1;
1073
1074         /*
1075          * Set if the SG buffer was modified by scst_set_resp_data_len()
1076          */
1077         unsigned int sg_buff_modified:1;
1078
1079         /*
1080          * Set if scst_cmd_init_stage1_done() called and the target
1081          * want that preprocessing_done() will be called
1082          */
1083         unsigned int preprocessing_only:1;
1084
1085         /* Set if scst_cmd_set_sn() was called */
1086         unsigned int sn_set:1;
1087
1088         /*
1089          * Set if scst_cmd_init_stage1_done() called and the target wants
1090          * that the SN for the cmd won't be assigned until scst_restart_cmd()
1091          */
1092         unsigned int set_sn_on_restart_cmd:1;
1093
1094         /* Set if the cmd's must not use sgv cache for data buffer */
1095         unsigned int no_sgv:1;
1096
1097         /*
1098          * Set if target driver may need to call dma_sync_sg() or similar
1099          * function before transferring cmd' data to the target device
1100          * via DMA.
1101          */
1102         unsigned int may_need_dma_sync:1;
1103
1104         /* Set if the cmd was done or aborted out of its SN */
1105         unsigned int out_of_sn:1;
1106
1107         /* Set if increment expected_sn in cmd->scst_cmd_done() */
1108         unsigned int inc_expected_sn_on_done:1;
1109
1110         /*
1111          * Set if xmit_response() is going to need a considerable processing
1112          * time. Processing time is considerable, if it's > context switch time
1113          * (about 1 usec on modern systems). It's needed to trigger other
1114          * threads to start processing other outstanding commands without
1115          * waiting XMIT for the current one to finish. E.g., it should be set
1116          * if iSCSI data digest used and cmd has READ direction.
1117          */
1118         unsigned int long_xmit:1;
1119
1120         /* Set if tgt_sn field is valid */
1121         unsigned int tgt_sn_set:1;
1122
1123         /* Set if cmd is done */
1124         unsigned int done:1;
1125
1126         /* Set if cmd is finished */
1127         unsigned int finished:1;
1128
1129         /**************************************************************/
1130
1131         unsigned long cmd_flags; /* cmd's async flags */
1132
1133         /* Keeps status of cmd's status/data delivery to remote initiator */
1134         int delivery_status;
1135
1136         struct scst_tgt_template *tgtt; /* to save extra dereferences */
1137         struct scst_tgt *tgt;           /* to save extra dereferences */
1138         struct scst_device *dev;        /* to save extra dereferences */
1139
1140         struct scst_tgt_dev *tgt_dev;   /* corresponding device for this cmd */
1141
1142         lun_t lun;                      /* LUN for this cmd */
1143
1144         unsigned long start_time;
1145
1146 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18)
1147         struct scsi_request *scsi_req;  /* SCSI request */
1148 #endif
1149
1150         /* List entry for tgt_dev's SN related lists */
1151         struct list_head sn_cmd_list_entry;
1152
1153         /* Cmd's serial number, used to execute cmd's in order of arrival */
1154         unsigned long sn;
1155
1156         /* The corresponding sn_slot in tgt_dev->sn_slots */
1157         atomic_t *sn_slot;
1158
1159         /* List entry for session's search_cmd_list */
1160         struct list_head search_cmd_list_entry;
1161
1162         /* 
1163          * Used to found the cmd by scst_find_cmd_by_tag(). Set by the
1164          * target driver on the cmd's initialization time
1165          */
1166         uint64_t tag;
1167
1168         uint32_t tgt_sn; /* SN set by target driver (for TM purposes) */
1169
1170         /* CDB and its len */
1171         uint8_t cdb[SCST_MAX_CDB_SIZE];
1172         int cdb_len;
1173
1174         enum scst_cdb_flags op_flags;
1175         const char *op_name;
1176
1177         enum scst_cmd_queue_type queue_type;
1178
1179         int timeout;    /* CDB execution timeout */
1180         int retries;    /* Amount of retries that will be done by SCSI mid-level */
1181
1182         /* SCSI data direction, one of SCST_DATA_* constants */
1183         scst_data_direction data_direction;
1184         
1185         /* Remote initiator supplied values, if any */
1186         scst_data_direction expected_data_direction;
1187         int expected_transfer_len;
1188
1189         /* 
1190          * Cmd data length. Could be different from bufflen for commands like
1191          * VERIFY, which transfer different amount of data (if any), than
1192          * processed.
1193          */
1194         int data_len;
1195
1196         /* Completition routine */
1197         void (*scst_cmd_done) (struct scst_cmd *cmd, int next_state);
1198
1199         struct sgv_pool_obj *sgv;       /* sgv object */
1200
1201         int bufflen;                    /* cmd buffer length */
1202         struct scatterlist *sg;         /* cmd data buffer SG vector */
1203         int sg_cnt;                     /* SG segments count */
1204         
1205         /* scst_get_sg_buf_[first,next]() support */
1206         int get_sg_buf_entry_num;
1207
1208         /*
1209          * The following two fields should be corrected by the dev_done(),
1210          * if necessary
1211          */
1212         int tgt_resp_flags;     /* response flags (SCST_TSC_FLAG_* constants) */
1213
1214         /* 
1215          * Response data length in data buffer. This field must not be set
1216          * directly, use scst_set_resp_data_len() for that
1217          */
1218         int resp_data_len;
1219
1220         uint8_t status;         /* status byte from target device */
1221         uint8_t msg_status;     /* return status from host adapter itself */
1222         uint8_t host_status;    /* set by low-level driver to indicate status */
1223         uint8_t driver_status;  /* set by mid-level */
1224
1225         uint8_t *sense;         /* pointer to sense buffer */
1226
1227         /* Used for storage of target driver private stuff */
1228         void *tgt_priv;
1229
1230         /* Used for storage of dev handler private stuff */
1231         void *dh_priv;
1232
1233         /* 
1234          * Used to restore the SG vector if it was modified by
1235          * scst_set_resp_data_len()
1236          */
1237         int orig_sg_cnt, orig_sg_entry, orig_entry_len;
1238
1239         /* List corresponding mgmt cmd, if any, protected by sess_list_lock */
1240         struct list_head mgmt_cmd_list;
1241
1242         /* List entry for dev's blocked_cmd_list */
1243         struct list_head blocked_cmd_list_entry;
1244
1245         struct scst_cmd *orig_cmd; /* Used to issue REQUEST SENSE */
1246
1247 #ifdef MEASURE_LATENCY /* must be last */
1248         uint64_t start, pre_exec_finish, post_exec_start;
1249 #endif
1250 };
1251
1252 struct scst_rx_mgmt_params
1253 {
1254         int fn;
1255         uint64_t tag;
1256         const uint8_t *lun;
1257         int lun_len;
1258         uint32_t cmd_sn;
1259         int atomic;
1260         void *tgt_priv;
1261         unsigned char tag_set;
1262         unsigned char lun_set;
1263         unsigned char cmd_sn_set;
1264 };
1265
1266 struct scst_mgmt_cmd_stub
1267 {
1268         struct scst_mgmt_cmd *mcmd;
1269
1270         /* List entry in cmd->mgmt_cmd_list */
1271         struct list_head cmd_mgmt_cmd_list_entry;
1272 };
1273
1274 struct scst_mgmt_cmd
1275 {
1276         /* List entry for *_mgmt_cmd_list */
1277         struct list_head mgmt_cmd_list_entry;
1278
1279         struct scst_session *sess;
1280
1281         /* Mgmt cmd state, one of SCST_MGMT_CMD_STATE_* constants */
1282         int state;
1283
1284         int fn;
1285
1286         unsigned int completed:1;       /* set, if the mcmd is completed */
1287         /* Set if device(s) should be unblocked after mcmd's finish */
1288         unsigned int needs_unblocking:1;
1289         unsigned int lun_set:1;         /* set, if lun field is valid */
1290         unsigned int cmd_sn_set:1;      /* set, if cmd_sn field is valid */
1291         unsigned int nexus_loss_check_done:1; /* set, if nexus loss check is done */
1292
1293         /*
1294          * Number of commands to finish before sending response,
1295          * protected by scst_mcmd_lock
1296          */
1297         int cmd_finish_wait_count;
1298
1299         /*
1300          * Number of commands to complete (done) before resetting reservation,
1301          * protected by scst_mcmd_lock
1302          */
1303         int cmd_done_wait_count;
1304
1305         /* Number of completed commands, protected by scst_mcmd_lock */
1306         int completed_cmd_count;
1307
1308         lun_t lun;      /* LUN for this mgmt cmd */
1309         /* or (and for iSCSI) */
1310         uint64_t tag;   /* tag of the corresponding cmd */
1311
1312         uint32_t cmd_sn; /* affected command's highest SN */
1313
1314         /* corresponding cmd (to be aborted, found by tag) */
1315         struct scst_cmd *cmd_to_abort;
1316
1317         /* corresponding device for this mgmt cmd (found by lun) */
1318         struct scst_tgt_dev *mcmd_tgt_dev;
1319
1320         /* completition status, one of the SCST_MGMT_STATUS_* constants */
1321         int status;
1322
1323         /* Used for storage of target driver private stuff */
1324         void *tgt_priv;
1325 };
1326
1327 struct scst_device
1328 {
1329         struct scst_dev_type *handler;  /* corresponding dev handler */
1330
1331         /* Pointer to lists of commands with the lock */
1332         struct scst_cmd_lists *p_cmd_lists;
1333
1334         /* Lists of commands with lock, if dedicated threads are used */
1335         struct scst_cmd_lists cmd_lists;
1336
1337         /* How many cmds alive on this dev */
1338         atomic_t dev_cmd_count; 
1339
1340         unsigned short type;    /* SCSI type of the device */
1341
1342         /*************************************************************
1343          ** Dev's flags. Updates serialized by dev_lock or suspended
1344          ** activity
1345          *************************************************************/
1346
1347         /* Set if dev is RESERVED */
1348         unsigned short dev_reserved:1;
1349
1350         /* Set if dev accepts only one command at time  */
1351         unsigned short dev_serialized:1;
1352
1353         /* Set if double reset UA is possible */
1354         unsigned short dev_double_ua_possible:1;
1355
1356         /* Set if reset UA sent (to avoid double reset UAs) */
1357         unsigned short dev_reset_ua_sent:1;
1358
1359         /**************************************************************/
1360
1361         /*************************************************************
1362          ** Dev's control mode page related values. Updates serialized
1363          ** by scst_block_dev(). It's long to not interfere with the
1364          ** above flags.
1365          *************************************************************/
1366
1367         unsigned long queue_alg:4;
1368         unsigned long tst:3;
1369         unsigned long tas:1;
1370         unsigned long swp:1;
1371
1372         /*
1373          * Set if device implements own ordered commands management. If not set
1374          * and queue_alg is SCST_CONTR_MODE_QUEUE_ALG_RESTRICTED_REORDER,
1375          * expected_sn will be incremented only after commands finished.
1376          */
1377         unsigned long has_own_order_mgmt:1;
1378
1379         /**************************************************************/
1380
1381         spinlock_t dev_lock;            /* device lock */
1382
1383         /* 
1384          * How many times device was blocked for new cmds execution.
1385          * Protected by dev_lock
1386          */
1387         int block_count;
1388
1389         /* 
1390          * How many there are "on_dev" commands, i.e. ones those are being
1391          * executed by the underlying SCSI/virtual device.
1392          */
1393         atomic_t on_dev_count;
1394
1395         struct list_head blocked_cmd_list; /* protected by dev_lock */
1396
1397         /* Used for storage of dev handler private stuff */
1398         void *dh_priv;
1399
1400         /* Used to translate SCSI's cmd to SCST's cmd */
1401         struct gendisk *rq_disk;
1402
1403         /* Corresponding real SCSI device, could be NULL for virtual devices */
1404         struct scsi_device *scsi_dev;
1405
1406         /* Used to wait for requested amount of "on_dev" commands */
1407         wait_queue_head_t on_dev_waitQ;
1408
1409         /* A list entry used during TM, protected by scst_mutex */
1410         struct list_head tm_dev_list_entry;
1411
1412         /* Virtual device internal ID */
1413         int virt_id;
1414         
1415         /* Pointer to virtual device name, for convenience only */
1416         const char *virt_name;
1417         
1418         /* List entry in global devices list */
1419         struct list_head dev_list_entry;
1420         
1421         /*
1422          * List of tgt_dev's, one per session, protected by scst_mutex or
1423          * dev_lock for reads and both for writes
1424          */
1425         struct list_head dev_tgt_dev_list;
1426         
1427         /* List of acg_dev's, one per acg, protected by scst_mutex */
1428         struct list_head dev_acg_dev_list;
1429
1430         /* List of dedicated threads, protected by scst_mutex */
1431         struct list_head threads_list;
1432
1433         /* Device number */
1434         int dev_num;
1435 };
1436
1437 /*
1438  * Used to store threads local tgt_dev specific data
1439  */
1440 struct scst_thr_data_hdr
1441 {
1442         /* List entry in tgt_dev->thr_data_list */
1443         struct list_head thr_data_list_entry;
1444         pid_t pid; /* PID of the owner thread */
1445         atomic_t ref;
1446         /* Function that will be called on the tgt_dev destruction */
1447         void (*free_fn) (struct scst_thr_data_hdr *data);
1448 };
1449
1450 /* 
1451  * Used to store per-session specific device information
1452  */
1453 struct scst_tgt_dev
1454 {
1455         /* List entry in sess->sess_tgt_dev_list_hash */
1456         struct list_head sess_tgt_dev_list_entry;
1457
1458         struct scst_device *dev; /* to save extra dereferences */
1459         lun_t lun;               /* to save extra dereferences */
1460
1461         /* How many cmds alive on this dev in this session */
1462         atomic_t tgt_dev_cmd_count;
1463
1464         int gfp_mask;
1465         struct sgv_pool *pool;
1466         int max_sg_cnt;
1467
1468         unsigned long tgt_dev_flags;    /* tgt_dev's async flags */
1469
1470         /* 
1471          * Used to execute cmd's in order of arrival, honoring SCSI task
1472          * attributes.
1473          *
1474          * Protected by sn_lock, except expected_sn, which is protected by
1475          * itself. Curr_sn must have the same size as expected_sn to
1476          * overflow simultaneously.
1477          */
1478         int def_cmd_count;
1479         spinlock_t sn_lock;
1480         unsigned long expected_sn;
1481         unsigned long curr_sn;
1482         int hq_cmd_count;
1483         struct list_head deferred_cmd_list;
1484         struct list_head skipped_sn_list;
1485
1486         /*
1487          * Set if the prev cmd was ORDERED. Size must allow unprotected
1488          * modifications
1489          */
1490         unsigned long prev_cmd_ordered;
1491
1492         int num_free_sn_slots; /* if it's <0, then all slots are busy */
1493         atomic_t *cur_sn_slot;
1494         atomic_t sn_slots[15];
1495
1496         /* Used for storage of dev handler private stuff */
1497         void *dh_priv;
1498
1499         /* List of scst_thr_data_hdr and lock */
1500         spinlock_t thr_data_lock;
1501         struct list_head thr_data_list;
1502
1503         spinlock_t tgt_dev_lock;        /* per-session device lock */
1504
1505         /* List of UA's for this device, protected by tgt_dev_lock */
1506         struct list_head UA_list;
1507
1508         struct scst_session *sess;      /* corresponding session */
1509         struct scst_acg_dev *acg_dev;   /* corresponding acg_dev */
1510
1511         /* list entry in dev->dev_tgt_dev_list */
1512         struct list_head dev_tgt_dev_list_entry;
1513         
1514         /* internal tmp list entry */
1515         struct list_head extra_tgt_dev_list_entry;
1516 };
1517
1518 /*
1519  * Used to store ACG-specific device information, like LUN
1520  */
1521 struct scst_acg_dev
1522 {
1523         struct scst_device *dev; /* corresponding device */
1524         lun_t lun;              /* device's LUN in this acg */
1525         unsigned int rd_only_flag:1; /* if != 0, then read only */
1526         struct scst_acg *acg;   /* parent acg */
1527         
1528         /* list entry in dev->dev_acg_dev_list */
1529         struct list_head dev_acg_dev_list_entry;
1530         
1531         /* list entry in acg->acg_dev_list */
1532         struct list_head acg_dev_list_entry;
1533 };
1534
1535 /*
1536  * ACG - access control group. Used to store group related
1537  * control information.
1538  */
1539 struct scst_acg
1540 {
1541         /* List of acg_dev's in this acg, protected by scst_mutex */
1542         struct list_head acg_dev_list;
1543
1544         /* List of attached sessions, protected by scst_mutex */
1545         struct list_head acg_sess_list;
1546
1547         /* List of attached acn's, protected by scst_mutex */
1548         struct list_head acn_list;
1549
1550         /* List entry in scst_acg_list */
1551         struct list_head scst_acg_list_entry;
1552
1553         /* Name of this acg */
1554         const char *acg_name;
1555
1556         /* The pointer to the /proc directory entry */
1557         struct proc_dir_entry *acg_proc_root;
1558 };
1559
1560 /*
1561  * ACN - access control name. Used to store names, by which
1562  * incoming sessions will be assigned to appropriate ACG.
1563  */
1564 struct scst_acn
1565 {
1566         /* Initiator's name */
1567         const char *name;
1568         /* List entry in acg->acn_list */
1569         struct list_head acn_list_entry;
1570 };
1571
1572 /* 
1573  * Used to store per-session UNIT ATTENTIONs
1574  */
1575 struct scst_tgt_dev_UA
1576 {
1577         /* List entry in tgt_dev->UA_list */
1578         struct list_head UA_list_entry;
1579         /* Unit Attention sense */
1580         uint8_t UA_sense_buffer[SCST_SENSE_BUFFERSIZE];
1581 };
1582
1583 #ifndef smp_mb__after_set_bit
1584 /* There is no smp_mb__after_set_bit() in the kernel */
1585 #define smp_mb__after_set_bit()                 smp_mb();
1586 #endif
1587
1588 /* 
1589  * Registers target template
1590  * Returns 0 on success or appropriate error code otherwise
1591  */
1592 int __scst_register_target_template(struct scst_tgt_template *vtt,
1593         const char *version);
1594 static inline int scst_register_target_template(struct scst_tgt_template *vtt)
1595 {
1596         return __scst_register_target_template(vtt, SCST_INTERFACE_VERSION);
1597 }
1598
1599 /* 
1600  * Unregisters target template
1601  */
1602 void scst_unregister_target_template(struct scst_tgt_template *vtt);
1603
1604 /* 
1605  * Registers and returns target adapter
1606  * Returns new target structure on success or NULL otherwise.
1607  *
1608  * If parameter "target_name" isn't NULL, then security group with name 
1609  * "Default_##target_name", if created, will be used as the default
1610  * instead of "Default" one for all initiators not assigned to any other group.
1611  */
1612 struct scst_tgt *scst_register(struct scst_tgt_template *vtt,
1613         const char *target_name);
1614
1615 /* 
1616  * Unregisters target adapter
1617  */
1618 void scst_unregister(struct scst_tgt *tgt);
1619
1620 /* 
1621  * Registers and returns a session
1622  *
1623  * Returns new session on success or NULL otherwise
1624  *
1625  * Parameters:
1626  *   tgt    - target
1627  *   atomic - true, if the function called in the atomic context
1628  *   initiator_name - remote initiator's name, any NULL-terminated string,
1629  *      e.g. iSCSI name, which used as the key to found appropriate access
1630  *      control group. Could be NULL, then "default" group is used. 
1631  *      The groups are set up via /proc interface.
1632  *   data - any target driver supplied data
1633  *   result_fn - pointer to the function that will be 
1634  *      asynchronously called when session initialization finishes.
1635  *      Can be NULL. Parameters:
1636  *       - sess - session
1637  *       - data - target driver supplied to scst_register_session() data
1638  *       - result - session initialization result, 0 on success or 
1639  *                  appropriate error code otherwise
1640  *
1641  * Note: A session creation and initialization is a complex task, 
1642  *       which requires sleeping state, so it can't be fully done
1643  *       in interrupt context. Therefore the "bottom half" of it, if
1644  *       scst_register_session() is called from atomic context, will be
1645  *       done in SCST thread context. In this case scst_register_session()
1646  *       will return not completely initialized session, but the target
1647  *       driver can supply commands to this session via scst_rx_cmd().
1648  *       Those commands processing will be delayed inside SCST until
1649  *       the session initialization is finished, then their processing
1650  *       will be restarted. The target driver will be notified about
1651  *       finish of the session initialization by function result_fn(). 
1652  *       On success the target driver could do nothing, but if the
1653  *       initialization fails, the target driver must ensure that
1654  *       no more new commands being sent or will be sent to SCST after
1655  *       result_fn() returns. All already sent to SCST commands for
1656  *       failed session will be returned in xmit_response() with BUSY status.
1657  *       In case of failure the driver shall call scst_unregister_session()
1658  *       inside result_fn(), it will NOT be called automatically.
1659  */
1660 struct scst_session *scst_register_session(struct scst_tgt *tgt, int atomic,
1661         const char *initiator_name, void *data,
1662         void (*result_fn) (struct scst_session *sess, void *data, int result));
1663
1664 /* 
1665  * Unregisters a session.
1666  * Parameters:
1667  *   sess - session to be unregistered
1668  *   wait - if true, instructs to wait until all commands, which
1669  *      currently is being executed and belonged to the session, finished.
1670  *      Otherwise, target driver should be prepared to receive
1671  *      xmit_response() for the session's command after 
1672  *      scst_unregister_session() returns.
1673  *   unreg_done_fn - pointer to the function that will be 
1674  *      asynchronously called when the last session's command finishes and
1675  *      the session is about to be completely freed. Can be NULL. 
1676  *      Parameter:
1677  *       - sess - session
1678  *   unreg_cmds_done_fn - pointer to the function that will be 
1679  *      asynchronously called when the last session's command completes, i.e.
1680  *      goes to XMIT stage. Can be NULL. 
1681  *      Parameter:
1682  *       - sess - session
1683  *
1684  * Notes:
1685  *
1686  * - All outstanding commands will be finished regularly. After
1687  *   scst_unregister_session() returned no new commands must be sent to
1688  *   SCST via scst_rx_cmd().
1689  *
1690  * - The caller must ensure that no scst_rx_cmd() or scst_rx_mgmt_fn_*() is
1691  *   called in paralell with scst_unregister_session().
1692  *
1693  * - Can be called before result_fn() of scst_register_session() called,
1694  *   i.e. during the session registration/initialization.
1695  *
1696  * - It is highly recommended to call scst_unregister_session() as soon as it
1697  *   gets clear that session will be unregistered and not to wait until all
1698  *   related commands finished. This function provides the wait functionality,
1699  *   but it also starts recovering stuck commands, if there are any.
1700  *   Otherwise, your target driver could wait for those commands forever.
1701  */
1702 void scst_unregister_session_ex(struct scst_session *sess, int wait,
1703         void (*unreg_done_fn) (struct scst_session *sess),
1704         void (*unreg_cmds_done_fn) (struct scst_session *sess));
1705
1706 static inline void scst_unregister_session(struct scst_session *sess, int wait,
1707         void (*unreg_done_fn) (struct scst_session *sess))
1708 {
1709         scst_unregister_session_ex(sess, wait, unreg_done_fn, NULL);
1710 }
1711
1712 /* 
1713  * Registers dev handler driver
1714  * Returns 0 on success or appropriate error code otherwise
1715  */
1716 int __scst_register_dev_driver(struct scst_dev_type *dev_type,
1717         const char *version);
1718 static inline int scst_register_dev_driver(struct scst_dev_type *dev_type)
1719 {
1720         return __scst_register_dev_driver(dev_type, SCST_INTERFACE_VERSION);
1721 }
1722
1723 /* 
1724  * Unregisters dev handler driver
1725  */
1726 void scst_unregister_dev_driver(struct scst_dev_type *dev_type);
1727
1728 /* 
1729  * Registers dev handler driver for virtual devices (eg VDISK)
1730  * Returns 0 on success or appropriate error code otherwise
1731  */
1732 int __scst_register_virtual_dev_driver(struct scst_dev_type *dev_type,
1733         const char *version);
1734 static inline int scst_register_virtual_dev_driver(
1735         struct scst_dev_type *dev_type)
1736 {
1737         return __scst_register_virtual_dev_driver(dev_type,
1738                 SCST_INTERFACE_VERSION);
1739 }
1740
1741 /* 
1742  * Unregisters dev handler driver for virtual devices
1743  */
1744 void scst_unregister_virtual_dev_driver(struct scst_dev_type *dev_type);
1745
1746 /* 
1747  * Creates and sends new command to SCST.
1748  * Must not be called in parallel with scst_unregister_session() for the
1749  * same sess. Returns the command on success or NULL otherwise
1750  */
1751 struct scst_cmd *scst_rx_cmd(struct scst_session *sess,
1752                              const uint8_t *lun, int lun_len,
1753                              const uint8_t *cdb, int cdb_len, int atomic);
1754
1755 /* 
1756  * Notifies SCST that the driver finished its part of the command 
1757  * initialization, and the command is ready for execution.
1758  * The second argument sets preferred command execition context. 
1759  * See SCST_CONTEXT_* constants for details.
1760  *
1761  * !!IMPORTANT!!
1762  *
1763  * If cmd->set_sn_on_restart_cmd not set, this function, as well as
1764  * scst_cmd_init_stage1_done() and scst_restart_cmd(), must not be
1765  * called simultaneously for the same session (more precisely,
1766  * for the same session/LUN, i.e. tgt_dev), i.e. they must be
1767  * somehow externally serialized. This is needed to have lock free fast path in
1768  * scst_cmd_set_sn(). For majority of targets those functions are naturally
1769  * serialized by the single source of commands. Only iSCSI immediate commands
1770  * with multiple connections per session seems to be an exception. For it, some
1771  * mutex/lock shall be used for the serialization.
1772  */
1773 void scst_cmd_init_done(struct scst_cmd *cmd, int pref_context);
1774
1775 /* 
1776  * Notifies SCST that the driver finished the first stage of the command
1777  * initialization, and the command is ready for execution, but after
1778  * SCST done the command's preprocessing preprocessing_done() function
1779  * should be called. The second argument sets preferred command execition
1780  * context. See SCST_CONTEXT_* constants for details.
1781  *
1782  * See also scst_cmd_init_done() comment for the serialization requirements.
1783  */
1784 static inline void scst_cmd_init_stage1_done(struct scst_cmd *cmd,
1785         int pref_context, int set_sn)
1786 {
1787         cmd->preprocessing_only = 1;
1788         cmd->set_sn_on_restart_cmd = !set_sn;
1789         scst_cmd_init_done(cmd, pref_context);
1790 }
1791
1792 /* 
1793  * Notifies SCST that the driver finished its part of the command's
1794  * preprocessing and it is ready for further processing.
1795  * The second argument sets data receiving completion status
1796  * (see SCST_PREPROCESS_STATUS_* constants for details)
1797  * The third argument sets preferred command execition context
1798  * (see SCST_CONTEXT_* constants for details).
1799  *
1800  * See also scst_cmd_init_done() comment for the serialization requirements.
1801  */
1802 void scst_restart_cmd(struct scst_cmd *cmd, int status, int pref_context);
1803
1804 /* 
1805  * Notifies SCST that the driver received all the necessary data 
1806  * and the command is ready for further processing.
1807  * The second argument sets data receiving completion status
1808  * (see SCST_RX_STATUS_* constants for details)
1809  * The third argument sets preferred command execition context
1810  * (see SCST_CONTEXT_* constants for details)
1811  */
1812 void scst_rx_data(struct scst_cmd *cmd, int status, int pref_context);
1813
1814 /* 
1815  * Notifies SCST that the driver sent the response and the command
1816  * can be freed now. Don't forget to set the delivery status, if it
1817  * isn't success, using scst_set_delivery_status() before calling
1818  * this function.
1819  */
1820 void scst_tgt_cmd_done(struct scst_cmd *cmd);
1821
1822 /* 
1823  * Creates new management command sends it for execution.
1824  * Must not be called in parallel with scst_unregister_session() for the 
1825  * same sess. Returns 0 for success, error code otherwise.
1826  */
1827 int scst_rx_mgmt_fn(struct scst_session *sess,
1828         const struct scst_rx_mgmt_params *params);
1829
1830 /* 
1831  * Creates new management command using tag and sends it for execution.
1832  * Can be used for SCST_ABORT_TASK only.
1833  * Must not be called in parallel with scst_unregister_session() for the 
1834  * same sess. Returns 0 for success, error code otherwise.
1835  *
1836  * Obsolete in favor of scst_rx_mgmt_fn()
1837  */
1838 static inline int scst_rx_mgmt_fn_tag(struct scst_session *sess, int fn,
1839         uint64_t tag, int atomic, void *tgt_priv)
1840 {
1841         struct scst_rx_mgmt_params params;
1842
1843         BUG_ON(fn != SCST_ABORT_TASK);
1844
1845         memset(&params, 0, sizeof(params));
1846         params.fn = fn;
1847         params.tag = tag;
1848         params.tag_set = 1;
1849         params.atomic = atomic;
1850         params.tgt_priv = tgt_priv;
1851         return scst_rx_mgmt_fn(sess, &params);
1852 }
1853
1854 /* 
1855  * Creates new management command using LUN and sends it for execution.
1856  * Currently can be used for any fn, except SCST_ABORT_TASK.
1857  * Must not be called in parallel with scst_unregister_session() for the 
1858  * same sess. Returns 0 for success, error code otherwise.
1859  *
1860  * Obsolete in favor of scst_rx_mgmt_fn()
1861  */
1862 static inline int scst_rx_mgmt_fn_lun(struct scst_session *sess, int fn,
1863         const uint8_t *lun, int lun_len, int atomic, void *tgt_priv)
1864 {
1865         struct scst_rx_mgmt_params params;
1866
1867         BUG_ON(fn == SCST_ABORT_TASK);
1868
1869         memset(&params, 0, sizeof(params));
1870         params.fn = fn;
1871         params.lun = lun;
1872         params.lun_len = lun_len;
1873         params.lun_set = 1;
1874         params.atomic = atomic;
1875         params.tgt_priv = tgt_priv;
1876         return scst_rx_mgmt_fn(sess, &params);
1877 }
1878
1879 /*
1880  * Provides various CDB info
1881  * Parameters:
1882  *   cdb_p - pointer to CDB
1883  *   dev_type - SCSI device type
1884  *   op_flags, direction, transfer_len, cdb_len, op_name - the result (output)
1885  * Returns: 0 on success, <0 if command is unknown, >0 if command is invalid.
1886  */
1887 int scst_get_cdb_info(struct scst_cmd *cmd);
1888
1889 /* 
1890  * Set error SCSI status in the command and prepares it for returning it
1891  */
1892 void scst_set_cmd_error_status(struct scst_cmd *cmd, int status);
1893
1894 /* 
1895  * Set error in the command and fill the sense buffer
1896  */
1897 void scst_set_cmd_error(struct scst_cmd *cmd, int key, int asc, int ascq);
1898
1899 /* 
1900  * Sets BUSY or TASK QUEUE FULL status
1901  */
1902 void scst_set_busy(struct scst_cmd *cmd);
1903
1904 /* 
1905  * Finds a command based on the supplied tag comparing it with one
1906  * that previously set by scst_cmd_set_tag(). 
1907  * Returns the command on success or NULL otherwise
1908  */
1909 struct scst_cmd *scst_find_cmd_by_tag(struct scst_session *sess, uint64_t tag);
1910
1911 /* 
1912  * Finds a command based on user supplied data and comparision
1913  * callback function, that should return true, if the command is found.
1914  * Returns the command on success or NULL otherwise
1915  */
1916 struct scst_cmd *scst_find_cmd(struct scst_session *sess, void *data,
1917                                int (*cmp_fn) (struct scst_cmd *cmd,
1918                                               void *data));
1919
1920 /*
1921  * Translates SCST's data direction to DMA one
1922  */
1923 static inline int scst_to_dma_dir(int scst_dir)
1924 {
1925         return scst_dir;
1926 }
1927
1928 /*
1929  * Translates SCST data direction to DMA one from the perspective
1930  * of the target device.
1931  */
1932 static inline int scst_to_tgt_dma_dir(int scst_dir)
1933 {
1934         if (scst_dir == SCST_DATA_WRITE)
1935                 return DMA_FROM_DEVICE;
1936         else if (scst_dir == SCST_DATA_READ)
1937                 return DMA_TO_DEVICE;
1938         return scst_dir;
1939 }
1940
1941 /*
1942  * Returns 1, if cmd's CDB is locally handled by SCST and 0 otherwise.
1943  * Dev handlers parse() and dev_done() not called for such commands.
1944  */
1945 static inline int scst_is_cmd_local(struct scst_cmd *cmd)
1946 {
1947         int res = 0;
1948         switch (cmd->cdb[0]) {
1949         case REPORT_LUNS:
1950                 res = 1;
1951         }
1952         return res;
1953 }
1954
1955 /*
1956  * Registers a virtual device.
1957  * Parameters:
1958  *   dev_type - the device's device handler
1959  *   dev_name - the new device name, NULL-terminated string. Must be uniq
1960  *              among all virtual devices in the system. The value isn't
1961  *              copied, only the reference is stored, so the value must
1962  *              remain valid during the device lifetime.
1963  * Returns assinged to the device ID on success, or negative value otherwise
1964  */
1965 int scst_register_virtual_device(struct scst_dev_type *dev_handler, 
1966         const char *dev_name);
1967
1968 /*
1969  * Unegisters a virtual device.
1970  * Parameters:
1971  *   id - the device's ID, returned by the registration function
1972  */
1973 void scst_unregister_virtual_device(int id);
1974
1975 /*
1976  * Get/Set functions for tgt's target private data
1977  */
1978 static inline void *scst_tgt_get_tgt_priv(struct scst_tgt *tgt)
1979 {
1980         return tgt->tgt_priv;
1981 }
1982
1983 static inline void scst_tgt_set_tgt_priv(struct scst_tgt *tgt, void *val)
1984 {
1985         tgt->tgt_priv = val;
1986 }
1987
1988 /*
1989  * Get/Set functions for session's target private data
1990  */
1991 static inline void *scst_sess_get_tgt_priv(struct scst_session *sess)
1992 {
1993         return sess->tgt_priv;
1994 }
1995
1996 static inline void scst_sess_set_tgt_priv(struct scst_session *sess,
1997                                               void *val)
1998 {
1999         sess->tgt_priv = val;
2000 }
2001
2002 /* Returns TRUE if cmd is being executed in atomic context */
2003 static inline int scst_cmd_atomic(struct scst_cmd *cmd)
2004 {
2005         int res = cmd->atomic;
2006 #ifdef EXTRACHECKS
2007         if (unlikely(in_atomic() && !res)) {
2008                 printk(KERN_ERR "ERROR: in_atomic() and non-atomic cmd\n");
2009                 dump_stack();
2010                 cmd->atomic = 1;
2011                 res = 1;
2012         }
2013 #endif
2014         return res;
2015 }
2016
2017 /* Returns cmd's session */
2018 static inline struct scst_session *scst_cmd_get_session(struct scst_cmd *cmd)
2019 {
2020         return cmd->sess;
2021 }
2022
2023 /* Returns cmd's response data length */
2024 static inline int scst_cmd_get_resp_data_len(struct scst_cmd *cmd)
2025 {
2026         return cmd->resp_data_len;
2027 }
2028
2029 /* Returns cmd's response flags (SCST_TSC_FLAG_* constants) */
2030 static inline int scst_cmd_get_tgt_resp_flags(struct scst_cmd *cmd)
2031 {
2032         return cmd->tgt_resp_flags;
2033 }
2034
2035 /*
2036  * Returns pointer to cmd's SG data buffer.
2037  *
2038  * Usage of this function is not recommended, use scst_get_buf_*()
2039  * family of functions instead.
2040  */
2041 static inline struct scatterlist *scst_cmd_get_sg(struct scst_cmd *cmd)
2042 {
2043         return cmd->sg;
2044 }
2045
2046 /*
2047  * Returns cmd's data buffer length.
2048  *
2049  * In case if you need to iterate over data in the buffer, usage of
2050  * this function is not recommended, use scst_get_buf_*()
2051  * family of functions instead.
2052  */
2053 static inline unsigned int scst_cmd_get_bufflen(struct scst_cmd *cmd)
2054 {
2055         return cmd->bufflen;
2056 }
2057
2058 /* 
2059  * Returns cmd's sg_cnt.
2060  *
2061  * Usage of this function is not recommended, use scst_get_buf_*()
2062  * family of functions instead.
2063  */
2064 static inline unsigned short scst_cmd_get_sg_cnt(struct scst_cmd *cmd)
2065 {
2066         return cmd->sg_cnt;
2067 }
2068
2069 /* Returns cmd's data direction */
2070 static inline scst_data_direction scst_cmd_get_data_direction(
2071         struct scst_cmd *cmd)
2072 {
2073         return cmd->data_direction;
2074 }
2075
2076 /* Returns cmd's relative data offset */
2077 static inline unsigned int scst_cmd_get_offset(struct scst_cmd *cmd)
2078 {
2079         return 0;
2080 }
2081
2082 /* Returns cmd's status byte from host device */
2083 static inline uint8_t scst_cmd_get_status(struct scst_cmd *cmd)
2084 {
2085         return cmd->status;
2086 }
2087
2088 /* Returns cmd's status from host adapter itself */
2089 static inline uint8_t scst_cmd_get_msg_status(struct scst_cmd *cmd)
2090 {
2091         return cmd->msg_status;
2092 }
2093
2094 /* Returns cmd's status set by low-level driver to indicate its status */
2095 static inline uint8_t scst_cmd_get_host_status(struct scst_cmd *cmd)
2096 {
2097         return cmd->host_status;
2098 }
2099
2100 /* Returns cmd's status set by SCSI mid-level */
2101 static inline uint8_t scst_cmd_get_driver_status(struct scst_cmd *cmd)
2102 {
2103         return cmd->driver_status;
2104 }
2105
2106 /* Returns pointer to cmd's sense buffer */
2107 static inline uint8_t *scst_cmd_get_sense_buffer(struct scst_cmd *cmd)
2108 {
2109         return cmd->sense;
2110 }
2111
2112 /* Returns cmd's sense buffer length */
2113 static inline int scst_cmd_get_sense_buffer_len(struct scst_cmd *cmd)
2114 {
2115         return SCST_SENSE_BUFFERSIZE;
2116 }
2117
2118 /*
2119  * Get/Set functions for cmd's target SN
2120  */
2121 static inline uint64_t scst_cmd_get_tag(struct scst_cmd *cmd)
2122 {
2123         return cmd->tag;
2124 }
2125
2126 static inline void scst_cmd_set_tag(struct scst_cmd *cmd, uint64_t tag)
2127 {
2128         cmd->tag = tag;
2129 }
2130
2131 /*
2132  * Get/Set functions for cmd's target private data.
2133  * Variant with *_lock must be used if target driver uses
2134  * scst_find_cmd() to avoid race with it, except inside scst_find_cmd()'s
2135  * callback, where lock is already taken.
2136  */
2137 static inline void *scst_cmd_get_tgt_priv(struct scst_cmd *cmd)
2138 {
2139         return cmd->tgt_priv;
2140 }
2141
2142 static inline void scst_cmd_set_tgt_priv(struct scst_cmd *cmd, void *val)
2143 {
2144         cmd->tgt_priv = val;
2145 }
2146
2147 void *scst_cmd_get_tgt_priv_lock(struct scst_cmd *cmd);
2148 void scst_cmd_set_tgt_priv_lock(struct scst_cmd *cmd, void *val);
2149
2150 /*
2151  * Get/Set functions for data_buf_tgt_alloc flag
2152  */
2153 static inline int scst_cmd_get_data_buf_tgt_alloc(struct scst_cmd *cmd)
2154 {
2155         return cmd->data_buf_tgt_alloc;
2156 }
2157
2158 static inline void scst_cmd_set_data_buf_tgt_alloc(struct scst_cmd *cmd)
2159 {
2160         cmd->data_buf_tgt_alloc = 1;
2161 }
2162
2163 /*
2164  * Get/Set functions for data_buf_alloced flag
2165  */
2166 static inline int scst_cmd_get_data_buff_alloced(struct scst_cmd *cmd)
2167 {
2168         return cmd->data_buf_alloced;
2169 }
2170
2171 static inline void scst_cmd_set_data_buff_alloced(struct scst_cmd *cmd)
2172 {
2173         cmd->data_buf_alloced = 1;
2174 }
2175
2176 /*
2177  * Get/Set functions for no_sgv flag
2178  */
2179 static inline int scst_cmd_get_no_sgv(struct scst_cmd *cmd)
2180 {
2181         return cmd->no_sgv;
2182 }
2183
2184 static inline void scst_cmd_set_no_sgv(struct scst_cmd *cmd)
2185 {
2186         cmd->no_sgv = 1;
2187 }
2188
2189 /*
2190  * Get/Set functions for tgt_sn
2191  */
2192 static inline int scst_cmd_get_tgt_sn(struct scst_cmd *cmd)
2193 {
2194         BUG_ON(!cmd->tgt_sn_set);
2195         return cmd->tgt_sn;
2196 }
2197
2198 static inline void scst_cmd_set_tgt_sn(struct scst_cmd *cmd, uint32_t tgt_sn)
2199 {
2200         cmd->tgt_sn_set = 1;
2201         cmd->tgt_sn = tgt_sn;
2202 }
2203
2204
2205 /*
2206  * Returns 1 if the cmd was aborted, so its status is invalid and no
2207  * reply shall be sent to the remote initiator. A target driver should
2208  * only clear internal resources, associated with cmd.
2209  */
2210 static inline int scst_cmd_aborted(struct scst_cmd *cmd)
2211 {
2212         return test_bit(SCST_CMD_ABORTED, &cmd->cmd_flags) &&
2213                 !test_bit(SCST_CMD_ABORTED_OTHER, &cmd->cmd_flags);
2214 }
2215
2216 /*
2217  * Get/Set functions for expected data direction, transfer length
2218  * and its validity flag
2219  */
2220 static inline int scst_cmd_is_expected_set(struct scst_cmd *cmd)
2221 {
2222         return cmd->expected_values_set;
2223 }
2224  
2225 static inline scst_data_direction scst_cmd_get_expected_data_direction(
2226         struct scst_cmd *cmd)
2227 {
2228         return cmd->expected_data_direction;
2229 }
2230
2231 static inline int scst_cmd_get_expected_transfer_len(
2232         struct scst_cmd *cmd)
2233 {
2234         return cmd->expected_transfer_len;
2235 }
2236
2237 static inline void scst_cmd_set_expected(struct scst_cmd *cmd,
2238         scst_data_direction expected_data_direction,
2239         int expected_transfer_len)
2240 {
2241         cmd->expected_data_direction = expected_data_direction;
2242         cmd->expected_transfer_len = expected_transfer_len;
2243         cmd->expected_values_set = 1;
2244 }
2245
2246 /*
2247  * Get/clear functions for cmd's may_need_dma_sync
2248  */
2249 static inline int scst_get_may_need_dma_sync(struct scst_cmd *cmd)
2250 {
2251         return cmd->may_need_dma_sync;
2252 }
2253
2254 static inline void scst_clear_may_need_dma_sync(struct scst_cmd *cmd)
2255 {
2256         cmd->may_need_dma_sync = 0;
2257 }
2258
2259 /*
2260  * Get/clear functions for cmd's delivery_status. It is one of
2261  * SCST_CMD_DELIVERY_* constants, it specifies the status of the
2262  * command's delivery to initiator.
2263  */
2264 static inline int scst_get_delivery_status(struct scst_cmd *cmd)
2265 {
2266         return cmd->delivery_status;
2267 }
2268
2269 static inline void scst_set_delivery_status(struct scst_cmd *cmd,
2270         int delivery_status)
2271 {
2272         cmd->delivery_status = delivery_status;
2273 }
2274
2275 /*
2276  * Get/set/clear functions for cmd's long XMIT flag.
2277  */
2278 static inline int scst_get_long_xmit(struct scst_cmd *cmd)
2279 {
2280         return cmd->long_xmit;
2281 }
2282
2283 static inline void scst_set_long_xmit(struct scst_cmd *cmd)
2284 {
2285         cmd->long_xmit = 1;
2286 }
2287
2288 static inline void scst_clear_long_xmit(struct scst_cmd *cmd)
2289 {
2290         cmd->long_xmit = 0;
2291 }
2292
2293 /*
2294  * Get/Set function for mgmt cmd's target private data
2295  */
2296 static inline void *scst_mgmt_cmd_get_tgt_priv(struct scst_mgmt_cmd *mcmd)
2297 {
2298         return mcmd->tgt_priv;
2299 }
2300
2301 static inline void scst_mgmt_cmd_set_tgt_priv(struct scst_mgmt_cmd *mcmd,
2302         void *val)
2303 {
2304         mcmd->tgt_priv = val;
2305 }
2306
2307 /*
2308  * Returns mgmt cmd's completition status (SCST_MGMT_STATUS_* constants)
2309  */
2310 static inline int scst_mgmt_cmd_get_status(struct scst_mgmt_cmd *mcmd)
2311 {
2312         return mcmd->status;
2313 }
2314
2315 /*
2316  * Returns mgmt cmd's TM fn
2317  */
2318 static inline int scst_mgmt_cmd_get_fn(struct scst_mgmt_cmd *mcmd)
2319 {
2320         return mcmd->fn;
2321 }
2322
2323 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24)
2324
2325 static inline struct page *sg_page(struct scatterlist *sg)
2326 {
2327         return sg->page;
2328 }
2329
2330 static inline void *sg_virt(struct scatterlist *sg)
2331 {
2332         return page_address(sg_page(sg)) + sg->offset;
2333 }
2334
2335 static inline void sg_init_table(struct scatterlist *sgl, unsigned int nents)
2336 {
2337         memset(sgl, 0, sizeof(*sgl) * nents);
2338 }
2339
2340 static inline void sg_assign_page(struct scatterlist *sg, struct page *page)
2341 {
2342         sg->page = page;
2343 }
2344
2345 static inline void sg_set_page(struct scatterlist *sg, struct page *page,
2346                                unsigned int len, unsigned int offset)
2347 {
2348         sg_assign_page(sg, page);
2349         sg->offset = offset;
2350         sg->length = len;
2351 }
2352
2353 static inline void sg_set_buf(struct scatterlist *sg, const void *buf,
2354                               unsigned int buflen)
2355 {
2356         sg_set_page(sg, virt_to_page(buf), buflen, offset_in_page(buf));
2357 }
2358
2359 #endif /* LINUX_VERSION_CODE < KERNEL_VERSION(2,6,24) */
2360
2361 static inline void sg_clear(struct scatterlist *sg)
2362 {
2363         memset(sg, 0, sizeof(*sg));
2364 #ifdef CONFIG_DEBUG_SG
2365         sg->sg_magic = SG_MAGIC;
2366 #endif
2367 }
2368
2369 /*
2370  * Functions for access to the commands data (SG) buffer,
2371  * including HIGHMEM environment. Should be used instead of direct
2372  * access. Returns the mapped buffer length for success, 0 for EOD,
2373  * negative error code otherwise. 
2374  *
2375  * "Buf" argument returns the mapped buffer
2376  *
2377  * The "put" function unmaps the buffer.
2378  */
2379 static inline int __scst_get_buf(struct scst_cmd *cmd, uint8_t **buf)
2380 {
2381         int res = 0;
2382         struct scatterlist *sg = cmd->sg;
2383         int i = cmd->get_sg_buf_entry_num;
2384         
2385         *buf = NULL;
2386         
2387         if ((i >= cmd->sg_cnt) || unlikely(sg == NULL))
2388                 goto out;
2389 #ifdef SCST_HIGHMEM /* HIGHMEM isn't currently supported */
2390         /* 
2391          * HIGHMEM pages not merged (clustered), so if it's 
2392          * not HIGHMEM page, kmap() is the same as page_address()
2393          */
2394         if (scst_cmd_atomic(cmd)) {
2395                 enum km_type km;
2396                 if (in_softirq())
2397                         km = KM_SOFTIRQ0;
2398                 else
2399                         km = KM_USER0;
2400                 *buf = kmap_atomic(sg[i].page, km);
2401         } else
2402                 *buf = kmap(sg[i].page);
2403 #else
2404         *buf = page_address(sg_page(&sg[i]));
2405 #endif
2406         *buf += sg[i].offset;
2407         res = sg[i].length;
2408         cmd->get_sg_buf_entry_num++;
2409         
2410 out:
2411         return res;
2412 }
2413
2414 static inline int scst_get_buf_first(struct scst_cmd *cmd, uint8_t **buf)
2415 {
2416         cmd->get_sg_buf_entry_num = 0;
2417         cmd->may_need_dma_sync = 1;
2418         return __scst_get_buf(cmd, buf);
2419 }
2420
2421 static inline int scst_get_buf_next(struct scst_cmd *cmd, uint8_t **buf)
2422 {
2423         return __scst_get_buf(cmd, buf);
2424 }
2425
2426 static inline void scst_put_buf(struct scst_cmd *cmd, void *buf)
2427 {
2428 #ifdef SCST_HIGHMEM /* HIGHMEM isn't currently supported */
2429         if (cmd->sg_cnt) {
2430                 if (scst_cmd_atomic(cmd)) {
2431                         enum km_type km;
2432                         BUG_ON(in_irq());
2433                         if (in_softirq())
2434                                 km = KM_SOFTIRQ0;
2435                         else
2436                                 km = KM_USER0;
2437                         kunmap_atomic(buf, km);
2438                 } else
2439                         kunmap(buf);
2440         }
2441 #endif
2442 }
2443
2444 /*
2445  * Returns approximate higher rounded buffers count that 
2446  * scst_get_buf_[first|next]() return.
2447  */
2448 static inline int scst_get_buf_count(struct scst_cmd *cmd)
2449 {
2450         int res;
2451 #ifdef SCST_HIGHMEM
2452         res = (cmd->bufflen >> PAGE_SHIFT) + 1;
2453 #else
2454         res = (cmd->sg_cnt == 0) ? 1 : cmd->sg_cnt;
2455 #endif
2456         return res;
2457 }
2458
2459 /* 
2460  * Suspends and resumes any activity. 
2461  * scst_suspend_activity() doesn't return until there are any
2462  * active commands (state after SCST_CMD_STATE_INIT). New arriving
2463  * commands stay in that state until scst_resume_activity() is called.
2464  */
2465 void scst_suspend_activity(void);
2466 void scst_resume_activity(void);
2467
2468 /*
2469  * Main SCST commands processing routing. Must be used only by dev handlers.
2470  * Argument context sets the execution context, only SCST_CONTEXT_DIRECT and
2471  * SCST_CONTEXT_DIRECT_ATOMIC with optional SCST_CONTEXT_PROCESSABLE flag
2472  * are allowed.
2473  */
2474 void scst_process_active_cmd(struct scst_cmd *cmd, int context);
2475
2476 /*
2477  * Checks if command can be executed (reservations, etc.) or there are local
2478  * events, like pending UAs. Returns < 0 if command must be aborted, > 0 if
2479  * there is an event and command should be immediately completed, or 0
2480  * otherwise.
2481  *
2482  * !! Dev handlers implementing exec() callback must call this function there !!
2483  * !! just before the actual command's execution                              !!
2484  */
2485 int scst_check_local_events(struct scst_cmd *cmd);
2486
2487 /* 
2488  * Returns target driver's root entry in SCST's /proc hierarchy.
2489  * The driver can create own files/directoryes here, which should
2490  * be deleted in the driver's release().
2491  */
2492 static inline struct proc_dir_entry *scst_proc_get_tgt_root(
2493         struct scst_tgt_template *vtt)
2494 {
2495         return vtt->proc_tgt_root;
2496 }
2497
2498 /* 
2499  * Returns device handler's root entry in SCST's /proc hierarchy.
2500  * The driver can create own files/directoryes here, which should
2501  * be deleted in the driver's detach()/release().
2502  */
2503 static inline struct proc_dir_entry *scst_proc_get_dev_type_root(
2504         struct scst_dev_type *dtt)
2505 {
2506         return dtt->proc_dev_type_root;
2507 }
2508
2509 /**
2510  ** Two library functions and the structure to help the drivers 
2511  ** that use scst_debug.* facilities manage "trace_level" /proc entry.
2512  ** The functions service "standard" log levels and allow to work
2513  ** with driver specific levels, which should be passed inside as
2514  ** NULL-terminated array of struct scst_proc_log's, where:
2515  **   - val - the level's numeric value
2516  **   - token - its string representation
2517  **/
2518
2519 struct scst_proc_log {
2520         unsigned int val;
2521         const char *token;
2522 };
2523
2524 int scst_proc_log_entry_read(struct seq_file *seq, unsigned long log_level, 
2525         const struct scst_proc_log *tbl);
2526
2527 int scst_proc_log_entry_write(struct file *file, const char *buf,
2528         unsigned long length, unsigned long *log_level,
2529         unsigned long default_level, const struct scst_proc_log *tbl);
2530
2531 /*
2532  * helper data structure and function to create proc entry.
2533  */
2534 struct scst_proc_data {
2535         struct file_operations seq_op;
2536         int (*show)(struct seq_file *, void *);
2537         void *data;
2538 };
2539
2540 int scst_single_seq_open(struct inode *inode, struct file *file);
2541
2542 struct proc_dir_entry *scst_create_proc_entry(struct proc_dir_entry * root,
2543         const char *name, struct scst_proc_data *pdata);
2544
2545 #define SCST_DEF_RW_SEQ_OP(x)                          \
2546         .seq_op = {                                    \
2547                 .owner          = THIS_MODULE,         \
2548                 .open           = scst_single_seq_open,\
2549                 .read           = seq_read,            \
2550                 .write          = x,                   \
2551                 .llseek         = seq_lseek,           \
2552                 .release        = single_release,      \
2553         },
2554
2555 /*
2556  * Adds and deletes (stops) num SCST's threads. Returns 0 on success,
2557  * error code otherwise.
2558  */
2559 int scst_add_cmd_threads(int num);
2560 void scst_del_cmd_threads(int num);
2561
2562 int scst_alloc_sense(struct scst_cmd *cmd, int atomic);
2563 int scst_alloc_set_sense(struct scst_cmd *cmd, int atomic,
2564         const uint8_t *sense, unsigned int len);
2565
2566 void scst_set_sense(uint8_t *buffer, int len, int key,
2567         int asc, int ascq);
2568
2569 void scst_set_cmd_error_sense(struct scst_cmd *cmd, uint8_t *sense, 
2570         unsigned int len);
2571
2572 /*
2573  * Returnes a pseudo-random number for debugging purposes. Available only with
2574  * DEBUG on
2575  */
2576 unsigned long scst_random(void);
2577
2578 /*
2579  * Sets response data length for cmd and truncates its SG vector accordingly.
2580  * The cmd->resp_data_len must not be set directly, it must be set only
2581  * using this function. Value of resp_data_len must be <= cmd->bufflen.
2582  */
2583 void scst_set_resp_data_len(struct scst_cmd *cmd, int resp_data_len);
2584
2585 /*
2586  * Checks if total memory allocated by commands is less, than defined
2587  * limit (scst_cur_max_cmd_mem) and returns 0, if it is so. Otherwise,
2588  * returnes 1 and sets on cmd QUEUE FULL or BUSY status as well as
2589  * SCST_CMD_STATE_PRE_XMIT_RESP state. Target drivers and dev handlers are
2590  * required to call this function if they allocate data buffers on their
2591  * own.
2592  */
2593 int scst_check_mem(struct scst_cmd *cmd);
2594
2595 /* 
2596  * Get/put global ref counter that prevents from entering into suspended
2597  * activities stage, so protects from any global management operations.
2598  */
2599 void scst_get(void);
2600 void scst_put(void);
2601
2602 /* 
2603  * Cmd ref counters
2604  */
2605 void scst_cmd_get(struct scst_cmd *cmd);
2606 void scst_cmd_put(struct scst_cmd *cmd);
2607
2608 /*
2609  * Allocates and returns pointer to SG vector with data size "size".
2610  * In *count returned the count of entries in the vector.
2611  * Returns NULL for failure.
2612  */
2613 struct scatterlist *scst_alloc(int size, unsigned long gfp_mask, int *count);
2614
2615 /* Frees SG vector returned by scst_alloc() */
2616 void scst_free(struct scatterlist *sg, int count);
2617
2618 /*
2619  * Adds local to the current thread data to tgt_dev 
2620  * (they will be local for the tgt_dev and current thread).
2621  */
2622 void scst_add_thr_data(struct scst_tgt_dev *tgt_dev,
2623         struct scst_thr_data_hdr *data,
2624         void (*free_fn) (struct scst_thr_data_hdr *data));
2625
2626 /* Deletes all local to threads data from tgt_dev */
2627 void scst_del_all_thr_data(struct scst_tgt_dev *tgt_dev);
2628
2629 /* Deletes all local to threads data from all tgt_dev's of the dev */
2630 void scst_dev_del_all_thr_data(struct scst_device *dev);
2631
2632 /* Finds local to the current thread data. Returns NULL, if they not found. */
2633 struct scst_thr_data_hdr *scst_find_thr_data(struct scst_tgt_dev *tgt_dev);
2634
2635 static inline void scst_thr_data_get(struct scst_thr_data_hdr *data)
2636 {
2637         atomic_inc(&data->ref);
2638 }
2639
2640 static inline void scst_thr_data_put(struct scst_thr_data_hdr *data)
2641 {
2642         if (atomic_dec_and_test(&data->ref))
2643                 data->free_fn(data);
2644 }
2645
2646 /* SGV pool routines and flag bits */
2647
2648 /* Set if the allocated object must be not from the cache */
2649 #define SCST_POOL_ALLOC_NO_CACHED               1
2650
2651 /* Set if there should not be any memory allocations on a cache miss */
2652 #define SCST_POOL_NO_ALLOC_ON_CACHE_MISS        2
2653
2654 /* Set an object should be returned even if it doesn't have SG vector built */
2655 #define SCST_POOL_RETURN_OBJ_ON_ALLOC_FAIL      4
2656
2657 struct sgv_pool_obj;
2658 struct sgv_pool;
2659
2660 struct sgv_pool *sgv_pool_create(const char *name, int clustered);
2661 void sgv_pool_destroy(struct sgv_pool *pool);
2662
2663 void sgv_pool_set_allocator(struct sgv_pool *pool,
2664         struct page *(*alloc_pages_fn)(struct scatterlist *, gfp_t, void *),
2665         void (*free_pages_fn)(struct scatterlist *, int, void *));
2666
2667 struct scatterlist *sgv_pool_alloc(struct sgv_pool *pool, unsigned int size,
2668         unsigned long gfp_mask, int atomic, int *count,
2669         struct sgv_pool_obj **sgv, void *priv);
2670 void sgv_pool_free(struct sgv_pool_obj *sgv);
2671
2672 void *sgv_get_priv(struct sgv_pool_obj *sgv);
2673
2674 /**
2675  ** Generic parse() support routines.
2676  ** Done via pointer on functions to avoid unneeded dereferences on
2677  ** the fast path.
2678  **/
2679
2680 /* Calculates and returns block shift for the given sector size */
2681 int scst_calc_block_shift(int sector_size);
2682
2683 /* Generic parse() for SBC (disk) devices */
2684 int scst_sbc_generic_parse(struct scst_cmd *cmd,
2685         int (*get_block_shift)(struct scst_cmd *cmd));
2686
2687 /* Generic parse() for MMC (cdrom) devices */
2688 int scst_cdrom_generic_parse(struct scst_cmd *cmd,
2689         int (*get_block_shift)(struct scst_cmd *cmd));
2690
2691 /* Generic parse() for MO disk devices */
2692 int scst_modisk_generic_parse(struct scst_cmd *cmd,
2693         int (*get_block_shift)(struct scst_cmd *cmd));
2694
2695 /* Generic parse() for tape devices */
2696 int scst_tape_generic_parse(struct scst_cmd *cmd,
2697         int (*get_block_size)(struct scst_cmd *cmd));
2698
2699 /* Generic parse() for changer devices */
2700 int scst_changer_generic_parse(struct scst_cmd *cmd,
2701         int (*nothing)(struct scst_cmd *cmd));
2702
2703 /* Generic parse() for "processor" devices */
2704 int scst_processor_generic_parse(struct scst_cmd *cmd,
2705         int (*nothing)(struct scst_cmd *cmd));
2706
2707 /* Generic parse() for RAID devices */
2708 int scst_raid_generic_parse(struct scst_cmd *cmd,
2709         int (*nothing)(struct scst_cmd *cmd));
2710
2711 /**
2712  ** Generic dev_done() support routines.
2713  ** Done via pointer on functions to avoid unneeded dereferences on
2714  ** the fast path.
2715  **/
2716
2717 /* Generic dev_done() for block devices */
2718 int scst_block_generic_dev_done(struct scst_cmd *cmd,
2719         void (*set_block_shift)(struct scst_cmd *cmd, int block_shift));
2720
2721 /* Generic dev_done() for tape devices */
2722 int scst_tape_generic_dev_done(struct scst_cmd *cmd,
2723         void (*set_block_size)(struct scst_cmd *cmd, int block_size));
2724
2725 /*
2726  * Issues a MODE SENSE for control mode page data and sets the corresponding
2727  * dev's parameter from it. Returns 0 on success and not 0 otherwise.
2728  */
2729 int scst_obtain_device_parameters(struct scst_device *dev);
2730
2731 #endif /* __SCST_H */