1 // SPDX-License-Identifier: GPL-2.0-only
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>
8 * by Konrad Rzeszutek <ketuzsezr@darnok.org>
10 * This code exposes the iSCSI Boot Format Table to userland via sysfs.
14 * 06 Jan 2010 - Peter Jones <pjones@redhat.com>
15 * New changelog entries are in the git log from now on. Not here.
17 * 14 Mar 2008 - Konrad Rzeszutek <ketuzsezr@darnok.org>
18 * Updated comments and copyrights. (v0.4.9)
20 * 11 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
21 * Converted to using ibft_addr. (v0.4.8)
23 * 8 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
24 * Combined two functions in one: reserve_ibft_region. (v0.4.7)
26 * 30 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
27 * Added logic to handle IPv6 addresses. (v0.4.6)
29 * 25 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
30 * Added logic to handle badly not-to-spec iBFT. (v0.4.5)
32 * 4 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
33 * Added __init to function declarations. (v0.4.4)
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)
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)
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)
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)
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)
53 * 29 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
54 * Added functionality in setup.c to reserve iBFT region. (v0.2)
56 * 27 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
57 * First version exposing iBFT data via a binary /sysfs. (v0.1)
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>
78 #define IBFT_ISCSI_VERSION "0.5.0"
79 #define IBFT_ISCSI_DATE "2010-Feb-25"
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);
93 } __attribute__((__packed__));
103 } __attribute__((__packed__));
105 struct ibft_initiator {
107 char isns_server[16];
109 char pri_radius_server[16];
110 char sec_radius_server[16];
111 u16 initiator_name_len;
112 u16 initiator_name_off;
113 } __attribute__((__packed__));
118 u8 subnet_mask_prefix;
121 char primary_dns[16];
122 char secondary_dns[16];
129 } __attribute__((__packed__));
144 u16 rev_chap_name_len;
145 u16 rev_chap_name_off;
146 u16 rev_chap_secret_len;
147 u16 rev_chap_secret_off;
148 } __attribute__((__packed__));
151 * The kobject different types and its names.
155 id_reserved = 0, /* We don't support. */
156 id_control = 1, /* Should show up only once and is not exported. */
160 id_extensions = 5, /* We don't support. */
165 * The kobject and attribute structures.
168 struct ibft_kobject {
169 struct acpi_table_ibft *header;
171 struct ibft_initiator *initiator;
172 struct ibft_nic *nic;
173 struct ibft_tgt *tgt;
174 struct ibft_hdr *hdr;
178 static struct iscsi_boot_kset *boot_kset;
180 /* fully null address */
181 static const char nulls[16];
183 /* IPv4-mapped IPv6 ::ffff:0.0.0.0 */
184 static const char mapped_nulls[16] = { 0x00, 0x00, 0x00, 0x00,
185 0x00, 0x00, 0x00, 0x00,
186 0x00, 0x00, 0xff, 0xff,
187 0x00, 0x00, 0x00, 0x00 };
189 static int address_not_null(u8 *ip)
191 return (memcmp(ip, nulls, 16) && memcmp(ip, mapped_nulls, 16));
195 * Helper functions to parse data properly.
197 static ssize_t sprintf_ipaddr(char *buf, u8 *ip)
201 if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] == 0 &&
202 ip[4] == 0 && ip[5] == 0 && ip[6] == 0 && ip[7] == 0 &&
203 ip[8] == 0 && ip[9] == 0 && ip[10] == 0xff && ip[11] == 0xff) {
207 str += sprintf(buf, "%pI4", ip + 12);
212 str += sprintf(str, "%pI6", ip);
214 str += sprintf(str, "\n");
218 static ssize_t sprintf_string(char *str, int len, char *buf)
220 return sprintf(str, "%.*s\n", len, buf);
224 * Helper function to verify the IBFT header.
226 static int ibft_verify_hdr(char *t, struct ibft_hdr *hdr, int id, int length)
229 printk(KERN_ERR "iBFT error: We expected the %s " \
230 "field header.id to have %d but " \
231 "found %d instead!\n", t, id, hdr->id);
234 if (hdr->length != length) {
235 printk(KERN_ERR "iBFT error: We expected the %s " \
236 "field header.length to have %d but " \
237 "found %d instead!\n", t, length, hdr->length);
245 * Routines for parsing the iBFT data to be human readable.
247 static ssize_t ibft_attr_show_initiator(void *data, int type, char *buf)
249 struct ibft_kobject *entry = data;
250 struct ibft_initiator *initiator = entry->initiator;
251 void *ibft_loc = entry->header;
258 case ISCSI_BOOT_INI_INDEX:
259 str += sprintf(str, "%d\n", initiator->hdr.index);
261 case ISCSI_BOOT_INI_FLAGS:
262 str += sprintf(str, "%d\n", initiator->hdr.flags);
264 case ISCSI_BOOT_INI_ISNS_SERVER:
265 str += sprintf_ipaddr(str, initiator->isns_server);
267 case ISCSI_BOOT_INI_SLP_SERVER:
268 str += sprintf_ipaddr(str, initiator->slp_server);
270 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
271 str += sprintf_ipaddr(str, initiator->pri_radius_server);
273 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
274 str += sprintf_ipaddr(str, initiator->sec_radius_server);
276 case ISCSI_BOOT_INI_INITIATOR_NAME:
277 str += sprintf_string(str, initiator->initiator_name_len,
279 initiator->initiator_name_off);
288 static ssize_t ibft_attr_show_nic(void *data, int type, char *buf)
290 struct ibft_kobject *entry = data;
291 struct ibft_nic *nic = entry->nic;
292 void *ibft_loc = entry->header;
300 case ISCSI_BOOT_ETH_INDEX:
301 str += sprintf(str, "%d\n", nic->hdr.index);
303 case ISCSI_BOOT_ETH_FLAGS:
304 str += sprintf(str, "%d\n", nic->hdr.flags);
306 case ISCSI_BOOT_ETH_IP_ADDR:
307 str += sprintf_ipaddr(str, nic->ip_addr);
309 case ISCSI_BOOT_ETH_SUBNET_MASK:
310 val = cpu_to_be32(~((1 << (32-nic->subnet_mask_prefix))-1));
311 str += sprintf(str, "%pI4", &val);
313 case ISCSI_BOOT_ETH_PREFIX_LEN:
314 str += sprintf(str, "%d\n", nic->subnet_mask_prefix);
316 case ISCSI_BOOT_ETH_ORIGIN:
317 str += sprintf(str, "%d\n", nic->origin);
319 case ISCSI_BOOT_ETH_GATEWAY:
320 str += sprintf_ipaddr(str, nic->gateway);
322 case ISCSI_BOOT_ETH_PRIMARY_DNS:
323 str += sprintf_ipaddr(str, nic->primary_dns);
325 case ISCSI_BOOT_ETH_SECONDARY_DNS:
326 str += sprintf_ipaddr(str, nic->secondary_dns);
328 case ISCSI_BOOT_ETH_DHCP:
329 str += sprintf_ipaddr(str, nic->dhcp);
331 case ISCSI_BOOT_ETH_VLAN:
332 str += sprintf(str, "%d\n", nic->vlan);
334 case ISCSI_BOOT_ETH_MAC:
335 str += sprintf(str, "%pM\n", nic->mac);
337 case ISCSI_BOOT_ETH_HOSTNAME:
338 str += sprintf_string(str, nic->hostname_len,
339 (char *)ibft_loc + nic->hostname_off);
348 static ssize_t ibft_attr_show_target(void *data, int type, char *buf)
350 struct ibft_kobject *entry = data;
351 struct ibft_tgt *tgt = entry->tgt;
352 void *ibft_loc = entry->header;
360 case ISCSI_BOOT_TGT_INDEX:
361 str += sprintf(str, "%d\n", tgt->hdr.index);
363 case ISCSI_BOOT_TGT_FLAGS:
364 str += sprintf(str, "%d\n", tgt->hdr.flags);
366 case ISCSI_BOOT_TGT_IP_ADDR:
367 str += sprintf_ipaddr(str, tgt->ip_addr);
369 case ISCSI_BOOT_TGT_PORT:
370 str += sprintf(str, "%d\n", tgt->port);
372 case ISCSI_BOOT_TGT_LUN:
373 for (i = 0; i < 8; i++)
374 str += sprintf(str, "%x", (u8)tgt->lun[i]);
375 str += sprintf(str, "\n");
377 case ISCSI_BOOT_TGT_NIC_ASSOC:
378 str += sprintf(str, "%d\n", tgt->nic_assoc);
380 case ISCSI_BOOT_TGT_CHAP_TYPE:
381 str += sprintf(str, "%d\n", tgt->chap_type);
383 case ISCSI_BOOT_TGT_NAME:
384 str += sprintf_string(str, tgt->tgt_name_len,
385 (char *)ibft_loc + tgt->tgt_name_off);
387 case ISCSI_BOOT_TGT_CHAP_NAME:
388 str += sprintf_string(str, tgt->chap_name_len,
389 (char *)ibft_loc + tgt->chap_name_off);
391 case ISCSI_BOOT_TGT_CHAP_SECRET:
392 str += sprintf_string(str, tgt->chap_secret_len,
393 (char *)ibft_loc + tgt->chap_secret_off);
395 case ISCSI_BOOT_TGT_REV_CHAP_NAME:
396 str += sprintf_string(str, tgt->rev_chap_name_len,
398 tgt->rev_chap_name_off);
400 case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
401 str += sprintf_string(str, tgt->rev_chap_secret_len,
403 tgt->rev_chap_secret_off);
412 static ssize_t ibft_attr_show_acpitbl(void *data, int type, char *buf)
414 struct ibft_kobject *entry = data;
418 case ISCSI_BOOT_ACPITBL_SIGNATURE:
419 str += sprintf_string(str, ACPI_NAMESEG_SIZE,
420 entry->header->header.signature);
422 case ISCSI_BOOT_ACPITBL_OEM_ID:
423 str += sprintf_string(str, ACPI_OEM_ID_SIZE,
424 entry->header->header.oem_id);
426 case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
427 str += sprintf_string(str, ACPI_OEM_TABLE_ID_SIZE,
428 entry->header->header.oem_table_id);
437 static int __init ibft_check_device(void)
443 len = ibft_addr->header.length;
445 /* Sanity checking of iBFT. */
446 if (ibft_addr->header.revision != 1) {
447 printk(KERN_ERR "iBFT module supports only revision 1, " \
448 "while this is %d.\n",
449 ibft_addr->header.revision);
452 for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
456 printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
464 * Helper routiners to check to determine if the entry is valid
465 * in the proper iBFT structure.
467 static umode_t ibft_check_nic_for(void *data, int type)
469 struct ibft_kobject *entry = data;
470 struct ibft_nic *nic = entry->nic;
474 case ISCSI_BOOT_ETH_INDEX:
475 case ISCSI_BOOT_ETH_FLAGS:
478 case ISCSI_BOOT_ETH_IP_ADDR:
479 if (address_not_null(nic->ip_addr))
482 case ISCSI_BOOT_ETH_PREFIX_LEN:
483 case ISCSI_BOOT_ETH_SUBNET_MASK:
484 if (nic->subnet_mask_prefix)
487 case ISCSI_BOOT_ETH_ORIGIN:
490 case ISCSI_BOOT_ETH_GATEWAY:
491 if (address_not_null(nic->gateway))
494 case ISCSI_BOOT_ETH_PRIMARY_DNS:
495 if (address_not_null(nic->primary_dns))
498 case ISCSI_BOOT_ETH_SECONDARY_DNS:
499 if (address_not_null(nic->secondary_dns))
502 case ISCSI_BOOT_ETH_DHCP:
503 if (address_not_null(nic->dhcp))
506 case ISCSI_BOOT_ETH_VLAN:
507 case ISCSI_BOOT_ETH_MAC:
510 case ISCSI_BOOT_ETH_HOSTNAME:
511 if (nic->hostname_off)
521 static umode_t __init ibft_check_tgt_for(void *data, int type)
523 struct ibft_kobject *entry = data;
524 struct ibft_tgt *tgt = entry->tgt;
528 case ISCSI_BOOT_TGT_INDEX:
529 case ISCSI_BOOT_TGT_FLAGS:
530 case ISCSI_BOOT_TGT_IP_ADDR:
531 case ISCSI_BOOT_TGT_PORT:
532 case ISCSI_BOOT_TGT_LUN:
533 case ISCSI_BOOT_TGT_NIC_ASSOC:
534 case ISCSI_BOOT_TGT_CHAP_TYPE:
537 case ISCSI_BOOT_TGT_NAME:
538 if (tgt->tgt_name_len)
541 case ISCSI_BOOT_TGT_CHAP_NAME:
542 case ISCSI_BOOT_TGT_CHAP_SECRET:
543 if (tgt->chap_name_len)
546 case ISCSI_BOOT_TGT_REV_CHAP_NAME:
547 case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
548 if (tgt->rev_chap_name_len)
558 static umode_t __init ibft_check_initiator_for(void *data, int type)
560 struct ibft_kobject *entry = data;
561 struct ibft_initiator *init = entry->initiator;
565 case ISCSI_BOOT_INI_INDEX:
566 case ISCSI_BOOT_INI_FLAGS:
569 case ISCSI_BOOT_INI_ISNS_SERVER:
570 if (address_not_null(init->isns_server))
573 case ISCSI_BOOT_INI_SLP_SERVER:
574 if (address_not_null(init->slp_server))
577 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
578 if (address_not_null(init->pri_radius_server))
581 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
582 if (address_not_null(init->sec_radius_server))
585 case ISCSI_BOOT_INI_INITIATOR_NAME:
586 if (init->initiator_name_len)
596 static umode_t __init ibft_check_acpitbl_for(void *data, int type)
602 case ISCSI_BOOT_ACPITBL_SIGNATURE:
603 case ISCSI_BOOT_ACPITBL_OEM_ID:
604 case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
614 static void ibft_kobj_release(void *data)
620 * Helper function for ibft_register_kobjects.
622 static int __init ibft_create_kobject(struct acpi_table_ibft *header,
623 struct ibft_hdr *hdr)
625 struct iscsi_boot_kobj *boot_kobj = NULL;
626 struct ibft_kobject *ibft_kobj = NULL;
627 struct ibft_nic *nic = (struct ibft_nic *)hdr;
628 struct pci_dev *pci_dev;
631 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
635 ibft_kobj->header = header;
636 ibft_kobj->hdr = hdr;
640 rc = ibft_verify_hdr("initiator", hdr, id_initiator,
641 sizeof(*ibft_kobj->initiator));
645 boot_kobj = iscsi_boot_create_initiator(boot_kset, hdr->index,
647 ibft_attr_show_initiator,
648 ibft_check_initiator_for,
656 rc = ibft_verify_hdr("ethernet", hdr, id_nic,
657 sizeof(*ibft_kobj->nic));
661 boot_kobj = iscsi_boot_create_ethernet(boot_kset, hdr->index,
672 rc = ibft_verify_hdr("target", hdr, id_target,
673 sizeof(*ibft_kobj->tgt));
677 boot_kobj = iscsi_boot_create_target(boot_kset, hdr->index,
679 ibft_attr_show_target,
690 /* Fields which we don't support. Ignore them */
694 printk(KERN_ERR "iBFT has unknown structure type (%d). " \
695 "Report this bug to %.6s!\n", hdr->id,
696 header->header.oem_id);
702 /* Skip adding this kobject, but exit with non-fatal error. */
707 if (hdr->id == id_nic) {
709 * We don't search for the device in other domains than
710 * zero. This is because on x86 platforms the BIOS
711 * executes only devices which are in domain 0. Furthermore, the
712 * iBFT spec doesn't have a domain id field :-(
714 pci_dev = pci_get_domain_bus_and_slot(0,
715 (nic->pci_bdf & 0xff00) >> 8,
716 (nic->pci_bdf & 0xff));
718 rc = sysfs_create_link(&boot_kobj->kobj,
719 &pci_dev->dev.kobj, "device");
720 pci_dev_put(pci_dev);
731 * Scan the IBFT table structure for the NIC and Target fields. When
732 * found add them on the passed-in list. We do not support the other
733 * fields at this point, so they are skipped.
735 static int __init ibft_register_kobjects(struct acpi_table_ibft *header)
737 struct ibft_control *control = NULL;
738 struct iscsi_boot_kobj *boot_kobj;
739 struct ibft_kobject *ibft_kobj;
745 control = (void *)header + sizeof(*header);
746 end = (void *)control + control->hdr.length;
747 eot_offset = (void *)header + header->header.length - (void *)control;
748 rc = ibft_verify_hdr("control", (struct ibft_hdr *)control, id_control,
751 /* iBFT table safety checking */
752 rc |= ((control->hdr.index) ? -ENODEV : 0);
754 printk(KERN_ERR "iBFT error: Control header is invalid!\n");
757 for (ptr = &control->initiator_off; ptr < end; ptr += sizeof(u16)) {
758 offset = *(u16 *)ptr;
759 if (offset && offset < header->header.length &&
760 offset < eot_offset) {
761 rc = ibft_create_kobject(header,
762 (void *)header + offset);
770 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
774 ibft_kobj->header = header;
775 ibft_kobj->hdr = NULL; /*for ibft_unregister*/
777 boot_kobj = iscsi_boot_create_acpitbl(boot_kset, 0,
779 ibft_attr_show_acpitbl,
780 ibft_check_acpitbl_for,
790 static void ibft_unregister(void)
792 struct iscsi_boot_kobj *boot_kobj, *tmp_kobj;
793 struct ibft_kobject *ibft_kobj;
795 list_for_each_entry_safe(boot_kobj, tmp_kobj,
796 &boot_kset->kobj_list, list) {
797 ibft_kobj = boot_kobj->data;
798 if (ibft_kobj->hdr && ibft_kobj->hdr->id == id_nic)
799 sysfs_remove_link(&boot_kobj->kobj, "device");
803 static void ibft_cleanup(void)
807 iscsi_boot_destroy_kset(boot_kset);
811 static void __exit ibft_exit(void)
817 static const struct {
821 * One spec says "IBFT", the other says "iBFT". We have to check
826 { "BIFT" }, /* Broadcom iSCSI Offload */
829 static void __init acpi_find_ibft_region(void)
832 struct acpi_table_header *table = NULL;
837 for (i = 0; i < ARRAY_SIZE(ibft_signs) && !ibft_addr; i++) {
838 acpi_get_table(ibft_signs[i].sign, 0, &table);
839 ibft_addr = (struct acpi_table_ibft *)table;
843 static void __init acpi_find_ibft_region(void)
849 * ibft_init() - creates sysfs tree entries for the iBFT data.
851 static int __init ibft_init(void)
856 As on UEFI systems the setup_arch()/find_ibft_region()
857 is called before ACPI tables are parsed and it only does
861 acpi_find_ibft_region();
864 pr_info("iBFT detected.\n");
866 rc = ibft_check_device();
870 boot_kset = iscsi_boot_create_kset("ibft");
874 /* Scan the IBFT for data and register the kobjects. */
875 rc = ibft_register_kobjects(ibft_addr);
879 printk(KERN_INFO "No iBFT detected.\n");
888 module_init(ibft_init);
889 module_exit(ibft_exit);