1/*
2 * Copyright (c) 2004, 2005 Topspin Communications.  All rights reserved.
3 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
4 * Copyright (c) 2006 Cisco Systems.  All rights reserved.
5 *
6 * This software is available to you under a choice of one of two
7 * licenses.  You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
11 *
12 *     Redistribution and use in source and binary forms, with or
13 *     without modification, are permitted provided that the following
14 *     conditions are met:
15 *
16 *      - Redistributions of source code must retain the above
17 *        copyright notice, this list of conditions and the following
18 *        disclaimer.
19 *
20 *      - Redistributions in binary form must reproduce the above
21 *        copyright notice, this list of conditions and the following
22 *        disclaimer in the documentation and/or other materials
23 *        provided with the distribution.
24 *
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 * SOFTWARE.
33 */
34
35#ifndef MTHCA_CMD_H
36#define MTHCA_CMD_H
37
38#include <rdma/ib_verbs.h>
39
40#define MTHCA_MAILBOX_SIZE 4096
41
42enum {
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
81enum {
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
96enum {
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_IPOIB_CSUM		= 1 << 7,
105	DEV_LIM_FLAG_BAD_PKEY_CNTR      = 1 << 8,
106	DEV_LIM_FLAG_BAD_QKEY_CNTR      = 1 << 9,
107	DEV_LIM_FLAG_MW                 = 1 << 16,
108	DEV_LIM_FLAG_AUTO_PATH_MIG      = 1 << 17,
109	DEV_LIM_FLAG_ATOMIC             = 1 << 18,
110	DEV_LIM_FLAG_RAW_MULTI          = 1 << 19,
111	DEV_LIM_FLAG_UD_AV_PORT_ENFORCE = 1 << 20,
112	DEV_LIM_FLAG_UD_MULTI           = 1 << 21,
113};
114
115struct mthca_mailbox {
116	dma_addr_t dma;
117	void      *buf;
118};
119
120struct mthca_dev_lim {
121	int max_srq_sz;
122	int max_qp_sz;
123	int reserved_qps;
124	int max_qps;
125	int reserved_srqs;
126	int max_srqs;
127	int reserved_eecs;
128	int max_eecs;
129	int max_cq_sz;
130	int reserved_cqs;
131	int max_cqs;
132	int max_mpts;
133	int reserved_eqs;
134	int max_eqs;
135	int reserved_mtts;
136	int max_mrw_sz;
137	int reserved_mrws;
138	int max_mtt_seg;
139	int max_requester_per_qp;
140	int max_responder_per_qp;
141	int max_rdma_global;
142	int local_ca_ack_delay;
143	int max_mtu;
144	int max_port_width;
145	int max_vl;
146	int num_ports;
147	int max_gids;
148	u16 stat_rate_support;
149	int max_pkeys;
150	u32 flags;
151	int reserved_uars;
152	int uar_size;
153	int min_page_sz;
154	int max_sg;
155	int max_desc_sz;
156	int max_qp_per_mcg;
157	int reserved_mgms;
158	int max_mcgs;
159	int reserved_pds;
160	int max_pds;
161	int reserved_rdds;
162	int max_rdds;
163	int eec_entry_sz;
164	int qpc_entry_sz;
165	int eeec_entry_sz;
166	int eqpc_entry_sz;
167	int eqc_entry_sz;
168	int cqc_entry_sz;
169	int srq_entry_sz;
170	int uar_scratch_entry_sz;
171	int mpt_entry_sz;
172	union {
173		struct {
174			int max_avs;
175		} tavor;
176		struct {
177			int resize_srq;
178			int max_pbl_sz;
179			u8  bmme_flags;
180			u32 reserved_lkey;
181			int lam_required;
182			u64 max_icm_sz;
183		} arbel;
184	} hca;
185};
186
187struct mthca_adapter {
188	u32  vendor_id;
189	u32  device_id;
190	u32  revision_id;
191	char board_id[MTHCA_BOARD_ID_LEN];
192	u8   inta_pin;
193};
194
195struct mthca_init_hca_param {
196	u64 qpc_base;
197	u64 eec_base;
198	u64 srqc_base;
199	u64 cqc_base;
200	u64 eqpc_base;
201	u64 eeec_base;
202	u64 eqc_base;
203	u64 rdb_base;
204	u64 mc_base;
205	u64 mpt_base;
206	u64 mtt_base;
207	u64 uar_scratch_base;
208	u64 uarc_base;
209	u16 log_mc_entry_sz;
210	u16 mc_hash_sz;
211	u8  log_num_qps;
212	u8  log_num_eecs;
213	u8  log_num_srqs;
214	u8  log_num_cqs;
215	u8  log_num_eqs;
216	u8  log_mc_table_sz;
217	u8  mtt_seg_sz;
218	u8  log_mpt_sz;
219	u8  log_uar_sz;
220	u8  log_uarc_sz;
221};
222
223struct mthca_init_ib_param {
224	int port_width;
225	int vl_cap;
226	int mtu_cap;
227	u16 gid_cap;
228	u16 pkey_cap;
229	int set_guid0;
230	u64 guid0;
231	int set_node_guid;
232	u64 node_guid;
233	int set_si_guid;
234	u64 si_guid;
235};
236
237struct mthca_set_ib_param {
238	int set_si_guid;
239	int reset_qkey_viol;
240	u64 si_guid;
241	u32 cap_mask;
242};
243
244int mthca_cmd_init(struct mthca_dev *dev);
245void mthca_cmd_cleanup(struct mthca_dev *dev);
246int mthca_cmd_use_events(struct mthca_dev *dev);
247void mthca_cmd_use_polling(struct mthca_dev *dev);
248void mthca_cmd_event(struct mthca_dev *dev, u16 token,
249		     u8  status, u64 out_param);
250
251struct mthca_mailbox *mthca_alloc_mailbox(struct mthca_dev *dev,
252					  gfp_t gfp_mask);
253void mthca_free_mailbox(struct mthca_dev *dev, struct mthca_mailbox *mailbox);
254
255int mthca_SYS_EN(struct mthca_dev *dev, u8 *status);
256int mthca_SYS_DIS(struct mthca_dev *dev, u8 *status);
257int mthca_MAP_FA(struct mthca_dev *dev, struct mthca_icm *icm, u8 *status);
258int mthca_UNMAP_FA(struct mthca_dev *dev, u8 *status);
259int mthca_RUN_FW(struct mthca_dev *dev, u8 *status);
260int mthca_QUERY_FW(struct mthca_dev *dev, u8 *status);
261int mthca_ENABLE_LAM(struct mthca_dev *dev, u8 *status);
262int mthca_DISABLE_LAM(struct mthca_dev *dev, u8 *status);
263int mthca_QUERY_DDR(struct mthca_dev *dev, u8 *status);
264int mthca_QUERY_DEV_LIM(struct mthca_dev *dev,
265			struct mthca_dev_lim *dev_lim, u8 *status);
266int mthca_QUERY_ADAPTER(struct mthca_dev *dev,
267			struct mthca_adapter *adapter, u8 *status);
268int mthca_INIT_HCA(struct mthca_dev *dev,
269		   struct mthca_init_hca_param *param,
270		   u8 *status);
271int mthca_INIT_IB(struct mthca_dev *dev,
272		  struct mthca_init_ib_param *param,
273		  int port, u8 *status);
274int mthca_CLOSE_IB(struct mthca_dev *dev, int port, u8 *status);
275int mthca_CLOSE_HCA(struct mthca_dev *dev, int panic, u8 *status);
276int mthca_SET_IB(struct mthca_dev *dev, struct mthca_set_ib_param *param,
277		 int port, u8 *status);
278int mthca_MAP_ICM(struct mthca_dev *dev, struct mthca_icm *icm, u64 virt, u8 *status);
279int mthca_MAP_ICM_page(struct mthca_dev *dev, u64 dma_addr, u64 virt, u8 *status);
280int mthca_UNMAP_ICM(struct mthca_dev *dev, u64 virt, u32 page_count, u8 *status);
281int mthca_MAP_ICM_AUX(struct mthca_dev *dev, struct mthca_icm *icm, u8 *status);
282int mthca_UNMAP_ICM_AUX(struct mthca_dev *dev, u8 *status);
283int mthca_SET_ICM_SIZE(struct mthca_dev *dev, u64 icm_size, u64 *aux_pages,
284		       u8 *status);
285int mthca_SW2HW_MPT(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
286		    int mpt_index, u8 *status);
287int mthca_HW2SW_MPT(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
288		    int mpt_index, u8 *status);
289int mthca_WRITE_MTT(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
290		    int num_mtt, u8 *status);
291int mthca_SYNC_TPT(struct mthca_dev *dev, u8 *status);
292int mthca_MAP_EQ(struct mthca_dev *dev, u64 event_mask, int unmap,
293		 int eq_num, u8 *status);
294int mthca_SW2HW_EQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
295		   int eq_num, u8 *status);
296int mthca_HW2SW_EQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
297		   int eq_num, u8 *status);
298int mthca_SW2HW_CQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
299		   int cq_num, u8 *status);
300int mthca_HW2SW_CQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
301		   int cq_num, u8 *status);
302int mthca_RESIZE_CQ(struct mthca_dev *dev, int cq_num, u32 lkey, u8 log_size,
303		    u8 *status);
304int mthca_SW2HW_SRQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
305		    int srq_num, u8 *status);
306int mthca_HW2SW_SRQ(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
307		    int srq_num, u8 *status);
308int mthca_QUERY_SRQ(struct mthca_dev *dev, u32 num,
309		    struct mthca_mailbox *mailbox, u8 *status);
310int mthca_ARM_SRQ(struct mthca_dev *dev, int srq_num, int limit, u8 *status);
311int mthca_MODIFY_QP(struct mthca_dev *dev, enum ib_qp_state cur,
312		    enum ib_qp_state next, u32 num, int is_ee,
313		    struct mthca_mailbox *mailbox, u32 optmask,
314		    u8 *status);
315int mthca_QUERY_QP(struct mthca_dev *dev, u32 num, int is_ee,
316		   struct mthca_mailbox *mailbox, u8 *status);
317int mthca_CONF_SPECIAL_QP(struct mthca_dev *dev, int type, u32 qpn,
318			  u8 *status);
319int mthca_MAD_IFC(struct mthca_dev *dev, int ignore_mkey, int ignore_bkey,
320		  int port, struct ib_wc *in_wc, struct ib_grh *in_grh,
321		  void *in_mad, void *response_mad, u8 *status);
322int mthca_READ_MGM(struct mthca_dev *dev, int index,
323		   struct mthca_mailbox *mailbox, u8 *status);
324int mthca_WRITE_MGM(struct mthca_dev *dev, int index,
325		    struct mthca_mailbox *mailbox, u8 *status);
326int mthca_MGID_HASH(struct mthca_dev *dev, struct mthca_mailbox *mailbox,
327		    u16 *hash, u8 *status);
328int mthca_NOP(struct mthca_dev *dev, u8 *status);
329
330#endif /* MTHCA_CMD_H */
331