xref: /openbmc/linux/drivers/firmware/iscsi_ibft.c (revision d9e32672)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  Copyright 2007-2010 Red Hat, Inc.
4  *  by Peter Jones <pjones@redhat.com>
5  *  Copyright 2008 IBM, Inc.
6  *  by Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
7  *  Copyright 2008
8  *  by Konrad Rzeszutek <ketuzsezr@darnok.org>
9  *
10  * This code exposes the iSCSI Boot Format Table to userland via sysfs.
11  *
12  * Changelog:
13  *
14  *  06 Jan 2010 - Peter Jones <pjones@redhat.com>
15  *    New changelog entries are in the git log from now on.  Not here.
16  *
17  *  14 Mar 2008 - Konrad Rzeszutek <ketuzsezr@darnok.org>
18  *    Updated comments and copyrights. (v0.4.9)
19  *
20  *  11 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
21  *    Converted to using ibft_addr. (v0.4.8)
22  *
23  *   8 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
24  *    Combined two functions in one: reserve_ibft_region. (v0.4.7)
25  *
26  *  30 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
27  *   Added logic to handle IPv6 addresses. (v0.4.6)
28  *
29  *  25 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
30  *   Added logic to handle badly not-to-spec iBFT. (v0.4.5)
31  *
32  *   4 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
33  *   Added __init to function declarations. (v0.4.4)
34  *
35  *  21 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
36  *   Updated kobject registration, combined unregister functions in one
37  *   and code and style cleanup. (v0.4.3)
38  *
39  *   5 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
40  *   Added end-markers to enums and re-organized kobject registration. (v0.4.2)
41  *
42  *   4 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
43  *   Created 'device' sysfs link to the NIC and style cleanup. (v0.4.1)
44  *
45  *  28 Nov 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
46  *   Added sysfs-ibft documentation, moved 'find_ibft' function to
47  *   in its own file and added text attributes for every struct field.  (v0.4)
48  *
49  *  21 Nov 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
50  *   Added text attributes emulating OpenFirmware /proc/device-tree naming.
51  *   Removed binary /sysfs interface (v0.3)
52  *
53  *  29 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
54  *   Added functionality in setup.c to reserve iBFT region. (v0.2)
55  *
56  *  27 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
57  *   First version exposing iBFT data via a binary /sysfs. (v0.1)
58  */
59 
60 
61 #include <linux/blkdev.h>
62 #include <linux/capability.h>
63 #include <linux/ctype.h>
64 #include <linux/device.h>
65 #include <linux/err.h>
66 #include <linux/init.h>
67 #include <linux/iscsi_ibft.h>
68 #include <linux/limits.h>
69 #include <linux/module.h>
70 #include <linux/pci.h>
71 #include <linux/slab.h>
72 #include <linux/stat.h>
73 #include <linux/string.h>
74 #include <linux/types.h>
75 #include <linux/acpi.h>
76 #include <linux/iscsi_boot_sysfs.h>
77 
78 #define IBFT_ISCSI_VERSION "0.5.0"
79 #define IBFT_ISCSI_DATE "2010-Feb-25"
80 
81 MODULE_AUTHOR("Peter Jones <pjones@redhat.com> and "
82 	      "Konrad Rzeszutek <ketuzsezr@darnok.org>");
83 MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
84 MODULE_LICENSE("GPL");
85 MODULE_VERSION(IBFT_ISCSI_VERSION);
86 
87 #ifndef CONFIG_ISCSI_IBFT_FIND
88 struct acpi_table_ibft *ibft_addr;
89 #endif
90 
91 struct ibft_hdr {
92 	u8 id;
93 	u8 version;
94 	u16 length;
95 	u8 index;
96 	u8 flags;
97 } __attribute__((__packed__));
98 
99 struct ibft_control {
100 	struct ibft_hdr hdr;
101 	u16 extensions;
102 	u16 initiator_off;
103 	u16 nic0_off;
104 	u16 tgt0_off;
105 	u16 nic1_off;
106 	u16 tgt1_off;
107 } __attribute__((__packed__));
108 
109 struct ibft_initiator {
110 	struct ibft_hdr hdr;
111 	char isns_server[16];
112 	char slp_server[16];
113 	char pri_radius_server[16];
114 	char sec_radius_server[16];
115 	u16 initiator_name_len;
116 	u16 initiator_name_off;
117 } __attribute__((__packed__));
118 
119 struct ibft_nic {
120 	struct ibft_hdr hdr;
121 	char ip_addr[16];
122 	u8 subnet_mask_prefix;
123 	u8 origin;
124 	char gateway[16];
125 	char primary_dns[16];
126 	char secondary_dns[16];
127 	char dhcp[16];
128 	u16 vlan;
129 	char mac[6];
130 	u16 pci_bdf;
131 	u16 hostname_len;
132 	u16 hostname_off;
133 } __attribute__((__packed__));
134 
135 struct ibft_tgt {
136 	struct ibft_hdr hdr;
137 	char ip_addr[16];
138 	u16 port;
139 	char lun[8];
140 	u8 chap_type;
141 	u8 nic_assoc;
142 	u16 tgt_name_len;
143 	u16 tgt_name_off;
144 	u16 chap_name_len;
145 	u16 chap_name_off;
146 	u16 chap_secret_len;
147 	u16 chap_secret_off;
148 	u16 rev_chap_name_len;
149 	u16 rev_chap_name_off;
150 	u16 rev_chap_secret_len;
151 	u16 rev_chap_secret_off;
152 } __attribute__((__packed__));
153 
154 /*
155  * The kobject different types and its names.
156  *
157 */
158 enum ibft_id {
159 	id_reserved = 0, /* We don't support. */
160 	id_control = 1, /* Should show up only once and is not exported. */
161 	id_initiator = 2,
162 	id_nic = 3,
163 	id_target = 4,
164 	id_extensions = 5, /* We don't support. */
165 	id_end_marker,
166 };
167 
168 /*
169  * The kobject and attribute structures.
170  */
171 
172 struct ibft_kobject {
173 	struct acpi_table_ibft *header;
174 	union {
175 		struct ibft_initiator *initiator;
176 		struct ibft_nic *nic;
177 		struct ibft_tgt *tgt;
178 		struct ibft_hdr *hdr;
179 	};
180 };
181 
182 static struct iscsi_boot_kset *boot_kset;
183 
184 /* fully null address */
185 static const char nulls[16];
186 
187 /* IPv4-mapped IPv6 ::ffff:0.0.0.0 */
188 static const char mapped_nulls[16] = { 0x00, 0x00, 0x00, 0x00,
189                                        0x00, 0x00, 0x00, 0x00,
190                                        0x00, 0x00, 0xff, 0xff,
191                                        0x00, 0x00, 0x00, 0x00 };
192 
193 static int address_not_null(u8 *ip)
194 {
195 	return (memcmp(ip, nulls, 16) && memcmp(ip, mapped_nulls, 16));
196 }
197 
198 /*
199  * Helper functions to parse data properly.
200  */
201 static ssize_t sprintf_ipaddr(char *buf, u8 *ip)
202 {
203 	char *str = buf;
204 
205 	if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] == 0 &&
206 	    ip[4] == 0 && ip[5] == 0 && ip[6] == 0 && ip[7] == 0 &&
207 	    ip[8] == 0 && ip[9] == 0 && ip[10] == 0xff && ip[11] == 0xff) {
208 		/*
209 		 * IPV4
210 		 */
211 		str += sprintf(buf, "%pI4", ip + 12);
212 	} else {
213 		/*
214 		 * IPv6
215 		 */
216 		str += sprintf(str, "%pI6", ip);
217 	}
218 	str += sprintf(str, "\n");
219 	return str - buf;
220 }
221 
222 static ssize_t sprintf_string(char *str, int len, char *buf)
223 {
224 	return sprintf(str, "%.*s\n", len, buf);
225 }
226 
227 /*
228  * Helper function to verify the IBFT header.
229  */
230 static int ibft_verify_hdr(char *t, struct ibft_hdr *hdr, int id, int length)
231 {
232 	if (hdr->id != id) {
233 		printk(KERN_ERR "iBFT error: We expected the %s " \
234 				"field header.id to have %d but " \
235 				"found %d instead!\n", t, id, hdr->id);
236 		return -ENODEV;
237 	}
238 	if (hdr->length != length) {
239 		printk(KERN_ERR "iBFT error: We expected the %s " \
240 				"field header.length to have %d but " \
241 				"found %d instead!\n", t, length, hdr->length);
242 		return -ENODEV;
243 	}
244 
245 	return 0;
246 }
247 
248 /*
249  *  Routines for parsing the iBFT data to be human readable.
250  */
251 static ssize_t ibft_attr_show_initiator(void *data, int type, char *buf)
252 {
253 	struct ibft_kobject *entry = data;
254 	struct ibft_initiator *initiator = entry->initiator;
255 	void *ibft_loc = entry->header;
256 	char *str = buf;
257 
258 	if (!initiator)
259 		return 0;
260 
261 	switch (type) {
262 	case ISCSI_BOOT_INI_INDEX:
263 		str += sprintf(str, "%d\n", initiator->hdr.index);
264 		break;
265 	case ISCSI_BOOT_INI_FLAGS:
266 		str += sprintf(str, "%d\n", initiator->hdr.flags);
267 		break;
268 	case ISCSI_BOOT_INI_ISNS_SERVER:
269 		str += sprintf_ipaddr(str, initiator->isns_server);
270 		break;
271 	case ISCSI_BOOT_INI_SLP_SERVER:
272 		str += sprintf_ipaddr(str, initiator->slp_server);
273 		break;
274 	case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
275 		str += sprintf_ipaddr(str, initiator->pri_radius_server);
276 		break;
277 	case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
278 		str += sprintf_ipaddr(str, initiator->sec_radius_server);
279 		break;
280 	case ISCSI_BOOT_INI_INITIATOR_NAME:
281 		str += sprintf_string(str, initiator->initiator_name_len,
282 				      (char *)ibft_loc +
283 				      initiator->initiator_name_off);
284 		break;
285 	default:
286 		break;
287 	}
288 
289 	return str - buf;
290 }
291 
292 static ssize_t ibft_attr_show_nic(void *data, int type, char *buf)
293 {
294 	struct ibft_kobject *entry = data;
295 	struct ibft_nic *nic = entry->nic;
296 	void *ibft_loc = entry->header;
297 	char *str = buf;
298 	__be32 val;
299 
300 	if (!nic)
301 		return 0;
302 
303 	switch (type) {
304 	case ISCSI_BOOT_ETH_INDEX:
305 		str += sprintf(str, "%d\n", nic->hdr.index);
306 		break;
307 	case ISCSI_BOOT_ETH_FLAGS:
308 		str += sprintf(str, "%d\n", nic->hdr.flags);
309 		break;
310 	case ISCSI_BOOT_ETH_IP_ADDR:
311 		str += sprintf_ipaddr(str, nic->ip_addr);
312 		break;
313 	case ISCSI_BOOT_ETH_SUBNET_MASK:
314 		val = cpu_to_be32(~((1 << (32-nic->subnet_mask_prefix))-1));
315 		str += sprintf(str, "%pI4", &val);
316 		break;
317 	case ISCSI_BOOT_ETH_PREFIX_LEN:
318 		str += sprintf(str, "%d\n", nic->subnet_mask_prefix);
319 		break;
320 	case ISCSI_BOOT_ETH_ORIGIN:
321 		str += sprintf(str, "%d\n", nic->origin);
322 		break;
323 	case ISCSI_BOOT_ETH_GATEWAY:
324 		str += sprintf_ipaddr(str, nic->gateway);
325 		break;
326 	case ISCSI_BOOT_ETH_PRIMARY_DNS:
327 		str += sprintf_ipaddr(str, nic->primary_dns);
328 		break;
329 	case ISCSI_BOOT_ETH_SECONDARY_DNS:
330 		str += sprintf_ipaddr(str, nic->secondary_dns);
331 		break;
332 	case ISCSI_BOOT_ETH_DHCP:
333 		str += sprintf_ipaddr(str, nic->dhcp);
334 		break;
335 	case ISCSI_BOOT_ETH_VLAN:
336 		str += sprintf(str, "%d\n", nic->vlan);
337 		break;
338 	case ISCSI_BOOT_ETH_MAC:
339 		str += sprintf(str, "%pM\n", nic->mac);
340 		break;
341 	case ISCSI_BOOT_ETH_HOSTNAME:
342 		str += sprintf_string(str, nic->hostname_len,
343 				      (char *)ibft_loc + nic->hostname_off);
344 		break;
345 	default:
346 		break;
347 	}
348 
349 	return str - buf;
350 };
351 
352 static ssize_t ibft_attr_show_target(void *data, int type, char *buf)
353 {
354 	struct ibft_kobject *entry = data;
355 	struct ibft_tgt *tgt = entry->tgt;
356 	void *ibft_loc = entry->header;
357 	char *str = buf;
358 	int i;
359 
360 	if (!tgt)
361 		return 0;
362 
363 	switch (type) {
364 	case ISCSI_BOOT_TGT_INDEX:
365 		str += sprintf(str, "%d\n", tgt->hdr.index);
366 		break;
367 	case ISCSI_BOOT_TGT_FLAGS:
368 		str += sprintf(str, "%d\n", tgt->hdr.flags);
369 		break;
370 	case ISCSI_BOOT_TGT_IP_ADDR:
371 		str += sprintf_ipaddr(str, tgt->ip_addr);
372 		break;
373 	case ISCSI_BOOT_TGT_PORT:
374 		str += sprintf(str, "%d\n", tgt->port);
375 		break;
376 	case ISCSI_BOOT_TGT_LUN:
377 		for (i = 0; i < 8; i++)
378 			str += sprintf(str, "%x", (u8)tgt->lun[i]);
379 		str += sprintf(str, "\n");
380 		break;
381 	case ISCSI_BOOT_TGT_NIC_ASSOC:
382 		str += sprintf(str, "%d\n", tgt->nic_assoc);
383 		break;
384 	case ISCSI_BOOT_TGT_CHAP_TYPE:
385 		str += sprintf(str, "%d\n", tgt->chap_type);
386 		break;
387 	case ISCSI_BOOT_TGT_NAME:
388 		str += sprintf_string(str, tgt->tgt_name_len,
389 				      (char *)ibft_loc + tgt->tgt_name_off);
390 		break;
391 	case ISCSI_BOOT_TGT_CHAP_NAME:
392 		str += sprintf_string(str, tgt->chap_name_len,
393 				      (char *)ibft_loc + tgt->chap_name_off);
394 		break;
395 	case ISCSI_BOOT_TGT_CHAP_SECRET:
396 		str += sprintf_string(str, tgt->chap_secret_len,
397 				      (char *)ibft_loc + tgt->chap_secret_off);
398 		break;
399 	case ISCSI_BOOT_TGT_REV_CHAP_NAME:
400 		str += sprintf_string(str, tgt->rev_chap_name_len,
401 				      (char *)ibft_loc +
402 				      tgt->rev_chap_name_off);
403 		break;
404 	case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
405 		str += sprintf_string(str, tgt->rev_chap_secret_len,
406 				      (char *)ibft_loc +
407 				      tgt->rev_chap_secret_off);
408 		break;
409 	default:
410 		break;
411 	}
412 
413 	return str - buf;
414 }
415 
416 static ssize_t ibft_attr_show_acpitbl(void *data, int type, char *buf)
417 {
418 	struct ibft_kobject *entry = data;
419 	char *str = buf;
420 
421 	switch (type) {
422 	case ISCSI_BOOT_ACPITBL_SIGNATURE:
423 		str += sprintf_string(str, ACPI_NAMESEG_SIZE,
424 				      entry->header->header.signature);
425 		break;
426 	case ISCSI_BOOT_ACPITBL_OEM_ID:
427 		str += sprintf_string(str, ACPI_OEM_ID_SIZE,
428 				      entry->header->header.oem_id);
429 		break;
430 	case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
431 		str += sprintf_string(str, ACPI_OEM_TABLE_ID_SIZE,
432 				      entry->header->header.oem_table_id);
433 		break;
434 	default:
435 		break;
436 	}
437 
438 	return str - buf;
439 }
440 
441 static int __init ibft_check_device(void)
442 {
443 	int len;
444 	u8 *pos;
445 	u8 csum = 0;
446 
447 	len = ibft_addr->header.length;
448 
449 	/* Sanity checking of iBFT. */
450 	if (ibft_addr->header.revision != 1) {
451 		printk(KERN_ERR "iBFT module supports only revision 1, " \
452 				"while this is %d.\n",
453 				ibft_addr->header.revision);
454 		return -ENOENT;
455 	}
456 	for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
457 		csum += *pos;
458 
459 	if (csum) {
460 		printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
461 		return -ENOENT;
462 	}
463 
464 	return 0;
465 }
466 
467 /*
468  * Helper routiners to check to determine if the entry is valid
469  * in the proper iBFT structure.
470  */
471 static umode_t ibft_check_nic_for(void *data, int type)
472 {
473 	struct ibft_kobject *entry = data;
474 	struct ibft_nic *nic = entry->nic;
475 	umode_t rc = 0;
476 
477 	switch (type) {
478 	case ISCSI_BOOT_ETH_INDEX:
479 	case ISCSI_BOOT_ETH_FLAGS:
480 		rc = S_IRUGO;
481 		break;
482 	case ISCSI_BOOT_ETH_IP_ADDR:
483 		if (address_not_null(nic->ip_addr))
484 			rc = S_IRUGO;
485 		break;
486 	case ISCSI_BOOT_ETH_PREFIX_LEN:
487 	case ISCSI_BOOT_ETH_SUBNET_MASK:
488 		if (nic->subnet_mask_prefix)
489 			rc = S_IRUGO;
490 		break;
491 	case ISCSI_BOOT_ETH_ORIGIN:
492 		rc = S_IRUGO;
493 		break;
494 	case ISCSI_BOOT_ETH_GATEWAY:
495 		if (address_not_null(nic->gateway))
496 			rc = S_IRUGO;
497 		break;
498 	case ISCSI_BOOT_ETH_PRIMARY_DNS:
499 		if (address_not_null(nic->primary_dns))
500 			rc = S_IRUGO;
501 		break;
502 	case ISCSI_BOOT_ETH_SECONDARY_DNS:
503 		if (address_not_null(nic->secondary_dns))
504 			rc = S_IRUGO;
505 		break;
506 	case ISCSI_BOOT_ETH_DHCP:
507 		if (address_not_null(nic->dhcp))
508 			rc = S_IRUGO;
509 		break;
510 	case ISCSI_BOOT_ETH_VLAN:
511 	case ISCSI_BOOT_ETH_MAC:
512 		rc = S_IRUGO;
513 		break;
514 	case ISCSI_BOOT_ETH_HOSTNAME:
515 		if (nic->hostname_off)
516 			rc = S_IRUGO;
517 		break;
518 	default:
519 		break;
520 	}
521 
522 	return rc;
523 }
524 
525 static umode_t __init ibft_check_tgt_for(void *data, int type)
526 {
527 	struct ibft_kobject *entry = data;
528 	struct ibft_tgt *tgt = entry->tgt;
529 	umode_t rc = 0;
530 
531 	switch (type) {
532 	case ISCSI_BOOT_TGT_INDEX:
533 	case ISCSI_BOOT_TGT_FLAGS:
534 	case ISCSI_BOOT_TGT_IP_ADDR:
535 	case ISCSI_BOOT_TGT_PORT:
536 	case ISCSI_BOOT_TGT_LUN:
537 	case ISCSI_BOOT_TGT_NIC_ASSOC:
538 	case ISCSI_BOOT_TGT_CHAP_TYPE:
539 		rc = S_IRUGO;
540 		break;
541 	case ISCSI_BOOT_TGT_NAME:
542 		if (tgt->tgt_name_len)
543 			rc = S_IRUGO;
544 		break;
545 	case ISCSI_BOOT_TGT_CHAP_NAME:
546 	case ISCSI_BOOT_TGT_CHAP_SECRET:
547 		if (tgt->chap_name_len)
548 			rc = S_IRUGO;
549 		break;
550 	case ISCSI_BOOT_TGT_REV_CHAP_NAME:
551 	case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
552 		if (tgt->rev_chap_name_len)
553 			rc = S_IRUGO;
554 		break;
555 	default:
556 		break;
557 	}
558 
559 	return rc;
560 }
561 
562 static umode_t __init ibft_check_initiator_for(void *data, int type)
563 {
564 	struct ibft_kobject *entry = data;
565 	struct ibft_initiator *init = entry->initiator;
566 	umode_t rc = 0;
567 
568 	switch (type) {
569 	case ISCSI_BOOT_INI_INDEX:
570 	case ISCSI_BOOT_INI_FLAGS:
571 		rc = S_IRUGO;
572 		break;
573 	case ISCSI_BOOT_INI_ISNS_SERVER:
574 		if (address_not_null(init->isns_server))
575 			rc = S_IRUGO;
576 		break;
577 	case ISCSI_BOOT_INI_SLP_SERVER:
578 		if (address_not_null(init->slp_server))
579 			rc = S_IRUGO;
580 		break;
581 	case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
582 		if (address_not_null(init->pri_radius_server))
583 			rc = S_IRUGO;
584 		break;
585 	case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
586 		if (address_not_null(init->sec_radius_server))
587 			rc = S_IRUGO;
588 		break;
589 	case ISCSI_BOOT_INI_INITIATOR_NAME:
590 		if (init->initiator_name_len)
591 			rc = S_IRUGO;
592 		break;
593 	default:
594 		break;
595 	}
596 
597 	return rc;
598 }
599 
600 static umode_t __init ibft_check_acpitbl_for(void *data, int type)
601 {
602 
603 	umode_t rc = 0;
604 
605 	switch (type) {
606 	case ISCSI_BOOT_ACPITBL_SIGNATURE:
607 	case ISCSI_BOOT_ACPITBL_OEM_ID:
608 	case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
609 		rc = S_IRUGO;
610 		break;
611 	default:
612 		break;
613 	}
614 
615 	return rc;
616 }
617 
618 static void ibft_kobj_release(void *data)
619 {
620 	kfree(data);
621 }
622 
623 /*
624  * Helper function for ibft_register_kobjects.
625  */
626 static int __init ibft_create_kobject(struct acpi_table_ibft *header,
627 				      struct ibft_hdr *hdr)
628 {
629 	struct iscsi_boot_kobj *boot_kobj = NULL;
630 	struct ibft_kobject *ibft_kobj = NULL;
631 	struct ibft_nic *nic = (struct ibft_nic *)hdr;
632 	struct pci_dev *pci_dev;
633 	int rc = 0;
634 
635 	ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
636 	if (!ibft_kobj)
637 		return -ENOMEM;
638 
639 	ibft_kobj->header = header;
640 	ibft_kobj->hdr = hdr;
641 
642 	switch (hdr->id) {
643 	case id_initiator:
644 		rc = ibft_verify_hdr("initiator", hdr, id_initiator,
645 				     sizeof(*ibft_kobj->initiator));
646 		if (rc)
647 			break;
648 
649 		boot_kobj = iscsi_boot_create_initiator(boot_kset, hdr->index,
650 						ibft_kobj,
651 						ibft_attr_show_initiator,
652 						ibft_check_initiator_for,
653 						ibft_kobj_release);
654 		if (!boot_kobj) {
655 			rc = -ENOMEM;
656 			goto free_ibft_obj;
657 		}
658 		break;
659 	case id_nic:
660 		rc = ibft_verify_hdr("ethernet", hdr, id_nic,
661 				     sizeof(*ibft_kobj->nic));
662 		if (rc)
663 			break;
664 
665 		boot_kobj = iscsi_boot_create_ethernet(boot_kset, hdr->index,
666 						       ibft_kobj,
667 						       ibft_attr_show_nic,
668 						       ibft_check_nic_for,
669 						       ibft_kobj_release);
670 		if (!boot_kobj) {
671 			rc = -ENOMEM;
672 			goto free_ibft_obj;
673 		}
674 		break;
675 	case id_target:
676 		rc = ibft_verify_hdr("target", hdr, id_target,
677 				     sizeof(*ibft_kobj->tgt));
678 		if (rc)
679 			break;
680 
681 		boot_kobj = iscsi_boot_create_target(boot_kset, hdr->index,
682 						     ibft_kobj,
683 						     ibft_attr_show_target,
684 						     ibft_check_tgt_for,
685 						     ibft_kobj_release);
686 		if (!boot_kobj) {
687 			rc = -ENOMEM;
688 			goto free_ibft_obj;
689 		}
690 		break;
691 	case id_reserved:
692 	case id_control:
693 	case id_extensions:
694 		/* Fields which we don't support. Ignore them */
695 		rc = 1;
696 		break;
697 	default:
698 		printk(KERN_ERR "iBFT has unknown structure type (%d). " \
699 				"Report this bug to %.6s!\n", hdr->id,
700 				header->header.oem_id);
701 		rc = 1;
702 		break;
703 	}
704 
705 	if (rc) {
706 		/* Skip adding this kobject, but exit with non-fatal error. */
707 		rc = 0;
708 		goto free_ibft_obj;
709 	}
710 
711 	if (hdr->id == id_nic) {
712 		/*
713 		* We don't search for the device in other domains than
714 		* zero. This is because on x86 platforms the BIOS
715 		* executes only devices which are in domain 0. Furthermore, the
716 		* iBFT spec doesn't have a domain id field :-(
717 		*/
718 		pci_dev = pci_get_domain_bus_and_slot(0,
719 						(nic->pci_bdf & 0xff00) >> 8,
720 						(nic->pci_bdf & 0xff));
721 		if (pci_dev) {
722 			rc = sysfs_create_link(&boot_kobj->kobj,
723 					       &pci_dev->dev.kobj, "device");
724 			pci_dev_put(pci_dev);
725 		}
726 	}
727 	return 0;
728 
729 free_ibft_obj:
730 	kfree(ibft_kobj);
731 	return rc;
732 }
733 
734 /*
735  * Scan the IBFT table structure for the NIC and Target fields. When
736  * found add them on the passed-in list. We do not support the other
737  * fields at this point, so they are skipped.
738  */
739 static int __init ibft_register_kobjects(struct acpi_table_ibft *header)
740 {
741 	struct ibft_control *control = NULL;
742 	struct iscsi_boot_kobj *boot_kobj;
743 	struct ibft_kobject *ibft_kobj;
744 	void *ptr, *end;
745 	int rc = 0;
746 	u16 offset;
747 	u16 eot_offset;
748 
749 	control = (void *)header + sizeof(*header);
750 	end = (void *)control + control->hdr.length;
751 	eot_offset = (void *)header + header->header.length - (void *)control;
752 	rc = ibft_verify_hdr("control", (struct ibft_hdr *)control, id_control,
753 			     sizeof(*control));
754 
755 	/* iBFT table safety checking */
756 	rc |= ((control->hdr.index) ? -ENODEV : 0);
757 	if (rc) {
758 		printk(KERN_ERR "iBFT error: Control header is invalid!\n");
759 		return rc;
760 	}
761 	for (ptr = &control->initiator_off; ptr < end; ptr += sizeof(u16)) {
762 		offset = *(u16 *)ptr;
763 		if (offset && offset < header->header.length &&
764 						offset < eot_offset) {
765 			rc = ibft_create_kobject(header,
766 						 (void *)header + offset);
767 			if (rc)
768 				break;
769 		}
770 	}
771 	if (rc)
772 		return rc;
773 
774 	ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
775 	if (!ibft_kobj)
776 		return -ENOMEM;
777 
778 	ibft_kobj->header = header;
779 	ibft_kobj->hdr = NULL; /*for ibft_unregister*/
780 
781 	boot_kobj = iscsi_boot_create_acpitbl(boot_kset, 0,
782 					ibft_kobj,
783 					ibft_attr_show_acpitbl,
784 					ibft_check_acpitbl_for,
785 					ibft_kobj_release);
786 	if (!boot_kobj)  {
787 		kfree(ibft_kobj);
788 		rc = -ENOMEM;
789 	}
790 
791 	return rc;
792 }
793 
794 static void ibft_unregister(void)
795 {
796 	struct iscsi_boot_kobj *boot_kobj, *tmp_kobj;
797 	struct ibft_kobject *ibft_kobj;
798 
799 	list_for_each_entry_safe(boot_kobj, tmp_kobj,
800 				 &boot_kset->kobj_list, list) {
801 		ibft_kobj = boot_kobj->data;
802 		if (ibft_kobj->hdr && ibft_kobj->hdr->id == id_nic)
803 			sysfs_remove_link(&boot_kobj->kobj, "device");
804 	};
805 }
806 
807 static void ibft_cleanup(void)
808 {
809 	if (boot_kset) {
810 		ibft_unregister();
811 		iscsi_boot_destroy_kset(boot_kset);
812 	}
813 }
814 
815 static void __exit ibft_exit(void)
816 {
817 	ibft_cleanup();
818 }
819 
820 #ifdef CONFIG_ACPI
821 static const struct {
822 	char *sign;
823 } ibft_signs[] = {
824 	/*
825 	 * One spec says "IBFT", the other says "iBFT". We have to check
826 	 * for both.
827 	 */
828 	{ ACPI_SIG_IBFT },
829 	{ "iBFT" },
830 	{ "BIFT" },	/* Broadcom iSCSI Offload */
831 };
832 
833 static void __init acpi_find_ibft_region(void)
834 {
835 	int i;
836 	struct acpi_table_header *table = NULL;
837 
838 	if (acpi_disabled)
839 		return;
840 
841 	for (i = 0; i < ARRAY_SIZE(ibft_signs) && !ibft_addr; i++) {
842 		acpi_get_table(ibft_signs[i].sign, 0, &table);
843 		ibft_addr = (struct acpi_table_ibft *)table;
844 	}
845 }
846 #else
847 static void __init acpi_find_ibft_region(void)
848 {
849 }
850 #endif
851 
852 /*
853  * ibft_init() - creates sysfs tree entries for the iBFT data.
854  */
855 static int __init ibft_init(void)
856 {
857 	int rc = 0;
858 
859 	/*
860 	   As on UEFI systems the setup_arch()/find_ibft_region()
861 	   is called before ACPI tables are parsed and it only does
862 	   legacy finding.
863 	*/
864 	if (!ibft_addr)
865 		acpi_find_ibft_region();
866 
867 	if (ibft_addr) {
868 		pr_info("iBFT detected.\n");
869 
870 		rc = ibft_check_device();
871 		if (rc)
872 			return rc;
873 
874 		boot_kset = iscsi_boot_create_kset("ibft");
875 		if (!boot_kset)
876 			return -ENOMEM;
877 
878 		/* Scan the IBFT for data and register the kobjects. */
879 		rc = ibft_register_kobjects(ibft_addr);
880 		if (rc)
881 			goto out_free;
882 	} else
883 		printk(KERN_INFO "No iBFT detected.\n");
884 
885 	return 0;
886 
887 out_free:
888 	ibft_cleanup();
889 	return rc;
890 }
891 
892 module_init(ibft_init);
893 module_exit(ibft_exit);
894