drivers/firmware/iscsi_ibft.c

   1 /*
   2  *  Copyright 2007 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  *  14 Mar 2008 - Konrad Rzeszutek <ketuzsezr@darnok.org>
  23  *    Updated comments and copyrights. (v0.4.9)
  24  *
  25  *  11 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  26  *    Converted to using ibft_addr. (v0.4.8)
  27  *
  28  *   8 Feb 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  29  *    Combined two functions in one: reserve_ibft_region. (v0.4.7)
  30  *
  31  *  30 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  32  *   Added logic to handle IPv6 addresses. (v0.4.6)
  33  *
  34  *  25 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  35  *   Added logic to handle badly not-to-spec iBFT. (v0.4.5)
  36  *
  37  *   4 Jan 2008 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  38  *   Added __init to function declarations. (v0.4.4)
  39  *
  40  *  21 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  41  *   Updated kobject registration, combined unregister functions in one
  42  *   and code and style cleanup. (v0.4.3)
  43  *
  44  *   5 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  45  *   Added end-markers to enums and re-organized kobject registration. (v0.4.2)
  46  *
  47  *   4 Dec 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  48  *   Created 'device' sysfs link to the NIC and style cleanup. (v0.4.1)
  49  *
  50  *  28 Nov 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  51  *   Added sysfs-ibft documentation, moved 'find_ibft' function to
  52  *   in its own file and added text attributes for every struct field.  (v0.4)
  53  *
  54  *  21 Nov 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  55  *   Added text attributes emulating OpenFirmware /proc/device-tree naming.
  56  *   Removed binary /sysfs interface (v0.3)
  57  *
  58  *  29 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  59  *   Added functionality in setup.c to reserve iBFT region. (v0.2)
  60  *
  61  *  27 Aug 2007 - Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
  62  *   First version exposing iBFT data via a binary /sysfs. (v0.1)
  63  *
  64  */
  65
  66
  67 #include <linux/blkdev.h>
  68 #include <linux/capability.h>
  69 #include <linux/ctype.h>
  70 #include <linux/device.h>
  71 #include <linux/err.h>
  72 #include <linux/init.h>
  73 #include <linux/iscsi_ibft.h>
  74 #include <linux/limits.h>
  75 #include <linux/module.h>
  76 #include <linux/pci.h>
  77 #include <linux/slab.h>
  78 #include <linux/stat.h>
  79 #include <linux/string.h>
  80 #include <linux/types.h>
  81
  82 #define IBFT_ISCSI_VERSION "0.4.9"
  83 #define IBFT_ISCSI_DATE "2008-Mar-14"
  84
  85 MODULE_AUTHOR("Peter Jones <pjones@redhat.com> and \
  86 Konrad Rzeszutek <ketuzsezr@darnok.org>");
  87 MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
  88 MODULE_LICENSE("GPL");
  89 MODULE_VERSION(IBFT_ISCSI_VERSION);
  90
  91 struct ibft_hdr {
  92         u8 id;
  93         u8 version;
  94         u16 length;
  95         u8 index;
  96         u8 flags;
  97 } __attribute__((__packed__));
  98
  99 struct ibft_control {
 100         struct ibft_hdr hdr;
 101         u16 extensions;
 102         u16 initiator_off;
 103         u16 nic0_off;
 104         u16 tgt0_off;
 105         u16 nic1_off;
 106         u16 tgt1_off;
 107 } __attribute__((__packed__));
 108
 109 struct ibft_initiator {
 110         struct ibft_hdr hdr;
 111         char isns_server[16];
 112         char slp_server[16];
 113         char pri_radius_server[16];
 114         char sec_radius_server[16];
 115         u16 initiator_name_len;
 116         u16 initiator_name_off;
 117 } __attribute__((__packed__));
 118
 119 struct ibft_nic {
 120         struct ibft_hdr hdr;
 121         char ip_addr[16];
 122         u8 subnet_mask_prefix;
 123         u8 origin;
 124         char gateway[16];
 125         char primary_dns[16];
 126         char secondary_dns[16];
 127         char dhcp[16];
 128         u16 vlan;
 129         char mac[6];
 130         u16 pci_bdf;
 131         u16 hostname_len;
 132         u16 hostname_off;
 133 } __attribute__((__packed__));
 134
 135 struct ibft_tgt {
 136         struct ibft_hdr hdr;
 137         char ip_addr[16];
 138         u16 port;
 139         char lun[8];
 140         u8 chap_type;
 141         u8 nic_assoc;
 142         u16 tgt_name_len;
 143         u16 tgt_name_off;
 144         u16 chap_name_len;
 145         u16 chap_name_off;
 146         u16 chap_secret_len;
 147         u16 chap_secret_off;
 148         u16 rev_chap_name_len;
 149         u16 rev_chap_name_off;
 150         u16 rev_chap_secret_len;
 151         u16 rev_chap_secret_off;
 152 } __attribute__((__packed__));
 153
 154 /*
 155  * The kobject different types and its names.
 156  *
 157 */
 158 enum ibft_id {
 159         id_reserved = 0, /* We don't support. */
 160         id_control = 1, /* Should show up only once and is not exported. */
 161         id_initiator = 2,
 162         id_nic = 3,
 163         id_target = 4,
 164         id_extensions = 5, /* We don't support. */
 165         id_end_marker,
 166 };
 167
 168 /*
 169  * We do not support the other types, hence the usage of NULL.
 170  * This maps to the enum ibft_id.
 171  */
 172 static const char *ibft_id_names[] =
 173         {NULL, NULL, "initiator", "ethernet%d", "target%d", NULL, NULL};
 174
 175 /*
 176  * The text attributes names for each of the kobjects.
 177 */
 178 enum ibft_eth_properties_enum {
 179         ibft_eth_index,
 180         ibft_eth_flags,
 181         ibft_eth_ip_addr,
 182         ibft_eth_subnet_mask,
 183         ibft_eth_origin,
 184         ibft_eth_gateway,
 185         ibft_eth_primary_dns,
 186         ibft_eth_secondary_dns,
 187         ibft_eth_dhcp,
 188         ibft_eth_vlan,
 189         ibft_eth_mac,
 190         /* ibft_eth_pci_bdf - this is replaced by link to the device itself. */
 191         ibft_eth_hostname,
 192         ibft_eth_end_marker,
 193 };
 194
 195 static const char *ibft_eth_properties[] =
 196         {"index", "flags", "ip-addr", "subnet-mask", "origin", "gateway",
 197         "primary-dns", "secondary-dns", "dhcp", "vlan", "mac", "hostname",
 198         NULL};
 199
 200 enum ibft_tgt_properties_enum {
 201         ibft_tgt_index,
 202         ibft_tgt_flags,
 203         ibft_tgt_ip_addr,
 204         ibft_tgt_port,
 205         ibft_tgt_lun,
 206         ibft_tgt_chap_type,
 207         ibft_tgt_nic_assoc,
 208         ibft_tgt_name,
 209         ibft_tgt_chap_name,
 210         ibft_tgt_chap_secret,
 211         ibft_tgt_rev_chap_name,
 212         ibft_tgt_rev_chap_secret,
 213         ibft_tgt_end_marker,
 214 };
 215
 216 static const char *ibft_tgt_properties[] =
 217         {"index", "flags", "ip-addr", "port", "lun", "chap-type", "nic-assoc",
 218         "target-name", "chap-name", "chap-secret", "rev-chap-name",
 219         "rev-chap-name-secret", NULL};
 220
 221 enum ibft_initiator_properties_enum {
 222         ibft_init_index,
 223         ibft_init_flags,
 224         ibft_init_isns_server,
 225         ibft_init_slp_server,
 226         ibft_init_pri_radius_server,
 227         ibft_init_sec_radius_server,
 228         ibft_init_initiator_name,
 229         ibft_init_end_marker,
 230 };
 231
 232 static const char *ibft_initiator_properties[] =
 233         {"index", "flags", "isns-server", "slp-server", "pri-radius-server",
 234         "sec-radius-server", "initiator-name", NULL};
 235
 236 /*
 237  * The kobject and attribute structures.
 238  */
 239
 240 struct ibft_kobject {
 241         struct ibft_table_header *header;
 242         union {
 243                 struct ibft_initiator *initiator;
 244                 struct ibft_nic *nic;
 245                 struct ibft_tgt *tgt;
 246                 struct ibft_hdr *hdr;
 247         };
 248         struct kobject kobj;
 249         struct list_head node;
 250 };
 251
 252 struct ibft_attribute {
 253         struct attribute attr;
 254         ssize_t (*show) (struct  ibft_kobject *entry,
 255                          struct ibft_attribute *attr, char *buf);
 256         union {
 257                 struct ibft_initiator *initiator;
 258                 struct ibft_nic *nic;
 259                 struct ibft_tgt *tgt;
 260                 struct ibft_hdr *hdr;
 261         };
 262         struct kobject *kobj;
 263         int type; /* The enum of the type. This can be any value of:
 264                 ibft_eth_properties_enum, ibft_tgt_properties_enum,
 265                 or ibft_initiator_properties_enum. */
 266         struct list_head node;
 267 };
 268
 269 static LIST_HEAD(ibft_attr_list);
 270 static LIST_HEAD(ibft_kobject_list);
 271
 272 static const char nulls[16];
 273
 274 /*
 275  * Helper functions to parse data properly.
 276  */
 277 static ssize_t sprintf_ipaddr(char *buf, u8 *ip)
 278 {
 279         char *str = buf;
 280
 281         if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] == 0 &&
 282             ip[4] == 0 && ip[5] == 0 && ip[6] == 0 && ip[7] == 0 &&
 283             ip[8] == 0 && ip[9] == 0 && ip[10] == 0xff && ip[11] == 0xff) {
 284                 /*
 285                  * IPV4
 286                  */
 287                 str += sprintf(buf, "%pI4", ip + 12);
 288         } else {
 289                 /*
 290                  * IPv6
 291                  */
 292                 str += sprintf(str, "%pI6", ip);
 293         }
 294         str += sprintf(str, "\n");
 295         return str - buf;
 296 }
 297
 298 static ssize_t sprintf_string(char *str, int len, char *buf)
 299 {
 300         return sprintf(str, "%.*s\n", len, buf);
 301 }
 302
 303 /*
 304  * Helper function to verify the IBFT header.
 305  */
 306 static int ibft_verify_hdr(char *t, struct ibft_hdr *hdr, int id, int length)
 307 {
 308         if (hdr->id != id) {
 309                 printk(KERN_ERR "iBFT error: We expected the " \
 310                                 "field header.id to have %d but " \
 311                                 "found %d instead!\n", id, hdr->id);
 312                 return -ENODEV;
 313         }
 314         if (hdr->length != length) {
 315                 printk(KERN_ERR "iBFT error: We expected the " \
 316                                 "field header.length to have %d but " \
 317                                 "found %d instead!\n", length, hdr->length);
 318                 return -ENODEV;
 319         }
 320
 321         return 0;
 322 }
 323
 324 static void ibft_release(struct kobject *kobj)
 325 {
 326         struct ibft_kobject *ibft =
 327                 container_of(kobj, struct ibft_kobject, kobj);
 328         kfree(ibft);
 329 }
 330
 331 /*
 332  *  Routines for parsing the iBFT data to be human readable.
 333  */
 334 static ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
 335                                         struct ibft_attribute *attr,
 336                                         char *buf)
 337 {
 338         struct ibft_initiator *initiator = entry->initiator;
 339         void *ibft_loc = entry->header;
 340         char *str = buf;
 341
 342         if (!initiator)
 343                 return 0;
 344
 345         switch (attr->type) {
 346         case ibft_init_index:
 347                 str += sprintf(str, "%d\n", initiator->hdr.index);
 348                 break;
 349         case ibft_init_flags:
 350                 str += sprintf(str, "%d\n", initiator->hdr.flags);
 351                 break;
 352         case ibft_init_isns_server:
 353                 str += sprintf_ipaddr(str, initiator->isns_server);
 354                 break;
 355         case ibft_init_slp_server:
 356                 str += sprintf_ipaddr(str, initiator->slp_server);
 357                 break;
 358         case ibft_init_pri_radius_server:
 359                 str += sprintf_ipaddr(str, initiator->pri_radius_server);
 360                 break;
 361         case ibft_init_sec_radius_server:
 362                 str += sprintf_ipaddr(str, initiator->sec_radius_server);
 363                 break;
 364         case ibft_init_initiator_name:
 365                 str += sprintf_string(str, initiator->initiator_name_len,
 366                                       (char *)ibft_loc +
 367                                       initiator->initiator_name_off);
 368                 break;
 369         default:
 370                 break;
 371         }
 372
 373         return str - buf;
 374 }
 375
 376 static ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
 377                                   struct ibft_attribute *attr,
 378                                   char *buf)
 379 {
 380         struct ibft_nic *nic = entry->nic;
 381         void *ibft_loc = entry->header;
 382         char *str = buf;
 383         char *mac;
 384         __be32 val;
 385
 386         if (!nic)
 387                 return 0;
 388
 389         switch (attr->type) {
 390         case ibft_eth_index:
 391                 str += sprintf(str, "%d\n", nic->hdr.index);
 392                 break;
 393         case ibft_eth_flags:
 394                 str += sprintf(str, "%d\n", nic->hdr.flags);
 395                 break;
 396         case ibft_eth_ip_addr:
 397                 str += sprintf_ipaddr(str, nic->ip_addr);
 398                 break;
 399         case ibft_eth_subnet_mask:
 400                 val = cpu_to_be32(~((1 << (32-nic->subnet_mask_prefix))-1));
 401                 str += sprintf(str, "%pI4", &val);
 402                 break;
 403         case ibft_eth_origin:
 404                 str += sprintf(str, "%d\n", nic->origin);
 405                 break;
 406         case ibft_eth_gateway:
 407                 str += sprintf_ipaddr(str, nic->gateway);
 408                 break;
 409         case ibft_eth_primary_dns:
 410                 str += sprintf_ipaddr(str, nic->primary_dns);
 411                 break;
 412         case ibft_eth_secondary_dns:
 413                 str += sprintf_ipaddr(str, nic->secondary_dns);
 414                 break;
 415         case ibft_eth_dhcp:
 416                 str += sprintf_ipaddr(str, nic->dhcp);
 417                 break;
 418         case ibft_eth_vlan:
 419                 str += sprintf(str, "%d\n", nic->vlan);
 420                 break;
 421         case ibft_eth_mac:
 422                 mac = nic->mac;
 423                 str += sprintf(str, "%02x:%02x:%02x:%02x:%02x:%02x\n",
 424                                (u8)mac[0], (u8)mac[1], (u8)mac[2],
 425                                (u8)mac[3], (u8)mac[4], (u8)mac[5]);
 426                 break;
 427         case ibft_eth_hostname:
 428                 str += sprintf_string(str, nic->hostname_len,
 429                                       (char *)ibft_loc + nic->hostname_off);
 430                 break;
 431         default:
 432                 break;
 433         }
 434
 435         return str - buf;
 436 };
 437
 438 static ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
 439                                      struct ibft_attribute *attr,
 440                                      char *buf)
 441 {
 442         struct ibft_tgt *tgt = entry->tgt;
 443         void *ibft_loc = entry->header;
 444         char *str = buf;
 445         int i;
 446
 447         if (!tgt)
 448                 return 0;
 449
 450         switch (attr->type) {
 451         case ibft_tgt_index:
 452                 str += sprintf(str, "%d\n", tgt->hdr.index);
 453                 break;
 454         case ibft_tgt_flags:
 455                 str += sprintf(str, "%d\n", tgt->hdr.flags);
 456                 break;
 457         case ibft_tgt_ip_addr:
 458                 str += sprintf_ipaddr(str, tgt->ip_addr);
 459                 break;
 460         case ibft_tgt_port:
 461                 str += sprintf(str, "%d\n", tgt->port);
 462                 break;
 463         case ibft_tgt_lun:
 464                 for (i = 0; i < 8; i++)
 465                         str += sprintf(str, "%x", (u8)tgt->lun[i]);
 466                 str += sprintf(str, "\n");
 467                 break;
 468         case ibft_tgt_nic_assoc:
 469                 str += sprintf(str, "%d\n", tgt->nic_assoc);
 470                 break;
 471         case ibft_tgt_chap_type:
 472                 str += sprintf(str, "%d\n", tgt->chap_type);
 473                 break;
 474         case ibft_tgt_name:
 475                 str += sprintf_string(str, tgt->tgt_name_len,
 476                                       (char *)ibft_loc + tgt->tgt_name_off);
 477                 break;
 478         case ibft_tgt_chap_name:
 479                 str += sprintf_string(str, tgt->chap_name_len,
 480                                       (char *)ibft_loc + tgt->chap_name_off);
 481                 break;
 482         case ibft_tgt_chap_secret:
 483                 str += sprintf_string(str, tgt->chap_secret_len,
 484                                       (char *)ibft_loc + tgt->chap_secret_off);
 485                 break;
 486         case ibft_tgt_rev_chap_name:
 487                 str += sprintf_string(str, tgt->rev_chap_name_len,
 488                                       (char *)ibft_loc +
 489                                       tgt->rev_chap_name_off);
 490                 break;
 491         case ibft_tgt_rev_chap_secret:
 492                 str += sprintf_string(str, tgt->rev_chap_secret_len,
 493                                       (char *)ibft_loc +
 494                                       tgt->rev_chap_secret_off);
 495                 break;
 496         default:
 497                 break;
 498         }
 499
 500         return str - buf;
 501 }
 502
 503 /*
 504  * The routine called for all sysfs attributes.
 505  */
 506 static ssize_t ibft_show_attribute(struct kobject *kobj,
 507                                     struct attribute *attr,
 508                                     char *buf)
 509 {
 510         struct ibft_kobject *dev =
 511                 container_of(kobj, struct ibft_kobject, kobj);
 512         struct ibft_attribute *ibft_attr =
 513                 container_of(attr, struct ibft_attribute, attr);
 514         ssize_t ret = -EIO;
 515         char *str = buf;
 516
 517         if (!capable(CAP_SYS_ADMIN))
 518                 return -EACCES;
 519
 520         if (ibft_attr->show)
 521                 ret = ibft_attr->show(dev, ibft_attr, str);
 522
 523         return ret;
 524 }
 525
 526 static struct sysfs_ops ibft_attr_ops = {
 527         .show = ibft_show_attribute,
 528 };
 529
 530 static struct kobj_type ibft_ktype = {
 531         .release = ibft_release,
 532         .sysfs_ops = &ibft_attr_ops,
 533 };
 534
 535 static struct kset *ibft_kset;
 536
 537 static int __init ibft_check_device(void)
 538 {
 539         int len;
 540         u8 *pos;
 541         u8 csum = 0;
 542
 543         len = ibft_addr->length;
 544
 545         /* Sanity checking of iBFT. */
 546         if (ibft_addr->revision != 1) {
 547                 printk(KERN_ERR "iBFT module supports only revision 1, " \
 548                                 "while this is %d.\n", ibft_addr->revision);
 549                 return -ENOENT;
 550         }
 551         for (pos = (u8 *)ibft_addr; pos < (u8 *)ibft_addr + len; pos++)
 552                 csum += *pos;
 553
 554         if (csum) {
 555                 printk(KERN_ERR "iBFT has incorrect checksum (0x%x)!\n", csum);
 556                 return -ENOENT;
 557         }
 558
 559         return 0;
 560 }
 561
 562 /*
 563  * Helper function for ibft_register_kobjects.
 564  */
 565 static int __init ibft_create_kobject(struct ibft_table_header *header,
 566                                        struct ibft_hdr *hdr,
 567                                        struct list_head *list)
 568 {
 569         struct ibft_kobject *ibft_kobj = NULL;
 570         struct ibft_nic *nic = (struct ibft_nic *)hdr;
 571         struct pci_dev *pci_dev;
 572         int rc = 0;
 573
 574         ibft_kobj = kzalloc(sizeof(*ibft_kobj), GFP_KERNEL);
 575         if (!ibft_kobj)
 576                 return -ENOMEM;
 577
 578         ibft_kobj->header = header;
 579         ibft_kobj->hdr = hdr;
 580
 581         switch (hdr->id) {
 582         case id_initiator:
 583                 rc = ibft_verify_hdr("initiator", hdr, id_initiator,
 584                                      sizeof(*ibft_kobj->initiator));
 585                 break;
 586         case id_nic:
 587                 rc = ibft_verify_hdr("ethernet", hdr, id_nic,
 588                                      sizeof(*ibft_kobj->nic));
 589                 break;
 590         case id_target:
 591                 rc = ibft_verify_hdr("target", hdr, id_target,
 592                                      sizeof(*ibft_kobj->tgt));
 593                 break;
 594         case id_reserved:
 595         case id_control:
 596         case id_extensions:
 597                 /* Fields which we don't support. Ignore them */
 598                 rc = 1;
 599                 break;
 600         default:
 601                 printk(KERN_ERR "iBFT has unknown structure type (%d). " \
 602                                 "Report this bug to %.6s!\n", hdr->id,
 603                                 header->oem_id);
 604                 rc = 1;
 605                 break;
 606         }
 607
 608         if (rc) {
 609                 /* Skip adding this kobject, but exit with non-fatal error. */
 610                 kfree(ibft_kobj);
 611                 goto out_invalid_struct;
 612         }
 613
 614         ibft_kobj->kobj.kset = ibft_kset;
 615
 616         rc = kobject_init_and_add(&ibft_kobj->kobj, &ibft_ktype,
 617                                   NULL, ibft_id_names[hdr->id], hdr->index);
 618
 619         if (rc) {
 620                 kfree(ibft_kobj);
 621                 goto out;
 622         }
 623
 624         kobject_uevent(&ibft_kobj->kobj, KOBJ_ADD);
 625
 626         if (hdr->id == id_nic) {
 627                 /*
 628                 * We don't search for the device in other domains than
 629                 * zero. This is because on x86 platforms the BIOS
 630                 * executes only devices which are in domain 0. Furthermore, the
 631                 * iBFT spec doesn't have a domain id field :-(
 632                 */
 633                 pci_dev = pci_get_bus_and_slot((nic->pci_bdf & 0xff00) >> 8,
 634                                                (nic->pci_bdf & 0xff));
 635                 if (pci_dev) {
 636                         rc = sysfs_create_link(&ibft_kobj->kobj,
 637                                                &pci_dev->dev.kobj, "device");
 638                         pci_dev_put(pci_dev);
 639                 }
 640         }
 641
 642         /* Nothing broke so lets add it to the list. */
 643         list_add_tail(&ibft_kobj->node, list);
 644 out:
 645         return rc;
 646 out_invalid_struct:
 647         /* Unsupported structs are skipped. */
 648         return 0;
 649 }
 650
 651 /*
 652  * Scan the IBFT table structure for the NIC and Target fields. When
 653  * found add them on the passed-in list. We do not support the other
 654  * fields at this point, so they are skipped.
 655  */
 656 static int __init ibft_register_kobjects(struct ibft_table_header *header,
 657                                           struct list_head *list)
 658 {
 659         struct ibft_control *control = NULL;
 660         void *ptr, *end;
 661         int rc = 0;
 662         u16 offset;
 663         u16 eot_offset;
 664
 665         control = (void *)header + sizeof(*header);
 666         end = (void *)control + control->hdr.length;
 667         eot_offset = (void *)header + header->length - (void *)control;
 668         rc = ibft_verify_hdr("control", (struct ibft_hdr *)control, id_control,
 669                              sizeof(*control));
 670
 671         /* iBFT table safety checking */
 672         rc |= ((control->hdr.index) ? -ENODEV : 0);
 673         if (rc) {
 674                 printk(KERN_ERR "iBFT error: Control header is invalid!\n");
 675                 return rc;
 676         }
 677         for (ptr = &control->initiator_off; ptr < end; ptr += sizeof(u16)) {
 678                 offset = *(u16 *)ptr;
 679                 if (offset && offset < header->length && offset < eot_offset) {
 680                         rc = ibft_create_kobject(header,
 681                                                  (void *)header + offset,
 682                                                  list);
 683                         if (rc)
 684                                 break;
 685                 }
 686         }
 687
 688         return rc;
 689 }
 690
 691 static void ibft_unregister(struct list_head *attr_list,
 692                              struct list_head *kobj_list)
 693 {
 694         struct ibft_kobject *data = NULL, *n;
 695         struct ibft_attribute *attr = NULL, *m;
 696
 697         list_for_each_entry_safe(attr, m, attr_list, node) {
 698                 sysfs_remove_file(attr->kobj, &attr->attr);
 699                 list_del(&attr->node);
 700                 kfree(attr);
 701         };
 702         list_del_init(attr_list);
 703
 704         list_for_each_entry_safe(data, n, kobj_list, node) {
 705                 list_del(&data->node);
 706                 if (data->hdr->id == id_nic)
 707                         sysfs_remove_link(&data->kobj, "device");
 708                 kobject_put(&data->kobj);
 709         };
 710         list_del_init(kobj_list);
 711 }
 712
 713 static int __init ibft_create_attribute(struct ibft_kobject *kobj_data,
 714                                          int type,
 715                                          const char *name,
 716                                          ssize_t (*show)(struct ibft_kobject *,
 717                                                          struct ibft_attribute*,
 718                                                          char *buf),
 719                                          struct list_head *list)
 720 {
 721         struct ibft_attribute *attr = NULL;
 722         struct ibft_hdr *hdr = kobj_data->hdr;
 723
 724         attr = kmalloc(sizeof(*attr), GFP_KERNEL);
 725         if (!attr)
 726                 return -ENOMEM;
 727
 728         attr->attr.name = name;
 729         attr->attr.mode = S_IRUSR;
 730
 731         attr->hdr = hdr;
 732         attr->show = show;
 733         attr->kobj = &kobj_data->kobj;
 734         attr->type = type;
 735
 736         list_add_tail(&attr->node, list);
 737
 738         return 0;
 739 }
 740
 741 /*
 742  * Helper routiners to check to determine if the entry is valid
 743  * in the proper iBFT structure.
 744  */
 745 static int __init ibft_check_nic_for(struct ibft_nic *nic, int entry)
 746 {
 747         int rc = 0;
 748
 749         switch (entry) {
 750         case ibft_eth_index:
 751         case ibft_eth_flags:
 752                 rc = 1;
 753                 break;
 754         case ibft_eth_ip_addr:
 755                 if (memcmp(nic->ip_addr, nulls, sizeof(nic->ip_addr)))
 756                         rc = 1;
 757                 break;
 758         case ibft_eth_subnet_mask:
 759                 if (nic->subnet_mask_prefix)
 760                         rc = 1;
 761                 break;
 762         case ibft_eth_origin:
 763                 rc = 1;
 764                 break;
 765         case ibft_eth_gateway:
 766                 if (memcmp(nic->gateway, nulls, sizeof(nic->gateway)))
 767                         rc = 1;
 768                 break;
 769         case ibft_eth_primary_dns:
 770                 if (memcmp(nic->primary_dns, nulls,
 771                            sizeof(nic->primary_dns)))
 772                         rc = 1;
 773                 break;
 774         case ibft_eth_secondary_dns:
 775                 if (memcmp(nic->secondary_dns, nulls,
 776                            sizeof(nic->secondary_dns)))
 777                         rc = 1;
 778                 break;
 779         case ibft_eth_dhcp:
 780                 if (memcmp(nic->dhcp, nulls, sizeof(nic->dhcp)))
 781                         rc = 1;
 782                 break;
 783         case ibft_eth_vlan:
 784         case ibft_eth_mac:
 785                 rc = 1;
 786                 break;
 787         case ibft_eth_hostname:
 788                 if (nic->hostname_off)
 789                         rc = 1;
 790                 break;
 791         default:
 792                 break;
 793         }
 794
 795         return rc;
 796 }
 797
 798 static int __init ibft_check_tgt_for(struct ibft_tgt *tgt, int entry)
 799 {
 800         int rc = 0;
 801
 802         switch (entry) {
 803         case ibft_tgt_index:
 804         case ibft_tgt_flags:
 805         case ibft_tgt_ip_addr:
 806         case ibft_tgt_port:
 807         case ibft_tgt_lun:
 808         case ibft_tgt_nic_assoc:
 809         case ibft_tgt_chap_type:
 810                 rc = 1;
 811         case ibft_tgt_name:
 812                 if (tgt->tgt_name_len)
 813                         rc = 1;
 814                 break;
 815         case ibft_tgt_chap_name:
 816         case ibft_tgt_chap_secret:
 817                 if (tgt->chap_name_len)
 818                         rc = 1;
 819                 break;
 820         case ibft_tgt_rev_chap_name:
 821         case ibft_tgt_rev_chap_secret:
 822                 if (tgt->rev_chap_name_len)
 823                         rc = 1;
 824                 break;
 825         default:
 826                 break;
 827         }
 828
 829         return rc;
 830 }
 831
 832 static int __init ibft_check_initiator_for(struct ibft_initiator *init,
 833                                             int entry)
 834 {
 835         int rc = 0;
 836
 837         switch (entry) {
 838         case ibft_init_index:
 839         case ibft_init_flags:
 840                 rc = 1;
 841                 break;
 842         case ibft_init_isns_server:
 843                 if (memcmp(init->isns_server, nulls,
 844                            sizeof(init->isns_server)))
 845                         rc = 1;
 846                 break;
 847         case ibft_init_slp_server:
 848                 if (memcmp(init->slp_server, nulls,
 849                            sizeof(init->slp_server)))
 850                         rc = 1;
 851                 break;
 852         case ibft_init_pri_radius_server:
 853                 if (memcmp(init->pri_radius_server, nulls,
 854                            sizeof(init->pri_radius_server)))
 855                         rc = 1;
 856                 break;
 857         case ibft_init_sec_radius_server:
 858                 if (memcmp(init->sec_radius_server, nulls,
 859                            sizeof(init->sec_radius_server)))
 860                         rc = 1;
 861                 break;
 862         case ibft_init_initiator_name:
 863                 if (init->initiator_name_len)
 864                         rc = 1;
 865                 break;
 866         default:
 867                 break;
 868         }
 869
 870         return rc;
 871 }
 872
 873 /*
 874  *  Register the attributes for all of the kobjects.
 875  */
 876 static int __init ibft_register_attributes(struct list_head *kobject_list,
 877                                             struct list_head *attr_list)
 878 {
 879         int rc = 0, i = 0;
 880         struct ibft_kobject *data = NULL;
 881         struct ibft_attribute *attr = NULL, *m;
 882
 883         list_for_each_entry(data, kobject_list, node) {
 884                 switch (data->hdr->id) {
 885                 case id_nic:
 886                         for (i = 0; i < ibft_eth_end_marker && !rc; i++)
 887                                 if (ibft_check_nic_for(data->nic, i))
 888                                         rc = ibft_create_attribute(data, i,
 889                                                 ibft_eth_properties[i],
 890                                                 ibft_attr_show_nic, attr_list);
 891                         break;
 892                 case id_target:
 893                         for (i = 0; i < ibft_tgt_end_marker && !rc; i++)
 894                                 if (ibft_check_tgt_for(data->tgt, i))
 895                                         rc = ibft_create_attribute(data, i,
 896                                                 ibft_tgt_properties[i],
 897                                                 ibft_attr_show_target,
 898                                                 attr_list);
 899                         break;
 900                 case id_initiator:
 901                         for (i = 0; i < ibft_init_end_marker && !rc; i++)
 902                                 if (ibft_check_initiator_for(
 903                                         data->initiator, i))
 904                                         rc = ibft_create_attribute(data, i,
 905                                                 ibft_initiator_properties[i],
 906                                                 ibft_attr_show_initiator,
 907                                                 attr_list);
 908                         break;
 909                 default:
 910                         break;
 911                 }
 912                 if (rc)
 913                         break;
 914         }
 915         list_for_each_entry_safe(attr, m, attr_list, node) {
 916                 rc = sysfs_create_file(attr->kobj, &attr->attr);
 917                 if (rc) {
 918                         list_del(&attr->node);
 919                         kfree(attr);
 920                         break;
 921                 }
 922         }
 923
 924         return rc;
 925 }
 926
 927 /*
 928  * ibft_init() - creates sysfs tree entries for the iBFT data.
 929  */
 930 static int __init ibft_init(void)
 931 {
 932         int rc = 0;
 933
 934         ibft_kset = kset_create_and_add("ibft", NULL, firmware_kobj);
 935         if (!ibft_kset)
 936                 return -ENOMEM;
 937
 938         if (ibft_addr) {
 939                 printk(KERN_INFO "iBFT detected at 0x%llx.\n",
 940                        (u64)isa_virt_to_bus(ibft_addr));
 941
 942                 rc = ibft_check_device();
 943                 if (rc)
 944                         goto out_firmware_unregister;
 945
 946                 /* Scan the IBFT for data and register the kobjects. */
 947                 rc = ibft_register_kobjects(ibft_addr, &ibft_kobject_list);
 948                 if (rc)
 949                         goto out_free;
 950
 951                 /* Register the attributes */
 952                 rc = ibft_register_attributes(&ibft_kobject_list,
 953                                               &ibft_attr_list);
 954                 if (rc)
 955                         goto out_free;
 956         } else
 957                 printk(KERN_INFO "No iBFT detected.\n");
 958
 959         return 0;
 960
 961 out_free:
 962         ibft_unregister(&ibft_attr_list, &ibft_kobject_list);
 963 out_firmware_unregister:
 964         kset_unregister(ibft_kset);
 965         return rc;
 966 }
 967
 968 static void __exit ibft_exit(void)
 969 {
 970         ibft_unregister(&ibft_attr_list, &ibft_kobject_list);
 971         kset_unregister(ibft_kset);
 972 }
 973
 974 module_init(ibft_init);
 975 module_exit(ibft_exit);