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_DEFAULT_QUEUE_SIZE  = 1 << 6,
  61         SRP_RSP_SQ_SIZE         = 1,
  62         SRP_TSK_MGMT_SQ_SIZE    = 1,
  63         SRP_DEFAULT_CMD_SQ_SIZE = SRP_DEFAULT_QUEUE_SIZE - SRP_RSP_SQ_SIZE -
  64                                   SRP_TSK_MGMT_SQ_SIZE,
  65
  66         SRP_TAG_NO_REQ          = ~0U,
  67         SRP_TAG_TSK_MGMT        = 1U << 31,
  68
  69         SRP_FMR_SIZE            = 512,
  70         SRP_FMR_MIN_SIZE        = 128,
  71         SRP_FMR_POOL_SIZE       = 1024,
  72         SRP_FMR_DIRTY_SIZE      = SRP_FMR_POOL_SIZE / 4,
  73
  74         SRP_MAP_ALLOW_FMR       = 0,
  75         SRP_MAP_NO_FMR          = 1,
  76 };
  77
  78 enum srp_target_state {
  79         SRP_TARGET_LIVE,
  80         SRP_TARGET_REMOVED,
  81 };
  82
  83 enum srp_iu_type {
  84         SRP_IU_CMD,
  85         SRP_IU_TSK_MGMT,
  86         SRP_IU_RSP,
  87 };
  88
  89 struct srp_device {
  90         struct list_head        dev_list;
  91         struct ib_device       *dev;
  92         struct ib_pd           *pd;
  93         struct ib_mr           *mr;
  94         struct ib_fmr_pool     *fmr_pool;
  95         u64                     fmr_page_mask;
  96         int                     fmr_page_size;
  97         int                     fmr_max_size;
  98 };
  99
 100 struct srp_host {
 101         struct srp_device      *srp_dev;
 102         u8                      port;
 103         struct device           dev;
 104         struct list_head        target_list;
 105         spinlock_t              target_lock;
 106         struct completion       released;
 107         struct list_head        list;
 108         struct mutex            add_target_mutex;
 109 };
 110
 111 struct srp_request {
 112         struct list_head        list;
 113         struct scsi_cmnd       *scmnd;
 114         struct srp_iu          *cmd;
 115         struct ib_pool_fmr    **fmr_list;
 116         u64                    *map_page;
 117         struct srp_direct_buf  *indirect_desc;
 118         dma_addr_t              indirect_dma_addr;
 119         short                   nfmr;
 120         short                   index;
 121 };
 122
 123 struct srp_target_port {
 124         /* These are RW in the hot path, and commonly used together */
 125         struct list_head        free_tx;
 126         struct list_head        free_reqs;
 127         spinlock_t              lock;
 128         s32                     req_lim;
 129
 130         /* These are read-only in the hot path */
 131         struct ib_cq           *send_cq ____cacheline_aligned_in_smp;
 132         struct ib_cq           *recv_cq;
 133         struct ib_qp           *qp;
 134         u32                     lkey;
 135         u32                     rkey;
 136         enum srp_target_state   state;
 137         unsigned int            max_iu_len;
 138         unsigned int            cmd_sg_cnt;
 139         unsigned int            indirect_size;
 140         bool                    allow_ext_sg;
 141
 142         /* Everything above this point is used in the hot path of
 143          * command processing. Try to keep them packed into cachelines.
 144          */
 145
 146         __be64                  id_ext;
 147         __be64                  ioc_guid;
 148         __be64                  service_id;
 149         __be64                  initiator_ext;
 150         u16                     io_class;
 151         struct srp_host        *srp_host;
 152         struct Scsi_Host       *scsi_host;
 153         struct srp_rport       *rport;
 154         char                    target_name[32];
 155         unsigned int            scsi_id;
 156         unsigned int            sg_tablesize;
 157         int                     queue_size;
 158         int                     req_ring_size;
 159         int                     comp_vector;
 160         int                     tl_retry_count;
 161
 162         struct ib_sa_path_rec   path;
 163         __be16                  orig_dgid[8];
 164         struct ib_sa_query     *path_query;
 165         int                     path_query_id;
 166
 167         u32                     rq_tmo_jiffies;
 168         bool                    connected;
 169
 170         struct ib_cm_id        *cm_id;
 171
 172         int                     max_ti_iu_len;
 173
 174         int                     zero_req_lim;
 175
 176         struct srp_iu          **tx_ring;
 177         struct srp_iu          **rx_ring;
 178         struct srp_request      *req_ring;
 179
 180         struct work_struct      tl_err_work;
 181         struct work_struct      remove_work;
 182
 183         struct list_head        list;
 184         struct completion       done;
 185         int                     status;
 186         bool                    qp_in_error;
 187
 188         struct completion       tsk_mgmt_done;
 189         u8                      tsk_mgmt_status;
 190 };
 191
 192 struct srp_iu {
 193         struct list_head        list;
 194         u64                     dma;
 195         void                   *buf;
 196         size_t                  size;
 197         enum dma_data_direction direction;
 198 };
 199
 200 struct srp_map_state {
 201         struct ib_pool_fmr    **next_fmr;
 202         struct srp_direct_buf  *desc;
 203         u64                    *pages;
 204         dma_addr_t              base_dma_addr;
 205         u32                     fmr_len;
 206         u32                     total_len;
 207         unsigned int            npages;
 208         unsigned int            nfmr;
 209         unsigned int            ndesc;
 210         struct scatterlist     *unmapped_sg;
 211         int                     unmapped_index;
 212         dma_addr_t              unmapped_addr;
 213 };
 214
 215 #endif /* IB_SRP_H */