drivers/firmware/iscsi_ibft.c

   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
 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  */
 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
 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  */
 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  */
 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
 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_ORIGIN:
 327                 str += sprintf(str, "%d\n", nic->origin);
 328                 break;
 329         case ISCSI_BOOT_ETH_GATEWAY:
 330                 str += sprintf_ipaddr(str, nic->gateway);
 331                 break;
 332         case ISCSI_BOOT_ETH_PRIMARY_DNS:
 333                 str += sprintf_ipaddr(str, nic->primary_dns);
 334                 break;
 335         case ISCSI_BOOT_ETH_SECONDARY_DNS:
 336                 str += sprintf_ipaddr(str, nic->secondary_dns);
 337                 break;
 338         case ISCSI_BOOT_ETH_DHCP:
 339                 str += sprintf_ipaddr(str, nic->dhcp);
 340                 break;
 341         case ISCSI_BOOT_ETH_VLAN:
 342                 str += sprintf(str, "%d\n", nic->vlan);
 343                 break;
 344         case ISCSI_BOOT_ETH_MAC:
 345                 str += sprintf(str, "%pM\n", nic->mac);
 346                 break;
 347         case ISCSI_BOOT_ETH_HOSTNAME:
 348                 str += sprintf_string(str, nic->hostname_len,
 349                                       (char *)ibft_loc + nic->hostname_off);
 350                 break;
 351         default:
 352                 break;
 353         }
 354
 355         return str - buf;
 356 };
 357
 358 static ssize_t ibft_attr_show_target(void *data, int type, char *buf)
 359 {
 360         struct ibft_kobject *entry = data;
 361         struct ibft_tgt *tgt = entry->tgt;
 362         void *ibft_loc = entry->header;
 363         char *str = buf;
 364         int i;
 365
 366         if (!tgt)
 367                 return 0;
 368
 369         switch (type) {
 370         case ISCSI_BOOT_TGT_INDEX:
 371                 str += sprintf(str, "%d\n", tgt->hdr.index);
 372                 break;
 373         case ISCSI_BOOT_TGT_FLAGS:
 374                 str += sprintf(str, "%d\n", tgt->hdr.flags);
 375                 break;
 376         case ISCSI_BOOT_TGT_IP_ADDR:
 377                 str += sprintf_ipaddr(str, tgt->ip_addr);
 378                 break;
 379         case ISCSI_BOOT_TGT_PORT:
 380                 str += sprintf(str, "%d\n", tgt->port);
 381                 break;
 382         case ISCSI_BOOT_TGT_LUN:
 383                 for (i = 0; i < 8; i++)
 384                         str += sprintf(str, "%x", (u8)tgt->lun[i]);
 385                 str += sprintf(str, "\n");
 386                 break;
 387         case ISCSI_BOOT_TGT_NIC_ASSOC:
 388                 str += sprintf(str, "%d\n", tgt->nic_assoc);
 389                 break;
 390         case ISCSI_BOOT_TGT_CHAP_TYPE:
 391                 str += sprintf(str, "%d\n", tgt->chap_type);
 392                 break;
 393         case ISCSI_BOOT_TGT_NAME:
 394                 str += sprintf_string(str, tgt->tgt_name_len,
 395                                       (char *)ibft_loc + tgt->tgt_name_off);
 396                 break;
 397         case ISCSI_BOOT_TGT_CHAP_NAME:
 398                 str += sprintf_string(str, tgt->chap_name_len,
 399                                       (char *)ibft_loc + tgt->chap_name_off);
 400                 break;
 401         case ISCSI_BOOT_TGT_CHAP_SECRET:
 402                 str += sprintf_string(str, tgt->chap_secret_len,
 403                                       (char *)ibft_loc + tgt->chap_secret_off);
 404                 break;
 405         case ISCSI_BOOT_TGT_REV_CHAP_NAME:
 406                 str += sprintf_string(str, tgt->rev_chap_name_len,
 407                                       (char *)ibft_loc +
 408                                       tgt->rev_chap_name_off);
 409                 break;
 410         case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
 411                 str += sprintf_string(str, tgt->rev_chap_secret_len,
 412                                       (char *)ibft_loc +
 413                                       tgt->rev_chap_secret_off);
 414                 break;
 415         default:
 416                 break;
 417         }
 418
 419         return str - buf;
 420 }
 421
 422 static int __init ibft_check_device(void)
 423 {
 424         int len;
 425         u8 *pos;
 426         u8 csum = 0;
 427
 428         len = ibft_addr->header.length;
 429
 430         /* Sanity checking of iBFT. */
 431         if (ibft_addr->header.revision != 1) {
 432                 printk(KERN_ERR "iBFT module supports only revision 1, " \
 433                                 "while this is %d.\n",
 434                                 ibft_addr->header.revision);
 435                 return -ENOENT;
 436         }
 437         for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
 438                 csum += *pos;
 439
 440         if (csum) {
 441                 printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
 442                 return -ENOENT;
 443         }
 444
 445         return 0;
 446 }
 447
 448 /*
 449  * Helper routiners to check to determine if the entry is valid
 450  * in the proper iBFT structure.
 451  */
 452 static umode_t ibft_check_nic_for(void *data, int type)
 453 {
 454         struct ibft_kobject *entry = data;
 455         struct ibft_nic *nic = entry->nic;
 456         umode_t rc = 0;
 457
 458         switch (type) {
 459         case ISCSI_BOOT_ETH_INDEX:
 460         case ISCSI_BOOT_ETH_FLAGS:
 461                 rc = S_IRUGO;
 462                 break;
 463         case ISCSI_BOOT_ETH_IP_ADDR:
 464                 if (address_not_null(nic->ip_addr))
 465                         rc = S_IRUGO;
 466                 break;
 467         case ISCSI_BOOT_ETH_SUBNET_MASK:
 468                 if (nic->subnet_mask_prefix)
 469                         rc = S_IRUGO;
 470                 break;
 471         case ISCSI_BOOT_ETH_ORIGIN:
 472                 rc = S_IRUGO;
 473                 break;
 474         case ISCSI_BOOT_ETH_GATEWAY:
 475                 if (address_not_null(nic->gateway))
 476                         rc = S_IRUGO;
 477                 break;
 478         case ISCSI_BOOT_ETH_PRIMARY_DNS:
 479                 if (address_not_null(nic->primary_dns))
 480                         rc = S_IRUGO;
 481                 break;
 482         case ISCSI_BOOT_ETH_SECONDARY_DNS:
 483                 if (address_not_null(nic->secondary_dns))
 484                         rc = S_IRUGO;
 485                 break;
 486         case ISCSI_BOOT_ETH_DHCP:
 487                 if (address_not_null(nic->dhcp))
 488                         rc = S_IRUGO;
 489                 break;
 490         case ISCSI_BOOT_ETH_VLAN:
 491         case ISCSI_BOOT_ETH_MAC:
 492                 rc = S_IRUGO;
 493                 break;
 494         case ISCSI_BOOT_ETH_HOSTNAME:
 495                 if (nic->hostname_off)
 496                         rc = S_IRUGO;
 497                 break;
 498         default:
 499                 break;
 500         }
 501
 502         return rc;
 503 }
 504
 505 static umode_t __init ibft_check_tgt_for(void *data, int type)
 506 {
 507         struct ibft_kobject *entry = data;
 508         struct ibft_tgt *tgt = entry->tgt;
 509         umode_t rc = 0;
 510
 511         switch (type) {
 512         case ISCSI_BOOT_TGT_INDEX:
 513         case ISCSI_BOOT_TGT_FLAGS:
 514         case ISCSI_BOOT_TGT_IP_ADDR:
 515         case ISCSI_BOOT_TGT_PORT:
 516         case ISCSI_BOOT_TGT_LUN:
 517         case ISCSI_BOOT_TGT_NIC_ASSOC:
 518         case ISCSI_BOOT_TGT_CHAP_TYPE:
 519                 rc = S_IRUGO;
 520                 break;
 521         case ISCSI_BOOT_TGT_NAME:
 522                 if (tgt->tgt_name_len)
 523                         rc = S_IRUGO;
 524                 break;
 525         case ISCSI_BOOT_TGT_CHAP_NAME:
 526         case ISCSI_BOOT_TGT_CHAP_SECRET:
 527                 if (tgt->chap_name_len)
 528                         rc = S_IRUGO;
 529                 break;
 530         case ISCSI_BOOT_TGT_REV_CHAP_NAME:
 531         case ISCSI_BOOT_TGT_REV_CHAP_SECRET:
 532                 if (tgt->rev_chap_name_len)
 533                         rc = S_IRUGO;
 534                 break;
 535         default:
 536                 break;
 537         }
 538
 539         return rc;
 540 }
 541
 542 static umode_t __init ibft_check_initiator_for(void *data, int type)
 543 {
 544         struct ibft_kobject *entry = data;
 545         struct ibft_initiator *init = entry->initiator;
 546         umode_t rc = 0;
 547
 548         switch (type) {
 549         case ISCSI_BOOT_INI_INDEX:
 550         case ISCSI_BOOT_INI_FLAGS:
 551                 rc = S_IRUGO;
 552                 break;
 553         case ISCSI_BOOT_INI_ISNS_SERVER:
 554                 if (address_not_null(init->isns_server))
 555                         rc = S_IRUGO;
 556                 break;
 557         case ISCSI_BOOT_INI_SLP_SERVER:
 558                 if (address_not_null(init->slp_server))
 559                         rc = S_IRUGO;
 560                 break;
 561         case ISCSI_BOOT_INI_PRI_RADIUS_SERVER:
 562                 if (address_not_null(init->pri_radius_server))
 563                         rc = S_IRUGO;
 564                 break;
 565         case ISCSI_BOOT_INI_SEC_RADIUS_SERVER:
 566                 if (address_not_null(init->sec_radius_server))
 567                         rc = S_IRUGO;
 568                 break;
 569         case ISCSI_BOOT_INI_INITIATOR_NAME:
 570                 if (init->initiator_name_len)
 571                         rc = S_IRUGO;
 572                 break;
 573         default:
 574                 break;
 575         }
 576
 577         return rc;
 578 }
 579
 580 static void ibft_kobj_release(void *data)
 581 {
 582         kfree(data);
 583 }
 584
 585 /*
 586  * Helper function for ibft_register_kobjects.
 587  */
 588 static int __init ibft_create_kobject(struct acpi_table_ibft *header,
 589                                       struct ibft_hdr *hdr)
 590 {
 591         struct iscsi_boot_kobj *boot_kobj = NULL;
 592         struct ibft_kobject *ibft_kobj = NULL;
 593         struct ibft_nic *nic = (struct ibft_nic *)hdr;
 594         struct pci_dev *pci_dev;
 595         int rc = 0;
 596
 597         ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
 598         if (!ibft_kobj)
 599                 return -ENOMEM;
 600
 601         ibft_kobj->header = header;
 602         ibft_kobj->hdr = hdr;
 603
 604         switch (hdr->id) {
 605         case id_initiator:
 606                 rc = ibft_verify_hdr("initiator", hdr, id_initiator,
 607                                      sizeof(*ibft_kobj->initiator));
 608                 if (rc)
 609                         break;
 610
 611                 boot_kobj = iscsi_boot_create_initiator(boot_kset, hdr->index,
 612                                                 ibft_kobj,
 613                                                 ibft_attr_show_initiator,
 614                                                 ibft_check_initiator_for,
 615                                                 ibft_kobj_release);
 616                 if (!boot_kobj) {
 617                         rc = -ENOMEM;
 618                         goto free_ibft_obj;
 619                 }
 620                 break;
 621         case id_nic:
 622                 rc = ibft_verify_hdr("ethernet", hdr, id_nic,
 623                                      sizeof(*ibft_kobj->nic));
 624                 if (rc)
 625                         break;
 626
 627                 boot_kobj = iscsi_boot_create_ethernet(boot_kset, hdr->index,
 628                                                        ibft_kobj,
 629                                                        ibft_attr_show_nic,
 630                                                        ibft_check_nic_for,
 631                                                        ibft_kobj_release);
 632                 if (!boot_kobj) {
 633                         rc = -ENOMEM;
 634                         goto free_ibft_obj;
 635                 }
 636                 break;
 637         case id_target:
 638                 rc = ibft_verify_hdr("target", hdr, id_target,
 639                                      sizeof(*ibft_kobj->tgt));
 640                 if (rc)
 641                         break;
 642
 643                 boot_kobj = iscsi_boot_create_target(boot_kset, hdr->index,
 644                                                      ibft_kobj,
 645                                                      ibft_attr_show_target,
 646                                                      ibft_check_tgt_for,
 647                                                      ibft_kobj_release);
 648                 if (!boot_kobj) {
 649                         rc = -ENOMEM;
 650                         goto free_ibft_obj;
 651                 }
 652                 break;
 653         case id_reserved:
 654         case id_control:
 655         case id_extensions:
 656                 /* Fields which we don't support. Ignore them */
 657                 rc = 1;
 658                 break;
 659         default:
 660                 printk(KERN_ERR "iBFT has unknown structure type (%d). " \
 661                                 "Report this bug to %.6s!\n", hdr->id,
 662                                 header->header.oem_id);
 663                 rc = 1;
 664                 break;
 665         }
 666
 667         if (rc) {
 668                 /* Skip adding this kobject, but exit with non-fatal error. */
 669                 rc = 0;
 670                 goto free_ibft_obj;
 671         }
 672
 673         if (hdr->id == id_nic) {
 674                 /*
 675                 * We don't search for the device in other domains than
 676                 * zero. This is because on x86 platforms the BIOS
 677                 * executes only devices which are in domain 0. Furthermore, the
 678                 * iBFT spec doesn't have a domain id field :-(
 679                 */
 680                 pci_dev = pci_get_bus_and_slot((nic->pci_bdf & 0xff00) >> 8,
 681                                                (nic->pci_bdf & 0xff));
 682                 if (pci_dev) {
 683                         rc = sysfs_create_link(&boot_kobj->kobj,
 684                                                &pci_dev->dev.kobj, "device");
 685                         pci_dev_put(pci_dev);
 686                 }
 687         }
 688         return 0;
 689
 690 free_ibft_obj:
 691         kfree(ibft_kobj);
 692         return rc;
 693 }
 694
 695 /*
 696  * Scan the IBFT table structure for the NIC and Target fields. When
 697  * found add them on the passed-in list. We do not support the other
 698  * fields at this point, so they are skipped.
 699  */
 700 static int __init ibft_register_kobjects(struct acpi_table_ibft *header)
 701 {
 702         struct ibft_control *control = NULL;
 703         void *ptr, *end;
 704         int rc = 0;
 705         u16 offset;
 706         u16 eot_offset;
 707
 708         control = (void *)header + sizeof(*header);
 709         end = (void *)control + control->hdr.length;
 710         eot_offset = (void *)header + header->header.length - (void *)control;
 711         rc = ibft_verify_hdr("control", (struct ibft_hdr *)control, id_control,
 712                              sizeof(*control));
 713
 714         /* iBFT table safety checking */
 715         rc |= ((control->hdr.index) ? -ENODEV : 0);
 716         if (rc) {
 717                 printk(KERN_ERR "iBFT error: Control header is invalid!\n");
 718                 return rc;
 719         }
 720         for (ptr = &control->initiator_off; ptr < end; ptr += sizeof(u16)) {
 721                 offset = *(u16 *)ptr;
 722                 if (offset && offset < header->header.length &&
 723                                                 offset < eot_offset) {
 724                         rc = ibft_create_kobject(header,
 725                                                  (void *)header + offset);
 726                         if (rc)
 727                                 break;
 728                 }
 729         }
 730
 731         return rc;
 732 }
 733
 734 static void ibft_unregister(void)
 735 {
 736         struct iscsi_boot_kobj *boot_kobj, *tmp_kobj;
 737         struct ibft_kobject *ibft_kobj;
 738
 739         list_for_each_entry_safe(boot_kobj, tmp_kobj,
 740                                  &boot_kset->kobj_list, list) {
 741                 ibft_kobj = boot_kobj->data;
 742                 if (ibft_kobj->hdr->id == id_nic)
 743                         sysfs_remove_link(&boot_kobj->kobj, "device");
 744         };
 745 }
 746
 747 static void ibft_cleanup(void)
 748 {
 749         if (boot_kset) {
 750                 ibft_unregister();
 751                 iscsi_boot_destroy_kset(boot_kset);
 752         }
 753 }
 754
 755 static void __exit ibft_exit(void)
 756 {
 757         ibft_cleanup();
 758 }
 759
 760 #ifdef CONFIG_ACPI
 761 static const struct {
 762         char *sign;
 763 } ibft_signs[] = {
 764         /*
 765          * One spec says "IBFT", the other says "iBFT". We have to check
 766          * for both.
 767          */
 768         { ACPI_SIG_IBFT },
 769         { "iBFT" },
 770         { "BIFT" },     /* Broadcom iSCSI Offload */
 771 };
 772
 773 static void __init acpi_find_ibft_region(void)
 774 {
 775         int i;
 776         struct acpi_table_header *table = NULL;
 777
 778         if (acpi_disabled)
 779                 return;
 780
 781         for (i = 0; i < ARRAY_SIZE(ibft_signs) && !ibft_addr; i++) {
 782                 acpi_get_table(ibft_signs[i].sign, 0, &table);
 783                 ibft_addr = (struct acpi_table_ibft *)table;
 784         }
 785 }
 786 #else
 787 static void __init acpi_find_ibft_region(void)
 788 {
 789 }
 790 #endif
 791
 792 /*
 793  * ibft_init() - creates sysfs tree entries for the iBFT data.
 794  */
 795 static int __init ibft_init(void)
 796 {
 797         int rc = 0;
 798
 799         /*
 800            As on UEFI systems the setup_arch()/find_ibft_region()
 801            is called before ACPI tables are parsed and it only does
 802            legacy finding.
 803         */
 804         if (!ibft_addr)
 805                 acpi_find_ibft_region();
 806
 807         if (ibft_addr) {
 808                 pr_info("iBFT detected.\n");
 809
 810                 rc = ibft_check_device();
 811                 if (rc)
 812                         return rc;
 813
 814                 boot_kset = iscsi_boot_create_kset("ibft");
 815                 if (!boot_kset)
 816                         return -ENOMEM;
 817
 818                 /* Scan the IBFT for data and register the kobjects. */
 819                 rc = ibft_register_kobjects(ibft_addr);
 820                 if (rc)
 821                         goto out_free;
 822         } else
 823                 printk(KERN_INFO "No iBFT detected.\n");
 824
 825         return 0;
 826
 827 out_free:
 828         ibft_cleanup();
 829         return rc;
 830 }
 831
 832 module_init(ibft_init);
 833 module_exit(ibft_exit);