1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Header file for SCSI device handler infrastruture.
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Modified version of patches posted by Mike Christie <michaelc@cs.wisc.edu>
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Copyright IBM Corporation, 2007
8*4882a593Smuzhiyun * Authors:
9*4882a593Smuzhiyun * Chandra Seetharaman <sekharan@us.ibm.com>
10*4882a593Smuzhiyun * Mike Anderson <andmike@linux.vnet.ibm.com>
11*4882a593Smuzhiyun */
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #include <scsi/scsi_device.h>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun enum {
16*4882a593Smuzhiyun SCSI_DH_OK = 0,
17*4882a593Smuzhiyun /*
18*4882a593Smuzhiyun * device errors
19*4882a593Smuzhiyun */
20*4882a593Smuzhiyun SCSI_DH_DEV_FAILED, /* generic device error */
21*4882a593Smuzhiyun SCSI_DH_DEV_TEMP_BUSY,
22*4882a593Smuzhiyun SCSI_DH_DEV_UNSUPP, /* device handler not supported */
23*4882a593Smuzhiyun SCSI_DH_DEVICE_MAX, /* max device blkerr definition */
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun /*
26*4882a593Smuzhiyun * transport errors
27*4882a593Smuzhiyun */
28*4882a593Smuzhiyun SCSI_DH_NOTCONN = SCSI_DH_DEVICE_MAX + 1,
29*4882a593Smuzhiyun SCSI_DH_CONN_FAILURE,
30*4882a593Smuzhiyun SCSI_DH_TRANSPORT_MAX, /* max transport blkerr definition */
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun /*
33*4882a593Smuzhiyun * driver and generic errors
34*4882a593Smuzhiyun */
35*4882a593Smuzhiyun SCSI_DH_IO = SCSI_DH_TRANSPORT_MAX + 1, /* generic error */
36*4882a593Smuzhiyun SCSI_DH_INVALID_IO,
37*4882a593Smuzhiyun SCSI_DH_RETRY, /* retry the req, but not immediately */
38*4882a593Smuzhiyun SCSI_DH_IMM_RETRY, /* immediately retry the req */
39*4882a593Smuzhiyun SCSI_DH_TIMED_OUT,
40*4882a593Smuzhiyun SCSI_DH_RES_TEMP_UNAVAIL,
41*4882a593Smuzhiyun SCSI_DH_DEV_OFFLINED,
42*4882a593Smuzhiyun SCSI_DH_NOMEM,
43*4882a593Smuzhiyun SCSI_DH_NOSYS,
44*4882a593Smuzhiyun SCSI_DH_DRIVER_MAX,
45*4882a593Smuzhiyun };
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun typedef void (*activate_complete)(void *, int);
48*4882a593Smuzhiyun struct scsi_device_handler {
49*4882a593Smuzhiyun /* Used by the infrastructure */
50*4882a593Smuzhiyun struct list_head list; /* list of scsi_device_handlers */
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun /* Filled by the hardware handler */
53*4882a593Smuzhiyun struct module *module;
54*4882a593Smuzhiyun const char *name;
55*4882a593Smuzhiyun int (*check_sense)(struct scsi_device *, struct scsi_sense_hdr *);
56*4882a593Smuzhiyun int (*attach)(struct scsi_device *);
57*4882a593Smuzhiyun void (*detach)(struct scsi_device *);
58*4882a593Smuzhiyun int (*activate)(struct scsi_device *, activate_complete, void *);
59*4882a593Smuzhiyun blk_status_t (*prep_fn)(struct scsi_device *, struct request *);
60*4882a593Smuzhiyun int (*set_params)(struct scsi_device *, const char *);
61*4882a593Smuzhiyun void (*rescan)(struct scsi_device *);
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun #ifdef CONFIG_SCSI_DH
65*4882a593Smuzhiyun extern int scsi_dh_activate(struct request_queue *, activate_complete, void *);
66*4882a593Smuzhiyun extern int scsi_dh_attach(struct request_queue *, const char *);
67*4882a593Smuzhiyun extern const char *scsi_dh_attached_handler_name(struct request_queue *, gfp_t);
68*4882a593Smuzhiyun extern int scsi_dh_set_params(struct request_queue *, const char *);
69*4882a593Smuzhiyun #else
scsi_dh_activate(struct request_queue * req,activate_complete fn,void * data)70*4882a593Smuzhiyun static inline int scsi_dh_activate(struct request_queue *req,
71*4882a593Smuzhiyun activate_complete fn, void *data)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun fn(data, 0);
74*4882a593Smuzhiyun return 0;
75*4882a593Smuzhiyun }
scsi_dh_attach(struct request_queue * req,const char * name)76*4882a593Smuzhiyun static inline int scsi_dh_attach(struct request_queue *req, const char *name)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun return SCSI_DH_NOSYS;
79*4882a593Smuzhiyun }
scsi_dh_attached_handler_name(struct request_queue * q,gfp_t gfp)80*4882a593Smuzhiyun static inline const char *scsi_dh_attached_handler_name(struct request_queue *q,
81*4882a593Smuzhiyun gfp_t gfp)
82*4882a593Smuzhiyun {
83*4882a593Smuzhiyun return NULL;
84*4882a593Smuzhiyun }
scsi_dh_set_params(struct request_queue * req,const char * params)85*4882a593Smuzhiyun static inline int scsi_dh_set_params(struct request_queue *req, const char *params)
86*4882a593Smuzhiyun {
87*4882a593Smuzhiyun return -SCSI_DH_NOSYS;
88*4882a593Smuzhiyun }
89*4882a593Smuzhiyun #endif
90