xref: /openbmc/linux/drivers/scsi/bnx2i/bnx2i_init.c (revision 4800cd83)
1 /* bnx2i.c: Broadcom NetXtreme II iSCSI driver.
2  *
3  * Copyright (c) 2006 - 2010 Broadcom Corporation
4  * Copyright (c) 2007, 2008 Red Hat, Inc.  All rights reserved.
5  * Copyright (c) 2007, 2008 Mike Christie
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation.
10  *
11  * Written by: Anil Veerabhadrappa (anilgv@broadcom.com)
12  * Maintained by: Eddie Wai (eddie.wai@broadcom.com)
13  */
14 
15 #include "bnx2i.h"
16 
17 static struct list_head adapter_list = LIST_HEAD_INIT(adapter_list);
18 static u32 adapter_count;
19 
20 #define DRV_MODULE_NAME		"bnx2i"
21 #define DRV_MODULE_VERSION	"2.6.2.2"
22 #define DRV_MODULE_RELDATE	"Nov 23, 2010"
23 
24 static char version[] __devinitdata =
25 		"Broadcom NetXtreme II iSCSI Driver " DRV_MODULE_NAME \
26 		" v" DRV_MODULE_VERSION " (" DRV_MODULE_RELDATE ")\n";
27 
28 
29 MODULE_AUTHOR("Anil Veerabhadrappa <anilgv@broadcom.com> and "
30 	      "Eddie Wai <eddie.wai@broadcom.com>");
31 
32 MODULE_DESCRIPTION("Broadcom NetXtreme II BCM5706/5708/5709/57710/57711"
33 		   " iSCSI Driver");
34 MODULE_LICENSE("GPL");
35 MODULE_VERSION(DRV_MODULE_VERSION);
36 
37 static DEFINE_MUTEX(bnx2i_dev_lock);
38 
39 unsigned int event_coal_min = 24;
40 module_param(event_coal_min, int, 0664);
41 MODULE_PARM_DESC(event_coal_min, "Event Coalescing Minimum Commands");
42 
43 unsigned int event_coal_div = 1;
44 module_param(event_coal_div, int, 0664);
45 MODULE_PARM_DESC(event_coal_div, "Event Coalescing Divide Factor");
46 
47 unsigned int en_tcp_dack = 1;
48 module_param(en_tcp_dack, int, 0664);
49 MODULE_PARM_DESC(en_tcp_dack, "Enable TCP Delayed ACK");
50 
51 unsigned int error_mask1 = 0x00;
52 module_param(error_mask1, int, 0664);
53 MODULE_PARM_DESC(error_mask1, "Config FW iSCSI Error Mask #1");
54 
55 unsigned int error_mask2 = 0x00;
56 module_param(error_mask2, int, 0664);
57 MODULE_PARM_DESC(error_mask2, "Config FW iSCSI Error Mask #2");
58 
59 unsigned int sq_size;
60 module_param(sq_size, int, 0664);
61 MODULE_PARM_DESC(sq_size, "Configure SQ size");
62 
63 unsigned int rq_size = BNX2I_RQ_WQES_DEFAULT;
64 module_param(rq_size, int, 0664);
65 MODULE_PARM_DESC(rq_size, "Configure RQ size");
66 
67 u64 iscsi_error_mask = 0x00;
68 
69 
70 /**
71  * bnx2i_identify_device - identifies NetXtreme II device type
72  * @hba: 		Adapter structure pointer
73  *
74  * This function identifies the NX2 device type and sets appropriate
75  *	queue mailbox register access method, 5709 requires driver to
76  *	access MBOX regs using *bin* mode
77  */
78 void bnx2i_identify_device(struct bnx2i_hba *hba)
79 {
80 	hba->cnic_dev_type = 0;
81 	if ((hba->pci_did == PCI_DEVICE_ID_NX2_5706) ||
82 	    (hba->pci_did == PCI_DEVICE_ID_NX2_5706S))
83 		set_bit(BNX2I_NX2_DEV_5706, &hba->cnic_dev_type);
84 	else if ((hba->pci_did == PCI_DEVICE_ID_NX2_5708) ||
85 	    (hba->pci_did == PCI_DEVICE_ID_NX2_5708S))
86 		set_bit(BNX2I_NX2_DEV_5708, &hba->cnic_dev_type);
87 	else if ((hba->pci_did == PCI_DEVICE_ID_NX2_5709) ||
88 	    (hba->pci_did == PCI_DEVICE_ID_NX2_5709S)) {
89 		set_bit(BNX2I_NX2_DEV_5709, &hba->cnic_dev_type);
90 		hba->mail_queue_access = BNX2I_MQ_BIN_MODE;
91 	} else if (hba->pci_did == PCI_DEVICE_ID_NX2_57710 ||
92 		   hba->pci_did == PCI_DEVICE_ID_NX2_57711 ||
93 		   hba->pci_did == PCI_DEVICE_ID_NX2_57711E)
94 		set_bit(BNX2I_NX2_DEV_57710, &hba->cnic_dev_type);
95 	else
96 		printk(KERN_ALERT "bnx2i: unknown device, 0x%x\n",
97 				  hba->pci_did);
98 }
99 
100 
101 /**
102  * get_adapter_list_head - returns head of adapter list
103  */
104 struct bnx2i_hba *get_adapter_list_head(void)
105 {
106 	struct bnx2i_hba *hba = NULL;
107 	struct bnx2i_hba *tmp_hba;
108 
109 	if (!adapter_count)
110 		goto hba_not_found;
111 
112 	mutex_lock(&bnx2i_dev_lock);
113 	list_for_each_entry(tmp_hba, &adapter_list, link) {
114 		if (tmp_hba->cnic && tmp_hba->cnic->cm_select_dev) {
115 			hba = tmp_hba;
116 			break;
117 		}
118 	}
119 	mutex_unlock(&bnx2i_dev_lock);
120 hba_not_found:
121 	return hba;
122 }
123 
124 
125 /**
126  * bnx2i_find_hba_for_cnic - maps cnic device instance to bnx2i adapter instance
127  * @cnic:	pointer to cnic device instance
128  *
129  */
130 struct bnx2i_hba *bnx2i_find_hba_for_cnic(struct cnic_dev *cnic)
131 {
132 	struct bnx2i_hba *hba, *temp;
133 
134 	mutex_lock(&bnx2i_dev_lock);
135 	list_for_each_entry_safe(hba, temp, &adapter_list, link) {
136 		if (hba->cnic == cnic) {
137 			mutex_unlock(&bnx2i_dev_lock);
138 			return hba;
139 		}
140 	}
141 	mutex_unlock(&bnx2i_dev_lock);
142 	return NULL;
143 }
144 
145 
146 /**
147  * bnx2i_start - cnic callback to initialize & start adapter instance
148  * @handle:	transparent handle pointing to adapter structure
149  *
150  * This function maps adapter structure to pcidev structure and initiates
151  *	firmware handshake to enable/initialize on chip iscsi components
152  * 	This bnx2i - cnic interface api callback is issued after following
153  *	2 conditions are met -
154  *	  a) underlying network interface is up (marked by event 'NETDEV_UP'
155  *		from netdev
156  *	  b) bnx2i adapter instance is registered
157  */
158 void bnx2i_start(void *handle)
159 {
160 #define BNX2I_INIT_POLL_TIME	(1000 / HZ)
161 	struct bnx2i_hba *hba = handle;
162 	int i = HZ;
163 
164 	bnx2i_send_fw_iscsi_init_msg(hba);
165 	while (!test_bit(ADAPTER_STATE_UP, &hba->adapter_state) && i--)
166 		msleep(BNX2I_INIT_POLL_TIME);
167 }
168 
169 
170 /**
171  * bnx2i_chip_cleanup - local routine to handle chip cleanup
172  * @hba:	Adapter instance to register
173  *
174  * Driver checks if adapter still has any active connections before
175  *	executing the cleanup process
176  */
177 static void bnx2i_chip_cleanup(struct bnx2i_hba *hba)
178 {
179 	struct bnx2i_endpoint *bnx2i_ep;
180 	struct list_head *pos, *tmp;
181 
182 	if (hba->ofld_conns_active) {
183 		/* Stage to force the disconnection
184 		 * This is the case where the daemon is either slow or
185 		 * not present
186 		 */
187 		printk(KERN_ALERT "bnx2i: (%s) chip cleanup for %d active "
188 			"connections\n", hba->netdev->name,
189 			hba->ofld_conns_active);
190 		mutex_lock(&hba->net_dev_lock);
191 		list_for_each_safe(pos, tmp, &hba->ep_active_list) {
192 			bnx2i_ep = list_entry(pos, struct bnx2i_endpoint, link);
193 			/* Clean up the chip only */
194 			bnx2i_hw_ep_disconnect(bnx2i_ep);
195 			bnx2i_ep->cm_sk = NULL;
196 		}
197 		mutex_unlock(&hba->net_dev_lock);
198 	}
199 }
200 
201 
202 /**
203  * bnx2i_stop - cnic callback to shutdown adapter instance
204  * @handle:	transparent handle pointing to adapter structure
205  *
206  * driver checks if adapter is already in shutdown mode, if not start
207  *	the shutdown process
208  */
209 void bnx2i_stop(void *handle)
210 {
211 	struct bnx2i_hba *hba = handle;
212 	int conns_active;
213 	int wait_delay = 1 * HZ;
214 
215 	/* check if cleanup happened in GOING_DOWN context */
216 	if (!test_and_set_bit(ADAPTER_STATE_GOING_DOWN,
217 			      &hba->adapter_state)) {
218 		iscsi_host_for_each_session(hba->shost,
219 					    bnx2i_drop_session);
220 		wait_delay = hba->hba_shutdown_tmo;
221 	}
222 	/* Wait for inflight offload connection tasks to complete before
223 	 * proceeding. Forcefully terminate all connection recovery in
224 	 * progress at the earliest, either in bind(), send_pdu(LOGIN),
225 	 * or conn_start()
226 	 */
227 	wait_event_interruptible_timeout(hba->eh_wait,
228 					 (list_empty(&hba->ep_ofld_list) &&
229 					 list_empty(&hba->ep_destroy_list)),
230 					 10 * HZ);
231 	/* Wait for all endpoints to be torn down, Chip will be reset once
232 	 *  control returns to network driver. So it is required to cleanup and
233 	 * release all connection resources before returning from this routine.
234 	 */
235 	while (hba->ofld_conns_active) {
236 		conns_active = hba->ofld_conns_active;
237 		wait_event_interruptible_timeout(hba->eh_wait,
238 				(hba->ofld_conns_active != conns_active),
239 				wait_delay);
240 		if (hba->ofld_conns_active == conns_active)
241 			break;
242 	}
243 	bnx2i_chip_cleanup(hba);
244 
245 	/* This flag should be cleared last so that ep_disconnect() gracefully
246 	 * cleans up connection context
247 	 */
248 	clear_bit(ADAPTER_STATE_GOING_DOWN, &hba->adapter_state);
249 	clear_bit(ADAPTER_STATE_UP, &hba->adapter_state);
250 }
251 
252 
253 /**
254  * bnx2i_init_one - initialize an adapter instance and allocate memory resources
255  * @hba:	bnx2i adapter instance
256  * @cnic:	cnic device handle
257  *
258  * Global resource lock is held during critical sections below. This routine is
259  *	called from either cnic_register_driver() or device hot plug context and
260  *	and does majority of device specific initialization
261  */
262 static int bnx2i_init_one(struct bnx2i_hba *hba, struct cnic_dev *cnic)
263 {
264 	int rc;
265 
266 	mutex_lock(&bnx2i_dev_lock);
267 	hba->cnic = cnic;
268 	rc = cnic->register_device(cnic, CNIC_ULP_ISCSI, hba);
269 	if (!rc) {
270 		hba->age++;
271 		set_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
272 		list_add_tail(&hba->link, &adapter_list);
273 		adapter_count++;
274 	} else if (rc == -EBUSY) 	/* duplicate registration */
275 		printk(KERN_ALERT "bnx2i, duplicate registration"
276 				  "hba=%p, cnic=%p\n", hba, cnic);
277 	else if (rc == -EAGAIN)
278 		printk(KERN_ERR "bnx2i, driver not registered\n");
279 	else if (rc == -EINVAL)
280 		printk(KERN_ERR "bnx2i, invalid type %d\n", CNIC_ULP_ISCSI);
281 	else
282 		printk(KERN_ERR "bnx2i dev reg, unknown error, %d\n", rc);
283 
284 	mutex_unlock(&bnx2i_dev_lock);
285 
286 	return rc;
287 }
288 
289 
290 /**
291  * bnx2i_ulp_init - initialize an adapter instance
292  * @dev:	cnic device handle
293  *
294  * Called from cnic_register_driver() context to initialize all enumerated
295  *	cnic devices. This routine allocate adapter structure and other
296  *	device specific resources.
297  */
298 void bnx2i_ulp_init(struct cnic_dev *dev)
299 {
300 	struct bnx2i_hba *hba;
301 
302 	/* Allocate a HBA structure for this device */
303 	hba = bnx2i_alloc_hba(dev);
304 	if (!hba) {
305 		printk(KERN_ERR "bnx2i init: hba initialization failed\n");
306 		return;
307 	}
308 
309 	/* Get PCI related information and update hba struct members */
310 	clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
311 	if (bnx2i_init_one(hba, dev)) {
312 		printk(KERN_ERR "bnx2i - hba %p init failed\n", hba);
313 		bnx2i_free_hba(hba);
314 	}
315 }
316 
317 
318 /**
319  * bnx2i_ulp_exit - shuts down adapter instance and frees all resources
320  * @dev:	cnic device handle
321  *
322  */
323 void bnx2i_ulp_exit(struct cnic_dev *dev)
324 {
325 	struct bnx2i_hba *hba;
326 
327 	hba = bnx2i_find_hba_for_cnic(dev);
328 	if (!hba) {
329 		printk(KERN_INFO "bnx2i_ulp_exit: hba not "
330 				 "found, dev 0x%p\n", dev);
331 		return;
332 	}
333 	mutex_lock(&bnx2i_dev_lock);
334 	list_del_init(&hba->link);
335 	adapter_count--;
336 
337 	if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
338 		hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
339 		clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
340 	}
341 	mutex_unlock(&bnx2i_dev_lock);
342 
343 	bnx2i_free_hba(hba);
344 }
345 
346 
347 /**
348  * bnx2i_mod_init - module init entry point
349  *
350  * initialize any driver wide global data structures such as endpoint pool,
351  *	tcp port manager/queue, sysfs. finally driver will register itself
352  *	with the cnic module
353  */
354 static int __init bnx2i_mod_init(void)
355 {
356 	int err;
357 
358 	printk(KERN_INFO "%s", version);
359 
360 	if (sq_size && !is_power_of_2(sq_size))
361 		sq_size = roundup_pow_of_two(sq_size);
362 
363 	mutex_init(&bnx2i_dev_lock);
364 
365 	bnx2i_scsi_xport_template =
366 			iscsi_register_transport(&bnx2i_iscsi_transport);
367 	if (!bnx2i_scsi_xport_template) {
368 		printk(KERN_ERR "Could not register bnx2i transport.\n");
369 		err = -ENOMEM;
370 		goto out;
371 	}
372 
373 	err = cnic_register_driver(CNIC_ULP_ISCSI, &bnx2i_cnic_cb);
374 	if (err) {
375 		printk(KERN_ERR "Could not register bnx2i cnic driver.\n");
376 		goto unreg_xport;
377 	}
378 
379 	return 0;
380 
381 unreg_xport:
382 	iscsi_unregister_transport(&bnx2i_iscsi_transport);
383 out:
384 	return err;
385 }
386 
387 
388 /**
389  * bnx2i_mod_exit - module cleanup/exit entry point
390  *
391  * Global resource lock and host adapter lock is held during critical sections
392  *	in this function. Driver will browse through the adapter list, cleans-up
393  *	each instance, unregisters iscsi transport name and finally driver will
394  *	unregister itself with the cnic module
395  */
396 static void __exit bnx2i_mod_exit(void)
397 {
398 	struct bnx2i_hba *hba;
399 
400 	mutex_lock(&bnx2i_dev_lock);
401 	while (!list_empty(&adapter_list)) {
402 		hba = list_entry(adapter_list.next, struct bnx2i_hba, link);
403 		list_del(&hba->link);
404 		adapter_count--;
405 
406 		if (test_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic)) {
407 			bnx2i_chip_cleanup(hba);
408 			hba->cnic->unregister_device(hba->cnic, CNIC_ULP_ISCSI);
409 			clear_bit(BNX2I_CNIC_REGISTERED, &hba->reg_with_cnic);
410 		}
411 
412 		bnx2i_free_hba(hba);
413 	}
414 	mutex_unlock(&bnx2i_dev_lock);
415 
416 	iscsi_unregister_transport(&bnx2i_iscsi_transport);
417 	cnic_unregister_driver(CNIC_ULP_ISCSI);
418 }
419 
420 module_init(bnx2i_mod_init);
421 module_exit(bnx2i_mod_exit);
422