c5cd43aae8604af42fb349b160e608a10a84c16d
[linux-2.6.git] / 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
50 enum {
51         SRP_PATH_REC_TIMEOUT_MS = 1000,
52         SRP_ABORT_TIMEOUT_MS    = 5000,
53
54         SRP_PORT_REDIRECT       = 1,
55         SRP_DLID_REDIRECT       = 2,
56
57         SRP_MAX_LUN             = 512,
58         SRP_MAX_IU_LEN          = 256,
59
60         SRP_RQ_SHIFT            = 6,
61         SRP_RQ_SIZE             = 1 << SRP_RQ_SHIFT,
62         SRP_SQ_SIZE             = SRP_RQ_SIZE - 1,
63         SRP_CQ_SIZE             = SRP_SQ_SIZE + SRP_RQ_SIZE,
64
65         SRP_TAG_TSK_MGMT        = 1 << (SRP_RQ_SHIFT + 1)
66 };
67
68 #define SRP_OP_RECV             (1 << 31)
69 #define SRP_MAX_INDIRECT        ((SRP_MAX_IU_LEN -                      \
70                                   sizeof (struct srp_cmd) -             \
71                                   sizeof (struct srp_indirect_buf)) / 16)
72
73 enum srp_target_state {
74         SRP_TARGET_LIVE,
75         SRP_TARGET_CONNECTING,
76         SRP_TARGET_DEAD,
77         SRP_TARGET_REMOVED
78 };
79
80 struct srp_host {
81         u8                      initiator_port_id[16];
82         struct ib_device       *dev;
83         u8                      port;
84         struct ib_pd           *pd;
85         struct ib_mr           *mr;
86         struct class_device     class_dev;
87         struct list_head        target_list;
88         struct mutex            target_mutex;
89         struct completion       released;
90         struct list_head        list;
91 };
92
93 struct srp_request {
94         struct list_head        list;
95         struct scsi_cmnd       *scmnd;
96         struct srp_iu          *cmd;
97         struct srp_iu          *tsk_mgmt;
98         /*
99          * Fake scatterlist used when scmnd->use_sg==0.  Can be killed
100          * when the SCSI midlayer no longer generates non-SG commands.
101          */
102         struct scatterlist      fake_sg;
103         struct completion       done;
104         short                   index;
105         u8                      cmd_done;
106         u8                      tsk_status;
107 };
108
109 struct srp_target_port {
110         __be64                  id_ext;
111         __be64                  ioc_guid;
112         __be64                  service_id;
113         struct srp_host        *srp_host;
114         struct Scsi_Host       *scsi_host;
115         char                    target_name[32];
116         unsigned int            scsi_id;
117
118         struct ib_sa_path_rec   path;
119         struct ib_sa_query     *path_query;
120         int                     path_query_id;
121
122         struct ib_cm_id        *cm_id;
123         struct ib_cq           *cq;
124         struct ib_qp           *qp;
125
126         int                     max_ti_iu_len;
127         s32                     req_lim;
128
129         unsigned                rx_head;
130         struct srp_iu          *rx_ring[SRP_RQ_SIZE];
131
132         unsigned                tx_head;
133         unsigned                tx_tail;
134         struct srp_iu          *tx_ring[SRP_SQ_SIZE + 1];
135
136         struct list_head        free_reqs;
137         struct list_head        req_queue;
138         struct srp_request      req_ring[SRP_SQ_SIZE];
139
140         struct work_struct      work;
141
142         struct list_head        list;
143         struct completion       done;
144         int                     status;
145         enum srp_target_state   state;
146 };
147
148 struct srp_iu {
149         dma_addr_t              dma;
150         void                   *buf;
151         size_t                  size;
152         enum dma_data_direction direction;
153 };
154
155 #endif /* IB_SRP_H */