1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * PCI Hot Plug Controller Driver for RPA-compliant PPC64 platform. 4 * Copyright (C) 2003 Linda Xie <lxie@us.ibm.com> 5 * 6 * All rights reserved. 7 * 8 * Send feedback to <lxie@us.ibm.com> 9 * 10 */ 11 #include <linux/kernel.h> 12 #include <linux/module.h> 13 #include <linux/moduleparam.h> 14 #include <linux/pci.h> 15 #include <linux/pci_hotplug.h> 16 #include <linux/smp.h> 17 #include <linux/init.h> 18 #include <linux/vmalloc.h> 19 #include <asm/firmware.h> 20 #include <asm/eeh.h> /* for eeh_add_device() */ 21 #include <asm/rtas.h> /* rtas_call */ 22 #include <asm/pci-bridge.h> /* for pci_controller */ 23 #include "../pci.h" /* for pci_add_new_bus */ 24 /* and pci_do_scan_bus */ 25 #include "rpaphp.h" 26 27 bool rpaphp_debug; 28 LIST_HEAD(rpaphp_slot_head); 29 EXPORT_SYMBOL_GPL(rpaphp_slot_head); 30 31 #define DRIVER_VERSION "0.1" 32 #define DRIVER_AUTHOR "Linda Xie <lxie@us.ibm.com>" 33 #define DRIVER_DESC "RPA HOT Plug PCI Controller Driver" 34 35 #define MAX_LOC_CODE 128 36 37 MODULE_AUTHOR(DRIVER_AUTHOR); 38 MODULE_DESCRIPTION(DRIVER_DESC); 39 MODULE_LICENSE("GPL"); 40 41 module_param_named(debug, rpaphp_debug, bool, 0644); 42 43 /** 44 * set_attention_status - set attention LED 45 * @hotplug_slot: target &hotplug_slot 46 * @value: LED control value 47 * 48 * echo 0 > attention -- set LED OFF 49 * echo 1 > attention -- set LED ON 50 * echo 2 > attention -- set LED ID(identify, light is blinking) 51 */ 52 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 value) 53 { 54 int rc; 55 struct slot *slot = to_slot(hotplug_slot); 56 57 switch (value) { 58 case 0: 59 case 1: 60 case 2: 61 break; 62 default: 63 value = 1; 64 break; 65 } 66 67 rc = rtas_set_indicator(DR_INDICATOR, slot->index, value); 68 if (!rc) 69 slot->attention_status = value; 70 71 return rc; 72 } 73 74 /** 75 * get_power_status - get power status of a slot 76 * @hotplug_slot: slot to get status 77 * @value: pointer to store status 78 */ 79 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value) 80 { 81 int retval, level; 82 struct slot *slot = to_slot(hotplug_slot); 83 84 retval = rtas_get_power_level(slot->power_domain, &level); 85 if (!retval) 86 *value = level; 87 return retval; 88 } 89 90 /** 91 * get_attention_status - get attention LED status 92 * @hotplug_slot: slot to get status 93 * @value: pointer to store status 94 */ 95 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value) 96 { 97 struct slot *slot = to_slot(hotplug_slot); 98 *value = slot->attention_status; 99 return 0; 100 } 101 102 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value) 103 { 104 struct slot *slot = to_slot(hotplug_slot); 105 int rc, state; 106 107 rc = rpaphp_get_sensor_state(slot, &state); 108 109 *value = NOT_VALID; 110 if (rc) 111 return rc; 112 113 if (state == EMPTY) 114 *value = EMPTY; 115 else if (state == PRESENT) 116 *value = slot->state; 117 118 return 0; 119 } 120 121 static enum pci_bus_speed get_max_bus_speed(struct slot *slot) 122 { 123 enum pci_bus_speed speed; 124 switch (slot->type) { 125 case 1: 126 case 2: 127 case 3: 128 case 4: 129 case 5: 130 case 6: 131 speed = PCI_SPEED_33MHz; /* speed for case 1-6 */ 132 break; 133 case 7: 134 case 8: 135 speed = PCI_SPEED_66MHz; 136 break; 137 case 11: 138 case 14: 139 speed = PCI_SPEED_66MHz_PCIX; 140 break; 141 case 12: 142 case 15: 143 speed = PCI_SPEED_100MHz_PCIX; 144 break; 145 case 13: 146 case 16: 147 speed = PCI_SPEED_133MHz_PCIX; 148 break; 149 default: 150 speed = PCI_SPEED_UNKNOWN; 151 break; 152 } 153 154 return speed; 155 } 156 157 static int get_children_props(struct device_node *dn, const __be32 **drc_indexes, 158 const __be32 **drc_names, const __be32 **drc_types, 159 const __be32 **drc_power_domains) 160 { 161 const __be32 *indexes, *names, *types, *domains; 162 163 indexes = of_get_property(dn, "ibm,drc-indexes", NULL); 164 names = of_get_property(dn, "ibm,drc-names", NULL); 165 types = of_get_property(dn, "ibm,drc-types", NULL); 166 domains = of_get_property(dn, "ibm,drc-power-domains", NULL); 167 168 if (!indexes || !names || !types || !domains) { 169 /* Slot does not have dynamically-removable children */ 170 return -EINVAL; 171 } 172 if (drc_indexes) 173 *drc_indexes = indexes; 174 if (drc_names) 175 /* &drc_names[1] contains NULL terminated slot names */ 176 *drc_names = names; 177 if (drc_types) 178 /* &drc_types[1] contains NULL terminated slot types */ 179 *drc_types = types; 180 if (drc_power_domains) 181 *drc_power_domains = domains; 182 183 return 0; 184 } 185 186 187 /* Verify the existence of 'drc_name' and/or 'drc_type' within the 188 * current node. First obtain its my-drc-index property. Next, 189 * obtain the DRC info from its parent. Use the my-drc-index for 190 * correlation, and obtain/validate the requested properties. 191 */ 192 193 static int rpaphp_check_drc_props_v1(struct device_node *dn, char *drc_name, 194 char *drc_type, unsigned int my_index) 195 { 196 char *name_tmp, *type_tmp; 197 const __be32 *indexes, *names; 198 const __be32 *types, *domains; 199 int i, rc; 200 201 rc = get_children_props(dn->parent, &indexes, &names, &types, &domains); 202 if (rc < 0) { 203 return -EINVAL; 204 } 205 206 name_tmp = (char *) &names[1]; 207 type_tmp = (char *) &types[1]; 208 209 /* Iterate through parent properties, looking for my-drc-index */ 210 for (i = 0; i < be32_to_cpu(indexes[0]); i++) { 211 if (be32_to_cpu(indexes[i + 1]) == my_index) 212 break; 213 214 name_tmp += (strlen(name_tmp) + 1); 215 type_tmp += (strlen(type_tmp) + 1); 216 } 217 218 if (((drc_name == NULL) || (drc_name && !strcmp(drc_name, name_tmp))) && 219 ((drc_type == NULL) || (drc_type && !strcmp(drc_type, type_tmp)))) 220 return 0; 221 222 return -EINVAL; 223 } 224 225 static int rpaphp_check_drc_props_v2(struct device_node *dn, char *drc_name, 226 char *drc_type, unsigned int my_index) 227 { 228 struct property *info; 229 unsigned int entries; 230 struct of_drc_info drc; 231 const __be32 *value; 232 char cell_drc_name[MAX_DRC_NAME_LEN]; 233 int j; 234 235 info = of_find_property(dn->parent, "ibm,drc-info", NULL); 236 if (info == NULL) 237 return -EINVAL; 238 239 value = of_prop_next_u32(info, NULL, &entries); 240 if (!value) 241 return -EINVAL; 242 else 243 value++; 244 245 for (j = 0; j < entries; j++) { 246 of_read_drc_info_cell(&info, &value, &drc); 247 248 /* Should now know end of current entry */ 249 250 /* Found it */ 251 if (my_index >= drc.drc_index_start && my_index <= drc.last_drc_index) { 252 int index = my_index - drc.drc_index_start; 253 sprintf(cell_drc_name, "%s%d", drc.drc_name_prefix, 254 drc.drc_name_suffix_start + index); 255 break; 256 } 257 } 258 259 if (((drc_name == NULL) || 260 (drc_name && !strcmp(drc_name, cell_drc_name))) && 261 ((drc_type == NULL) || 262 (drc_type && !strcmp(drc_type, drc.drc_type)))) 263 return 0; 264 265 return -EINVAL; 266 } 267 268 int rpaphp_check_drc_props(struct device_node *dn, char *drc_name, 269 char *drc_type) 270 { 271 const __be32 *my_index; 272 273 my_index = of_get_property(dn, "ibm,my-drc-index", NULL); 274 if (!my_index) { 275 /* Node isn't DLPAR/hotplug capable */ 276 return -EINVAL; 277 } 278 279 if (of_find_property(dn->parent, "ibm,drc-info", NULL)) 280 return rpaphp_check_drc_props_v2(dn, drc_name, drc_type, 281 be32_to_cpu(*my_index)); 282 else 283 return rpaphp_check_drc_props_v1(dn, drc_name, drc_type, 284 be32_to_cpu(*my_index)); 285 } 286 EXPORT_SYMBOL_GPL(rpaphp_check_drc_props); 287 288 289 static int is_php_type(char *drc_type) 290 { 291 char *endptr; 292 293 /* PCI Hotplug nodes have an integer for drc_type */ 294 simple_strtoul(drc_type, &endptr, 10); 295 if (endptr == drc_type) 296 return 0; 297 298 return 1; 299 } 300 301 /** 302 * is_php_dn() - return 1 if this is a hotpluggable pci slot, else 0 303 * @dn: target &device_node 304 * @indexes: passed to get_children_props() 305 * @names: passed to get_children_props() 306 * @types: returned from get_children_props() 307 * @power_domains: 308 * 309 * This routine will return true only if the device node is 310 * a hotpluggable slot. This routine will return false 311 * for built-in pci slots (even when the built-in slots are 312 * dlparable.) 313 */ 314 static int is_php_dn(struct device_node *dn, const __be32 **indexes, 315 const __be32 **names, const __be32 **types, 316 const __be32 **power_domains) 317 { 318 const __be32 *drc_types; 319 int rc; 320 321 rc = get_children_props(dn, indexes, names, &drc_types, power_domains); 322 if (rc < 0) 323 return 0; 324 325 if (!is_php_type((char *) &drc_types[1])) 326 return 0; 327 328 *types = drc_types; 329 return 1; 330 } 331 332 static int rpaphp_drc_info_add_slot(struct device_node *dn) 333 { 334 struct slot *slot; 335 struct property *info; 336 struct of_drc_info drc; 337 char drc_name[MAX_DRC_NAME_LEN]; 338 const __be32 *cur; 339 u32 count; 340 int retval = 0; 341 342 info = of_find_property(dn, "ibm,drc-info", NULL); 343 if (!info) 344 return 0; 345 346 cur = of_prop_next_u32(info, NULL, &count); 347 if (cur) 348 cur++; 349 else 350 return 0; 351 352 of_read_drc_info_cell(&info, &cur, &drc); 353 if (!is_php_type(drc.drc_type)) 354 return 0; 355 356 sprintf(drc_name, "%s%d", drc.drc_name_prefix, drc.drc_name_suffix_start); 357 358 slot = alloc_slot_struct(dn, drc.drc_index_start, drc_name, drc.drc_power_domain); 359 if (!slot) 360 return -ENOMEM; 361 362 slot->type = simple_strtoul(drc.drc_type, NULL, 10); 363 retval = rpaphp_enable_slot(slot); 364 if (!retval) 365 retval = rpaphp_register_slot(slot); 366 367 if (retval) 368 dealloc_slot_struct(slot); 369 370 return retval; 371 } 372 373 static int rpaphp_drc_add_slot(struct device_node *dn) 374 { 375 struct slot *slot; 376 int retval = 0; 377 int i; 378 const __be32 *indexes, *names, *types, *power_domains; 379 char *name, *type; 380 381 /* If this is not a hotplug slot, return without doing anything. */ 382 if (!is_php_dn(dn, &indexes, &names, &types, &power_domains)) 383 return 0; 384 385 dbg("Entry %s: dn=%pOF\n", __func__, dn); 386 387 /* register PCI devices */ 388 name = (char *) &names[1]; 389 type = (char *) &types[1]; 390 for (i = 0; i < be32_to_cpu(indexes[0]); i++) { 391 int index; 392 393 index = be32_to_cpu(indexes[i + 1]); 394 slot = alloc_slot_struct(dn, index, name, 395 be32_to_cpu(power_domains[i + 1])); 396 if (!slot) 397 return -ENOMEM; 398 399 slot->type = simple_strtoul(type, NULL, 10); 400 401 dbg("Found drc-index:0x%x drc-name:%s drc-type:%s\n", 402 index, name, type); 403 404 retval = rpaphp_enable_slot(slot); 405 if (!retval) 406 retval = rpaphp_register_slot(slot); 407 408 if (retval) 409 dealloc_slot_struct(slot); 410 411 name += strlen(name) + 1; 412 type += strlen(type) + 1; 413 } 414 dbg("%s - Exit: rc[%d]\n", __func__, retval); 415 416 /* XXX FIXME: reports a failure only if last entry in loop failed */ 417 return retval; 418 } 419 420 /** 421 * rpaphp_add_slot -- declare a hotplug slot to the hotplug subsystem. 422 * @dn: device node of slot 423 * 424 * This subroutine will register a hotpluggable slot with the 425 * PCI hotplug infrastructure. This routine is typically called 426 * during boot time, if the hotplug slots are present at boot time, 427 * or is called later, by the dlpar add code, if the slot is 428 * being dynamically added during runtime. 429 * 430 * If the device node points at an embedded (built-in) slot, this 431 * routine will just return without doing anything, since embedded 432 * slots cannot be hotplugged. 433 * 434 * To remove a slot, it suffices to call rpaphp_deregister_slot(). 435 */ 436 int rpaphp_add_slot(struct device_node *dn) 437 { 438 if (!of_node_name_eq(dn, "pci")) 439 return 0; 440 441 if (of_find_property(dn, "ibm,drc-info", NULL)) 442 return rpaphp_drc_info_add_slot(dn); 443 else 444 return rpaphp_drc_add_slot(dn); 445 } 446 EXPORT_SYMBOL_GPL(rpaphp_add_slot); 447 448 static void __exit cleanup_slots(void) 449 { 450 struct slot *slot, *next; 451 452 /* 453 * Unregister all of our slots with the pci_hotplug subsystem, 454 * and free up all memory that we had allocated. 455 */ 456 457 list_for_each_entry_safe(slot, next, &rpaphp_slot_head, 458 rpaphp_slot_list) { 459 list_del(&slot->rpaphp_slot_list); 460 pci_hp_deregister(&slot->hotplug_slot); 461 dealloc_slot_struct(slot); 462 } 463 } 464 465 static int __init rpaphp_init(void) 466 { 467 struct device_node *dn; 468 469 info(DRIVER_DESC " version: " DRIVER_VERSION "\n"); 470 471 for_each_node_by_name(dn, "pci") 472 rpaphp_add_slot(dn); 473 474 return 0; 475 } 476 477 static void __exit rpaphp_exit(void) 478 { 479 cleanup_slots(); 480 } 481 482 static int enable_slot(struct hotplug_slot *hotplug_slot) 483 { 484 struct slot *slot = to_slot(hotplug_slot); 485 int state; 486 int retval; 487 488 if (slot->state == CONFIGURED) 489 return 0; 490 491 retval = rpaphp_get_sensor_state(slot, &state); 492 if (retval) 493 return retval; 494 495 if (state == PRESENT) { 496 pseries_eeh_init_edev_recursive(PCI_DN(slot->dn)); 497 498 pci_lock_rescan_remove(); 499 pci_hp_add_devices(slot->bus); 500 pci_unlock_rescan_remove(); 501 slot->state = CONFIGURED; 502 } else if (state == EMPTY) { 503 slot->state = EMPTY; 504 } else { 505 err("%s: slot[%s] is in invalid state\n", __func__, slot->name); 506 slot->state = NOT_VALID; 507 return -EINVAL; 508 } 509 510 slot->bus->max_bus_speed = get_max_bus_speed(slot); 511 return 0; 512 } 513 514 static int disable_slot(struct hotplug_slot *hotplug_slot) 515 { 516 struct slot *slot = to_slot(hotplug_slot); 517 if (slot->state == NOT_CONFIGURED) 518 return -EINVAL; 519 520 pci_lock_rescan_remove(); 521 pci_hp_remove_devices(slot->bus); 522 pci_unlock_rescan_remove(); 523 vm_unmap_aliases(); 524 525 slot->state = NOT_CONFIGURED; 526 return 0; 527 } 528 529 const struct hotplug_slot_ops rpaphp_hotplug_slot_ops = { 530 .enable_slot = enable_slot, 531 .disable_slot = disable_slot, 532 .set_attention_status = set_attention_status, 533 .get_power_status = get_power_status, 534 .get_attention_status = get_attention_status, 535 .get_adapter_status = get_adapter_status, 536 }; 537 538 module_init(rpaphp_init); 539 module_exit(rpaphp_exit); 540