1 /* cnic_if.h: Broadcom CNIC core network driver.
2  *
3  * Copyright (c) 2006-2012 Broadcom Corporation
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation.
8  *
9  */
10 
11 
12 #ifndef CNIC_IF_H
13 #define CNIC_IF_H
14 
15 #define CNIC_MODULE_VERSION	"2.5.10"
16 #define CNIC_MODULE_RELDATE	"March 21, 2012"
17 
18 #define CNIC_ULP_RDMA		0
19 #define CNIC_ULP_ISCSI		1
20 #define CNIC_ULP_FCOE		2
21 #define CNIC_ULP_L4		3
22 #define MAX_CNIC_ULP_TYPE_EXT	3
23 #define MAX_CNIC_ULP_TYPE	4
24 
25 struct kwqe {
26 	u32 kwqe_op_flag;
27 
28 #define KWQE_QID_SHIFT		8
29 #define KWQE_OPCODE_MASK	0x00ff0000
30 #define KWQE_OPCODE_SHIFT	16
31 #define KWQE_OPCODE(x)		((x & KWQE_OPCODE_MASK) >> KWQE_OPCODE_SHIFT)
32 #define KWQE_LAYER_MASK			0x70000000
33 #define KWQE_LAYER_SHIFT		28
34 #define KWQE_FLAGS_LAYER_MASK_L2	(2<<28)
35 #define KWQE_FLAGS_LAYER_MASK_L3	(3<<28)
36 #define KWQE_FLAGS_LAYER_MASK_L4	(4<<28)
37 #define KWQE_FLAGS_LAYER_MASK_L5_RDMA	(5<<28)
38 #define KWQE_FLAGS_LAYER_MASK_L5_ISCSI	(6<<28)
39 #define KWQE_FLAGS_LAYER_MASK_L5_FCOE	(7<<28)
40 
41 	u32 kwqe_info0;
42 	u32 kwqe_info1;
43 	u32 kwqe_info2;
44 	u32 kwqe_info3;
45 	u32 kwqe_info4;
46 	u32 kwqe_info5;
47 	u32 kwqe_info6;
48 };
49 
50 struct kwqe_16 {
51 	u32 kwqe_info0;
52 	u32 kwqe_info1;
53 	u32 kwqe_info2;
54 	u32 kwqe_info3;
55 };
56 
57 struct kcqe {
58 	u32 kcqe_info0;
59 	u32 kcqe_info1;
60 	u32 kcqe_info2;
61 	u32 kcqe_info3;
62 	u32 kcqe_info4;
63 	u32 kcqe_info5;
64 	u32 kcqe_info6;
65 	u32 kcqe_op_flag;
66 		#define KCQE_RAMROD_COMPLETION		(0x1<<27) /* Everest */
67 		#define KCQE_FLAGS_LAYER_MASK		(0x7<<28)
68 		#define KCQE_FLAGS_LAYER_MASK_MISC	(0<<28)
69 		#define KCQE_FLAGS_LAYER_MASK_L2	(2<<28)
70 		#define KCQE_FLAGS_LAYER_MASK_L3	(3<<28)
71 		#define KCQE_FLAGS_LAYER_MASK_L4	(4<<28)
72 		#define KCQE_FLAGS_LAYER_MASK_L5_RDMA	(5<<28)
73 		#define KCQE_FLAGS_LAYER_MASK_L5_ISCSI	(6<<28)
74 		#define KCQE_FLAGS_LAYER_MASK_L5_FCOE	(7<<28)
75 		#define KCQE_FLAGS_NEXT 		(1<<31)
76 		#define KCQE_FLAGS_OPCODE_MASK		(0xff<<16)
77 		#define KCQE_FLAGS_OPCODE_SHIFT		(16)
78 		#define KCQE_OPCODE(op)			\
79 		(((op) & KCQE_FLAGS_OPCODE_MASK) >> KCQE_FLAGS_OPCODE_SHIFT)
80 };
81 
82 #define MAX_CNIC_CTL_DATA	64
83 #define MAX_DRV_CTL_DATA	64
84 
85 #define CNIC_CTL_STOP_CMD		1
86 #define CNIC_CTL_START_CMD		2
87 #define CNIC_CTL_COMPLETION_CMD		3
88 #define CNIC_CTL_STOP_ISCSI_CMD		4
89 #define CNIC_CTL_FCOE_STATS_GET_CMD	5
90 #define CNIC_CTL_ISCSI_STATS_GET_CMD	6
91 
92 #define DRV_CTL_IO_WR_CMD		0x101
93 #define DRV_CTL_IO_RD_CMD		0x102
94 #define DRV_CTL_CTX_WR_CMD		0x103
95 #define DRV_CTL_CTXTBL_WR_CMD		0x104
96 #define DRV_CTL_RET_L5_SPQ_CREDIT_CMD	0x105
97 #define DRV_CTL_START_L2_CMD		0x106
98 #define DRV_CTL_STOP_L2_CMD		0x107
99 #define DRV_CTL_RET_L2_SPQ_CREDIT_CMD	0x10c
100 #define DRV_CTL_ISCSI_STOPPED_CMD	0x10d
101 #define DRV_CTL_ULP_REGISTER_CMD	0x10e
102 #define DRV_CTL_ULP_UNREGISTER_CMD	0x10f
103 
104 struct cnic_ctl_completion {
105 	u32	cid;
106 	u8	opcode;
107 	u8	error;
108 };
109 
110 struct cnic_ctl_info {
111 	int	cmd;
112 	union {
113 		struct cnic_ctl_completion comp;
114 		char bytes[MAX_CNIC_CTL_DATA];
115 	} data;
116 };
117 
118 struct drv_ctl_spq_credit {
119 	u32	credit_count;
120 };
121 
122 struct drv_ctl_io {
123 	u32		cid_addr;
124 	u32		offset;
125 	u32		data;
126 	dma_addr_t	dma_addr;
127 };
128 
129 struct drv_ctl_l2_ring {
130 	u32		client_id;
131 	u32		cid;
132 };
133 
134 struct drv_ctl_info {
135 	int	cmd;
136 	union {
137 		struct drv_ctl_spq_credit credit;
138 		struct drv_ctl_io io;
139 		struct drv_ctl_l2_ring ring;
140 		int ulp_type;
141 		char bytes[MAX_DRV_CTL_DATA];
142 	} data;
143 };
144 
145 struct cnic_ops {
146 	struct module	*cnic_owner;
147 	/* Calls to these functions are protected by RCU.  When
148 	 * unregistering, we wait for any calls to complete before
149 	 * continuing.
150 	 */
151 	int		(*cnic_handler)(void *, void *);
152 	int		(*cnic_ctl)(void *, struct cnic_ctl_info *);
153 };
154 
155 #define MAX_CNIC_VEC	8
156 
157 struct cnic_irq {
158 	unsigned int	vector;
159 	void		*status_blk;
160 	u32		status_blk_num;
161 	u32		status_blk_num2;
162 	u32		irq_flags;
163 #define CNIC_IRQ_FL_MSIX		0x00000001
164 };
165 
166 struct cnic_eth_dev {
167 	struct module	*drv_owner;
168 	u32		drv_state;
169 #define CNIC_DRV_STATE_REGD		0x00000001
170 #define CNIC_DRV_STATE_USING_MSIX	0x00000002
171 #define CNIC_DRV_STATE_NO_ISCSI_OOO	0x00000004
172 #define CNIC_DRV_STATE_NO_ISCSI		0x00000008
173 #define CNIC_DRV_STATE_NO_FCOE		0x00000010
174 	u32		chip_id;
175 	u32		max_kwqe_pending;
176 	struct pci_dev	*pdev;
177 	void __iomem	*io_base;
178 	void __iomem	*io_base2;
179 	const void	*iro_arr;
180 
181 	u32		ctx_tbl_offset;
182 	u32		ctx_tbl_len;
183 	int		ctx_blk_size;
184 	u32		starting_cid;
185 	u32		max_iscsi_conn;
186 	u32		max_fcoe_conn;
187 	u32		max_rdma_conn;
188 	u32		fcoe_init_cid;
189 	u32		fcoe_wwn_port_name_hi;
190 	u32		fcoe_wwn_port_name_lo;
191 	u32		fcoe_wwn_node_name_hi;
192 	u32		fcoe_wwn_node_name_lo;
193 
194 	u16		iscsi_l2_client_id;
195 	u16		iscsi_l2_cid;
196 	u8		iscsi_mac[ETH_ALEN];
197 
198 	int		num_irq;
199 	struct cnic_irq	irq_arr[MAX_CNIC_VEC];
200 	int		(*drv_register_cnic)(struct net_device *,
201 					     struct cnic_ops *, void *);
202 	int		(*drv_unregister_cnic)(struct net_device *);
203 	int		(*drv_submit_kwqes_32)(struct net_device *,
204 					       struct kwqe *[], u32);
205 	int		(*drv_submit_kwqes_16)(struct net_device *,
206 					       struct kwqe_16 *[], u32);
207 	int		(*drv_ctl)(struct net_device *, struct drv_ctl_info *);
208 	unsigned long	reserved1[2];
209 	union drv_info_to_mcp	*addr_drv_info_to_mcp;
210 };
211 
212 struct cnic_sockaddr {
213 	union {
214 		struct sockaddr_in	v4;
215 		struct sockaddr_in6	v6;
216 	} local;
217 	union {
218 		struct sockaddr_in	v4;
219 		struct sockaddr_in6	v6;
220 	} remote;
221 };
222 
223 struct cnic_sock {
224 	struct cnic_dev *dev;
225 	void	*context;
226 	u32	src_ip[4];
227 	u32	dst_ip[4];
228 	u16	src_port;
229 	u16	dst_port;
230 	u16	vlan_id;
231 	unsigned char old_ha[6];
232 	unsigned char ha[6];
233 	u32	mtu;
234 	u32	cid;
235 	u32	l5_cid;
236 	u32	pg_cid;
237 	int	ulp_type;
238 
239 	u32	ka_timeout;
240 	u32	ka_interval;
241 	u8	ka_max_probe_count;
242 	u8	tos;
243 	u8	ttl;
244 	u8	snd_seq_scale;
245 	u32	rcv_buf;
246 	u32	snd_buf;
247 	u32	seed;
248 
249 	unsigned long	tcp_flags;
250 #define SK_TCP_NO_DELAY_ACK	0x1
251 #define SK_TCP_KEEP_ALIVE	0x2
252 #define SK_TCP_NAGLE		0x4
253 #define SK_TCP_TIMESTAMP	0x8
254 #define SK_TCP_SACK		0x10
255 #define SK_TCP_SEG_SCALING	0x20
256 	unsigned long	flags;
257 #define SK_F_INUSE		0
258 #define SK_F_OFFLD_COMPLETE	1
259 #define SK_F_OFFLD_SCHED	2
260 #define SK_F_PG_OFFLD_COMPLETE	3
261 #define SK_F_CONNECT_START	4
262 #define SK_F_IPV6		5
263 #define SK_F_CLOSING		7
264 #define SK_F_HW_ERR		8
265 
266 	atomic_t ref_count;
267 	u32 state;
268 	struct kwqe kwqe1;
269 	struct kwqe kwqe2;
270 	struct kwqe kwqe3;
271 };
272 
273 struct cnic_dev {
274 	struct net_device	*netdev;
275 	struct pci_dev		*pcidev;
276 	void __iomem		*regview;
277 	struct list_head	list;
278 
279 	int (*register_device)(struct cnic_dev *dev, int ulp_type,
280 			       void *ulp_ctx);
281 	int (*unregister_device)(struct cnic_dev *dev, int ulp_type);
282 	int (*submit_kwqes)(struct cnic_dev *dev, struct kwqe *wqes[],
283 				u32 num_wqes);
284 	int (*submit_kwqes_16)(struct cnic_dev *dev, struct kwqe_16 *wqes[],
285 				u32 num_wqes);
286 
287 	int (*cm_create)(struct cnic_dev *, int, u32, u32, struct cnic_sock **,
288 			 void *);
289 	int (*cm_destroy)(struct cnic_sock *);
290 	int (*cm_connect)(struct cnic_sock *, struct cnic_sockaddr *);
291 	int (*cm_abort)(struct cnic_sock *);
292 	int (*cm_close)(struct cnic_sock *);
293 	struct cnic_dev *(*cm_select_dev)(struct sockaddr_in *, int ulp_type);
294 	int (*iscsi_nl_msg_recv)(struct cnic_dev *dev, u32 msg_type,
295 				 char *data, u16 data_size);
296 	unsigned long	flags;
297 #define CNIC_F_CNIC_UP		1
298 #define CNIC_F_BNX2_CLASS	3
299 #define CNIC_F_BNX2X_CLASS	4
300 	atomic_t	ref_count;
301 	u8		mac_addr[6];
302 
303 	int		max_iscsi_conn;
304 	int		max_fcoe_conn;
305 	int		max_rdma_conn;
306 
307 	union drv_info_to_mcp	*stats_addr;
308 
309 	void		*cnic_priv;
310 };
311 
312 #define CNIC_WR(dev, off, val)		writel(val, dev->regview + off)
313 #define CNIC_WR16(dev, off, val)	writew(val, dev->regview + off)
314 #define CNIC_WR8(dev, off, val)		writeb(val, dev->regview + off)
315 #define CNIC_RD(dev, off)		readl(dev->regview + off)
316 #define CNIC_RD16(dev, off)		readw(dev->regview + off)
317 
318 struct cnic_ulp_ops {
319 	/* Calls to these functions are protected by RCU.  When
320 	 * unregistering, we wait for any calls to complete before
321 	 * continuing.
322 	 */
323 
324 	void (*cnic_init)(struct cnic_dev *dev);
325 	void (*cnic_exit)(struct cnic_dev *dev);
326 	void (*cnic_start)(void *ulp_ctx);
327 	void (*cnic_stop)(void *ulp_ctx);
328 	void (*indicate_kcqes)(void *ulp_ctx, struct kcqe *cqes[],
329 				u32 num_cqes);
330 	void (*indicate_netevent)(void *ulp_ctx, unsigned long event, u16 vid);
331 	void (*cm_connect_complete)(struct cnic_sock *);
332 	void (*cm_close_complete)(struct cnic_sock *);
333 	void (*cm_abort_complete)(struct cnic_sock *);
334 	void (*cm_remote_close)(struct cnic_sock *);
335 	void (*cm_remote_abort)(struct cnic_sock *);
336 	int (*iscsi_nl_send_msg)(void *ulp_ctx, u32 msg_type,
337 				  char *data, u16 data_size);
338 	int (*cnic_get_stats)(void *ulp_ctx);
339 	struct module *owner;
340 	atomic_t ref_count;
341 };
342 
343 extern int cnic_register_driver(int ulp_type, struct cnic_ulp_ops *ulp_ops);
344 
345 extern int cnic_unregister_driver(int ulp_type);
346 
347 extern struct cnic_eth_dev *bnx2_cnic_probe(struct net_device *dev);
348 extern struct cnic_eth_dev *bnx2x_cnic_probe(struct net_device *dev);
349 
350 #endif
351