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 static const char nulls
[16];
192 * Helper functions to parse data properly.
194 static ssize_t
sprintf_ipaddr(char *buf
, u8
*ip
)
198 if (ip
[0] == 0 && ip
[1] == 0 && ip
[2] == 0 && ip
[3] == 0 &&
199 ip
[4] == 0 && ip
[5] == 0 && ip
[6] == 0 && ip
[7] == 0 &&
200 ip
[8] == 0 && ip
[9] == 0 && ip
[10] == 0xff && ip
[11] == 0xff) {
204 str
+= sprintf(buf
, "%pI4", ip
+ 12);
209 str
+= sprintf(str
, "%pI6", ip
);
211 str
+= sprintf(str
, "\n");
215 static ssize_t
sprintf_string(char *str
, int len
, char *buf
)
217 return sprintf(str
, "%.*s\n", len
, buf
);
221 * Helper function to verify the IBFT header.
223 static int ibft_verify_hdr(char *t
, struct ibft_hdr
*hdr
, int id
, int length
)
226 printk(KERN_ERR
"iBFT error: We expected the %s " \
227 "field header.id to have %d but " \
228 "found %d instead!\n", t
, id
, hdr
->id
);
231 if (hdr
->length
!= length
) {
232 printk(KERN_ERR
"iBFT error: We expected the %s " \
233 "field header.length to have %d but " \
234 "found %d instead!\n", t
, length
, hdr
->length
);
242 * Routines for parsing the iBFT data to be human readable.
244 static ssize_t
ibft_attr_show_initiator(void *data
, int type
, char *buf
)
246 struct ibft_kobject
*entry
= data
;
247 struct ibft_initiator
*initiator
= entry
->initiator
;
248 void *ibft_loc
= entry
->header
;
255 case ISCSI_BOOT_INI_INDEX
:
256 str
+= sprintf(str
, "%d\n", initiator
->hdr
.index
);
258 case ISCSI_BOOT_INI_FLAGS
:
259 str
+= sprintf(str
, "%d\n", initiator
->hdr
.flags
);
261 case ISCSI_BOOT_INI_ISNS_SERVER
:
262 str
+= sprintf_ipaddr(str
, initiator
->isns_server
);
264 case ISCSI_BOOT_INI_SLP_SERVER
:
265 str
+= sprintf_ipaddr(str
, initiator
->slp_server
);
267 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER
:
268 str
+= sprintf_ipaddr(str
, initiator
->pri_radius_server
);
270 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER
:
271 str
+= sprintf_ipaddr(str
, initiator
->sec_radius_server
);
273 case ISCSI_BOOT_INI_INITIATOR_NAME
:
274 str
+= sprintf_string(str
, initiator
->initiator_name_len
,
276 initiator
->initiator_name_off
);
285 static ssize_t
ibft_attr_show_nic(void *data
, int type
, char *buf
)
287 struct ibft_kobject
*entry
= data
;
288 struct ibft_nic
*nic
= entry
->nic
;
289 void *ibft_loc
= entry
->header
;
297 case ISCSI_BOOT_ETH_INDEX
:
298 str
+= sprintf(str
, "%d\n", nic
->hdr
.index
);
300 case ISCSI_BOOT_ETH_FLAGS
:
301 str
+= sprintf(str
, "%d\n", nic
->hdr
.flags
);
303 case ISCSI_BOOT_ETH_IP_ADDR
:
304 str
+= sprintf_ipaddr(str
, nic
->ip_addr
);
306 case ISCSI_BOOT_ETH_SUBNET_MASK
:
307 val
= cpu_to_be32(~((1 << (32-nic
->subnet_mask_prefix
))-1));
308 str
+= sprintf(str
, "%pI4", &val
);
310 case ISCSI_BOOT_ETH_ORIGIN
:
311 str
+= sprintf(str
, "%d\n", nic
->origin
);
313 case ISCSI_BOOT_ETH_GATEWAY
:
314 str
+= sprintf_ipaddr(str
, nic
->gateway
);
316 case ISCSI_BOOT_ETH_PRIMARY_DNS
:
317 str
+= sprintf_ipaddr(str
, nic
->primary_dns
);
319 case ISCSI_BOOT_ETH_SECONDARY_DNS
:
320 str
+= sprintf_ipaddr(str
, nic
->secondary_dns
);
322 case ISCSI_BOOT_ETH_DHCP
:
323 str
+= sprintf_ipaddr(str
, nic
->dhcp
);
325 case ISCSI_BOOT_ETH_VLAN
:
326 str
+= sprintf(str
, "%d\n", nic
->vlan
);
328 case ISCSI_BOOT_ETH_MAC
:
329 str
+= sprintf(str
, "%pM\n", nic
->mac
);
331 case ISCSI_BOOT_ETH_HOSTNAME
:
332 str
+= sprintf_string(str
, nic
->hostname_len
,
333 (char *)ibft_loc
+ nic
->hostname_off
);
342 static ssize_t
ibft_attr_show_target(void *data
, int type
, char *buf
)
344 struct ibft_kobject
*entry
= data
;
345 struct ibft_tgt
*tgt
= entry
->tgt
;
346 void *ibft_loc
= entry
->header
;
354 case ISCSI_BOOT_TGT_INDEX
:
355 str
+= sprintf(str
, "%d\n", tgt
->hdr
.index
);
357 case ISCSI_BOOT_TGT_FLAGS
:
358 str
+= sprintf(str
, "%d\n", tgt
->hdr
.flags
);
360 case ISCSI_BOOT_TGT_IP_ADDR
:
361 str
+= sprintf_ipaddr(str
, tgt
->ip_addr
);
363 case ISCSI_BOOT_TGT_PORT
:
364 str
+= sprintf(str
, "%d\n", tgt
->port
);
366 case ISCSI_BOOT_TGT_LUN
:
367 for (i
= 0; i
< 8; i
++)
368 str
+= sprintf(str
, "%x", (u8
)tgt
->lun
[i
]);
369 str
+= sprintf(str
, "\n");
371 case ISCSI_BOOT_TGT_NIC_ASSOC
:
372 str
+= sprintf(str
, "%d\n", tgt
->nic_assoc
);
374 case ISCSI_BOOT_TGT_CHAP_TYPE
:
375 str
+= sprintf(str
, "%d\n", tgt
->chap_type
);
377 case ISCSI_BOOT_TGT_NAME
:
378 str
+= sprintf_string(str
, tgt
->tgt_name_len
,
379 (char *)ibft_loc
+ tgt
->tgt_name_off
);
381 case ISCSI_BOOT_TGT_CHAP_NAME
:
382 str
+= sprintf_string(str
, tgt
->chap_name_len
,
383 (char *)ibft_loc
+ tgt
->chap_name_off
);
385 case ISCSI_BOOT_TGT_CHAP_SECRET
:
386 str
+= sprintf_string(str
, tgt
->chap_secret_len
,
387 (char *)ibft_loc
+ tgt
->chap_secret_off
);
389 case ISCSI_BOOT_TGT_REV_CHAP_NAME
:
390 str
+= sprintf_string(str
, tgt
->rev_chap_name_len
,
392 tgt
->rev_chap_name_off
);
394 case ISCSI_BOOT_TGT_REV_CHAP_SECRET
:
395 str
+= sprintf_string(str
, tgt
->rev_chap_secret_len
,
397 tgt
->rev_chap_secret_off
);
406 static int __init
ibft_check_device(void)
412 len
= ibft_addr
->header
.length
;
414 /* Sanity checking of iBFT. */
415 if (ibft_addr
->header
.revision
!= 1) {
416 printk(KERN_ERR
"iBFT module supports only revision 1, " \
417 "while this is %d.\n",
418 ibft_addr
->header
.revision
);
421 for (pos
= (u8
*)ibft_addr
; pos
< (u8
*)ibft_addr
+ len
; pos
++)
425 printk(KERN_ERR
"iBFT has incorrect checksum (0x%x)!\n", csum
);
433 * Helper routiners to check to determine if the entry is valid
434 * in the proper iBFT structure.
436 static mode_t
ibft_check_nic_for(void *data
, int type
)
438 struct ibft_kobject
*entry
= data
;
439 struct ibft_nic
*nic
= entry
->nic
;
443 case ISCSI_BOOT_ETH_INDEX
:
444 case ISCSI_BOOT_ETH_FLAGS
:
447 case ISCSI_BOOT_ETH_IP_ADDR
:
448 if (memcmp(nic
->ip_addr
, nulls
, sizeof(nic
->ip_addr
)))
451 case ISCSI_BOOT_ETH_SUBNET_MASK
:
452 if (nic
->subnet_mask_prefix
)
455 case ISCSI_BOOT_ETH_ORIGIN
:
458 case ISCSI_BOOT_ETH_GATEWAY
:
459 if (memcmp(nic
->gateway
, nulls
, sizeof(nic
->gateway
)))
462 case ISCSI_BOOT_ETH_PRIMARY_DNS
:
463 if (memcmp(nic
->primary_dns
, nulls
,
464 sizeof(nic
->primary_dns
)))
467 case ISCSI_BOOT_ETH_SECONDARY_DNS
:
468 if (memcmp(nic
->secondary_dns
, nulls
,
469 sizeof(nic
->secondary_dns
)))
472 case ISCSI_BOOT_ETH_DHCP
:
473 if (memcmp(nic
->dhcp
, nulls
, sizeof(nic
->dhcp
)))
476 case ISCSI_BOOT_ETH_VLAN
:
477 case ISCSI_BOOT_ETH_MAC
:
480 case ISCSI_BOOT_ETH_HOSTNAME
:
481 if (nic
->hostname_off
)
491 static mode_t __init
ibft_check_tgt_for(void *data
, int type
)
493 struct ibft_kobject
*entry
= data
;
494 struct ibft_tgt
*tgt
= entry
->tgt
;
498 case ISCSI_BOOT_TGT_INDEX
:
499 case ISCSI_BOOT_TGT_FLAGS
:
500 case ISCSI_BOOT_TGT_IP_ADDR
:
501 case ISCSI_BOOT_TGT_PORT
:
502 case ISCSI_BOOT_TGT_LUN
:
503 case ISCSI_BOOT_TGT_NIC_ASSOC
:
504 case ISCSI_BOOT_TGT_CHAP_TYPE
:
506 case ISCSI_BOOT_TGT_NAME
:
507 if (tgt
->tgt_name_len
)
510 case ISCSI_BOOT_TGT_CHAP_NAME
:
511 case ISCSI_BOOT_TGT_CHAP_SECRET
:
512 if (tgt
->chap_name_len
)
515 case ISCSI_BOOT_TGT_REV_CHAP_NAME
:
516 case ISCSI_BOOT_TGT_REV_CHAP_SECRET
:
517 if (tgt
->rev_chap_name_len
)
527 static mode_t __init
ibft_check_initiator_for(void *data
, int type
)
529 struct ibft_kobject
*entry
= data
;
530 struct ibft_initiator
*init
= entry
->initiator
;
534 case ISCSI_BOOT_INI_INDEX
:
535 case ISCSI_BOOT_INI_FLAGS
:
538 case ISCSI_BOOT_INI_ISNS_SERVER
:
539 if (memcmp(init
->isns_server
, nulls
,
540 sizeof(init
->isns_server
)))
543 case ISCSI_BOOT_INI_SLP_SERVER
:
544 if (memcmp(init
->slp_server
, nulls
,
545 sizeof(init
->slp_server
)))
548 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER
:
549 if (memcmp(init
->pri_radius_server
, nulls
,
550 sizeof(init
->pri_radius_server
)))
553 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER
:
554 if (memcmp(init
->sec_radius_server
, nulls
,
555 sizeof(init
->sec_radius_server
)))
558 case ISCSI_BOOT_INI_INITIATOR_NAME
:
559 if (init
->initiator_name_len
)
570 * Helper function for ibft_register_kobjects.
572 static int __init
ibft_create_kobject(struct acpi_table_ibft
*header
,
573 struct ibft_hdr
*hdr
)
575 struct iscsi_boot_kobj
*boot_kobj
= NULL
;
576 struct ibft_kobject
*ibft_kobj
= NULL
;
577 struct ibft_nic
*nic
= (struct ibft_nic
*)hdr
;
578 struct pci_dev
*pci_dev
;
581 ibft_kobj
= kzalloc(sizeof(*ibft_kobj
), GFP_KERNEL
);
585 ibft_kobj
->header
= header
;
586 ibft_kobj
->hdr
= hdr
;
590 rc
= ibft_verify_hdr("initiator", hdr
, id_initiator
,
591 sizeof(*ibft_kobj
->initiator
));
595 boot_kobj
= iscsi_boot_create_initiator(boot_kset
, hdr
->index
,
597 ibft_attr_show_initiator
,
598 ibft_check_initiator_for
);
605 rc
= ibft_verify_hdr("ethernet", hdr
, id_nic
,
606 sizeof(*ibft_kobj
->nic
));
610 boot_kobj
= iscsi_boot_create_ethernet(boot_kset
, hdr
->index
,
620 rc
= ibft_verify_hdr("target", hdr
, id_target
,
621 sizeof(*ibft_kobj
->tgt
));
625 boot_kobj
= iscsi_boot_create_target(boot_kset
, hdr
->index
,
627 ibft_attr_show_target
,
637 /* Fields which we don't support. Ignore them */
641 printk(KERN_ERR
"iBFT has unknown structure type (%d). " \
642 "Report this bug to %.6s!\n", hdr
->id
,
643 header
->header
.oem_id
);
649 /* Skip adding this kobject, but exit with non-fatal error. */
654 if (hdr
->id
== id_nic
) {
656 * We don't search for the device in other domains than
657 * zero. This is because on x86 platforms the BIOS
658 * executes only devices which are in domain 0. Furthermore, the
659 * iBFT spec doesn't have a domain id field :-(
661 pci_dev
= pci_get_bus_and_slot((nic
->pci_bdf
& 0xff00) >> 8,
662 (nic
->pci_bdf
& 0xff));
664 rc
= sysfs_create_link(&boot_kobj
->kobj
,
665 &pci_dev
->dev
.kobj
, "device");
666 pci_dev_put(pci_dev
);
677 * Scan the IBFT table structure for the NIC and Target fields. When
678 * found add them on the passed-in list. We do not support the other
679 * fields at this point, so they are skipped.
681 static int __init
ibft_register_kobjects(struct acpi_table_ibft
*header
)
683 struct ibft_control
*control
= NULL
;
689 control
= (void *)header
+ sizeof(*header
);
690 end
= (void *)control
+ control
->hdr
.length
;
691 eot_offset
= (void *)header
+ header
->header
.length
- (void *)control
;
692 rc
= ibft_verify_hdr("control", (struct ibft_hdr
*)control
, id_control
,
695 /* iBFT table safety checking */
696 rc
|= ((control
->hdr
.index
) ? -ENODEV
: 0);
698 printk(KERN_ERR
"iBFT error: Control header is invalid!\n");
701 for (ptr
= &control
->initiator_off
; ptr
< end
; ptr
+= sizeof(u16
)) {
702 offset
= *(u16
*)ptr
;
703 if (offset
&& offset
< header
->header
.length
&&
704 offset
< eot_offset
) {
705 rc
= ibft_create_kobject(header
,
706 (void *)header
+ offset
);
715 static void ibft_unregister(void)
717 struct iscsi_boot_kobj
*boot_kobj
, *tmp_kobj
;
718 struct ibft_kobject
*ibft_kobj
;
720 list_for_each_entry_safe(boot_kobj
, tmp_kobj
,
721 &boot_kset
->kobj_list
, list
) {
722 ibft_kobj
= boot_kobj
->data
;
723 if (ibft_kobj
->hdr
->id
== id_nic
)
724 sysfs_remove_link(&boot_kobj
->kobj
, "device");
728 static void ibft_cleanup(void)
732 iscsi_boot_destroy_kset(boot_kset
);
736 static void __exit
ibft_exit(void)
742 * ibft_init() - creates sysfs tree entries for the iBFT data.
744 static int __init
ibft_init(void)
749 printk(KERN_INFO
"iBFT detected at 0x%llx.\n",
750 (u64
)isa_virt_to_bus(ibft_addr
));
752 rc
= ibft_check_device();
756 boot_kset
= iscsi_boot_create_kset("ibft");
760 /* Scan the IBFT for data and register the kobjects. */
761 rc
= ibft_register_kobjects(ibft_addr
);
765 printk(KERN_INFO
"No iBFT detected.\n");
774 module_init(ibft_init
);
775 module_exit(ibft_exit
);