LXR linux/include/scsi/scsi_transport

   1/*
   2 * iSCSI transport class definitions
   3 *
   4 * Copyright (C) IBM Corporation, 2004
   5 * Copyright (C) Mike Christie, 2004 - 2006
   6 * Copyright (C) Dmitry Yusupov, 2004 - 2005
   7 * Copyright (C) Alex Aizman, 2004 - 2005
   8 *
   9 * This program is free software; you can redistribute it and/or modify
  10 * it under the terms of the GNU General Public License as published by
  11 * the Free Software Foundation; either version 2 of the License, or
  12 * (at your option) any later version.
  13 *
  14 * This program is distributed in the hope that it will be useful,
  15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 * GNU General Public License for more details.
  18 *
  19 * You should have received a copy of the GNU General Public License
  20 * along with this program; if not, write to the Free Software
  21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22 */
  23#ifndef SCSI_TRANSPORT_ISCSI_H
  24#define SCSI_TRANSPORT_ISCSI_H
  25
  26#include <linux/device.h>
  27#include <linux/list.h>
  28#include <linux/mutex.h>
  29#include <scsi/iscsi_if.h>
  30
  31struct scsi_transport_template;
  32struct iscsi_transport;
  33struct iscsi_endpoint;
  34struct Scsi_Host;
  35struct scsi_cmnd;
  36struct iscsi_cls_conn;
  37struct iscsi_conn;
  38struct iscsi_task;
  39struct sockaddr;
  40struct iscsi_iface;
  41struct bsg_job;
  42struct iscsi_bus_flash_session;
  43struct iscsi_bus_flash_conn;
  44
  45/**
  46 * struct iscsi_transport - iSCSI Transport template
  47 *
  48 * @name:               transport name
  49 * @caps:               iSCSI Data-Path capabilities
  50 * @create_session:     create new iSCSI session object
  51 * @destroy_session:    destroy existing iSCSI session object
  52 * @create_conn:        create new iSCSI connection
  53 * @bind_conn:          associate this connection with existing iSCSI session
  54 *                      and specified transport descriptor
  55 * @destroy_conn:       destroy inactive iSCSI connection
  56 * @set_param:          set iSCSI parameter. Return 0 on success, -ENODATA
  57 *                      when param is not supported, and a -Exx value on other
  58 *                      error.
  59 * @get_param           get iSCSI parameter. Must return number of bytes
  60 *                      copied to buffer on success, -ENODATA when param
  61 *                      is not supported, and a -Exx value on other error
  62 * @start_conn:         set connection to be operational
  63 * @stop_conn:          suspend/recover/terminate connection
  64 * @send_pdu:           send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
  65 * @session_recovery_timedout: notify LLD a block during recovery timed out
  66 * @init_task:          Initialize a iscsi_task and any internal structs.
  67 *                      When offloading the data path, this is called from
  68 *                      queuecommand with the session lock, or from the
  69 *                      iscsi_conn_send_pdu context with the session lock.
  70 *                      When not offloading the data path, this is called
  71 *                      from the scsi work queue without the session lock.
  72 * @xmit_task           Requests LLD to transfer cmd task. Returns 0 or the
  73 *                      the number of bytes transferred on success, and -Exyz
  74 *                      value on error. When offloading the data path, this
  75 *                      is called from queuecommand with the session lock, or
  76 *                      from the iscsi_conn_send_pdu context with the session
  77 *                      lock. When not offloading the data path, this is called
  78 *                      from the scsi work queue without the session lock.
  79 * @cleanup_task:       requests LLD to fail task. Called with session lock
  80 *                      and after the connection has been suspended and
  81 *                      terminated during recovery. If called
  82 *                      from abort task then connection is not suspended
  83 *                      or terminated but sk_callback_lock is held
  84 *
  85 * Template API provided by iSCSI Transport
  86 */
  87struct iscsi_transport {
  88        struct module *owner;
  89        char *name;
  90        unsigned int caps;
  91
  92        struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
  93                                        uint16_t cmds_max, uint16_t qdepth,
  94                                        uint32_t sn);
  95        void (*destroy_session) (struct iscsi_cls_session *session);
  96        struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
  97                                uint32_t cid);
  98        int (*bind_conn) (struct iscsi_cls_session *session,
  99                          struct iscsi_cls_conn *cls_conn,
 100                          uint64_t transport_eph, int is_leading);
 101        int (*start_conn) (struct iscsi_cls_conn *conn);
 102        void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
 103        void (*destroy_conn) (struct iscsi_cls_conn *conn);
 104        int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
 105                          char *buf, int buflen);
 106        int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
 107                             char *buf);
 108        int (*get_conn_param) (struct iscsi_cls_conn *conn,
 109                               enum iscsi_param param, char *buf);
 110        int (*get_session_param) (struct iscsi_cls_session *session,
 111                                  enum iscsi_param param, char *buf);
 112        int (*get_host_param) (struct Scsi_Host *shost,
 113                                enum iscsi_host_param param, char *buf);
 114        int (*set_host_param) (struct Scsi_Host *shost,
 115                               enum iscsi_host_param param, char *buf,
 116                               int buflen);
 117        int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
 118                         char *data, uint32_t data_size);
 119        void (*get_stats) (struct iscsi_cls_conn *conn,
 120                           struct iscsi_stats *stats);
 121
 122        int (*init_task) (struct iscsi_task *task);
 123        int (*xmit_task) (struct iscsi_task *task);
 124        void (*cleanup_task) (struct iscsi_task *task);
 125
 126        int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
 127        int (*xmit_pdu) (struct iscsi_task *task);
 128        int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
 129                         unsigned int count);
 130        void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
 131                               int *index, int *age);
 132
 133        void (*session_recovery_timedout) (struct iscsi_cls_session *session);
 134        struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
 135                                              struct sockaddr *dst_addr,
 136                                              int non_blocking);
 137        int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
 138        void (*ep_disconnect) (struct iscsi_endpoint *ep);
 139        int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
 140                          uint32_t enable, struct sockaddr *dst_addr);
 141        int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
 142        int (*set_iface_param) (struct Scsi_Host *shost, void *data,
 143                                uint32_t len);
 144        int (*get_iface_param) (struct iscsi_iface *iface,
 145                                enum iscsi_param_type param_type,
 146                                int param, char *buf);
 147        umode_t (*attr_is_visible)(int param_type, int param);
 148        int (*bsg_request)(struct bsg_job *job);
 149        int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
 150                          uint32_t iface_type, uint32_t payload_size,
 151                          uint32_t pid, struct sockaddr *dst_addr);
 152        int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
 153                         uint32_t *num_entries, char *buf);
 154        int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
 155        int (*set_chap) (struct Scsi_Host *shost, void *data, int len);
 156        int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
 157                                    int param, char *buf);
 158        int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
 159                                    struct iscsi_bus_flash_conn *fnode_conn,
 160                                    void *data, int len);
 161        int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
 162                              int len);
 163        int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
 164        int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
 165                                struct iscsi_bus_flash_conn *fnode_conn);
 166        int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
 167                                 struct iscsi_bus_flash_conn *fnode_conn);
 168        int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
 169        int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len);
 170        u8 (*check_protection)(struct iscsi_task *task, sector_t *sector);
 171};
 172
 173/*
 174 * transport registration upcalls
 175 */
 176extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
 177extern int iscsi_unregister_transport(struct iscsi_transport *tt);
 178
 179/*
 180 * control plane upcalls
 181 */
 182extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
 183                                   enum iscsi_err error);
 184extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
 185                                   enum iscsi_conn_state state);
 186extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
 187                          char *data, uint32_t data_size);
 188
 189extern int iscsi_offload_mesg(struct Scsi_Host *shost,
 190                              struct iscsi_transport *transport, uint32_t type,
 191                              char *data, uint16_t data_size);
 192
 193extern void iscsi_post_host_event(uint32_t host_no,
 194                                  struct iscsi_transport *transport,
 195                                  enum iscsi_host_event_code code,
 196                                  uint32_t data_size,
 197                                  uint8_t *data);
 198
 199extern void iscsi_ping_comp_event(uint32_t host_no,
 200                                  struct iscsi_transport *transport,
 201                                  uint32_t status, uint32_t pid,
 202                                  uint32_t data_size, uint8_t *data);
 203
 204struct iscsi_cls_conn {
 205        struct list_head conn_list;     /* item in connlist */
 206        void *dd_data;                  /* LLD private data */
 207        struct iscsi_transport *transport;
 208        uint32_t cid;                   /* connection id */
 209        struct mutex ep_mutex;
 210        struct iscsi_endpoint *ep;
 211
 212        struct device dev;              /* sysfs transport/container device */
 213};
 214
 215#define iscsi_dev_to_conn(_dev) \
 216        container_of(_dev, struct iscsi_cls_conn, dev)
 217
 218#define transport_class_to_conn(_cdev) \
 219        iscsi_dev_to_conn(_cdev->parent)
 220
 221#define iscsi_conn_to_session(_conn) \
 222        iscsi_dev_to_session(_conn->dev.parent)
 223
 224/* iscsi class session state */
 225enum {
 226        ISCSI_SESSION_LOGGED_IN,
 227        ISCSI_SESSION_FAILED,
 228        ISCSI_SESSION_FREE,
 229};
 230
 231#define ISCSI_MAX_TARGET -1
 232
 233struct iscsi_cls_session {
 234        struct list_head sess_list;             /* item in session_list */
 235        struct iscsi_transport *transport;
 236        spinlock_t lock;
 237        struct work_struct block_work;
 238        struct work_struct unblock_work;
 239        struct work_struct scan_work;
 240        struct work_struct unbind_work;
 241
 242        /* recovery fields */
 243        int recovery_tmo;
 244        struct delayed_work recovery_work;
 245
 246        unsigned int target_id;
 247        bool ida_used;
 248
 249        /*
 250         * pid of userspace process that created session or -1 if
 251         * created by the kernel.
 252         */
 253        pid_t creator;
 254        int state;
 255        int sid;                                /* session id */
 256        void *dd_data;                          /* LLD private data */
 257        struct device dev;      /* sysfs transport/container device */
 258};
 259
 260#define iscsi_dev_to_session(_dev) \
 261        container_of(_dev, struct iscsi_cls_session, dev)
 262
 263#define transport_class_to_session(_cdev) \
 264        iscsi_dev_to_session(_cdev->parent)
 265
 266#define iscsi_session_to_shost(_session) \
 267        dev_to_shost(_session->dev.parent)
 268
 269#define starget_to_session(_stgt) \
 270        iscsi_dev_to_session(_stgt->dev.parent)
 271
 272struct iscsi_cls_host {
 273        atomic_t nr_scans;
 274        struct mutex mutex;
 275        struct request_queue *bsg_q;
 276        uint32_t port_speed;
 277        uint32_t port_state;
 278};
 279
 280#define iscsi_job_to_shost(_job) \
 281        dev_to_shost(_job->dev)
 282
 283extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
 284                                void (*fn)(struct iscsi_cls_session *));
 285
 286struct iscsi_endpoint {
 287        void *dd_data;                  /* LLD private data */
 288        struct device dev;
 289        uint64_t id;
 290        struct iscsi_cls_conn *conn;
 291};
 292
 293struct iscsi_iface {
 294        struct device dev;
 295        struct iscsi_transport *transport;
 296        uint32_t iface_type;    /* IPv4 or IPv6 */
 297        uint32_t iface_num;     /* iface number, 0 - n */
 298        void *dd_data;          /* LLD private data */
 299};
 300
 301#define iscsi_dev_to_iface(_dev) \
 302        container_of(_dev, struct iscsi_iface, dev)
 303
 304#define iscsi_iface_to_shost(_iface) \
 305        dev_to_shost(_iface->dev.parent)
 306
 307
 308struct iscsi_bus_flash_conn {
 309        struct list_head conn_list;     /* item in connlist */
 310        void *dd_data;                  /* LLD private data */
 311        struct iscsi_transport *transport;
 312        struct device dev;              /* sysfs transport/container device */
 313        /* iscsi connection parameters */
 314        uint32_t                exp_statsn;
 315        uint32_t                statsn;
 316        unsigned                max_recv_dlength; /* initiator_max_recv_dsl*/
 317        unsigned                max_xmit_dlength; /* target_max_recv_dsl */
 318        unsigned                max_segment_size;
 319        unsigned                tcp_xmit_wsf;
 320        unsigned                tcp_recv_wsf;
 321        int                     hdrdgst_en;
 322        int                     datadgst_en;
 323        int                     port;
 324        char                    *ipaddress;
 325        char                    *link_local_ipv6_addr;
 326        char                    *redirect_ipaddr;
 327        uint16_t                keepalive_timeout;
 328        uint16_t                local_port;
 329        uint8_t                 snack_req_en;
 330        /* tcp timestamp negotiation status */
 331        uint8_t                 tcp_timestamp_stat;
 332        uint8_t                 tcp_nagle_disable;
 333        /* tcp window scale factor */
 334        uint8_t                 tcp_wsf_disable;
 335        uint8_t                 tcp_timer_scale;
 336        uint8_t                 tcp_timestamp_en;
 337        uint8_t                 ipv4_tos;
 338        uint8_t                 ipv6_traffic_class;
 339        uint8_t                 ipv6_flow_label;
 340        uint8_t                 fragment_disable;
 341        /* Link local IPv6 address is assigned by firmware or driver */
 342        uint8_t                 is_fw_assigned_ipv6;
 343};
 344
 345#define iscsi_dev_to_flash_conn(_dev) \
 346        container_of(_dev, struct iscsi_bus_flash_conn, dev)
 347
 348#define iscsi_flash_conn_to_flash_session(_conn) \
 349        iscsi_dev_to_flash_session(_conn->dev.parent)
 350
 351#define ISID_SIZE 6
 352
 353struct iscsi_bus_flash_session {
 354        struct list_head sess_list;             /* item in session_list */
 355        struct iscsi_transport *transport;
 356        unsigned int target_id;
 357        int flash_state;        /* persistent or non-persistent */
 358        void *dd_data;                          /* LLD private data */
 359        struct device dev;      /* sysfs transport/container device */
 360        /* iscsi session parameters */
 361        unsigned                first_burst;
 362        unsigned                max_burst;
 363        unsigned short          max_r2t;
 364        int                     default_taskmgmt_timeout;
 365        int                     initial_r2t_en;
 366        int                     imm_data_en;
 367        int                     time2wait;
 368        int                     time2retain;
 369        int                     pdu_inorder_en;
 370        int                     dataseq_inorder_en;
 371        int                     erl;
 372        int                     tpgt;
 373        char                    *username;
 374        char                    *username_in;
 375        char                    *password;
 376        char                    *password_in;
 377        char                    *targetname;
 378        char                    *targetalias;
 379        char                    *portal_type;
 380        uint16_t                tsid;
 381        uint16_t                chap_in_idx;
 382        uint16_t                chap_out_idx;
 383        /* index of iSCSI discovery session if the entry is
 384         * discovered by iSCSI discovery session
 385         */
 386        uint16_t                discovery_parent_idx;
 387        /* indicates if discovery was done through iSNS discovery service
 388         * or through sendTarget */
 389        uint16_t                discovery_parent_type;
 390        /* Firmware auto sendtarget discovery disable */
 391        uint8_t                 auto_snd_tgt_disable;
 392        uint8_t                 discovery_sess;
 393        /* indicates if this flashnode entry is enabled or disabled */
 394        uint8_t                 entry_state;
 395        uint8_t                 chap_auth_en;
 396        /* enables firmware to auto logout the discovery session on discovery
 397         * completion
 398         */
 399        uint8_t                 discovery_logout_en;
 400        uint8_t                 bidi_chap_en;
 401        /* makes authentication for discovery session optional */
 402        uint8_t                 discovery_auth_optional;
 403        uint8_t                 isid[ISID_SIZE];
 404        uint8_t                 is_boot_target;
 405};
 406
 407#define iscsi_dev_to_flash_session(_dev) \
 408        container_of(_dev, struct iscsi_bus_flash_session, dev)
 409
 410#define iscsi_flash_session_to_shost(_session) \
 411        dev_to_shost(_session->dev.parent)
 412
 413/*
 414 * session and connection functions that can be used by HW iSCSI LLDs
 415 */
 416#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
 417        dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
 418
 419#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
 420        dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
 421
 422extern int iscsi_session_chkready(struct iscsi_cls_session *session);
 423extern int iscsi_is_session_online(struct iscsi_cls_session *session);
 424extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
 425                                struct iscsi_transport *transport, int dd_size);
 426extern int iscsi_add_session(struct iscsi_cls_session *session,
 427                             unsigned int target_id);
 428extern int iscsi_session_event(struct iscsi_cls_session *session,
 429                               enum iscsi_uevent_e event);
 430extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
 431                                                struct iscsi_transport *t,
 432                                                int dd_size,
 433                                                unsigned int target_id);
 434extern void iscsi_remove_session(struct iscsi_cls_session *session);
 435extern void iscsi_free_session(struct iscsi_cls_session *session);
 436extern int iscsi_destroy_session(struct iscsi_cls_session *session);
 437extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
 438                                                int dd_size, uint32_t cid);
 439extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
 440extern void iscsi_unblock_session(struct iscsi_cls_session *session);
 441extern void iscsi_block_session(struct iscsi_cls_session *session);
 442extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
 443extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
 444extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
 445extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
 446extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
 447extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
 448                                              struct iscsi_transport *t,
 449                                              uint32_t iface_type,
 450                                              uint32_t iface_num, int dd_size);
 451extern void iscsi_destroy_iface(struct iscsi_iface *iface);
 452extern struct iscsi_iface *iscsi_lookup_iface(int handle);
 453extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
 454extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
 455extern int iscsi_is_session_dev(const struct device *dev);
 456
 457extern char *iscsi_get_discovery_parent_name(int parent_type);
 458extern struct device *
 459iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
 460                     int (*fn)(struct device *dev, void *data));
 461
 462extern struct iscsi_bus_flash_session *
 463iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
 464                            struct iscsi_transport *transport, int dd_size);
 465
 466extern struct iscsi_bus_flash_conn *
 467iscsi_create_flashnode_conn(struct Scsi_Host *shost,
 468                            struct iscsi_bus_flash_session *fnode_sess,
 469                            struct iscsi_transport *transport, int dd_size);
 470
 471extern void
 472iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
 473
 474extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
 475extern int iscsi_flashnode_bus_match(struct device *dev,
 476                                     struct device_driver *drv);
 477extern struct device *
 478iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
 479                          int (*fn)(struct device *dev, void *data));
 480extern struct device *
 481iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
 482
 483extern char *
 484iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
 485extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);
 486#endif
 487