1 /*
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>
6 * Copyright 2008
7 * by Konrad Rzeszutek <ketuzsezr@darnok.org>
8 *
9 * This code exposes the iSCSI Boot Format Table to userland via sysfs.
10 *
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
14 *
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.
19 *
20 * Changelog:
21 *
22 * 06 Jan 2010 - Peter Jones <pjones@redhat.com>
23 * New changelog entries are in the git log from now on. Not here.
24 *
25 * 14 Mar 2008 - Konrad Rzeszutek <ketuzsezr@darnok.org>
26 * Updated comments and copyrights. (v0.4.9)
27 *
28 * 11 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
29 * Converted to using ibft_addr. (v0.4.8)
30 *
31 * 8 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
32 * Combined two functions in one: reserve_ibft_region. (v0.4.7)
33 *
34 * 30 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
35 * Added logic to handle IPv6 addresses. (v0.4.6)
36 *
37 * 25 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
38 * Added logic to handle badly not-to-spec iBFT. (v0.4.5)
39 *
40 * 4 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
41 * Added __init to function declarations. (v0.4.4)
42 *
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)
46 *
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)
49 *
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)
52 *
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)
56 *
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)
60 *
61 * 29 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
62 * Added functionality in setup.c to reserve iBFT region. (v0.2)
63 *
64 * 27 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
65 * First version exposing iBFT data via a binary /sysfs. (v0.1)
66 *
67 */
68
69
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>
86
87 #define IBFT_ISCSI_VERSION "0.5.0"
88 #define IBFT_ISCSI_DATE "2010-Feb-25"
89
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);
95
96 #ifndef CONFIG_ISCSI_IBFT_FIND
97 struct acpi_table_ibft *ibft_addr;
98 #endif
99
100 struct ibft_hdr {
101 u8 id;
102 u8 version;
103 u16 length;
104 u8 index;
105 u8 flags;
106 } __attribute__((__packed__));
107
108 struct ibft_control {
109 struct ibft_hdr hdr;
110 u16 extensions;
111 u16 initiator_off;
112 u16 nic0_off;
113 u16 tgt0_off;
114 u16 nic1_off;
115 u16 tgt1_off;
116 } __attribute__((__packed__));
117
118 struct ibft_initiator {
119 struct ibft_hdr hdr;
120 char isns_server[16];
121 char slp_server[16];
122 char pri_radius_server[16];
123 char sec_radius_server[16];
124 u16 initiator_name_len;
125 u16 initiator_name_off;
126 } __attribute__((__packed__));
127
128 struct ibft_nic {
129 struct ibft_hdr hdr;
130 char ip_addr[16];
131 u8 subnet_mask_prefix;
132 u8 origin;
133 char gateway[16];
134 char primary_dns[16];
135 char secondary_dns[16];
136 char dhcp[16];
137 u16 vlan;
138 char mac[6];
139 u16 pci_bdf;
140 u16 hostname_len;
141 u16 hostname_off;
142 } __attribute__((__packed__));
143
144 struct ibft_tgt {
145 struct ibft_hdr hdr;
146 char ip_addr[16];
147 u16 port;
148 char lun[8];
149 u8 chap_type;
150 u8 nic_assoc;
151 u16 tgt_name_len;
152 u16 tgt_name_off;
153 u16 chap_name_len;
154 u16 chap_name_off;
155 u16 chap_secret_len;
156 u16 chap_secret_off;
157 u16 rev_chap_name_len;
158 u16 rev_chap_name_off;
159 u16 rev_chap_secret_len;
160 u16 rev_chap_secret_off;
161 } __attribute__((__packed__));
162
163 /*
164 * The kobject different types and its names.
165 *
166 */
167 enum ibft_id {
168 id_reserved = 0, /* We don't support. */
169 id_control = 1, /* Should show up only once and is not exported. */
170 id_initiator = 2,
171 id_nic = 3,
172 id_target = 4,
173 id_extensions = 5, /* We don't support. */
174 id_end_marker,
175 };
176
177 /*
178 * The kobject and attribute structures.
179 */
180
181 struct ibft_kobject {
182 struct acpi_table_ibft *header;
183 union {
184 struct ibft_initiator *initiator;
185 struct ibft_nic *nic;
186 struct ibft_tgt *tgt;
187 struct ibft_hdr *hdr;
188 };
189 };
190
191 static struct iscsi_boot_kset *boot_kset;
192
193 /* fully null address */
194 static const char nulls[16];
195
196 /* IPv4-mapped IPv6 ::ffff:0.0.0.0 */
197 static const char mapped_nulls[16] = { 0x00, 0x00, 0x00, 0x00,
198 0x00, 0x00, 0x00, 0x00,
199 0x00, 0x00, 0xff, 0xff,
200 0x00, 0x00, 0x00, 0x00 };
201
address_not_null(u8 * ip)202 static int address_not_null(u8 *ip)
203 {
204 return (memcmp(ip, nulls, 16) && memcmp(ip, mapped_nulls, 16));
205 }
206
207 /*
208 * Helper functions to parse data properly.
209 */
sprintf_ipaddr(char * buf,u8 * ip)210 static ssize_t sprintf_ipaddr(char *buf, u8 *ip)
211 {
212 char *str = buf;
213
214 if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] == 0 &&
215 ip[4] == 0 && ip[5] == 0 && ip[6] == 0 && ip[7] == 0 &&
216 ip[8] == 0 && ip[9] == 0 && ip[10] == 0xff && ip[11] == 0xff) {
217 /*
218 * IPV4
219 */
220 str += sprintf(buf, "%pI4", ip + 12);
221 } else {
222 /*
223 * IPv6
224 */
225 str += sprintf(str, "%pI6", ip);
226 }
227 str += sprintf(str, "\n");
228 return str - buf;
229 }
230
sprintf_string(char * str,int len,char * buf)231 static ssize_t sprintf_string(char *str, int len, char *buf)
232 {
233 return sprintf(str, "%.*s\n", len, buf);
234 }
235
236 /*
237 * Helper function to verify the IBFT header.
238 */
ibft_verify_hdr(char * t,struct ibft_hdr * hdr,int id,int length)239 static int ibft_verify_hdr(char *t, struct ibft_hdr *hdr, int id, int length)
240 {
241 if (hdr->id != id) {
242 printk(KERN_ERR "iBFT error: We expected the %s " \
243 "field header.id to have %d but " \
244 "found %d instead!\n", t, id, hdr->id);
245 return -ENODEV;
246 }
247 if (hdr->length != length) {
248 printk(KERN_ERR "iBFT error: We expected the %s " \
249 "field header.length to have %d but " \
250 "found %d instead!\n", t, length, hdr->length);
251 return -ENODEV;
252 }
253
254 return 0;
255 }
256
257 /*
258 * Routines for parsing the iBFT data to be human readable.
259 */
ibft_attr_show_initiator(void * data,int type,char * buf)260 static ssize_t ibft_attr_show_initiator(void *data, int type, char *buf)
261 {
262 struct ibft_kobject *entry = data;
263 struct ibft_initiator *initiator = entry->initiator;
264 void *ibft_loc = entry->header;
265 char *str = buf;
266
267 if (!initiator)
268 return 0;
269
270 switch (type) {
271 case ISCSI_BOOT_INI_INDEX:
272 str += sprintf(str, "%d\n", initiator->hdr.index);
273 break;
274 case ISCSI_BOOT_INI_FLAGS:
275 str += sprintf(str, "%d\n", initiator->hdr.flags);
276 break;
277 case ISCSI_BOOT_INI_ISNS_SERVER:
278 str += sprintf_ipaddr(str, initiator->isns_server);
279 break;
280 case ISCSI_BOOT_INI_SLP_SERVER:
281 str += sprintf_ipaddr(str, initiator->slp_server);
282 break;
283 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
284 str += sprintf_ipaddr(str, initiator->pri_radius_server);
285 break;
286 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
287 str += sprintf_ipaddr(str, initiator->sec_radius_server);
288 break;
289 case ISCSI_BOOT_INI_INITIATOR_NAME:
290 str += sprintf_string(str, initiator->initiator_name_len,
291 (char *)ibft_loc +
292 initiator->initiator_name_off);
293 break;
294 default:
295 break;
296 }
297
298 return str - buf;
299 }
300
ibft_attr_show_nic(void * data,int type,char * buf)301 static ssize_t ibft_attr_show_nic(void *data, int type, char *buf)
302 {
303 struct ibft_kobject *entry = data;
304 struct ibft_nic *nic = entry->nic;
305 void *ibft_loc = entry->header;
306 char *str = buf;
307 __be32 val;
308
309 if (!nic)
310 return 0;
311
312 switch (type) {
313 case ISCSI_BOOT_ETH_INDEX:
314 str += sprintf(str, "%d\n", nic->hdr.index);
315 break;
316 case ISCSI_BOOT_ETH_FLAGS:
317 str += sprintf(str, "%d\n", nic->hdr.flags);
318 break;
319 case ISCSI_BOOT_ETH_IP_ADDR:
320 str += sprintf_ipaddr(str, nic->ip_addr);
321 break;
322 case ISCSI_BOOT_ETH_SUBNET_MASK:
323 val = cpu_to_be32(~((1 << (32-nic->subnet_mask_prefix))-1));
324 str += sprintf(str, "%pI4", &val);
325 break;
326 case ISCSI_BOOT_ETH_PREFIX_LEN:
327 str += sprintf(str, "%d\n", nic->subnet_mask_prefix);
328 break;
329 case ISCSI_BOOT_ETH_ORIGIN:
330 str += sprintf(str, "%d\n", nic->origin);
331 break;
332 case ISCSI_BOOT_ETH_GATEWAY:
333 str += sprintf_ipaddr(str, nic->gateway);
334 break;
335 case ISCSI_BOOT_ETH_PRIMARY_DNS:
336 str += sprintf_ipaddr(str, nic->primary_dns);
337 break;
338 case ISCSI_BOOT_ETH_SECONDARY_DNS:
339 str += sprintf_ipaddr(str, nic->secondary_dns);
340 break;
341 case ISCSI_BOOT_ETH_DHCP:
342 str += sprintf_ipaddr(str, nic->dhcp);
343 break;
344 case ISCSI_BOOT_ETH_VLAN:
345 str += sprintf(str, "%d\n", nic->vlan);
346 break;
347 case ISCSI_BOOT_ETH_MAC:
348 str += sprintf(str, "%pM\n", nic->mac);
349 break;
350 case ISCSI_BOOT_ETH_HOSTNAME:
351 str += sprintf_string(str, nic->hostname_len,
352 (char *)ibft_loc + nic->hostname_off);
353 break;
354 default:
355 break;
356 }
357
358 return str - buf;
359 };
360
ibft_attr_show_target(void * data,int type,char * buf)361 static ssize_t ibft_attr_show_target(void *data, int type, char *buf)
362 {
363 struct ibft_kobject *entry = data;
364 struct ibft_tgt *tgt = entry->tgt;
365 void *ibft_loc = entry->header;
366 char *str = buf;
367 int i;
368
369 if (!tgt)
370 return 0;
371
372 switch (type) {
373 case ISCSI_BOOT_TGT_INDEX:
374 str += sprintf(str, "%d\n", tgt->hdr.index);
375 break;
376 case ISCSI_BOOT_TGT_FLAGS:
377 str += sprintf(str, "%d\n", tgt->hdr.flags);
378 break;
379 case ISCSI_BOOT_TGT_IP_ADDR:
380 str += sprintf_ipaddr(str, tgt->ip_addr);
381 break;
382 case ISCSI_BOOT_TGT_PORT:
383 str += sprintf(str, "%d\n", tgt->port);
384 break;
385 case ISCSI_BOOT_TGT_LUN:
386 for (i = 0; i < 8; i++)
387 str += sprintf(str, "%x", (u8)tgt->lun[i]);
388 str += sprintf(str, "\n");
389 break;
390 case ISCSI_BOOT_TGT_NIC_ASSOC:
391 str += sprintf(str, "%d\n", tgt->nic_assoc);
392 break;
393 case ISCSI_BOOT_TGT_CHAP_TYPE:
394 str += sprintf(str, "%d\n", tgt->chap_type);
395 break;
396 case ISCSI_BOOT_TGT_NAME:
397 str += sprintf_string(str, tgt->tgt_name_len,
398 (char *)ibft_loc + tgt->tgt_name_off);
399 break;
400 case ISCSI_BOOT_TGT_CHAP_NAME:
401 str += sprintf_string(str, tgt->chap_name_len,
402 (char *)ibft_loc + tgt->chap_name_off);
403 break;
404 case ISCSI_BOOT_TGT_CHAP_SECRET:
405 str += sprintf_string(str, tgt->chap_secret_len,
406 (char *)ibft_loc + tgt->chap_secret_off);
407 break;
408 case ISCSI_BOOT_TGT_REV_CHAP_NAME:
409 str += sprintf_string(str, tgt->rev_chap_name_len,
410 (char *)ibft_loc +
411 tgt->rev_chap_name_off);
412 break;
413 case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
414 str += sprintf_string(str, tgt->rev_chap_secret_len,
415 (char *)ibft_loc +
416 tgt->rev_chap_secret_off);
417 break;
418 default:
419 break;
420 }
421
422 return str - buf;
423 }
424
ibft_attr_show_acpitbl(void * data,int type,char * buf)425 static ssize_t ibft_attr_show_acpitbl(void *data, int type, char *buf)
426 {
427 struct ibft_kobject *entry = data;
428 char *str = buf;
429
430 switch (type) {
431 case ISCSI_BOOT_ACPITBL_SIGNATURE:
432 str += sprintf_string(str, ACPI_NAME_SIZE,
433 entry->header->header.signature);
434 break;
435 case ISCSI_BOOT_ACPITBL_OEM_ID:
436 str += sprintf_string(str, ACPI_OEM_ID_SIZE,
437 entry->header->header.oem_id);
438 break;
439 case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
440 str += sprintf_string(str, ACPI_OEM_TABLE_ID_SIZE,
441 entry->header->header.oem_table_id);
442 break;
443 default:
444 break;
445 }
446
447 return str - buf;
448 }
449
ibft_check_device(void)450 static int __init ibft_check_device(void)
451 {
452 int len;
453 u8 *pos;
454 u8 csum = 0;
455
456 len = ibft_addr->header.length;
457
458 /* Sanity checking of iBFT. */
459 if (ibft_addr->header.revision != 1) {
460 printk(KERN_ERR "iBFT module supports only revision 1, " \
461 "while this is %d.\n",
462 ibft_addr->header.revision);
463 return -ENOENT;
464 }
465 for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
466 csum += *pos;
467
468 if (csum) {
469 printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
470 return -ENOENT;
471 }
472
473 return 0;
474 }
475
476 /*
477 * Helper routiners to check to determine if the entry is valid
478 * in the proper iBFT structure.
479 */
ibft_check_nic_for(void * data,int type)480 static umode_t ibft_check_nic_for(void *data, int type)
481 {
482 struct ibft_kobject *entry = data;
483 struct ibft_nic *nic = entry->nic;
484 umode_t rc = 0;
485
486 switch (type) {
487 case ISCSI_BOOT_ETH_INDEX:
488 case ISCSI_BOOT_ETH_FLAGS:
489 rc = S_IRUGO;
490 break;
491 case ISCSI_BOOT_ETH_IP_ADDR:
492 if (address_not_null(nic->ip_addr))
493 rc = S_IRUGO;
494 break;
495 case ISCSI_BOOT_ETH_PREFIX_LEN:
496 case ISCSI_BOOT_ETH_SUBNET_MASK:
497 if (nic->subnet_mask_prefix)
498 rc = S_IRUGO;
499 break;
500 case ISCSI_BOOT_ETH_ORIGIN:
501 rc = S_IRUGO;
502 break;
503 case ISCSI_BOOT_ETH_GATEWAY:
504 if (address_not_null(nic->gateway))
505 rc = S_IRUGO;
506 break;
507 case ISCSI_BOOT_ETH_PRIMARY_DNS:
508 if (address_not_null(nic->primary_dns))
509 rc = S_IRUGO;
510 break;
511 case ISCSI_BOOT_ETH_SECONDARY_DNS:
512 if (address_not_null(nic->secondary_dns))
513 rc = S_IRUGO;
514 break;
515 case ISCSI_BOOT_ETH_DHCP:
516 if (address_not_null(nic->dhcp))
517 rc = S_IRUGO;
518 break;
519 case ISCSI_BOOT_ETH_VLAN:
520 case ISCSI_BOOT_ETH_MAC:
521 rc = S_IRUGO;
522 break;
523 case ISCSI_BOOT_ETH_HOSTNAME:
524 if (nic->hostname_off)
525 rc = S_IRUGO;
526 break;
527 default:
528 break;
529 }
530
531 return rc;
532 }
533
ibft_check_tgt_for(void * data,int type)534 static umode_t __init ibft_check_tgt_for(void *data, int type)
535 {
536 struct ibft_kobject *entry = data;
537 struct ibft_tgt *tgt = entry->tgt;
538 umode_t rc = 0;
539
540 switch (type) {
541 case ISCSI_BOOT_TGT_INDEX:
542 case ISCSI_BOOT_TGT_FLAGS:
543 case ISCSI_BOOT_TGT_IP_ADDR:
544 case ISCSI_BOOT_TGT_PORT:
545 case ISCSI_BOOT_TGT_LUN:
546 case ISCSI_BOOT_TGT_NIC_ASSOC:
547 case ISCSI_BOOT_TGT_CHAP_TYPE:
548 rc = S_IRUGO;
549 break;
550 case ISCSI_BOOT_TGT_NAME:
551 if (tgt->tgt_name_len)
552 rc = S_IRUGO;
553 break;
554 case ISCSI_BOOT_TGT_CHAP_NAME:
555 case ISCSI_BOOT_TGT_CHAP_SECRET:
556 if (tgt->chap_name_len)
557 rc = S_IRUGO;
558 break;
559 case ISCSI_BOOT_TGT_REV_CHAP_NAME:
560 case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
561 if (tgt->rev_chap_name_len)
562 rc = S_IRUGO;
563 break;
564 default:
565 break;
566 }
567
568 return rc;
569 }
570
ibft_check_initiator_for(void * data,int type)571 static umode_t __init ibft_check_initiator_for(void *data, int type)
572 {
573 struct ibft_kobject *entry = data;
574 struct ibft_initiator *init = entry->initiator;
575 umode_t rc = 0;
576
577 switch (type) {
578 case ISCSI_BOOT_INI_INDEX:
579 case ISCSI_BOOT_INI_FLAGS:
580 rc = S_IRUGO;
581 break;
582 case ISCSI_BOOT_INI_ISNS_SERVER:
583 if (address_not_null(init->isns_server))
584 rc = S_IRUGO;
585 break;
586 case ISCSI_BOOT_INI_SLP_SERVER:
587 if (address_not_null(init->slp_server))
588 rc = S_IRUGO;
589 break;
590 case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
591 if (address_not_null(init->pri_radius_server))
592 rc = S_IRUGO;
593 break;
594 case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
595 if (address_not_null(init->sec_radius_server))
596 rc = S_IRUGO;
597 break;
598 case ISCSI_BOOT_INI_INITIATOR_NAME:
599 if (init->initiator_name_len)
600 rc = S_IRUGO;
601 break;
602 default:
603 break;
604 }
605
606 return rc;
607 }
608
ibft_check_acpitbl_for(void * data,int type)609 static umode_t __init ibft_check_acpitbl_for(void *data, int type)
610 {
611
612 umode_t rc = 0;
613
614 switch (type) {
615 case ISCSI_BOOT_ACPITBL_SIGNATURE:
616 case ISCSI_BOOT_ACPITBL_OEM_ID:
617 case ISCSI_BOOT_ACPITBL_OEM_TABLE_ID:
618 rc = S_IRUGO;
619 break;
620 default:
621 break;
622 }
623
624 return rc;
625 }
626
ibft_kobj_release(void * data)627 static void ibft_kobj_release(void *data)
628 {
629 kfree(data);
630 }
631
632 /*
633 * Helper function for ibft_register_kobjects.
634 */
ibft_create_kobject(struct acpi_table_ibft * header,struct ibft_hdr * hdr)635 static int __init ibft_create_kobject(struct acpi_table_ibft *header,
636 struct ibft_hdr *hdr)
637 {
638 struct iscsi_boot_kobj *boot_kobj = NULL;
639 struct ibft_kobject *ibft_kobj = NULL;
640 struct ibft_nic *nic = (struct ibft_nic *)hdr;
641 struct pci_dev *pci_dev;
642 int rc = 0;
643
644 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
645 if (!ibft_kobj)
646 return -ENOMEM;
647
648 ibft_kobj->header = header;
649 ibft_kobj->hdr = hdr;
650
651 switch (hdr->id) {
652 case id_initiator:
653 rc = ibft_verify_hdr("initiator", hdr, id_initiator,
654 sizeof(*ibft_kobj->initiator));
655 if (rc)
656 break;
657
658 boot_kobj = iscsi_boot_create_initiator(boot_kset, hdr->index,
659 ibft_kobj,
660 ibft_attr_show_initiator,
661 ibft_check_initiator_for,
662 ibft_kobj_release);
663 if (!boot_kobj) {
664 rc = -ENOMEM;
665 goto free_ibft_obj;
666 }
667 break;
668 case id_nic:
669 rc = ibft_verify_hdr("ethernet", hdr, id_nic,
670 sizeof(*ibft_kobj->nic));
671 if (rc)
672 break;
673
674 boot_kobj = iscsi_boot_create_ethernet(boot_kset, hdr->index,
675 ibft_kobj,
676 ibft_attr_show_nic,
677 ibft_check_nic_for,
678 ibft_kobj_release);
679 if (!boot_kobj) {
680 rc = -ENOMEM;
681 goto free_ibft_obj;
682 }
683 break;
684 case id_target:
685 rc = ibft_verify_hdr("target", hdr, id_target,
686 sizeof(*ibft_kobj->tgt));
687 if (rc)
688 break;
689
690 boot_kobj = iscsi_boot_create_target(boot_kset, hdr->index,
691 ibft_kobj,
692 ibft_attr_show_target,
693 ibft_check_tgt_for,
694 ibft_kobj_release);
695 if (!boot_kobj) {
696 rc = -ENOMEM;
697 goto free_ibft_obj;
698 }
699 break;
700 case id_reserved:
701 case id_control:
702 case id_extensions:
703 /* Fields which we don't support. Ignore them */
704 rc = 1;
705 break;
706 default:
707 printk(KERN_ERR "iBFT has unknown structure type (%d). " \
708 "Report this bug to %.6s!\n", hdr->id,
709 header->header.oem_id);
710 rc = 1;
711 break;
712 }
713
714 if (rc) {
715 /* Skip adding this kobject, but exit with non-fatal error. */
716 rc = 0;
717 goto free_ibft_obj;
718 }
719
720 if (hdr->id == id_nic) {
721 /*
722 * We don't search for the device in other domains than
723 * zero. This is because on x86 platforms the BIOS
724 * executes only devices which are in domain 0. Furthermore, the
725 * iBFT spec doesn't have a domain id field :-(
726 */
727 pci_dev = pci_get_bus_and_slot((nic->pci_bdf & 0xff00) >> 8,
728 (nic->pci_bdf & 0xff));
729 if (pci_dev) {
730 rc = sysfs_create_link(&boot_kobj->kobj,
731 &pci_dev->dev.kobj, "device");
732 pci_dev_put(pci_dev);
733 }
734 }
735 return 0;
736
737 free_ibft_obj:
738 kfree(ibft_kobj);
739 return rc;
740 }
741
742 /*
743 * Scan the IBFT table structure for the NIC and Target fields. When
744 * found add them on the passed-in list. We do not support the other
745 * fields at this point, so they are skipped.
746 */
ibft_register_kobjects(struct acpi_table_ibft * header)747 static int __init ibft_register_kobjects(struct acpi_table_ibft *header)
748 {
749 struct ibft_control *control = NULL;
750 struct iscsi_boot_kobj *boot_kobj;
751 struct ibft_kobject *ibft_kobj;
752 void *ptr, *end;
753 int rc = 0;
754 u16 offset;
755 u16 eot_offset;
756
757 control = (void *)header + sizeof(*header);
758 end = (void *)control + control->hdr.length;
759 eot_offset = (void *)header + header->header.length - (void *)control;
760 rc = ibft_verify_hdr("control", (struct ibft_hdr *)control, id_control,
761 sizeof(*control));
762
763 /* iBFT table safety checking */
764 rc |= ((control->hdr.index) ? -ENODEV : 0);
765 if (rc) {
766 printk(KERN_ERR "iBFT error: Control header is invalid!\n");
767 return rc;
768 }
769 for (ptr = &control->initiator_off; ptr < end; ptr += sizeof(u16)) {
770 offset = *(u16 *)ptr;
771 if (offset && offset < header->header.length &&
772 offset < eot_offset) {
773 rc = ibft_create_kobject(header,
774 (void *)header + offset);
775 if (rc)
776 break;
777 }
778 }
779 if (rc)
780 return rc;
781
782 ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
783 if (!ibft_kobj)
784 return -ENOMEM;
785
786 ibft_kobj->header = header;
787 ibft_kobj->hdr = NULL; /*for ibft_unregister*/
788
789 boot_kobj = iscsi_boot_create_acpitbl(boot_kset, 0,
790 ibft_kobj,
791 ibft_attr_show_acpitbl,
792 ibft_check_acpitbl_for,
793 ibft_kobj_release);
794 if (!boot_kobj) {
795 kfree(ibft_kobj);
796 rc = -ENOMEM;
797 }
798
799 return rc;
800 }
801
ibft_unregister(void)802 static void ibft_unregister(void)
803 {
804 struct iscsi_boot_kobj *boot_kobj, *tmp_kobj;
805 struct ibft_kobject *ibft_kobj;
806
807 list_for_each_entry_safe(boot_kobj, tmp_kobj,
808 &boot_kset->kobj_list, list) {
809 ibft_kobj = boot_kobj->data;
810 if (ibft_kobj->hdr && ibft_kobj->hdr->id == id_nic)
811 sysfs_remove_link(&boot_kobj->kobj, "device");
812 };
813 }
814
ibft_cleanup(void)815 static void ibft_cleanup(void)
816 {
817 if (boot_kset) {
818 ibft_unregister();
819 iscsi_boot_destroy_kset(boot_kset);
820 }
821 }
822
ibft_exit(void)823 static void __exit ibft_exit(void)
824 {
825 ibft_cleanup();
826 }
827
828 #ifdef CONFIG_ACPI
829 static const struct {
830 char *sign;
831 } ibft_signs[] = {
832 /*
833 * One spec says "IBFT", the other says "iBFT". We have to check
834 * for both.
835 */
836 { ACPI_SIG_IBFT },
837 { "iBFT" },
838 { "BIFT" }, /* Broadcom iSCSI Offload */
839 };
840
acpi_find_ibft_region(void)841 static void __init acpi_find_ibft_region(void)
842 {
843 int i;
844 struct acpi_table_header *table = NULL;
845
846 if (acpi_disabled)
847 return;
848
849 for (i = 0; i < ARRAY_SIZE(ibft_signs) && !ibft_addr; i++) {
850 acpi_get_table(ibft_signs[i].sign, 0, &table);
851 ibft_addr = (struct acpi_table_ibft *)table;
852 }
853 }
854 #else
acpi_find_ibft_region(void)855 static void __init acpi_find_ibft_region(void)
856 {
857 }
858 #endif
859
860 /*
861 * ibft_init() - creates sysfs tree entries for the iBFT data.
862 */
ibft_init(void)863 static int __init ibft_init(void)
864 {
865 int rc = 0;
866
867 /*
868 As on UEFI systems the setup_arch()/find_ibft_region()
869 is called before ACPI tables are parsed and it only does
870 legacy finding.
871 */
872 if (!ibft_addr)
873 acpi_find_ibft_region();
874
875 if (ibft_addr) {
876 pr_info("iBFT detected.\n");
877
878 rc = ibft_check_device();
879 if (rc)
880 return rc;
881
882 boot_kset = iscsi_boot_create_kset("ibft");
883 if (!boot_kset)
884 return -ENOMEM;
885
886 /* Scan the IBFT for data and register the kobjects. */
887 rc = ibft_register_kobjects(ibft_addr);
888 if (rc)
889 goto out_free;
890 } else
891 printk(KERN_INFO "No iBFT detected.\n");
892
893 return 0;
894
895 out_free:
896 ibft_cleanup();
897 return rc;
898 }
899
900 module_init(ibft_init);
901 module_exit(ibft_exit);
902