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