2 * Copyright 2007-2010 Red Hat, Inc.
3 * by Peter Jones <pjones@redhat.com>
4 * Copyright 2008 IBM, Inc.
5 * by Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
7 * by Konrad Rzeszutek <ketuzsezr@darnok.org>
9 * This code exposes the iSCSI Boot Format Table to userland via sysfs.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License v2.0 as published by
13 * the Free Software Foundation
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
22 * 06 Jan 2010 - Peter Jones <pjones@redhat.com>
23 * New changelog entries are in the git log from now on. Not here.
25 * 14 Mar 2008 - Konrad Rzeszutek <ketuzsezr@darnok.org>
26 * Updated comments and copyrights. (v0.4.9)
28 * 11 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
29 * Converted to using ibft_addr. (v0.4.8)
31 * 8 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
32 * Combined two functions in one: reserve_ibft_region. (v0.4.7)
34 * 30 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
35 * Added logic to handle IPv6 addresses. (v0.4.6)
37 * 25 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
38 * Added logic to handle badly not-to-spec iBFT. (v0.4.5)
40 * 4 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
41 * Added __init to function declarations. (v0.4.4)
43 * 21 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
44 * Updated kobject registration, combined unregister functions in one
45 * and code and style cleanup. (v0.4.3)
47 * 5 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
48 * Added end-markers to enums and re-organized kobject registration. (v0.4.2)
50 * 4 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
51 * Created 'device' sysfs link to the NIC and style cleanup. (v0.4.1)
53 * 28 Nov 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
54 * Added sysfs-ibft documentation, moved 'find_ibft' function to
55 * in its own file and added text attributes for every struct field. (v0.4)
57 * 21 Nov 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
58 * Added text attributes emulating OpenFirmware /proc/device-tree naming.
59 * Removed binary /sysfs interface (v0.3)
61 * 29 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
62 * Added functionality in setup.c to reserve iBFT region. (v0.2)
64 * 27 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
65 * First version exposing iBFT data via a binary /sysfs. (v0.1)
70 #include <linux/blkdev.h>
71 #include <linux/capability.h>
72 #include <linux/ctype.h>
73 #include <linux/device.h>
74 #include <linux/err.h>
75 #include <linux/init.h>
76 #include <linux/iscsi_ibft.h>
77 #include <linux/limits.h>
78 #include <linux/module.h>
79 #include <linux/pci.h>
80 #include <linux/slab.h>
81 #include <linux/stat.h>
82 #include <linux/string.h>
83 #include <linux/types.h>
84 #include <linux/acpi.h>
85 #include <linux/iscsi_boot_sysfs.h>
87 #define IBFT_ISCSI_VERSION "0.5.0"
88 #define IBFT_ISCSI_DATE "2010-Feb-25"
90 MODULE_AUTHOR("Peter Jones <pjones@redhat.com> and "
91 "Konrad Rzeszutek <ketuzsezr@darnok.org>");
92 MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
93 MODULE_LICENSE("GPL");
94 MODULE_VERSION(IBFT_ISCSI_VERSION
);
102 } __attribute__((__packed__
));
104 struct ibft_control
{
112 } __attribute__((__packed__
));
114 struct ibft_initiator
{
116 char isns_server
[16];
118 char pri_radius_server
[16];
119 char sec_radius_server
[16];
120 u16 initiator_name_len
;
121 u16 initiator_name_off
;
122 } __attribute__((__packed__
));
127 u8 subnet_mask_prefix
;
130 char primary_dns
[16];
131 char secondary_dns
[16];
138 } __attribute__((__packed__
));
153 u16 rev_chap_name_len
;
154 u16 rev_chap_name_off
;
155 u16 rev_chap_secret_len
;
156 u16 rev_chap_secret_off
;
157 } __attribute__((__packed__
));
160 * The kobject different types and its names.
164 id_reserved
= 0, /* We don't support. */
165 id_control
= 1, /* Should show up only once and is not exported. */
169 id_extensions
= 5, /* We don't support. */
174 * The kobject and attribute structures.
177 struct ibft_kobject
{
178 struct acpi_table_ibft
*header
;
180 struct ibft_initiator
*initiator
;
181 struct ibft_nic
*nic
;
182 struct ibft_tgt
*tgt
;
183 struct ibft_hdr
*hdr
;
187 static struct iscsi_boot_kset
*boot_kset
;
189 /* fully null address */
190 static const char nulls
[16];
192 /* IPv4-mapped IPv6 ::ffff:0.0.0.0 */
193 static const char mapped_nulls
[16] = { 0x00, 0x00, 0x00, 0x00,
194 0x00, 0x00, 0x00, 0x00,
195 0x00, 0x00, 0xff, 0xff,
196 0x00, 0x00, 0x00, 0x00 };
198 static int address_not_null(u8
*ip
)
200 return (memcmp(ip
, nulls
, 16) && memcmp(ip
, mapped_nulls
, 16));
204 * Helper functions to parse data properly.
206 static ssize_t
sprintf_ipaddr(char *buf
, u8
*ip
)
210 if (ip
[0] == 0 && ip
[1] == 0 && ip
[2] == 0 && ip
[3] == 0 &&
211 ip
[4] == 0 && ip
[5] == 0 && ip
[6] == 0 && ip
[7] == 0 &&
212 ip
[8] == 0 && ip
[9] == 0 && ip
[10] == 0xff && ip
[11] == 0xff) {
216 str
+= sprintf(buf
, "%pI4", ip
+ 12);
221 str
+= sprintf(str
, "%pI6", ip
);
223 str
+= sprintf(str
, "\n");
227 static ssize_t
sprintf_string(char *str
, int len
, char *buf
)
229 return sprintf(str
, "%.*s\n", len
, buf
);
233 * Helper function to verify the IBFT header.
235 static int ibft_verify_hdr(char *t
, struct ibft_hdr
*hdr
, int id
, int length
)
238 printk(KERN_ERR
"iBFT error: We expected the %s " \
239 "field header.id to have %d but " \
240 "found %d instead!\n", t
, id
, hdr
->id
);
243 if (hdr
->length
!= length
) {
244 printk(KERN_ERR
"iBFT error: We expected the %s " \
245 "field header.length to have %d but " \
246 "found %d instead!\n", t
, length
, hdr
->length
);
254 * Routines for parsing the iBFT data to be human readable.
256 static ssize_t
ibft_attr_show_initiator(void *data
, int type
, char *buf
)
258 struct ibft_kobject
*entry
= data
;
259 struct ibft_initiator
*initiator
= entry
->initiator
;
260 void *ibft_loc
= entry
->header
;
267 case ISCSI_BOOT_INI_INDEX
:
268 str
+= sprintf(str
, "%d\n", initiator
->hdr
.index
);
270 case ISCSI_BOOT_INI_FLAGS
:
271 str
+= sprintf(str
, "%d\n", initiator
->hdr
.flags
);
273 case ISCSI_BOOT_INI_ISNS_SERVER
:
274 str
+= sprintf_ipaddr(str
, initiator
->isns_server
);
276 case ISCSI_BOOT_INI_SLP_SERVER
:
277 str
+= sprintf_ipaddr(str
, initiator
->slp_server
);
279 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER
:
280 str
+= sprintf_ipaddr(str
, initiator
->pri_radius_server
);
282 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER
:
283 str
+= sprintf_ipaddr(str
, initiator
->sec_radius_server
);
285 case ISCSI_BOOT_INI_INITIATOR_NAME
:
286 str
+= sprintf_string(str
, initiator
->initiator_name_len
,
288 initiator
->initiator_name_off
);
297 static ssize_t
ibft_attr_show_nic(void *data
, int type
, char *buf
)
299 struct ibft_kobject
*entry
= data
;
300 struct ibft_nic
*nic
= entry
->nic
;
301 void *ibft_loc
= entry
->header
;
309 case ISCSI_BOOT_ETH_INDEX
:
310 str
+= sprintf(str
, "%d\n", nic
->hdr
.index
);
312 case ISCSI_BOOT_ETH_FLAGS
:
313 str
+= sprintf(str
, "%d\n", nic
->hdr
.flags
);
315 case ISCSI_BOOT_ETH_IP_ADDR
:
316 str
+= sprintf_ipaddr(str
, nic
->ip_addr
);
318 case ISCSI_BOOT_ETH_SUBNET_MASK
:
319 val
= cpu_to_be32(~((1 << (32-nic
->subnet_mask_prefix
))-1));
320 str
+= sprintf(str
, "%pI4", &val
);
322 case ISCSI_BOOT_ETH_ORIGIN
:
323 str
+= sprintf(str
, "%d\n", nic
->origin
);
325 case ISCSI_BOOT_ETH_GATEWAY
:
326 str
+= sprintf_ipaddr(str
, nic
->gateway
);
328 case ISCSI_BOOT_ETH_PRIMARY_DNS
:
329 str
+= sprintf_ipaddr(str
, nic
->primary_dns
);
331 case ISCSI_BOOT_ETH_SECONDARY_DNS
:
332 str
+= sprintf_ipaddr(str
, nic
->secondary_dns
);
334 case ISCSI_BOOT_ETH_DHCP
:
335 str
+= sprintf_ipaddr(str
, nic
->dhcp
);
337 case ISCSI_BOOT_ETH_VLAN
:
338 str
+= sprintf(str
, "%d\n", nic
->vlan
);
340 case ISCSI_BOOT_ETH_MAC
:
341 str
+= sprintf(str
, "%pM\n", nic
->mac
);
343 case ISCSI_BOOT_ETH_HOSTNAME
:
344 str
+= sprintf_string(str
, nic
->hostname_len
,
345 (char *)ibft_loc
+ nic
->hostname_off
);
354 static ssize_t
ibft_attr_show_target(void *data
, int type
, char *buf
)
356 struct ibft_kobject
*entry
= data
;
357 struct ibft_tgt
*tgt
= entry
->tgt
;
358 void *ibft_loc
= entry
->header
;
366 case ISCSI_BOOT_TGT_INDEX
:
367 str
+= sprintf(str
, "%d\n", tgt
->hdr
.index
);
369 case ISCSI_BOOT_TGT_FLAGS
:
370 str
+= sprintf(str
, "%d\n", tgt
->hdr
.flags
);
372 case ISCSI_BOOT_TGT_IP_ADDR
:
373 str
+= sprintf_ipaddr(str
, tgt
->ip_addr
);
375 case ISCSI_BOOT_TGT_PORT
:
376 str
+= sprintf(str
, "%d\n", tgt
->port
);
378 case ISCSI_BOOT_TGT_LUN
:
379 for (i
= 0; i
< 8; i
++)
380 str
+= sprintf(str
, "%x", (u8
)tgt
->lun
[i
]);
381 str
+= sprintf(str
, "\n");
383 case ISCSI_BOOT_TGT_NIC_ASSOC
:
384 str
+= sprintf(str
, "%d\n", tgt
->nic_assoc
);
386 case ISCSI_BOOT_TGT_CHAP_TYPE
:
387 str
+= sprintf(str
, "%d\n", tgt
->chap_type
);
389 case ISCSI_BOOT_TGT_NAME
:
390 str
+= sprintf_string(str
, tgt
->tgt_name_len
,
391 (char *)ibft_loc
+ tgt
->tgt_name_off
);
393 case ISCSI_BOOT_TGT_CHAP_NAME
:
394 str
+= sprintf_string(str
, tgt
->chap_name_len
,
395 (char *)ibft_loc
+ tgt
->chap_name_off
);
397 case ISCSI_BOOT_TGT_CHAP_SECRET
:
398 str
+= sprintf_string(str
, tgt
->chap_secret_len
,
399 (char *)ibft_loc
+ tgt
->chap_secret_off
);
401 case ISCSI_BOOT_TGT_REV_CHAP_NAME
:
402 str
+= sprintf_string(str
, tgt
->rev_chap_name_len
,
404 tgt
->rev_chap_name_off
);
406 case ISCSI_BOOT_TGT_REV_CHAP_SECRET
:
407 str
+= sprintf_string(str
, tgt
->rev_chap_secret_len
,
409 tgt
->rev_chap_secret_off
);
418 static int __init
ibft_check_device(void)
424 len
= ibft_addr
->header
.length
;
426 /* Sanity checking of iBFT. */
427 if (ibft_addr
->header
.revision
!= 1) {
428 printk(KERN_ERR
"iBFT module supports only revision 1, " \
429 "while this is %d.\n",
430 ibft_addr
->header
.revision
);
433 for (pos
= (u8
*)ibft_addr
; pos
< (u8
*)ibft_addr
+ len
; pos
++)
437 printk(KERN_ERR
"iBFT has incorrect checksum (0x%x)!\n", csum
);
445 * Helper routiners to check to determine if the entry is valid
446 * in the proper iBFT structure.
448 static umode_t
ibft_check_nic_for(void *data
, int type
)
450 struct ibft_kobject
*entry
= data
;
451 struct ibft_nic
*nic
= entry
->nic
;
455 case ISCSI_BOOT_ETH_INDEX
:
456 case ISCSI_BOOT_ETH_FLAGS
:
459 case ISCSI_BOOT_ETH_IP_ADDR
:
460 if (address_not_null(nic
->ip_addr
))
463 case ISCSI_BOOT_ETH_SUBNET_MASK
:
464 if (nic
->subnet_mask_prefix
)
467 case ISCSI_BOOT_ETH_ORIGIN
:
470 case ISCSI_BOOT_ETH_GATEWAY
:
471 if (address_not_null(nic
->gateway
))
474 case ISCSI_BOOT_ETH_PRIMARY_DNS
:
475 if (address_not_null(nic
->primary_dns
))
478 case ISCSI_BOOT_ETH_SECONDARY_DNS
:
479 if (address_not_null(nic
->secondary_dns
))
482 case ISCSI_BOOT_ETH_DHCP
:
483 if (address_not_null(nic
->dhcp
))
486 case ISCSI_BOOT_ETH_VLAN
:
487 case ISCSI_BOOT_ETH_MAC
:
490 case ISCSI_BOOT_ETH_HOSTNAME
:
491 if (nic
->hostname_off
)
501 static umode_t __init
ibft_check_tgt_for(void *data
, int type
)
503 struct ibft_kobject
*entry
= data
;
504 struct ibft_tgt
*tgt
= entry
->tgt
;
508 case ISCSI_BOOT_TGT_INDEX
:
509 case ISCSI_BOOT_TGT_FLAGS
:
510 case ISCSI_BOOT_TGT_IP_ADDR
:
511 case ISCSI_BOOT_TGT_PORT
:
512 case ISCSI_BOOT_TGT_LUN
:
513 case ISCSI_BOOT_TGT_NIC_ASSOC
:
514 case ISCSI_BOOT_TGT_CHAP_TYPE
:
516 case ISCSI_BOOT_TGT_NAME
:
517 if (tgt
->tgt_name_len
)
520 case ISCSI_BOOT_TGT_CHAP_NAME
:
521 case ISCSI_BOOT_TGT_CHAP_SECRET
:
522 if (tgt
->chap_name_len
)
525 case ISCSI_BOOT_TGT_REV_CHAP_NAME
:
526 case ISCSI_BOOT_TGT_REV_CHAP_SECRET
:
527 if (tgt
->rev_chap_name_len
)
537 static umode_t __init
ibft_check_initiator_for(void *data
, int type
)
539 struct ibft_kobject
*entry
= data
;
540 struct ibft_initiator
*init
= entry
->initiator
;
544 case ISCSI_BOOT_INI_INDEX
:
545 case ISCSI_BOOT_INI_FLAGS
:
548 case ISCSI_BOOT_INI_ISNS_SERVER
:
549 if (address_not_null(init
->isns_server
))
552 case ISCSI_BOOT_INI_SLP_SERVER
:
553 if (address_not_null(init
->slp_server
))
556 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER
:
557 if (address_not_null(init
->pri_radius_server
))
560 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER
:
561 if (address_not_null(init
->sec_radius_server
))
564 case ISCSI_BOOT_INI_INITIATOR_NAME
:
565 if (init
->initiator_name_len
)
575 static void ibft_kobj_release(void *data
)
581 * Helper function for ibft_register_kobjects.
583 static int __init
ibft_create_kobject(struct acpi_table_ibft
*header
,
584 struct ibft_hdr
*hdr
)
586 struct iscsi_boot_kobj
*boot_kobj
= NULL
;
587 struct ibft_kobject
*ibft_kobj
= NULL
;
588 struct ibft_nic
*nic
= (struct ibft_nic
*)hdr
;
589 struct pci_dev
*pci_dev
;
592 ibft_kobj
= kzalloc(sizeof(*ibft_kobj
), GFP_KERNEL
);
596 ibft_kobj
->header
= header
;
597 ibft_kobj
->hdr
= hdr
;
601 rc
= ibft_verify_hdr("initiator", hdr
, id_initiator
,
602 sizeof(*ibft_kobj
->initiator
));
606 boot_kobj
= iscsi_boot_create_initiator(boot_kset
, hdr
->index
,
608 ibft_attr_show_initiator
,
609 ibft_check_initiator_for
,
617 rc
= ibft_verify_hdr("ethernet", hdr
, id_nic
,
618 sizeof(*ibft_kobj
->nic
));
622 boot_kobj
= iscsi_boot_create_ethernet(boot_kset
, hdr
->index
,
633 rc
= ibft_verify_hdr("target", hdr
, id_target
,
634 sizeof(*ibft_kobj
->tgt
));
638 boot_kobj
= iscsi_boot_create_target(boot_kset
, hdr
->index
,
640 ibft_attr_show_target
,
651 /* Fields which we don't support. Ignore them */
655 printk(KERN_ERR
"iBFT has unknown structure type (%d). " \
656 "Report this bug to %.6s!\n", hdr
->id
,
657 header
->header
.oem_id
);
663 /* Skip adding this kobject, but exit with non-fatal error. */
668 if (hdr
->id
== id_nic
) {
670 * We don't search for the device in other domains than
671 * zero. This is because on x86 platforms the BIOS
672 * executes only devices which are in domain 0. Furthermore, the
673 * iBFT spec doesn't have a domain id field :-(
675 pci_dev
= pci_get_bus_and_slot((nic
->pci_bdf
& 0xff00) >> 8,
676 (nic
->pci_bdf
& 0xff));
678 rc
= sysfs_create_link(&boot_kobj
->kobj
,
679 &pci_dev
->dev
.kobj
, "device");
680 pci_dev_put(pci_dev
);
691 * Scan the IBFT table structure for the NIC and Target fields. When
692 * found add them on the passed-in list. We do not support the other
693 * fields at this point, so they are skipped.
695 static int __init
ibft_register_kobjects(struct acpi_table_ibft
*header
)
697 struct ibft_control
*control
= NULL
;
703 control
= (void *)header
+ sizeof(*header
);
704 end
= (void *)control
+ control
->hdr
.length
;
705 eot_offset
= (void *)header
+ header
->header
.length
- (void *)control
;
706 rc
= ibft_verify_hdr("control", (struct ibft_hdr
*)control
, id_control
,
709 /* iBFT table safety checking */
710 rc
|= ((control
->hdr
.index
) ? -ENODEV
: 0);
712 printk(KERN_ERR
"iBFT error: Control header is invalid!\n");
715 for (ptr
= &control
->initiator_off
; ptr
< end
; ptr
+= sizeof(u16
)) {
716 offset
= *(u16
*)ptr
;
717 if (offset
&& offset
< header
->header
.length
&&
718 offset
< eot_offset
) {
719 rc
= ibft_create_kobject(header
,
720 (void *)header
+ offset
);
729 static void ibft_unregister(void)
731 struct iscsi_boot_kobj
*boot_kobj
, *tmp_kobj
;
732 struct ibft_kobject
*ibft_kobj
;
734 list_for_each_entry_safe(boot_kobj
, tmp_kobj
,
735 &boot_kset
->kobj_list
, list
) {
736 ibft_kobj
= boot_kobj
->data
;
737 if (ibft_kobj
->hdr
->id
== id_nic
)
738 sysfs_remove_link(&boot_kobj
->kobj
, "device");
742 static void ibft_cleanup(void)
746 iscsi_boot_destroy_kset(boot_kset
);
750 static void __exit
ibft_exit(void)
756 static const struct {
760 * One spec says "IBFT", the other says "iBFT". We have to check
765 { "BIFT" }, /* Broadcom iSCSI Offload */
768 static void __init
acpi_find_ibft_region(void)
771 struct acpi_table_header
*table
= NULL
;
776 for (i
= 0; i
< ARRAY_SIZE(ibft_signs
) && !ibft_addr
; i
++) {
777 acpi_get_table(ibft_signs
[i
].sign
, 0, &table
);
778 ibft_addr
= (struct acpi_table_ibft
*)table
;
782 static void __init
acpi_find_ibft_region(void)
788 * ibft_init() - creates sysfs tree entries for the iBFT data.
790 static int __init
ibft_init(void)
795 As on UEFI systems the setup_arch()/find_ibft_region()
796 is called before ACPI tables are parsed and it only does
800 acpi_find_ibft_region();
803 pr_info("iBFT detected.\n");
805 rc
= ibft_check_device();
809 boot_kset
= iscsi_boot_create_kset("ibft");
813 /* Scan the IBFT for data and register the kobjects. */
814 rc
= ibft_register_kobjects(ibft_addr
);
818 printk(KERN_INFO
"No iBFT detected.\n");
827 module_init(ibft_init
);
828 module_exit(ibft_exit
);