1 /* cnic_if.h: Broadcom CNIC core network driver.
2  *
3  * Copyright (c) 2006-2011 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.2.13"
16 #define CNIC_MODULE_RELDATE	"Jan 31, 2011"
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 
89 #define DRV_CTL_IO_WR_CMD		0x101
90 #define DRV_CTL_IO_RD_CMD		0x102
91 #define DRV_CTL_CTX_WR_CMD		0x103
92 #define DRV_CTL_CTXTBL_WR_CMD		0x104
93 #define DRV_CTL_RET_L5_SPQ_CREDIT_CMD	0x105
94 #define DRV_CTL_START_L2_CMD		0x106
95 #define DRV_CTL_STOP_L2_CMD		0x107
96 #define DRV_CTL_RET_L2_SPQ_CREDIT_CMD	0x10c
97 
98 struct cnic_ctl_completion {
99 	u32	cid;
100 };
101 
102 struct cnic_ctl_info {
103 	int	cmd;
104 	union {
105 		struct cnic_ctl_completion comp;
106 		char bytes[MAX_CNIC_CTL_DATA];
107 	} data;
108 };
109 
110 struct drv_ctl_spq_credit {
111 	u32	credit_count;
112 };
113 
114 struct drv_ctl_io {
115 	u32		cid_addr;
116 	u32		offset;
117 	u32		data;
118 	dma_addr_t	dma_addr;
119 };
120 
121 struct drv_ctl_l2_ring {
122 	u32		client_id;
123 	u32		cid;
124 };
125 
126 struct drv_ctl_info {
127 	int	cmd;
128 	union {
129 		struct drv_ctl_spq_credit credit;
130 		struct drv_ctl_io io;
131 		struct drv_ctl_l2_ring ring;
132 		char bytes[MAX_DRV_CTL_DATA];
133 	} data;
134 };
135 
136 struct cnic_ops {
137 	struct module	*cnic_owner;
138 	/* Calls to these functions are protected by RCU.  When
139 	 * unregistering, we wait for any calls to complete before
140 	 * continuing.
141 	 */
142 	int		(*cnic_handler)(void *, void *);
143 	int		(*cnic_ctl)(void *, struct cnic_ctl_info *);
144 };
145 
146 #define MAX_CNIC_VEC	8
147 
148 struct cnic_irq {
149 	unsigned int	vector;
150 	void		*status_blk;
151 	u32		status_blk_num;
152 	u32		status_blk_num2;
153 	u32		irq_flags;
154 #define CNIC_IRQ_FL_MSIX		0x00000001
155 };
156 
157 struct cnic_eth_dev {
158 	struct module	*drv_owner;
159 	u32		drv_state;
160 #define CNIC_DRV_STATE_REGD		0x00000001
161 #define CNIC_DRV_STATE_USING_MSIX	0x00000002
162 #define CNIC_DRV_STATE_NO_ISCSI_OOO	0x00000004
163 #define CNIC_DRV_STATE_NO_ISCSI		0x00000008
164 #define CNIC_DRV_STATE_NO_FCOE		0x00000010
165 	u32		chip_id;
166 	u32		max_kwqe_pending;
167 	struct pci_dev	*pdev;
168 	void __iomem	*io_base;
169 	void __iomem	*io_base2;
170 	void		*iro_arr;
171 
172 	u32		ctx_tbl_offset;
173 	u32		ctx_tbl_len;
174 	int		ctx_blk_size;
175 	u32		starting_cid;
176 	u32		max_iscsi_conn;
177 	u32		max_fcoe_conn;
178 	u32		max_rdma_conn;
179 	u32		fcoe_init_cid;
180 	u16		iscsi_l2_client_id;
181 	u16		iscsi_l2_cid;
182 	u8		iscsi_mac[ETH_ALEN];
183 
184 	int		num_irq;
185 	struct cnic_irq	irq_arr[MAX_CNIC_VEC];
186 	int		(*drv_register_cnic)(struct net_device *,
187 					     struct cnic_ops *, void *);
188 	int		(*drv_unregister_cnic)(struct net_device *);
189 	int		(*drv_submit_kwqes_32)(struct net_device *,
190 					       struct kwqe *[], u32);
191 	int		(*drv_submit_kwqes_16)(struct net_device *,
192 					       struct kwqe_16 *[], u32);
193 	int		(*drv_ctl)(struct net_device *, struct drv_ctl_info *);
194 	unsigned long	reserved1[2];
195 };
196 
197 struct cnic_sockaddr {
198 	union {
199 		struct sockaddr_in	v4;
200 		struct sockaddr_in6	v6;
201 	} local;
202 	union {
203 		struct sockaddr_in	v4;
204 		struct sockaddr_in6	v6;
205 	} remote;
206 };
207 
208 struct cnic_sock {
209 	struct cnic_dev *dev;
210 	void	*context;
211 	u32	src_ip[4];
212 	u32	dst_ip[4];
213 	u16	src_port;
214 	u16	dst_port;
215 	u16	vlan_id;
216 	unsigned char old_ha[6];
217 	unsigned char ha[6];
218 	u32	mtu;
219 	u32	cid;
220 	u32	l5_cid;
221 	u32	pg_cid;
222 	int	ulp_type;
223 
224 	u32	ka_timeout;
225 	u32	ka_interval;
226 	u8	ka_max_probe_count;
227 	u8	tos;
228 	u8	ttl;
229 	u8	snd_seq_scale;
230 	u32	rcv_buf;
231 	u32	snd_buf;
232 	u32	seed;
233 
234 	unsigned long	tcp_flags;
235 #define SK_TCP_NO_DELAY_ACK	0x1
236 #define SK_TCP_KEEP_ALIVE	0x2
237 #define SK_TCP_NAGLE		0x4
238 #define SK_TCP_TIMESTAMP	0x8
239 #define SK_TCP_SACK		0x10
240 #define SK_TCP_SEG_SCALING	0x20
241 	unsigned long	flags;
242 #define SK_F_INUSE		0
243 #define SK_F_OFFLD_COMPLETE	1
244 #define SK_F_OFFLD_SCHED	2
245 #define SK_F_PG_OFFLD_COMPLETE	3
246 #define SK_F_CONNECT_START	4
247 #define SK_F_IPV6		5
248 #define SK_F_CLOSING		7
249 
250 	atomic_t ref_count;
251 	u32 state;
252 	struct kwqe kwqe1;
253 	struct kwqe kwqe2;
254 	struct kwqe kwqe3;
255 };
256 
257 struct cnic_dev {
258 	struct net_device	*netdev;
259 	struct pci_dev		*pcidev;
260 	void __iomem		*regview;
261 	struct list_head	list;
262 
263 	int (*register_device)(struct cnic_dev *dev, int ulp_type,
264 			       void *ulp_ctx);
265 	int (*unregister_device)(struct cnic_dev *dev, int ulp_type);
266 	int (*submit_kwqes)(struct cnic_dev *dev, struct kwqe *wqes[],
267 				u32 num_wqes);
268 	int (*submit_kwqes_16)(struct cnic_dev *dev, struct kwqe_16 *wqes[],
269 				u32 num_wqes);
270 
271 	int (*cm_create)(struct cnic_dev *, int, u32, u32, struct cnic_sock **,
272 			 void *);
273 	int (*cm_destroy)(struct cnic_sock *);
274 	int (*cm_connect)(struct cnic_sock *, struct cnic_sockaddr *);
275 	int (*cm_abort)(struct cnic_sock *);
276 	int (*cm_close)(struct cnic_sock *);
277 	struct cnic_dev *(*cm_select_dev)(struct sockaddr_in *, int ulp_type);
278 	int (*iscsi_nl_msg_recv)(struct cnic_dev *dev, u32 msg_type,
279 				 char *data, u16 data_size);
280 	unsigned long	flags;
281 #define CNIC_F_CNIC_UP		1
282 #define CNIC_F_BNX2_CLASS	3
283 #define CNIC_F_BNX2X_CLASS	4
284 	atomic_t	ref_count;
285 	u8		mac_addr[6];
286 
287 	int		max_iscsi_conn;
288 	int		max_fcoe_conn;
289 	int		max_rdma_conn;
290 
291 	void		*cnic_priv;
292 };
293 
294 #define CNIC_WR(dev, off, val)		writel(val, dev->regview + off)
295 #define CNIC_WR16(dev, off, val)	writew(val, dev->regview + off)
296 #define CNIC_WR8(dev, off, val)		writeb(val, dev->regview + off)
297 #define CNIC_RD(dev, off)		readl(dev->regview + off)
298 #define CNIC_RD16(dev, off)		readw(dev->regview + off)
299 
300 struct cnic_ulp_ops {
301 	/* Calls to these functions are protected by RCU.  When
302 	 * unregistering, we wait for any calls to complete before
303 	 * continuing.
304 	 */
305 
306 	void (*cnic_init)(struct cnic_dev *dev);
307 	void (*cnic_exit)(struct cnic_dev *dev);
308 	void (*cnic_start)(void *ulp_ctx);
309 	void (*cnic_stop)(void *ulp_ctx);
310 	void (*indicate_kcqes)(void *ulp_ctx, struct kcqe *cqes[],
311 				u32 num_cqes);
312 	void (*indicate_netevent)(void *ulp_ctx, unsigned long event);
313 	void (*cm_connect_complete)(struct cnic_sock *);
314 	void (*cm_close_complete)(struct cnic_sock *);
315 	void (*cm_abort_complete)(struct cnic_sock *);
316 	void (*cm_remote_close)(struct cnic_sock *);
317 	void (*cm_remote_abort)(struct cnic_sock *);
318 	int (*iscsi_nl_send_msg)(void *ulp_ctx, u32 msg_type,
319 				  char *data, u16 data_size);
320 	struct module *owner;
321 	atomic_t ref_count;
322 };
323 
324 extern int cnic_register_driver(int ulp_type, struct cnic_ulp_ops *ulp_ops);
325 
326 extern int cnic_unregister_driver(int ulp_type);
327 
328 extern struct cnic_eth_dev *bnx2_cnic_probe(struct net_device *dev);
329 extern struct cnic_eth_dev *bnx2x_cnic_probe(struct net_device *dev);
330 
331 #endif
332