2 * Copyright 2007 Red Hat, Inc.
4 * Copyright 2008 IBM, Inc.
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.
23 * Updated comments and copyrights. (v0.4.9)
26 * Converted to using ibft_addr. (v0.4.8)
29 * Combined two functions in one: reserve_ibft_region. (v0.4.7)
32 * Added logic to handle IPv6 addresses. (v0.4.6)
35 * Added logic to handle badly not-to-spec iBFT. (v0.4.5)
38 * Added __init to function declarations. (v0.4.4)
41 * Updated kobject registration, combined unregister functions in one
42 * and code and style cleanup. (v0.4.3)
45 * Added end-markers to enums and re-organized kobject registration. (v0.4.2)
48 * Created 'device' sysfs link to the NIC and style cleanup. (v0.4.1)
51 * Added sysfs-ibft documentation, moved 'find_ibft' function to
52 * in its own file and added text attributes for every struct field. (v0.4)
55 * Added text attributes emulating OpenFirmware /proc/device-tree naming.
56 * Removed binary /sysfs interface (v0.3)
59 * Added functionality in setup.c to reserve iBFT region. (v0.2)
62 * First version exposing iBFT data via a binary /sysfs. (v0.1)
67 #include <linux/blkdev.h>
68 #include <linux/capability.h>
69 #include <linux/ctype.h>
70 #include <linux/device.h>
71 #include <linux/err.h>
72 #include <linux/init.h>
73 #include <linux/iscsi_ibft.h>
74 #include <linux/limits.h>
75 #include <linux/module.h>
76 #include <linux/pci.h>
77 #include <linux/slab.h>
78 #include <linux/stat.h>
79 #include <linux/string.h>
80 #include <linux/types.h>
82 #define IBFT_ISCSI_VERSION "0.4.9"
83 #define IBFT_ISCSI_DATE "2008-Mar-14"
87 MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
88 MODULE_LICENSE("GPL");
89 MODULE_VERSION(IBFT_ISCSI_VERSION);
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 * We do not support the other types, hence the usage of NULL.
170 * This maps to the enum ibft_id.
172 static const char *ibft_id_names[] =
173 {NULL, NULL, "initiator", "ethernet%d", "target%d", NULL, NULL};
176 * The text attributes names for each of the kobjects.
178 enum ibft_eth_properties_enum {
182 ibft_eth_subnet_mask,
185 ibft_eth_primary_dns,
186 ibft_eth_secondary_dns,
190 /* ibft_eth_pci_bdf - this is replaced by link to the device itself. */
195 static const char *ibft_eth_properties[] =
196 {"index", "flags", "ip-addr", "subnet-mask", "origin", "gateway",
197 "primary-dns", "secondary-dns", "dhcp", "vlan", "mac", "hostname",
200 enum ibft_tgt_properties_enum {
210 ibft_tgt_chap_secret,
211 ibft_tgt_rev_chap_name,
212 ibft_tgt_rev_chap_secret,
216 static const char *ibft_tgt_properties[] =
217 {"index", "flags", "ip-addr", "port", "lun", "chap-type", "nic-assoc",
218 "target-name", "chap-name", "chap-secret", "rev-chap-name",
219 "rev-chap-name-secret", NULL};
221 enum ibft_initiator_properties_enum {
224 ibft_init_isns_server,
225 ibft_init_slp_server,
226 ibft_init_pri_radius_server,
227 ibft_init_sec_radius_server,
228 ibft_init_initiator_name,
229 ibft_init_end_marker,
232 static const char *ibft_initiator_properties[] =
233 {"index", "flags", "isns-server", "slp-server", "pri-radius-server",
234 "sec-radius-server", "initiator-name", NULL};
237 * The kobject and attribute structures.
240 struct ibft_kobject {
241 struct ibft_table_header *header;
243 struct ibft_initiator *initiator;
244 struct ibft_nic *nic;
245 struct ibft_tgt *tgt;
246 struct ibft_hdr *hdr;
249 struct list_head node;
252 struct ibft_attribute {
253 struct attribute attr;
254 ssize_t (*show) (struct ibft_kobject *entry,
255 struct ibft_attribute *attr, char *buf);
257 struct ibft_initiator *initiator;
258 struct ibft_nic *nic;
259 struct ibft_tgt *tgt;
260 struct ibft_hdr *hdr;
262 struct kobject *kobj;
263 int type; /* The enum of the type. This can be any value of:
264 ibft_eth_properties_enum, ibft_tgt_properties_enum,
265 or ibft_initiator_properties_enum. */
266 struct list_head node;
269 static LIST_HEAD(ibft_attr_list);
270 static LIST_HEAD(ibft_kobject_list);
272 static const char nulls[16];
275 * Helper functions to parse data properly.
277 static ssize_t sprintf_ipaddr(char *buf, u8 *ip)
281 if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] == 0 &&
282 ip[4] == 0 && ip[5] == 0 && ip[6] == 0 && ip[7] == 0 &&
283 ip[8] == 0 && ip[9] == 0 && ip[10] == 0xff && ip[11] == 0xff) {
287 str += sprintf(buf, "%pI4", ip + 12);
292 str += sprintf(str, "%pI6", ip);
294 str += sprintf(str, "\n");
298 static ssize_t sprintf_string(char *str, int len, char *buf)
300 return sprintf(str, "%.*s\n", len, buf);
304 * Helper function to verify the IBFT header.
306 static int ibft_verify_hdr(char *t, struct ibft_hdr *hdr, int id, int length)
309 printk(KERN_ERR "iBFT error: We expected the " \
310 "field header.id to have %d but " \
311 "found %d instead!\n", id, hdr->id);
314 if (hdr->length != length) {
315 printk(KERN_ERR "iBFT error: We expected the " \
316 "field header.length to have %d but " \
317 "found %d instead!\n", length, hdr->length);
324 static void ibft_release(struct kobject *kobj)
326 struct ibft_kobject *ibft =
327 container_of(kobj, struct ibft_kobject, kobj);
332 * Routines for parsing the iBFT data to be human readable.
334 static ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
335 struct ibft_attribute *attr,
338 struct ibft_initiator *initiator = entry->initiator;
339 void *ibft_loc = entry->header;
345 switch (attr->type) {
346 case ibft_init_index:
347 str += sprintf(str, "%d\n", initiator->hdr.index);
349 case ibft_init_flags:
350 str += sprintf(str, "%d\n", initiator->hdr.flags);
352 case ibft_init_isns_server:
353 str += sprintf_ipaddr(str, initiator->isns_server);
355 case ibft_init_slp_server:
356 str += sprintf_ipaddr(str, initiator->slp_server);
358 case ibft_init_pri_radius_server:
359 str += sprintf_ipaddr(str, initiator->pri_radius_server);
361 case ibft_init_sec_radius_server:
362 str += sprintf_ipaddr(str, initiator->sec_radius_server);
364 case ibft_init_initiator_name:
365 str += sprintf_string(str, initiator->initiator_name_len,
367 initiator->initiator_name_off);
376 static ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
377 struct ibft_attribute *attr,
380 struct ibft_nic *nic = entry->nic;
381 void *ibft_loc = entry->header;
388 switch (attr->type) {
390 str += sprintf(str, "%d\n", nic->hdr.index);
393 str += sprintf(str, "%d\n", nic->hdr.flags);
395 case ibft_eth_ip_addr:
396 str += sprintf_ipaddr(str, nic->ip_addr);
398 case ibft_eth_subnet_mask:
399 val = cpu_to_be32(~((1 << (32-nic->subnet_mask_prefix))-1));
400 str += sprintf(str, "%pI4", &val);
402 case ibft_eth_origin:
403 str += sprintf(str, "%d\n", nic->origin);
405 case ibft_eth_gateway:
406 str += sprintf_ipaddr(str, nic->gateway);
408 case ibft_eth_primary_dns:
409 str += sprintf_ipaddr(str, nic->primary_dns);
411 case ibft_eth_secondary_dns:
412 str += sprintf_ipaddr(str, nic->secondary_dns);
415 str += sprintf_ipaddr(str, nic->dhcp);
418 str += sprintf(str, "%d\n", nic->vlan);
421 str += sprintf(str, "%pM\n", nic->mac);
423 case ibft_eth_hostname:
424 str += sprintf_string(str, nic->hostname_len,
425 (char *)ibft_loc + nic->hostname_off);
434 static ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
435 struct ibft_attribute *attr,
438 struct ibft_tgt *tgt = entry->tgt;
439 void *ibft_loc = entry->header;
446 switch (attr->type) {
448 str += sprintf(str, "%d\n", tgt->hdr.index);
451 str += sprintf(str, "%d\n", tgt->hdr.flags);
453 case ibft_tgt_ip_addr:
454 str += sprintf_ipaddr(str, tgt->ip_addr);
457 str += sprintf(str, "%d\n", tgt->port);
460 for (i = 0; i < 8; i++)
461 str += sprintf(str, "%x", (u8)tgt->lun[i]);
462 str += sprintf(str, "\n");
464 case ibft_tgt_nic_assoc:
465 str += sprintf(str, "%d\n", tgt->nic_assoc);
467 case ibft_tgt_chap_type:
468 str += sprintf(str, "%d\n", tgt->chap_type);
471 str += sprintf_string(str, tgt->tgt_name_len,
472 (char *)ibft_loc + tgt->tgt_name_off);
474 case ibft_tgt_chap_name:
475 str += sprintf_string(str, tgt->chap_name_len,
476 (char *)ibft_loc + tgt->chap_name_off);
478 case ibft_tgt_chap_secret:
479 str += sprintf_string(str, tgt->chap_secret_len,
480 (char *)ibft_loc + tgt->chap_secret_off);
482 case ibft_tgt_rev_chap_name:
483 str += sprintf_string(str, tgt->rev_chap_name_len,
485 tgt->rev_chap_name_off);
487 case ibft_tgt_rev_chap_secret:
488 str += sprintf_string(str, tgt->rev_chap_secret_len,
490 tgt->rev_chap_secret_off);
500 * The routine called for all sysfs attributes.
502 static ssize_t ibft_show_attribute(struct kobject *kobj,
503 struct attribute *attr,
506 struct ibft_kobject *dev =
507 container_of(kobj, struct ibft_kobject, kobj);
508 struct ibft_attribute *ibft_attr =
509 container_of(attr, struct ibft_attribute, attr);
513 if (!capable(CAP_SYS_ADMIN))
517 ret = ibft_attr->show(dev, ibft_attr, str);
522 static const struct sysfs_ops ibft_attr_ops = {
523 .show = ibft_show_attribute,
526 static struct kobj_type ibft_ktype = {
527 .release = ibft_release,
528 .sysfs_ops = &ibft_attr_ops,
531 static struct kset *ibft_kset;
533 static int __init ibft_check_device(void)
539 len = ibft_addr->length;
541 /* Sanity checking of iBFT. */
542 if (ibft_addr->revision != 1) {
543 printk(KERN_ERR "iBFT module supports only revision 1, " \
544 "while this is %d.\n", ibft_addr->revision);
547 for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
551 printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
559 * Helper function for ibft_register_kobjects.
561 static int __init ibft_create_kobject(struct ibft_table_header *header,
562 struct ibft_hdr *hdr,
563 struct list_head *list)
565 struct ibft_kobject *ibft_kobj = NULL;
566 struct ibft_nic *nic = (struct ibft_nic *)hdr;
567 struct pci_dev *pci_dev;
570 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
574 ibft_kobj->header = header;
575 ibft_kobj->hdr = hdr;
579 rc = ibft_verify_hdr("initiator", hdr, id_initiator,
580 sizeof(*ibft_kobj->initiator));
583 rc = ibft_verify_hdr("ethernet", hdr, id_nic,
584 sizeof(*ibft_kobj->nic));
587 rc = ibft_verify_hdr("target", hdr, id_target,
588 sizeof(*ibft_kobj->tgt));
593 /* Fields which we don't support. Ignore them */
597 printk(KERN_ERR "iBFT has unknown structure type (%d). " \
598 "Report this bug to %.6s!\n", hdr->id,
605 /* Skip adding this kobject, but exit with non-fatal error. */
607 goto out_invalid_struct;
610 ibft_kobj->kobj.kset = ibft_kset;
612 rc = kobject_init_and_add(&ibft_kobj->kobj, &ibft_ktype,
613 NULL, ibft_id_names[hdr->id], hdr->index);
620 kobject_uevent(&ibft_kobj->kobj, KOBJ_ADD);
622 if (hdr->id == id_nic) {
624 * We don't search for the device in other domains than
625 * zero. This is because on x86 platforms the BIOS
626 * executes only devices which are in domain 0. Furthermore, the
627 * iBFT spec doesn't have a domain id field :-(
629 pci_dev = pci_get_bus_and_slot((nic->pci_bdf & 0xff00) >> 8,
630 (nic->pci_bdf & 0xff));
632 rc = sysfs_create_link(&ibft_kobj->kobj,
633 &pci_dev->dev.kobj, "device");
634 pci_dev_put(pci_dev);
638 /* Nothing broke so lets add it to the list. */
639 list_add_tail(&ibft_kobj->node, list);
643 /* Unsupported structs are skipped. */
648 * Scan the IBFT table structure for the NIC and Target fields. When
649 * found add them on the passed-in list. We do not support the other
650 * fields at this point, so they are skipped.
652 static int __init ibft_register_kobjects(struct ibft_table_header *header,
653 struct list_head *list)
655 struct ibft_control *control = NULL;
661 control = (void *)header + sizeof(*header);
662 end = (void *)control + control->hdr.length;
663 eot_offset = (void *)header + header->length - (void *)control;
664 rc = ibft_verify_hdr("control", (struct ibft_hdr *)control, id_control,
667 /* iBFT table safety checking */
668 rc |= ((control->hdr.index) ? -ENODEV : 0);
670 printk(KERN_ERR "iBFT error: Control header is invalid!\n");
673 for (ptr = &control->initiator_off; ptr < end; ptr += sizeof(u16)) {
674 offset = *(u16 *)ptr;
675 if (offset && offset < header->length && offset < eot_offset) {
676 rc = ibft_create_kobject(header,
677 (void *)header + offset,
687 static void ibft_unregister(struct list_head *attr_list,
688 struct list_head *kobj_list)
690 struct ibft_kobject *data = NULL, *n;
691 struct ibft_attribute *attr = NULL, *m;
693 list_for_each_entry_safe(attr, m, attr_list, node) {
694 sysfs_remove_file(attr->kobj, &attr->attr);
695 list_del(&attr->node);
698 list_del_init(attr_list);
700 list_for_each_entry_safe(data, n, kobj_list, node) {
701 list_del(&data->node);
702 if (data->hdr->id == id_nic)
703 sysfs_remove_link(&data->kobj, "device");
704 kobject_put(&data->kobj);
706 list_del_init(kobj_list);
709 static int __init ibft_create_attribute(struct ibft_kobject *kobj_data,
712 ssize_t (*show)(struct ibft_kobject *,
713 struct ibft_attribute*,
715 struct list_head *list)
717 struct ibft_attribute *attr = NULL;
718 struct ibft_hdr *hdr = kobj_data->hdr;
720 attr = kmalloc(sizeof(*attr), GFP_KERNEL);
724 attr->attr.name = name;
725 attr->attr.mode = S_IRUSR;
729 attr->kobj = &kobj_data->kobj;
732 list_add_tail(&attr->node, list);
738 * Helper routiners to check to determine if the entry is valid
739 * in the proper iBFT structure.
741 static int __init ibft_check_nic_for(struct ibft_nic *nic, int entry)
750 case ibft_eth_ip_addr:
751 if (memcmp(nic->ip_addr, nulls, sizeof(nic->ip_addr)))
754 case ibft_eth_subnet_mask:
755 if (nic->subnet_mask_prefix)
758 case ibft_eth_origin:
761 case ibft_eth_gateway:
762 if (memcmp(nic->gateway, nulls, sizeof(nic->gateway)))
765 case ibft_eth_primary_dns:
766 if (memcmp(nic->primary_dns, nulls,
767 sizeof(nic->primary_dns)))
770 case ibft_eth_secondary_dns:
771 if (memcmp(nic->secondary_dns, nulls,
772 sizeof(nic->secondary_dns)))
776 if (memcmp(nic->dhcp, nulls, sizeof(nic->dhcp)))
783 case ibft_eth_hostname:
784 if (nic->hostname_off)
794 static int __init ibft_check_tgt_for(struct ibft_tgt *tgt, int entry)
801 case ibft_tgt_ip_addr:
804 case ibft_tgt_nic_assoc:
805 case ibft_tgt_chap_type:
808 if (tgt->tgt_name_len)
811 case ibft_tgt_chap_name:
812 case ibft_tgt_chap_secret:
813 if (tgt->chap_name_len)
816 case ibft_tgt_rev_chap_name:
817 case ibft_tgt_rev_chap_secret:
818 if (tgt->rev_chap_name_len)
828 static int __init ibft_check_initiator_for(struct ibft_initiator *init,
834 case ibft_init_index:
835 case ibft_init_flags:
838 case ibft_init_isns_server:
839 if (memcmp(init->isns_server, nulls,
840 sizeof(init->isns_server)))
843 case ibft_init_slp_server:
844 if (memcmp(init->slp_server, nulls,
845 sizeof(init->slp_server)))
848 case ibft_init_pri_radius_server:
849 if (memcmp(init->pri_radius_server, nulls,
850 sizeof(init->pri_radius_server)))
853 case ibft_init_sec_radius_server:
854 if (memcmp(init->sec_radius_server, nulls,
855 sizeof(init->sec_radius_server)))
858 case ibft_init_initiator_name:
859 if (init->initiator_name_len)
870 * Register the attributes for all of the kobjects.
872 static int __init ibft_register_attributes(struct list_head *kobject_list,
873 struct list_head *attr_list)
876 struct ibft_kobject *data = NULL;
877 struct ibft_attribute *attr = NULL, *m;
879 list_for_each_entry(data, kobject_list, node) {
880 switch (data->hdr->id) {
882 for (i = 0; i < ibft_eth_end_marker && !rc; i++)
883 if (ibft_check_nic_for(data->nic, i))
884 rc = ibft_create_attribute(data, i,
885 ibft_eth_properties[i],
886 ibft_attr_show_nic, attr_list);
889 for (i = 0; i < ibft_tgt_end_marker && !rc; i++)
890 if (ibft_check_tgt_for(data->tgt, i))
891 rc = ibft_create_attribute(data, i,
892 ibft_tgt_properties[i],
893 ibft_attr_show_target,
897 for (i = 0; i < ibft_init_end_marker && !rc; i++)
898 if (ibft_check_initiator_for(
900 rc = ibft_create_attribute(data, i,
901 ibft_initiator_properties[i],
902 ibft_attr_show_initiator,
911 list_for_each_entry_safe(attr, m, attr_list, node) {
912 rc = sysfs_create_file(attr->kobj, &attr->attr);
914 list_del(&attr->node);
924 * ibft_init() - creates sysfs tree entries for the iBFT data.
926 static int __init ibft_init(void)
930 ibft_kset = kset_create_and_add("ibft", NULL, firmware_kobj);
935 printk(KERN_INFO "iBFT detected at 0x%llx.\n",
936 (u64)isa_virt_to_bus(ibft_addr));
938 rc = ibft_check_device();
940 goto out_firmware_unregister;
942 /* Scan the IBFT for data and register the kobjects. */
943 rc = ibft_register_kobjects(ibft_addr, &ibft_kobject_list);
947 /* Register the attributes */
948 rc = ibft_register_attributes(&ibft_kobject_list,
953 printk(KERN_INFO "No iBFT detected.\n");
958 ibft_unregister(&ibft_attr_list, &ibft_kobject_list);
959 out_firmware_unregister:
960 kset_unregister(ibft_kset);
964 static void __exit ibft_exit(void)
966 ibft_unregister(&ibft_attr_list, &ibft_kobject_list);
967 kset_unregister(ibft_kset);
970 module_init(ibft_init);
971 module_exit(ibft_exit);