include/scsi/scsi_transport_srp.h

   1 #ifndef SCSI_TRANSPORT_SRP_H
   2 #define SCSI_TRANSPORT_SRP_H
   3
   4 #include <linux/transport_class.h>
   5 #include <linux/types.h>
   6 #include <linux/mutex.h>
   7
   8 #define SRP_RPORT_ROLE_INITIATOR 0
   9 #define SRP_RPORT_ROLE_TARGET 1
  10
  11 struct srp_rport_identifiers {
  12         u8 port_id[16];
  13         u8 roles;
  14 };
  15
  16 /**
  17  * enum srp_rport_state - SRP transport layer state
  18  * @SRP_RPORT_RUNNING:   Transport layer operational.
  19  * @SRP_RPORT_BLOCKED:   Transport layer not operational; fast I/O fail timer
  20  *                       is running and I/O has been blocked.
  21  * @SRP_RPORT_FAIL_FAST: Fast I/O fail timer has expired; fail I/O fast.
  22  * @SRP_RPORT_LOST:      Device loss timer has expired; port is being removed.
  23  */
  24 enum srp_rport_state {
  25         SRP_RPORT_RUNNING,
  26         SRP_RPORT_BLOCKED,
  27         SRP_RPORT_FAIL_FAST,
  28         SRP_RPORT_LOST,
  29 };
  30
  31 /**
  32  * struct srp_rport
  33  * @lld_data: LLD private data.
  34  * @mutex:    Protects against concurrent rport fast_io_fail / dev_loss_tmo.
  35  */
  36 struct srp_rport {
  37         /* for initiator and target drivers */
  38
  39         struct device dev;
  40
  41         u8 port_id[16];
  42         u8 roles;
  43
  44         /* for initiator drivers */
  45
  46         void                    *lld_data;
  47
  48         struct mutex            mutex;
  49         enum srp_rport_state    state;
  50         bool                    deleted;
  51         int                     fast_io_fail_tmo;
  52         int                     dev_loss_tmo;
  53         struct delayed_work     fast_io_fail_work;
  54         struct delayed_work     dev_loss_work;
  55 };
  56
  57 /**
  58  * struct srp_function_template
  59  * @has_rport_state: Whether or not to create the state, fast_io_fail_tmo and
  60  *     dev_loss_tmo sysfs attribute for an rport.
  61  * @reset_timer_if_blocked: Whether or srp_timed_out() should reset the command
  62  *     timer if the device on which it has been queued is blocked.
  63  * @fast_io_fail_tmo: If not NULL, points to the default fast_io_fail_tmo value.
  64  * @dev_loss_tmo: If not NULL, points to the default dev_loss_tmo value.
  65  * @reconnect: Callback function for reconnecting to the target. See also
  66  *     srp_reconnect_rport().
  67  * @terminate_rport_io: Callback function for terminating all outstanding I/O
  68  *     requests for an rport.
  69  */
  70 struct srp_function_template {
  71         /* for initiator drivers */
  72         bool has_rport_state;
  73         bool reset_timer_if_blocked;
  74         int *fast_io_fail_tmo;
  75         int *dev_loss_tmo;
  76         int (*reconnect)(struct srp_rport *rport);
  77         void (*terminate_rport_io)(struct srp_rport *rport);
  78         void (*rport_delete)(struct srp_rport *rport);
  79         /* for target drivers */
  80         int (* tsk_mgmt_response)(struct Scsi_Host *, u64, u64, int);
  81         int (* it_nexus_response)(struct Scsi_Host *, u64, int);
  82 };
  83
  84 extern struct scsi_transport_template *
  85 srp_attach_transport(struct srp_function_template *);
  86 extern void srp_release_transport(struct scsi_transport_template *);
  87
  88 extern void srp_rport_get(struct srp_rport *rport);
  89 extern void srp_rport_put(struct srp_rport *rport);
  90 extern struct srp_rport *srp_rport_add(struct Scsi_Host *,
  91                                        struct srp_rport_identifiers *);
  92 extern void srp_rport_del(struct srp_rport *);
  93 extern int srp_tmo_valid(int fast_io_fail_tmo, int dev_loss_tmo);
  94 extern int srp_reconnect_rport(struct srp_rport *rport);
  95 extern void srp_start_tl_fail_timers(struct srp_rport *rport);
  96 extern void srp_remove_host(struct Scsi_Host *);
  97
  98 /**
  99  * srp_chkready() - evaluate the transport layer state before I/O
 100  *
 101  * Returns a SCSI result code that can be returned by the LLD queuecommand()
 102  * implementation. The role of this function is similar to that of
 103  * fc_remote_port_chkready().
 104  */
 105 static inline int srp_chkready(struct srp_rport *rport)
 106 {
 107         switch (rport->state) {
 108         case SRP_RPORT_RUNNING:
 109         case SRP_RPORT_BLOCKED:
 110         default:
 111                 return 0;
 112         case SRP_RPORT_FAIL_FAST:
 113                 return DID_TRANSPORT_FAILFAST << 16;
 114         case SRP_RPORT_LOST:
 115                 return DID_NO_CONNECT << 16;
 116         }
 117 }
 118
 119 #endif