1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright 2007-2010 Red Hat, Inc.
5 * Copyright 2008 IBM, Inc.
10 * This code exposes the iSCSI Boot Format Table to userland via sysfs.
15 * New changelog entries are in the git log from now on. Not here.
18 * Updated comments and copyrights. (v0.4.9)
21 * Converted to using ibft_addr. (v0.4.8)
24 * Combined two functions in one: reserve_ibft_region. (v0.4.7)
27 * Added logic to handle IPv6 addresses. (v0.4.6)
30 * Added logic to handle badly not-to-spec iBFT. (v0.4.5)
33 * Added __init to function declarations. (v0.4.4)
36 * Updated kobject registration, combined unregister functions in one
37 * and code and style cleanup. (v0.4.3)
40 * Added end-markers to enums and re-organized kobject registration. (v0.4.2)
43 * Created 'device' sysfs link to the NIC and style cleanup. (v0.4.1)
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)
50 * Added text attributes emulating OpenFirmware /proc/device-tree naming.
51 * Removed binary /sysfs interface (v0.3)
54 * Added functionality in setup.c to reserve iBFT region. (v0.2)
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"
83 MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
84 MODULE_LICENSE("GPL");
85 MODULE_VERSION(IBFT_ISCSI_VERSION);
87 #ifndef CONFIG_ISCSI_IBFT_FIND
88 struct acpi_table_ibft *ibft_addr;
97 } __attribute__((__packed__));
107 } __attribute__((__packed__));
109 struct ibft_initiator {
111 char isns_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__));
122 u8 subnet_mask_prefix;
125 char primary_dns[16];
126 char secondary_dns[16];
133 } __attribute__((__packed__));
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__));
155 * The kobject different types and its names.
159 id_reserved = 0, /* We don't support. */
160 id_control = 1, /* Should show up only once and is not exported. */
164 id_extensions = 5, /* We don't support. */
169 * The kobject and attribute structures.
172 struct ibft_kobject {
173 struct acpi_table_ibft *header;
175 struct ibft_initiator *initiator;
176 struct ibft_nic *nic;
177 struct ibft_tgt *tgt;
178 struct ibft_hdr *hdr;
182 static struct iscsi_boot_kset *boot_kset;
184 /* fully null address */
185 static const char nulls[16];
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 };
193 static int address_not_null(u8 *ip)
195 return (memcmp(ip, nulls, 16) && memcmp(ip, mapped_nulls, 16));
199 * Helper functions to parse data properly.
201 static ssize_t sprintf_ipaddr(char *buf, u8 *ip)
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) {
211 str += sprintf(buf, "%pI4", ip + 12);
216 str += sprintf(str, "%pI6", ip);
218 str += sprintf(str, "\n");
222 static ssize_t sprintf_string(char *str, int len, char *buf)
224 return sprintf(str, "%.*s\n", len, buf);
228 * Helper function to verify the IBFT header.
230 static int ibft_verify_hdr(char *t, struct ibft_hdr *hdr, int id, int length)
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);
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);
249 * Routines for parsing the iBFT data to be human readable.
251 static ssize_t ibft_attr_show_initiator(void *data, int type, char *buf)
253 struct ibft_kobject *entry = data;
254 struct ibft_initiator *initiator = entry->initiator;
255 void *ibft_loc = entry->header;
262 case ISCSI_BOOT_INI_INDEX:
263 str += sprintf(str, "%d\n", initiator->hdr.index);
265 case ISCSI_BOOT_INI_FLAGS:
266 str += sprintf(str, "%d\n", initiator->hdr.flags);
268 case ISCSI_BOOT_INI_ISNS_SERVER:
269 str += sprintf_ipaddr(str, initiator->isns_server);
271 case ISCSI_BOOT_INI_SLP_SERVER:
272 str += sprintf_ipaddr(str, initiator->slp_server);
274 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
275 str += sprintf_ipaddr(str, initiator->pri_radius_server);
277 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
278 str += sprintf_ipaddr(str, initiator->sec_radius_server);
280 case ISCSI_BOOT_INI_INITIATOR_NAME:
281 str += sprintf_string(str, initiator->initiator_name_len,
283 initiator->initiator_name_off);
292 static ssize_t ibft_attr_show_nic(void *data, int type, char *buf)
294 struct ibft_kobject *entry = data;
295 struct ibft_nic *nic = entry->nic;
296 void *ibft_loc = entry->header;
304 case ISCSI_BOOT_ETH_INDEX:
305 str += sprintf(str, "%d\n", nic->hdr.index);
307 case ISCSI_BOOT_ETH_FLAGS:
308 str += sprintf(str, "%d\n", nic->hdr.flags);
310 case ISCSI_BOOT_ETH_IP_ADDR:
311 str += sprintf_ipaddr(str, nic->ip_addr);
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);
317 case ISCSI_BOOT_ETH_PREFIX_LEN:
318 str += sprintf(str, "%d\n", nic->subnet_mask_prefix);
320 case ISCSI_BOOT_ETH_ORIGIN:
321 str += sprintf(str, "%d\n", nic->origin);
323 case ISCSI_BOOT_ETH_GATEWAY:
324 str += sprintf_ipaddr(str, nic->gateway);
326 case ISCSI_BOOT_ETH_PRIMARY_DNS:
327 str += sprintf_ipaddr(str, nic->primary_dns);
329 case ISCSI_BOOT_ETH_SECONDARY_DNS:
330 str += sprintf_ipaddr(str, nic->secondary_dns);
332 case ISCSI_BOOT_ETH_DHCP:
333 str += sprintf_ipaddr(str, nic->dhcp);
335 case ISCSI_BOOT_ETH_VLAN:
336 str += sprintf(str, "%d\n", nic->vlan);
338 case ISCSI_BOOT_ETH_MAC:
339 str += sprintf(str, "%pM\n", nic->mac);
341 case ISCSI_BOOT_ETH_HOSTNAME:
342 str += sprintf_string(str, nic->hostname_len,
343 (char *)ibft_loc + nic->hostname_off);
352 static ssize_t ibft_attr_show_target(void *data, int type, char *buf)
354 struct ibft_kobject *entry = data;
355 struct ibft_tgt *tgt = entry->tgt;
356 void *ibft_loc = entry->header;
364 case ISCSI_BOOT_TGT_INDEX:
365 str += sprintf(str, "%d\n", tgt->hdr.index);
367 case ISCSI_BOOT_TGT_FLAGS:
368 str += sprintf(str, "%d\n", tgt->hdr.flags);
370 case ISCSI_BOOT_TGT_IP_ADDR:
371 str += sprintf_ipaddr(str, tgt->ip_addr);
373 case ISCSI_BOOT_TGT_PORT:
374 str += sprintf(str, "%d\n", tgt->port);
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");
381 case ISCSI_BOOT_TGT_NIC_ASSOC:
382 str += sprintf(str, "%d\n", tgt->nic_assoc);
384 case ISCSI_BOOT_TGT_CHAP_TYPE:
385 str += sprintf(str, "%d\n", tgt->chap_type);
387 case ISCSI_BOOT_TGT_NAME:
388 str += sprintf_string(str, tgt->tgt_name_len,
389 (char *)ibft_loc + tgt->tgt_name_off);
391 case ISCSI_BOOT_TGT_CHAP_NAME:
392 str += sprintf_string(str, tgt->chap_name_len,
393 (char *)ibft_loc + tgt->chap_name_off);
395 case ISCSI_BOOT_TGT_CHAP_SECRET:
396 str += sprintf_string(str, tgt->chap_secret_len,
397 (char *)ibft_loc + tgt->chap_secret_off);
399 case ISCSI_BOOT_TGT_REV_CHAP_NAME:
400 str += sprintf_string(str, tgt->rev_chap_name_len,
402 tgt->rev_chap_name_off);
404 case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
405 str += sprintf_string(str, tgt->rev_chap_secret_len,
407 tgt->rev_chap_secret_off);
416 static ssize_t ibft_attr_show_acpitbl(void *data, int type, char *buf)
418 struct ibft_kobject *entry = data;
422 case ISCSI_BOOT_ACPITBL_SIGNATURE:
423 str += sprintf_string(str, ACPI_NAMESEG_SIZE,
424 entry->header->header.signature);
426 case ISCSI_BOOT_ACPITBL_OEM_ID:
427 str += sprintf_string(str, ACPI_OEM_ID_SIZE,
428 entry->header->header.oem_id);
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);
441 static int __init ibft_check_device(void)
447 len = ibft_addr->header.length;
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);
456 for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
460 printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
468 * Helper routiners to check to determine if the entry is valid
469 * in the proper iBFT structure.
471 static umode_t ibft_check_nic_for(void *data, int type)
473 struct ibft_kobject *entry = data;
474 struct ibft_nic *nic = entry->nic;
478 case ISCSI_BOOT_ETH_INDEX:
479 case ISCSI_BOOT_ETH_FLAGS:
482 case ISCSI_BOOT_ETH_IP_ADDR:
483 if (address_not_null(nic->ip_addr))
486 case ISCSI_BOOT_ETH_PREFIX_LEN:
487 case ISCSI_BOOT_ETH_SUBNET_MASK:
488 if (nic->subnet_mask_prefix)
491 case ISCSI_BOOT_ETH_ORIGIN:
494 case ISCSI_BOOT_ETH_GATEWAY:
495 if (address_not_null(nic->gateway))
498 case ISCSI_BOOT_ETH_PRIMARY_DNS:
499 if (address_not_null(nic->primary_dns))
502 case ISCSI_BOOT_ETH_SECONDARY_DNS:
503 if (address_not_null(nic->secondary_dns))
506 case ISCSI_BOOT_ETH_DHCP:
507 if (address_not_null(nic->dhcp))
510 case ISCSI_BOOT_ETH_VLAN:
511 case ISCSI_BOOT_ETH_MAC:
514 case ISCSI_BOOT_ETH_HOSTNAME:
515 if (nic->hostname_off)
525 static umode_t __init ibft_check_tgt_for(void *data, int type)
527 struct ibft_kobject *entry = data;
528 struct ibft_tgt *tgt = entry->tgt;
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:
541 case ISCSI_BOOT_TGT_NAME:
542 if (tgt->tgt_name_len)
545 case ISCSI_BOOT_TGT_CHAP_NAME:
546 case ISCSI_BOOT_TGT_CHAP_SECRET:
547 if (tgt->chap_name_len)
550 case ISCSI_BOOT_TGT_REV_CHAP_NAME:
551 case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
552 if (tgt->rev_chap_name_len)
562 static umode_t __init ibft_check_initiator_for(void *data, int type)
564 struct ibft_kobject *entry = data;
565 struct ibft_initiator *init = entry->initiator;
569 case ISCSI_BOOT_INI_INDEX:
570 case ISCSI_BOOT_INI_FLAGS:
573 case ISCSI_BOOT_INI_ISNS_SERVER:
574 if (address_not_null(init->isns_server))
577 case ISCSI_BOOT_INI_SLP_SERVER:
578 if (address_not_null(init->slp_server))
581 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
582 if (address_not_null(init->pri_radius_server))
585 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
586 if (address_not_null(init->sec_radius_server))
589 case ISCSI_BOOT_INI_INITIATOR_NAME:
590 if (init->initiator_name_len)
600 static umode_t __init ibft_check_acpitbl_for(void *data, int type)
606 case ISCSI_BOOT_ACPITBL_SIGNATURE:
607 case ISCSI_BOOT_ACPITBL_OEM_ID:
608 case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
618 static void ibft_kobj_release(void *data)
624 * Helper function for ibft_register_kobjects.
626 static int __init ibft_create_kobject(struct acpi_table_ibft *header,
627 struct ibft_hdr *hdr)
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;
635 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
639 ibft_kobj->header = header;
640 ibft_kobj->hdr = hdr;
644 rc = ibft_verify_hdr("initiator", hdr, id_initiator,
645 sizeof(*ibft_kobj->initiator));
649 boot_kobj = iscsi_boot_create_initiator(boot_kset, hdr->index,
651 ibft_attr_show_initiator,
652 ibft_check_initiator_for,
660 rc = ibft_verify_hdr("ethernet", hdr, id_nic,
661 sizeof(*ibft_kobj->nic));
665 boot_kobj = iscsi_boot_create_ethernet(boot_kset, hdr->index,
676 rc = ibft_verify_hdr("target", hdr, id_target,
677 sizeof(*ibft_kobj->tgt));
681 boot_kobj = iscsi_boot_create_target(boot_kset, hdr->index,
683 ibft_attr_show_target,
694 /* Fields which we don't support. Ignore them */
698 printk(KERN_ERR "iBFT has unknown structure type (%d). " \
699 "Report this bug to %.6s!\n", hdr->id,
700 header->header.oem_id);
706 /* Skip adding this kobject, but exit with non-fatal error. */
711 if (hdr->id == id_nic) {
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 :-(
718 pci_dev = pci_get_domain_bus_and_slot(0,
719 (nic->pci_bdf & 0xff00) >> 8,
720 (nic->pci_bdf & 0xff));
722 rc = sysfs_create_link(&boot_kobj->kobj,
723 &pci_dev->dev.kobj, "device");
724 pci_dev_put(pci_dev);
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.
739 static int __init ibft_register_kobjects(struct acpi_table_ibft *header)
741 struct ibft_control *control = NULL;
742 struct iscsi_boot_kobj *boot_kobj;
743 struct ibft_kobject *ibft_kobj;
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,
755 /* iBFT table safety checking */
756 rc |= ((control->hdr.index) ? -ENODEV : 0);
758 printk(KERN_ERR "iBFT error: Control header is invalid!\n");
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);
774 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
778 ibft_kobj->header = header;
779 ibft_kobj->hdr = NULL; /*for ibft_unregister*/
781 boot_kobj = iscsi_boot_create_acpitbl(boot_kset, 0,
783 ibft_attr_show_acpitbl,
784 ibft_check_acpitbl_for,
794 static void ibft_unregister(void)
796 struct iscsi_boot_kobj *boot_kobj, *tmp_kobj;
797 struct ibft_kobject *ibft_kobj;
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");
807 static void ibft_cleanup(void)
811 iscsi_boot_destroy_kset(boot_kset);
815 static void __exit ibft_exit(void)
821 static const struct {
825 * One spec says "IBFT", the other says "iBFT". We have to check
830 { "BIFT" }, /* Broadcom iSCSI Offload */
833 static void __init acpi_find_ibft_region(void)
836 struct acpi_table_header *table = NULL;
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;
847 static void __init acpi_find_ibft_region(void)
853 * ibft_init() - creates sysfs tree entries for the iBFT data.
855 static int __init ibft_init(void)
860 As on UEFI systems the setup_arch()/find_ibft_region()
861 is called before ACPI tables are parsed and it only does
865 acpi_find_ibft_region();
868 pr_info("iBFT detected.\n");
870 rc = ibft_check_device();
874 boot_kset = iscsi_boot_create_kset("ibft");
878 /* Scan the IBFT for data and register the kobjects. */
879 rc = ibft_register_kobjects(ibft_addr);
883 printk(KERN_INFO "No iBFT detected.\n");
892 module_init(ibft_init);
893 module_exit(ibft_exit);