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