drivers/pci/hotplug/rpaphp_core.c

   1 /*
   2  * PCI Hot Plug Controller Driver for RPA-compliant PPC64 platform.
   3  * Copyright (C) 2003 Linda Xie <lxie@us.ibm.com>
   4  *
   5  * All rights reserved.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or (at
  10  * your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
  15  * NON INFRINGEMENT.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * Send feedback to <lxie@us.ibm.com>
  23  *
  24  */
  25 #include <linux/kernel.h>
  26 #include <linux/module.h>
  27 #include <linux/moduleparam.h>
  28 #include <linux/pci.h>
  29 #include <linux/pci_hotplug.h>
  30 #include <linux/slab.h>
  31 #include <linux/smp.h>
  32 #include <linux/smp_lock.h>
  33 #include <linux/init.h>
  34 #include <asm/eeh.h>       /* for eeh_add_device() */
  35 #include <asm/rtas.h>           /* rtas_call */
  36 #include <asm/pci-bridge.h>     /* for pci_controller */
  37 #include "../pci.h"             /* for pci_add_new_bus */
  38                                 /* and pci_do_scan_bus */
  39 #include "rpaphp.h"
  40
  41 int debug;
  42 static struct semaphore rpaphp_sem;
  43 LIST_HEAD(rpaphp_slot_head);
  44
  45 #define DRIVER_VERSION  "0.1"
  46 #define DRIVER_AUTHOR   "Linda Xie <lxie@us.ibm.com>"
  47 #define DRIVER_DESC     "RPA HOT Plug PCI Controller Driver"
  48
  49 #define MAX_LOC_CODE 128
  50
  51 MODULE_AUTHOR(DRIVER_AUTHOR);
  52 MODULE_DESCRIPTION(DRIVER_DESC);
  53 MODULE_LICENSE("GPL");
  54
  55 module_param(debug, bool, 0644);
  56
  57 /**
  58  * set_attention_status - set attention LED
  59  * echo 0 > attention -- set LED OFF
  60  * echo 1 > attention -- set LED ON
  61  * echo 2 > attention -- set LED ID(identify, light is blinking)
  62  *
  63  */
  64 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 value)
  65 {
  66         int rc;
  67         struct slot *slot = (struct slot *)hotplug_slot->private;
  68
  69         down(&rpaphp_sem);
  70         switch (value) {
  71         case 0:
  72         case 1:
  73         case 2:
  74                 break;
  75         default:
  76                 value = 1;
  77                 break;
  78         }
  79         up(&rpaphp_sem);
  80
  81         rc = rtas_set_indicator(DR_INDICATOR, slot->index, value);
  82         if (!rc)
  83                 hotplug_slot->info->attention_status = value;
  84
  85         return rc;
  86 }
  87
  88 /**
  89  * get_power_status - get power status of a slot
  90  * @hotplug_slot: slot to get status
  91  * @value: pointer to store status
  92  */
  93 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 * value)
  94 {
  95         int retval, level;
  96         struct slot *slot = (struct slot *)hotplug_slot->private;
  97
  98         down(&rpaphp_sem);
  99         retval = rtas_get_power_level (slot->power_domain, &level);
 100         if (!retval)
 101                 *value = level;
 102         up(&rpaphp_sem);
 103         return retval;
 104 }
 105
 106 /**
 107  * get_attention_status - get attention LED status
 108  */
 109 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 * value)
 110 {
 111         struct slot *slot = (struct slot *)hotplug_slot->private;
 112         *value = slot->hotplug_slot->info->attention_status;
 113         return 0;
 114 }
 115
 116 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 * value)
 117 {
 118         struct slot *slot = (struct slot *)hotplug_slot->private;
 119         int rc, state;
 120
 121         down(&rpaphp_sem);
 122         rc = rpaphp_get_sensor_state(slot, &state);
 123         up(&rpaphp_sem);
 124
 125         *value = NOT_VALID;
 126         if (rc)
 127                 return rc;
 128
 129         if (state == EMPTY)
 130                 *value = EMPTY;
 131         else if (state == PRESENT)
 132                 *value = slot->state;
 133
 134         return 0;
 135 }
 136
 137 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
 138 {
 139         struct slot *slot = (struct slot *)hotplug_slot->private;
 140
 141         down(&rpaphp_sem);
 142         switch (slot->type) {
 143         case 1:
 144         case 2:
 145         case 3:
 146         case 4:
 147         case 5:
 148         case 6:
 149                 *value = PCI_SPEED_33MHz;       /* speed for case 1-6 */
 150                 break;
 151         case 7:
 152         case 8:
 153                 *value = PCI_SPEED_66MHz;
 154                 break;
 155         case 11:
 156         case 14:
 157                 *value = PCI_SPEED_66MHz_PCIX;
 158                 break;
 159         case 12:
 160         case 15:
 161                 *value = PCI_SPEED_100MHz_PCIX;
 162                 break;
 163         case 13:
 164         case 16:
 165                 *value = PCI_SPEED_133MHz_PCIX;
 166                 break;
 167         default:
 168                 *value = PCI_SPEED_UNKNOWN;
 169                 break;
 170
 171         }
 172         up(&rpaphp_sem);
 173         return 0;
 174 }
 175
 176 static int get_children_props(struct device_node *dn, const int **drc_indexes,
 177                 const int **drc_names, const int **drc_types,
 178                 const int **drc_power_domains)
 179 {
 180         const int *indexes, *names, *types, *domains;
 181
 182         indexes = get_property(dn, "ibm,drc-indexes", NULL);
 183         names = get_property(dn, "ibm,drc-names", NULL);
 184         types = get_property(dn, "ibm,drc-types", NULL);
 185         domains = get_property(dn, "ibm,drc-power-domains", NULL);
 186
 187         if (!indexes || !names || !types || !domains) {
 188                 /* Slot does not have dynamically-removable children */
 189                 return -EINVAL;
 190         }
 191         if (drc_indexes)
 192                 *drc_indexes = indexes;
 193         if (drc_names)
 194                 /* &drc_names[1] contains NULL terminated slot names */
 195                 *drc_names = names;
 196         if (drc_types)
 197                 /* &drc_types[1] contains NULL terminated slot types */
 198                 *drc_types = types;
 199         if (drc_power_domains)
 200                 *drc_power_domains = domains;
 201
 202         return 0;
 203 }
 204
 205 /* To get the DRC props describing the current node, first obtain it's
 206  * my-drc-index property.  Next obtain the DRC list from it's parent.  Use
 207  * the my-drc-index for correlation, and obtain the requested properties.
 208  */
 209 int rpaphp_get_drc_props(struct device_node *dn, int *drc_index,
 210                 char **drc_name, char **drc_type, int *drc_power_domain)
 211 {
 212         const int *indexes, *names;
 213         const int *types, *domains;
 214         const unsigned int *my_index;
 215         char *name_tmp, *type_tmp;
 216         int i, rc;
 217
 218         my_index = get_property(dn, "ibm,my-drc-index", NULL);
 219         if (!my_index) {
 220                 /* Node isn't DLPAR/hotplug capable */
 221                 return -EINVAL;
 222         }
 223
 224         rc = get_children_props(dn->parent, &indexes, &names, &types, &domains);
 225         if (rc < 0) {
 226                 return -EINVAL;
 227         }
 228
 229         name_tmp = (char *) &names[1];
 230         type_tmp = (char *) &types[1];
 231
 232         /* Iterate through parent properties, looking for my-drc-index */
 233         for (i = 0; i < indexes[0]; i++) {
 234                 if ((unsigned int) indexes[i + 1] == *my_index) {
 235                         if (drc_name)
 236                                 *drc_name = name_tmp;
 237                         if (drc_type)
 238                                 *drc_type = type_tmp;
 239                         if (drc_index)
 240                                 *drc_index = *my_index;
 241                         if (drc_power_domain)
 242                                 *drc_power_domain = domains[i+1];
 243                         return 0;
 244                 }
 245                 name_tmp += (strlen(name_tmp) + 1);
 246                 type_tmp += (strlen(type_tmp) + 1);
 247         }
 248
 249         return -EINVAL;
 250 }
 251
 252 static int is_php_type(char *drc_type)
 253 {
 254         unsigned long value;
 255         char *endptr;
 256
 257         /* PCI Hotplug nodes have an integer for drc_type */
 258         value = simple_strtoul(drc_type, &endptr, 10);
 259         if (endptr == drc_type)
 260                 return 0;
 261
 262         return 1;
 263 }
 264
 265 /**
 266  * is_php_dn() - return 1 if this is a hotpluggable pci slot, else 0
 267  *
 268  * This routine will return true only if the device node is
 269  * a hotpluggable slot. This routine will return false
 270  * for built-in pci slots (even when the built-in slots are
 271  * dlparable.)
 272  */
 273 static int is_php_dn(struct device_node *dn, const int **indexes,
 274                 const int **names, const int **types, const int **power_domains)
 275 {
 276         const int *drc_types;
 277         int rc;
 278
 279         rc = get_children_props(dn, indexes, names, &drc_types, power_domains);
 280         if (rc < 0)
 281                 return 0;
 282
 283         if (!is_php_type((char *) &drc_types[1]))
 284                 return 0;
 285
 286         *types = drc_types;
 287         return 1;
 288 }
 289
 290 /**
 291  * rpaphp_add_slot -- declare a hotplug slot to the hotplug subsystem.
 292  * @dn device node of slot
 293  *
 294  * This subroutine will register a hotplugable slot with the
 295  * PCI hotplug infrastructure. This routine is typicaly called
 296  * during boot time, if the hotplug slots are present at boot time,
 297  * or is called later, by the dlpar add code, if the slot is
 298  * being dynamically added during runtime.
 299  *
 300  * If the device node points at an embedded (built-in) slot, this
 301  * routine will just return without doing anything, since embedded
 302  * slots cannot be hotplugged.
 303  *
 304  * To remove a slot, it suffices to call rpaphp_deregister_slot()
 305  */
 306 int rpaphp_add_slot(struct device_node *dn)
 307 {
 308         struct slot *slot;
 309         int retval = 0;
 310         int i;
 311         const int *indexes, *names, *types, *power_domains;
 312         char *name, *type;
 313
 314         if (!dn->name || strcmp(dn->name, "pci"))
 315                 return 0;
 316
 317         /* If this is not a hotplug slot, return without doing anything. */
 318         if (!is_php_dn(dn, &indexes, &names, &types, &power_domains))
 319                 return 0;
 320
 321         dbg("Entry %s: dn->full_name=%s\n", __FUNCTION__, dn->full_name);
 322
 323         /* register PCI devices */
 324         name = (char *) &names[1];
 325         type = (char *) &types[1];
 326         for (i = 0; i < indexes[0]; i++) {
 327
 328                 slot = alloc_slot_struct(dn, indexes[i + 1], name, power_domains[i + 1]);
 329                 if (!slot)
 330                         return -ENOMEM;
 331
 332                 slot->type = simple_strtoul(type, NULL, 10);
 333
 334                 dbg("Found drc-index:0x%x drc-name:%s drc-type:%s\n",
 335                                 indexes[i + 1], name, type);
 336
 337                 retval = rpaphp_enable_slot(slot);
 338                 if (!retval)
 339                         retval = rpaphp_register_slot(slot);
 340
 341                 if (retval)
 342                         dealloc_slot_struct(slot);
 343
 344                 name += strlen(name) + 1;
 345                 type += strlen(type) + 1;
 346         }
 347         dbg("%s - Exit: rc[%d]\n", __FUNCTION__, retval);
 348
 349         /* XXX FIXME: reports a failure only if last entry in loop failed */
 350         return retval;
 351 }
 352
 353 static void __exit cleanup_slots(void)
 354 {
 355         struct list_head *tmp, *n;
 356         struct slot *slot;
 357
 358         /*
 359          * Unregister all of our slots with the pci_hotplug subsystem,
 360          * and free up all memory that we had allocated.
 361          * memory will be freed in release_slot callback.
 362          */
 363
 364         list_for_each_safe(tmp, n, &rpaphp_slot_head) {
 365                 slot = list_entry(tmp, struct slot, rpaphp_slot_list);
 366                 list_del(&slot->rpaphp_slot_list);
 367                 pci_hp_deregister(slot->hotplug_slot);
 368         }
 369         return;
 370 }
 371
 372 static int __init rpaphp_init(void)
 373 {
 374         struct device_node *dn = NULL;
 375
 376         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
 377         init_MUTEX(&rpaphp_sem);
 378
 379         while ((dn = of_find_node_by_name(dn, "pci")))
 380                 rpaphp_add_slot(dn);
 381
 382         return 0;
 383 }
 384
 385 static void __exit rpaphp_exit(void)
 386 {
 387         cleanup_slots();
 388 }
 389
 390 static int __enable_slot(struct slot *slot)
 391 {
 392         int state;
 393         int retval;
 394
 395         if (slot->state == CONFIGURED)
 396                 return 0;
 397
 398         retval = rpaphp_get_sensor_state(slot, &state);
 399         if (retval)
 400                 return retval;
 401
 402         if (state == PRESENT) {
 403                 pcibios_add_pci_devices(slot->bus);
 404                 slot->state = CONFIGURED;
 405         } else if (state == EMPTY) {
 406                 slot->state = EMPTY;
 407         } else {
 408                 err("%s: slot[%s] is in invalid state\n", __FUNCTION__, slot->name);
 409                 slot->state = NOT_VALID;
 410                 return -EINVAL;
 411         }
 412         return 0;
 413 }
 414
 415 static int enable_slot(struct hotplug_slot *hotplug_slot)
 416 {
 417         int retval;
 418         struct slot *slot = (struct slot *)hotplug_slot->private;
 419
 420         down(&rpaphp_sem);
 421         retval = __enable_slot(slot);
 422         up(&rpaphp_sem);
 423
 424         return retval;
 425 }
 426
 427 static inline int __disable_slot(struct slot *slot)
 428 {
 429         if (slot->state == NOT_CONFIGURED)
 430                 return -EINVAL;
 431
 432         pcibios_remove_pci_devices(slot->bus);
 433         slot->state = NOT_CONFIGURED;
 434         return 0;
 435 }
 436
 437 static int disable_slot(struct hotplug_slot *hotplug_slot)
 438 {
 439         struct slot *slot = (struct slot *)hotplug_slot->private;
 440         int retval;
 441
 442         down(&rpaphp_sem);
 443         retval = __disable_slot (slot);
 444         up(&rpaphp_sem);
 445
 446         return retval;
 447 }
 448
 449 struct hotplug_slot_ops rpaphp_hotplug_slot_ops = {
 450         .owner = THIS_MODULE,
 451         .enable_slot = enable_slot,
 452         .disable_slot = disable_slot,
 453         .set_attention_status = set_attention_status,
 454         .get_power_status = get_power_status,
 455         .get_attention_status = get_attention_status,
 456         .get_adapter_status = get_adapter_status,
 457         .get_max_bus_speed = get_max_bus_speed,
 458 };
 459
 460 module_init(rpaphp_init);
 461 module_exit(rpaphp_exit);
 462
 463 EXPORT_SYMBOL_GPL(rpaphp_add_slot);
 464 EXPORT_SYMBOL_GPL(rpaphp_slot_head);
 465 EXPORT_SYMBOL_GPL(rpaphp_get_drc_props);