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  * $Id: ib_srp.h 3932 2005-11-01 17:19:29Z roland $
  33  */
  34
  35 #ifndef IB_SRP_H
  36 #define IB_SRP_H
  37
  38 #include <linux/types.h>
  39 #include <linux/list.h>
  40 #include <linux/mutex.h>
  41 #include <linux/scatterlist.h>
  42
  43 #include <scsi/scsi_host.h>
  44 #include <scsi/scsi_cmnd.h>
  45
  46 #include <rdma/ib_verbs.h>
  47 #include <rdma/ib_sa.h>
  48 #include <rdma/ib_cm.h>
  49 #include <rdma/ib_fmr_pool.h>
  50
  51 enum {
  52         SRP_PATH_REC_TIMEOUT_MS = 1000,
  53         SRP_ABORT_TIMEOUT_MS    = 5000,
  54
  55         SRP_PORT_REDIRECT       = 1,
  56         SRP_DLID_REDIRECT       = 2,
  57
  58         SRP_MAX_LUN             = 512,
  59         SRP_MAX_IU_LEN          = 256,
  60
  61         SRP_RQ_SHIFT            = 6,
  62         SRP_RQ_SIZE             = 1 << SRP_RQ_SHIFT,
  63         SRP_SQ_SIZE             = SRP_RQ_SIZE - 1,
  64         SRP_CQ_SIZE             = SRP_SQ_SIZE + SRP_RQ_SIZE,
  65
  66         SRP_TAG_TSK_MGMT        = 1 << (SRP_RQ_SHIFT + 1),
  67
  68         SRP_FMR_SIZE            = 256,
  69         SRP_FMR_POOL_SIZE       = 1024,
  70         SRP_FMR_DIRTY_SIZE      = SRP_FMR_POOL_SIZE / 4
  71 };
  72
  73 #define SRP_OP_RECV             (1 << 31)
  74 #define SRP_MAX_INDIRECT        ((SRP_MAX_IU_LEN -                      \
  75                                   sizeof (struct srp_cmd) -             \
  76                                   sizeof (struct srp_indirect_buf)) / 16)
  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 struct srp_device {
  86         struct list_head        dev_list;
  87         struct ib_device       *dev;
  88         struct ib_pd           *pd;
  89         struct ib_mr           *mr;
  90         struct ib_fmr_pool     *fmr_pool;
  91         int                     fmr_page_shift;
  92         int                     fmr_page_size;
  93         unsigned long           fmr_page_mask;
  94 };
  95
  96 struct srp_host {
  97         u8                      initiator_port_id[16];
  98         struct srp_device      *dev;
  99         u8                      port;
 100         struct class_device     class_dev;
 101         struct list_head        target_list;
 102         struct mutex            target_mutex;
 103         struct completion       released;
 104         struct list_head        list;
 105 };
 106
 107 struct srp_request {
 108         struct list_head        list;
 109         struct scsi_cmnd       *scmnd;
 110         struct srp_iu          *cmd;
 111         struct srp_iu          *tsk_mgmt;
 112         struct ib_pool_fmr     *fmr;
 113         /*
 114          * Fake scatterlist used when scmnd->use_sg==0.  Can be killed
 115          * when the SCSI midlayer no longer generates non-SG commands.
 116          */
 117         struct scatterlist      fake_sg;
 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         struct srp_host        *srp_host;
 129         struct Scsi_Host       *scsi_host;
 130         char                    target_name[32];
 131         unsigned int            scsi_id;
 132
 133         struct ib_sa_path_rec   path;
 134         struct ib_sa_query     *path_query;
 135         int                     path_query_id;
 136
 137         struct ib_cm_id        *cm_id;
 138         struct ib_cq           *cq;
 139         struct ib_qp           *qp;
 140
 141         int                     max_ti_iu_len;
 142         s32                     req_lim;
 143
 144         unsigned                rx_head;
 145         struct srp_iu          *rx_ring[SRP_RQ_SIZE];
 146
 147         unsigned                tx_head;
 148         unsigned                tx_tail;
 149         struct srp_iu          *tx_ring[SRP_SQ_SIZE + 1];
 150
 151         struct list_head        free_reqs;
 152         struct list_head        req_queue;
 153         struct srp_request      req_ring[SRP_SQ_SIZE];
 154
 155         struct work_struct      work;
 156
 157         struct list_head        list;
 158         struct completion       done;
 159         int                     status;
 160         enum srp_target_state   state;
 161 };
 162
 163 struct srp_iu {
 164         dma_addr_t              dma;
 165         void                   *buf;
 166         size_t                  size;
 167         enum dma_data_direction direction;
 168 };
 169
 170 #endif /* IB_SRP_H */