xref: /linux/drivers/infiniband/hw/mthca/mthca_cmd.h (revision d67b569f5f620c0fb95d5212642746b7ba9d29e4)
1 /*
2  * Copyright (c) 2004, 2005 Topspin Communications.  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: mthca_cmd.h 1349 2004-12-16 21:09:43Z roland $
33  */
34 
35 #ifndef MTHCA_CMD_H
36 #define MTHCA_CMD_H
37 
38 #include <ib_verbs.h>
39 
40 #define MTHCA_MAILBOX_SIZE 4096
41 
42 enum {
43 	/* command completed successfully: */
44 	MTHCA_CMD_STAT_OK 	      = 0x00,
45 	/* Internal error (such as a bus error) occurred while processing command: */
46 	MTHCA_CMD_STAT_INTERNAL_ERR   = 0x01,
47 	/* Operation/command not supported or opcode modifier not supported: */
48 	MTHCA_CMD_STAT_BAD_OP 	      = 0x02,
49 	/* Parameter not supported or parameter out of range: */
50 	MTHCA_CMD_STAT_BAD_PARAM      = 0x03,
51 	/* System not enabled or bad system state: */
52 	MTHCA_CMD_STAT_BAD_SYS_STATE  = 0x04,
53 	/* Attempt to access reserved or unallocaterd resource: */
54 	MTHCA_CMD_STAT_BAD_RESOURCE   = 0x05,
55 	/* Requested resource is currently executing a command, or is otherwise busy: */
56 	MTHCA_CMD_STAT_RESOURCE_BUSY  = 0x06,
57 	/* memory error: */
58 	MTHCA_CMD_STAT_DDR_MEM_ERR    = 0x07,
59 	/* Required capability exceeds device limits: */
60 	MTHCA_CMD_STAT_EXCEED_LIM     = 0x08,
61 	/* Resource is not in the appropriate state or ownership: */
62 	MTHCA_CMD_STAT_BAD_RES_STATE  = 0x09,
63 	/* Index out of range: */
64 	MTHCA_CMD_STAT_BAD_INDEX      = 0x0a,
65 	/* FW image corrupted: */
66 	MTHCA_CMD_STAT_BAD_NVMEM      = 0x0b,
67 	/* Attempt to modify a QP/EE which is not in the presumed state: */
68 	MTHCA_CMD_STAT_BAD_QPEE_STATE = 0x10,
69 	/* Bad segment parameters (Address/Size): */
70 	MTHCA_CMD_STAT_BAD_SEG_PARAM  = 0x20,
71 	/* Memory Region has Memory Windows bound to: */
72 	MTHCA_CMD_STAT_REG_BOUND      = 0x21,
73 	/* HCA local attached memory not present: */
74 	MTHCA_CMD_STAT_LAM_NOT_PRE    = 0x22,
75         /* Bad management packet (silently discarded): */
76 	MTHCA_CMD_STAT_BAD_PKT 	      = 0x30,
77         /* More outstanding CQEs in CQ than new CQ size: */
78 	MTHCA_CMD_STAT_BAD_SIZE       = 0x40
79 };
80 
81 enum {
82 	MTHCA_TRANS_INVALID = 0,
83 	MTHCA_TRANS_RST2INIT,
84 	MTHCA_TRANS_INIT2INIT,
85 	MTHCA_TRANS_INIT2RTR,
86 	MTHCA_TRANS_RTR2RTS,
87 	MTHCA_TRANS_RTS2RTS,
88 	MTHCA_TRANS_SQERR2RTS,
89 	MTHCA_TRANS_ANY2ERR,
90 	MTHCA_TRANS_RTS2SQD,
91 	MTHCA_TRANS_SQD2SQD,
92 	MTHCA_TRANS_SQD2RTS,
93 	MTHCA_TRANS_ANY2RST,
94 };
95 
96 enum {
97 	DEV_LIM_FLAG_RC                 = 1 << 0,
98 	DEV_LIM_FLAG_UC                 = 1 << 1,
99 	DEV_LIM_FLAG_UD                 = 1 << 2,
100 	DEV_LIM_FLAG_RD                 = 1 << 3,
101 	DEV_LIM_FLAG_RAW_IPV6           = 1 << 4,
102 	DEV_LIM_FLAG_RAW_ETHER          = 1 << 5,
103 	DEV_LIM_FLAG_SRQ                = 1 << 6,
104 	DEV_LIM_FLAG_BAD_PKEY_CNTR      = 1 << 8,
105 	DEV_LIM_FLAG_BAD_QKEY_CNTR      = 1 << 9,
106 	DEV_LIM_FLAG_MW                 = 1 << 16,
107 	DEV_LIM_FLAG_AUTO_PATH_MIG      = 1 << 17,
108 	DEV_LIM_FLAG_ATOMIC             = 1 << 18,
109 	DEV_LIM_FLAG_RAW_MULTI          = 1 << 19,
110 	DEV_LIM_FLAG_UD_AV_PORT_ENFORCE = 1 << 20,
111 	DEV_LIM_FLAG_UD_MULTI           = 1 << 21,
112 };
113 
114 struct mthca_mailbox {
115 	dma_addr_t dma;
116 	void      *buf;
117 };
118 
119 struct mthca_dev_lim {
120 	int max_srq_sz;
121 	int max_qp_sz;
122 	int reserved_qps;
123 	int max_qps;
124 	int reserved_srqs;
125 	int max_srqs;
126 	int reserved_eecs;
127 	int max_eecs;
128 	int max_cq_sz;
129 	int reserved_cqs;
130 	int max_cqs;
131 	int max_mpts;
132 	int reserved_eqs;
133 	int max_eqs;
134 	int reserved_mtts;
135 	int max_mrw_sz;
136 	int reserved_mrws;
137 	int max_mtt_seg;
138 	int max_requester_per_qp;
139 	int max_responder_per_qp;
140 	int max_rdma_global;
141 	int local_ca_ack_delay;
142 	int max_mtu;
143 	int max_port_width;
144 	int max_vl;
145 	int num_ports;
146 	int max_gids;
147 	int max_pkeys;
148 	u32 flags;
149 	int reserved_uars;
150 	int uar_size;
151 	int min_page_sz;
152 	int max_sg;
153 	int max_desc_sz;
154 	int max_qp_per_mcg;
155 	int reserved_mgms;
156 	int max_mcgs;
157 	int reserved_pds;
158 	int max_pds;
159 	int reserved_rdds;
160 	int max_rdds;
161 	int eec_entry_sz;
162 	int qpc_entry_sz;
163 	int eeec_entry_sz;
164 	int eqpc_entry_sz;
165 	int eqc_entry_sz;
166 	int cqc_entry_sz;
167 	int srq_entry_sz;
168 	int uar_scratch_entry_sz;
169 	int mpt_entry_sz;
170 	union {
171 		struct {
172 			int max_avs;
173 		} tavor;
174 		struct {
175 			int resize_srq;
176 			int max_pbl_sz;
177 			u8  bmme_flags;
178 			u32 reserved_lkey;
179 			int lam_required;
180 			u64 max_icm_sz;
181 		} arbel;
182 	} hca;
183 };
184 
185 struct mthca_adapter {
186 	u32 vendor_id;
187 	u32 device_id;
188 	u32 revision_id;
189 	u8  inta_pin;
190 };
191 
192 struct mthca_init_hca_param {
193 	u64 qpc_base;
194 	u64 eec_base;
195 	u64 srqc_base;
196 	u64 cqc_base;
197 	u64 eqpc_base;
198 	u64 eeec_base;
199 	u64 eqc_base;
200 	u64 rdb_base;
201 	u64 mc_base;
202 	u64 mpt_base;
203 	u64 mtt_base;
204 	u64 uar_scratch_base;
205 	u64 uarc_base;
206 	u16 log_mc_entry_sz;
207 	u16 mc_hash_sz;
208 	u8  log_num_qps;
209 	u8  log_num_eecs;
210 	u8  log_num_srqs;
211 	u8  log_num_cqs;
212 	u8  log_num_eqs;
213 	u8  log_mc_table_sz;
214 	u8  mtt_seg_sz;
215 	u8  log_mpt_sz;
216 	u8  log_uar_sz;
217 	u8  log_uarc_sz;
218 };
219 
220 struct mthca_init_ib_param {
221 	int enable_1x;
222 	int enable_4x;
223 	int vl_cap;
224 	int mtu_cap;
225 	u16 gid_cap;
226 	u16 pkey_cap;
227 	int set_guid0;
228 	u64 guid0;
229 	int set_node_guid;
230 	u64 node_guid;
231 	int set_si_guid;
232 	u64 si_guid;
233 };
234 
235 struct mthca_set_ib_param {
236 	int set_si_guid;
237 	int reset_qkey_viol;
238 	u64 si_guid;
239 	u32 cap_mask;
240 };
241 
242 int mthca_cmd_init(struct mthca_dev *dev);
243 void mthca_cmd_cleanup(struct mthca_dev *dev);
244 int mthca_cmd_use_events(struct mthca_dev *dev);
245 void mthca_cmd_use_polling(struct mthca_dev *dev);
246 void mthca_cmd_event(struct mthca_dev *dev, u16 token,
247 		     u8  status, u64 out_param);
248 
249 struct mthca_mailbox *mthca_alloc_mailbox(struct mthca_dev *dev,
250 					  unsigned int gfp_mask);
251 void mthca_free_mailbox(struct mthca_dev *dev, struct mthca_mailbox *mailbox);
252 
253 int mthca_SYS_EN(struct mthca_dev *dev, u8 *status);
254 int mthca_SYS_DIS(struct mthca_dev *dev, u8 *status);
255 int mthca_MAP_FA(struct mthca_dev *dev, struct mthca_icm *icm, u8 *status);
256 int mthca_UNMAP_FA(struct mthca_dev *dev, u8 *status);
257 int mthca_RUN_FW(struct mthca_dev *dev, u8 *status);
258 int mthca_QUERY_FW(struct mthca_dev *dev, u8 *status);
259 int mthca_ENABLE_LAM(struct mthca_dev *dev, u8 *status);
260 int mthca_DISABLE_LAM(struct mthca_dev *dev, u8 *status);
261 int mthca_QUERY_DDR(struct mthca_dev *dev, u8 *status);
262 int mthca_QUERY_DEV_LIM(struct mthca_dev *dev,
263 			struct mthca_dev_lim *dev_lim, u8 *status);
264 int mthca_QUERY_ADAPTER(struct mthca_dev *dev,
265 			struct mthca_adapter *adapter, u8 *status);
266 int mthca_INIT_HCA(struct mthca_dev *dev,
267 		   struct mthca_init_hca_param *param,
268 		   u8 *status);
269 int mthca_INIT_IB(struct mthca_dev *dev,
270 		  struct mthca_init_ib_param *param,
271 		  int port, u8 *status);
272 int mthca_CLOSE_IB(struct mthca_dev *dev, int port, u8 *status);
273 int mthca_CLOSE_HCA(struct mthca_dev *dev, int panic, u8 *status);
274 int mthca_SET_IB(struct mthca_dev *dev, struct mthca_set_ib_param *param,
275 		 int port, u8 *status);
276 int mthca_MAP_ICM(struct mthca_dev *dev, struct mthca_icm *icm, u64 virt, u8 *status);
277 int mthca_MAP_ICM_page(struct mthca_dev *dev, u64 dma_addr, u64 virt, u8 *status);
278 int mthca_UNMAP_ICM(struct mthca_dev *dev, u64 virt, u32 page_count, u8 *status);
279 int mthca_MAP_ICM_AUX(struct mthca_dev *dev, struct mthca_icm *icm, u8 *status);
280 int mthca_UNMAP_ICM_AUX(struct mthca_dev *dev, u8 *status);
281 int mthca_SET_ICM_SIZE(struct mthca_dev *dev, u64 icm_size, u64 *aux_pages,
282 		       u8 *status);
283 int mthca_SW2HW_MPT(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
284 		    int mpt_index, u8 *status);
285 int mthca_HW2SW_MPT(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
286 		    int mpt_index, u8 *status);
287 int mthca_WRITE_MTT(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
288 		    int num_mtt, u8 *status);
289 int mthca_SYNC_TPT(struct mthca_dev *dev, u8 *status);
290 int mthca_MAP_EQ(struct mthca_dev *dev, u64 event_mask, int unmap,
291 		 int eq_num, u8 *status);
292 int mthca_SW2HW_EQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
293 		   int eq_num, u8 *status);
294 int mthca_HW2SW_EQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
295 		   int eq_num, u8 *status);
296 int mthca_SW2HW_CQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
297 		   int cq_num, u8 *status);
298 int mthca_HW2SW_CQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
299 		   int cq_num, u8 *status);
300 int mthca_MODIFY_QP(struct mthca_dev *dev, int trans, u32 num,
301 		    int is_ee, struct mthca_mailbox *mailbox, u32 optmask,
302 		    u8 *status);
303 int mthca_QUERY_QP(struct mthca_dev *dev, u32 num, int is_ee,
304 		   struct mthca_mailbox *mailbox, u8 *status);
305 int mthca_CONF_SPECIAL_QP(struct mthca_dev *dev, int type, u32 qpn,
306 			  u8 *status);
307 int mthca_MAD_IFC(struct mthca_dev *dev, int ignore_mkey, int ignore_bkey,
308 		  int port, struct ib_wc *in_wc, struct ib_grh *in_grh,
309 		  void *in_mad, void *response_mad, u8 *status);
310 int mthca_READ_MGM(struct mthca_dev *dev, int index,
311 		   struct mthca_mailbox *mailbox, u8 *status);
312 int mthca_WRITE_MGM(struct mthca_dev *dev, int index,
313 		    struct mthca_mailbox *mailbox, u8 *status);
314 int mthca_MGID_HASH(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
315 		    u16 *hash, u8 *status);
316 int mthca_NOP(struct mthca_dev *dev, u8 *status);
317 
318 #endif /* MTHCA_CMD_H */
319