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