drivers/infiniband/ulp/srp/ib_srp.h

   1 /*
   2  * Copyright (c) 2005 Cisco Systems.  All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and/or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef IB_SRP_H
  34 #define IB_SRP_H
  35
  36 #include <linux/types.h>
  37 #include <linux/list.h>
  38 #include <linux/mutex.h>
  39 #include <linux/scatterlist.h>
  40
  41 #include <scsi/scsi_host.h>
  42 #include <scsi/scsi_cmnd.h>
  43
  44 #include <rdma/ib_verbs.h>
  45 #include <rdma/ib_sa.h>
  46 #include <rdma/ib_cm.h>
  47 #include <rdma/ib_fmr_pool.h>
  48
  49 enum {
  50         SRP_PATH_REC_TIMEOUT_MS = 1000,
  51         SRP_ABORT_TIMEOUT_MS    = 5000,
  52
  53         SRP_PORT_REDIRECT       = 1,
  54         SRP_DLID_REDIRECT       = 2,
  55         SRP_STALE_CONN          = 3,
  56
  57         SRP_MAX_LUN             = 512,
  58         SRP_DEF_SG_TABLESIZE    = 12,
  59
  60         SRP_RQ_SHIFT            = 6,
  61         SRP_RQ_SIZE             = 1 << SRP_RQ_SHIFT,
  62         SRP_RQ_MASK             = SRP_RQ_SIZE - 1,
  63
  64         SRP_SQ_SIZE             = SRP_RQ_SIZE,
  65         SRP_SQ_MASK             = SRP_SQ_SIZE - 1,
  66         SRP_RSP_SQ_SIZE         = 1,
  67         SRP_REQ_SQ_SIZE         = SRP_SQ_SIZE - SRP_RSP_SQ_SIZE,
  68         SRP_TSK_MGMT_SQ_SIZE    = 1,
  69         SRP_CMD_SQ_SIZE         = SRP_REQ_SQ_SIZE - SRP_TSK_MGMT_SQ_SIZE,
  70
  71         SRP_TAG_TSK_MGMT        = 1 << (SRP_RQ_SHIFT + 1),
  72
  73         SRP_FMR_SIZE            = 256,
  74         SRP_FMR_POOL_SIZE       = 1024,
  75         SRP_FMR_DIRTY_SIZE      = SRP_FMR_POOL_SIZE / 4
  76 };
  77
  78 enum srp_target_state {
  79         SRP_TARGET_LIVE,
  80         SRP_TARGET_CONNECTING,
  81         SRP_TARGET_DEAD,
  82         SRP_TARGET_REMOVED
  83 };
  84
  85 enum srp_iu_type {
  86         SRP_IU_CMD,
  87         SRP_IU_TSK_MGMT,
  88         SRP_IU_RSP,
  89 };
  90
  91 struct srp_device {
  92         struct list_head        dev_list;
  93         struct ib_device       *dev;
  94         struct ib_pd           *pd;
  95         struct ib_mr           *mr;
  96         struct ib_fmr_pool     *fmr_pool;
  97         int                     fmr_page_shift;
  98         int                     fmr_page_size;
  99         u64                     fmr_page_mask;
 100 };
 101
 102 struct srp_host {
 103         struct srp_device      *srp_dev;
 104         u8                      port;
 105         struct device           dev;
 106         struct list_head        target_list;
 107         spinlock_t              target_lock;
 108         struct completion       released;
 109         struct list_head        list;
 110 };
 111
 112 struct srp_request {
 113         struct list_head        list;
 114         struct scsi_cmnd       *scmnd;
 115         struct srp_iu          *cmd;
 116         struct srp_iu          *tsk_mgmt;
 117         struct ib_pool_fmr     *fmr;
 118         struct completion       done;
 119         short                   index;
 120         u8                      cmd_done;
 121         u8                      tsk_status;
 122 };
 123
 124 struct srp_target_port {
 125         __be64                  id_ext;
 126         __be64                  ioc_guid;
 127         __be64                  service_id;
 128         __be64                  initiator_ext;
 129         u16                     io_class;
 130         struct srp_host        *srp_host;
 131         struct Scsi_Host       *scsi_host;
 132         char                    target_name[32];
 133         unsigned int            scsi_id;
 134
 135         struct ib_sa_path_rec   path;
 136         __be16                  orig_dgid[8];
 137         struct ib_sa_query     *path_query;
 138         int                     path_query_id;
 139
 140         struct ib_cm_id        *cm_id;
 141         struct ib_cq           *recv_cq;
 142         struct ib_cq           *send_cq;
 143         struct ib_qp           *qp;
 144
 145         int                     max_ti_iu_len;
 146         s32                     req_lim;
 147
 148         int                     zero_req_lim;
 149
 150         unsigned                rx_head;
 151         struct srp_iu          *rx_ring[SRP_RQ_SIZE];
 152
 153         unsigned                tx_head;
 154         unsigned                tx_tail;
 155         struct srp_iu          *tx_ring[SRP_SQ_SIZE];
 156
 157         struct list_head        free_reqs;
 158         struct list_head        req_queue;
 159         struct srp_request      req_ring[SRP_CMD_SQ_SIZE];
 160
 161         struct work_struct      work;
 162
 163         struct list_head        list;
 164         struct completion       done;
 165         int                     status;
 166         enum srp_target_state   state;
 167         int                     qp_in_error;
 168 };
 169
 170 struct srp_iu {
 171         u64                     dma;
 172         void                   *buf;
 173         size_t                  size;
 174         enum dma_data_direction direction;
 175         enum srp_iu_type        type;
 176 };
 177
 178 #endif /* IB_SRP_H */