linux/drivers/infiniband/ulp/srp/ib_srp.h
<<
>>
Prefs
   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
  49enum {
  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
  78enum srp_target_state {
  79        SRP_TARGET_LIVE,
  80        SRP_TARGET_REMOVED,
  81};
  82
  83enum srp_iu_type {
  84        SRP_IU_CMD,
  85        SRP_IU_TSK_MGMT,
  86        SRP_IU_RSP,
  87};
  88
  89struct 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
 100struct 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};
 109
 110struct srp_request {
 111        struct list_head        list;
 112        struct scsi_cmnd       *scmnd;
 113        struct srp_iu          *cmd;
 114        struct ib_pool_fmr    **fmr_list;
 115        u64                    *map_page;
 116        struct srp_direct_buf  *indirect_desc;
 117        dma_addr_t              indirect_dma_addr;
 118        short                   nfmr;
 119        short                   index;
 120};
 121
 122struct srp_target_port {
 123        /* These are RW in the hot path, and commonly used together */
 124        struct list_head        free_tx;
 125        struct list_head        free_reqs;
 126        spinlock_t              lock;
 127        s32                     req_lim;
 128
 129        /* These are read-only in the hot path */
 130        struct ib_cq           *send_cq ____cacheline_aligned_in_smp;
 131        struct ib_cq           *recv_cq;
 132        struct ib_qp           *qp;
 133        u32                     lkey;
 134        u32                     rkey;
 135        enum srp_target_state   state;
 136        unsigned int            max_iu_len;
 137        unsigned int            cmd_sg_cnt;
 138        unsigned int            indirect_size;
 139        bool                    allow_ext_sg;
 140
 141        /* Everything above this point is used in the hot path of
 142         * command processing. Try to keep them packed into cachelines.
 143         */
 144
 145        __be64                  id_ext;
 146        __be64                  ioc_guid;
 147        __be64                  service_id;
 148        __be64                  initiator_ext;
 149        u16                     io_class;
 150        struct srp_host        *srp_host;
 151        struct Scsi_Host       *scsi_host;
 152        struct srp_rport       *rport;
 153        char                    target_name[32];
 154        unsigned int            scsi_id;
 155        unsigned int            sg_tablesize;
 156        int                     queue_size;
 157        int                     req_ring_size;
 158        int                     comp_vector;
 159        int                     tl_retry_count;
 160
 161        struct ib_sa_path_rec   path;
 162        __be16                  orig_dgid[8];
 163        struct ib_sa_query     *path_query;
 164        int                     path_query_id;
 165
 166        u32                     rq_tmo_jiffies;
 167        bool                    connected;
 168
 169        struct ib_cm_id        *cm_id;
 170
 171        int                     max_ti_iu_len;
 172
 173        int                     zero_req_lim;
 174
 175        struct srp_iu          **tx_ring;
 176        struct srp_iu          **rx_ring;
 177        struct srp_request      *req_ring;
 178
 179        struct work_struct      tl_err_work;
 180        struct work_struct      remove_work;
 181
 182        struct list_head        list;
 183        struct completion       done;
 184        int                     status;
 185        bool                    qp_in_error;
 186
 187        struct completion       tsk_mgmt_done;
 188        u8                      tsk_mgmt_status;
 189};
 190
 191struct srp_iu {
 192        struct list_head        list;
 193        u64                     dma;
 194        void                   *buf;
 195        size_t                  size;
 196        enum dma_data_direction direction;
 197};
 198
 199struct srp_map_state {
 200        struct ib_pool_fmr    **next_fmr;
 201        struct srp_direct_buf  *desc;
 202        u64                    *pages;
 203        dma_addr_t              base_dma_addr;
 204        u32                     fmr_len;
 205        u32                     total_len;
 206        unsigned int            npages;
 207        unsigned int            nfmr;
 208        unsigned int            ndesc;
 209        struct scatterlist     *unmapped_sg;
 210        int                     unmapped_index;
 211        dma_addr_t              unmapped_addr;
 212};
 213
 214#endif /* IB_SRP_H */
 215