[PATCH] powerpc/PCI hotplug: cleanup: add prefix
[sfrench/cifs-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/config.h>
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/moduleparam.h>
29 #include <linux/pci.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 #include "pci_hotplug.h"
41
42 int debug;
43 static struct semaphore rpaphp_sem;
44 LIST_HEAD(rpaphp_slot_head);
45 int num_slots;
46
47 #define DRIVER_VERSION  "0.1"
48 #define DRIVER_AUTHOR   "Linda Xie <lxie@us.ibm.com>"
49 #define DRIVER_DESC     "RPA HOT Plug PCI Controller Driver"
50
51 #define MAX_LOC_CODE 128
52
53 MODULE_AUTHOR(DRIVER_AUTHOR);
54 MODULE_DESCRIPTION(DRIVER_DESC);
55 MODULE_LICENSE("GPL");
56
57 module_param(debug, bool, 0644);
58
59 static int enable_slot(struct hotplug_slot *slot);
60 static int disable_slot(struct hotplug_slot *slot);
61 static int set_attention_status(struct hotplug_slot *slot, u8 value);
62 static int get_power_status(struct hotplug_slot *slot, u8 * value);
63 static int get_attention_status(struct hotplug_slot *slot, u8 * value);
64 static int get_adapter_status(struct hotplug_slot *slot, u8 * value);
65 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value);
66
67 struct hotplug_slot_ops rpaphp_hotplug_slot_ops = {
68         .owner = THIS_MODULE,
69         .enable_slot = enable_slot,
70         .disable_slot = disable_slot,
71         .set_attention_status = set_attention_status,
72         .get_power_status = get_power_status,
73         .get_attention_status = get_attention_status,
74         .get_adapter_status = get_adapter_status,
75         .get_max_bus_speed = get_max_bus_speed,
76 };
77
78 static int rpaphp_get_attention_status(struct slot *slot)
79 {
80         return slot->hotplug_slot->info->attention_status;
81 }
82
83 /**
84  * set_attention_status - set attention LED
85  * echo 0 > attention -- set LED OFF
86  * echo 1 > attention -- set LED ON
87  * echo 2 > attention -- set LED ID(identify, light is blinking)
88  *
89  */
90 static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 value)
91 {
92         int retval = 0;
93         struct slot *slot = (struct slot *)hotplug_slot->private;
94
95         down(&rpaphp_sem);
96         switch (value) {
97         case 0:
98                 retval = rpaphp_set_attention_status(slot, LED_OFF);
99                 hotplug_slot->info->attention_status = 0;
100                 break;
101         case 1:
102         default:
103                 retval = rpaphp_set_attention_status(slot, LED_ON);
104                 hotplug_slot->info->attention_status = 1;
105                 break;
106         case 2:
107                 retval = rpaphp_set_attention_status(slot, LED_ID);
108                 hotplug_slot->info->attention_status = 2;
109                 break;
110         }
111         up(&rpaphp_sem);
112         return retval;
113 }
114
115 /**
116  * get_power_status - get power status of a slot
117  * @hotplug_slot: slot to get status
118  * @value: pointer to store status
119  *
120  *
121  */
122 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 * value)
123 {
124         int retval;
125         struct slot *slot = (struct slot *)hotplug_slot->private;
126
127         down(&rpaphp_sem);
128         retval = rpaphp_get_power_status(slot, value);
129         up(&rpaphp_sem);
130         return retval;
131 }
132
133 /**
134  * get_attention_status - get attention LED status
135  *
136  *
137  */
138 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 * value)
139 {
140         int retval = 0;
141         struct slot *slot = (struct slot *)hotplug_slot->private;
142
143         down(&rpaphp_sem);
144         *value = rpaphp_get_attention_status(slot);
145         up(&rpaphp_sem);
146         return retval;
147 }
148
149 static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 * value)
150 {
151         struct slot *slot = (struct slot *)hotplug_slot->private;
152         int retval = 0;
153
154         down(&rpaphp_sem);
155         retval = rpaphp_get_pci_adapter_status(slot, 0, value);
156         up(&rpaphp_sem);
157         return retval;
158 }
159
160 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
161 {
162         struct slot *slot = (struct slot *)hotplug_slot->private;
163
164         down(&rpaphp_sem);
165         switch (slot->type) {
166         case 1:
167         case 2:
168         case 3:
169         case 4:
170         case 5:
171         case 6:
172                 *value = PCI_SPEED_33MHz;       /* speed for case 1-6 */
173                 break;
174         case 7:
175         case 8:
176                 *value = PCI_SPEED_66MHz;
177                 break;
178         case 11:
179         case 14:
180                 *value = PCI_SPEED_66MHz_PCIX;
181                 break;
182         case 12:
183         case 15:
184                 *value = PCI_SPEED_100MHz_PCIX;
185                 break;
186         case 13:
187         case 16:
188                 *value = PCI_SPEED_133MHz_PCIX;
189                 break;
190         default:
191                 *value = PCI_SPEED_UNKNOWN;
192                 break;
193
194         }
195         up(&rpaphp_sem);
196         return 0;
197 }
198
199 static int get_children_props(struct device_node *dn, int **drc_indexes,
200                 int **drc_names, int **drc_types, int **drc_power_domains)
201 {
202         int *indexes, *names;
203         int *types, *domains;
204
205         indexes = (int *) get_property(dn, "ibm,drc-indexes", NULL);
206         names = (int *) get_property(dn, "ibm,drc-names", NULL);
207         types = (int *) get_property(dn, "ibm,drc-types", NULL);
208         domains = (int *) get_property(dn, "ibm,drc-power-domains", NULL);
209
210         if (!indexes || !names || !types || !domains) {
211                 /* Slot does not have dynamically-removable children */
212                 return -EINVAL;
213         }
214         if (drc_indexes)
215                 *drc_indexes = indexes;
216         if (drc_names)
217                 /* &drc_names[1] contains NULL terminated slot names */
218                 *drc_names = names;
219         if (drc_types)
220                 /* &drc_types[1] contains NULL terminated slot types */
221                 *drc_types = types;
222         if (drc_power_domains)
223                 *drc_power_domains = domains;
224
225         return 0;
226 }
227
228 /* To get the DRC props describing the current node, first obtain it's
229  * my-drc-index property.  Next obtain the DRC list from it's parent.  Use
230  * the my-drc-index for correlation, and obtain the requested properties.
231  */
232 int rpaphp_get_drc_props(struct device_node *dn, int *drc_index,
233                 char **drc_name, char **drc_type, int *drc_power_domain)
234 {
235         int *indexes, *names;
236         int *types, *domains;
237         unsigned int *my_index;
238         char *name_tmp, *type_tmp;
239         int i, rc;
240
241         my_index = (int *) get_property(dn, "ibm,my-drc-index", NULL);
242         if (!my_index) {
243                 /* Node isn't DLPAR/hotplug capable */
244                 return -EINVAL;
245         }
246
247         rc = get_children_props(dn->parent, &indexes, &names, &types, &domains);
248         if (rc < 0) {
249                 return -EINVAL;
250         }
251
252         name_tmp = (char *) &names[1];
253         type_tmp = (char *) &types[1];
254
255         /* Iterate through parent properties, looking for my-drc-index */
256         for (i = 0; i < indexes[0]; i++) {
257                 if ((unsigned int) indexes[i + 1] == *my_index) {
258                         if (drc_name)
259                                 *drc_name = name_tmp;
260                         if (drc_type)
261                                 *drc_type = type_tmp;
262                         if (drc_index)
263                                 *drc_index = *my_index;
264                         if (drc_power_domain)
265                                 *drc_power_domain = domains[i+1];
266                         return 0;
267                 }
268                 name_tmp += (strlen(name_tmp) + 1);
269                 type_tmp += (strlen(type_tmp) + 1);
270         }
271
272         return -EINVAL;
273 }
274
275 static int is_php_type(char *drc_type)
276 {
277         unsigned long value;
278         char *endptr;
279
280         /* PCI Hotplug nodes have an integer for drc_type */
281         value = simple_strtoul(drc_type, &endptr, 10);
282         if (endptr == drc_type)
283                 return 0;
284
285         return 1;
286 }
287
288 static int is_php_dn(struct device_node *dn, int **indexes, int **names,
289                 int **types, int **power_domains)
290 {
291         int *drc_types;
292         int rc;
293
294         rc = get_children_props(dn, indexes, names, &drc_types, power_domains);
295         if (rc >= 0) {
296                 if (is_php_type((char *) &drc_types[1])) {
297                         *types = drc_types;
298                         return 1;
299                 }
300         }
301
302         return 0;
303 }
304
305 /**
306  * rpaphp_add_slot -- add hotplug or dlpar slot
307  *
308  *      rpaphp not only registers PCI hotplug slots(HOTPLUG), 
309  *      but also logical DR slots(EMBEDDED).
310  *      HOTPLUG slot: An adapter can be physically added/removed. 
311  *      EMBEDDED slot: An adapter can be logically removed/added
312  *                from/to a partition with the slot.
313  */
314 int rpaphp_add_slot(struct device_node *dn)
315 {
316         struct slot *slot;
317         int retval = 0;
318         int i;
319         int *indexes, *names, *types, *power_domains;
320         char *name, *type;
321
322         dbg("Entry %s: dn->full_name=%s\n", __FUNCTION__, dn->full_name);
323
324         /* register PCI devices */
325         if (dn->name != 0 && strcmp(dn->name, "pci") == 0) {
326                 if (!is_php_dn(dn, &indexes, &names, &types, &power_domains))
327                         goto exit;
328
329                 name = (char *) &names[1];
330                 type = (char *) &types[1];
331                 for (i = 0; i < indexes[0]; i++,
332                         name += (strlen(name) + 1), type += (strlen(type) + 1))                 {
333
334                         if (!(slot = alloc_slot_struct(dn, indexes[i + 1], name,
335                                        power_domains[i + 1]))) {
336                                 retval = -ENOMEM;
337                                 goto exit;
338                         }
339                         slot->type = simple_strtoul(type, NULL, 10);
340                                 
341                         dbg("Found drc-index:0x%x drc-name:%s drc-type:%s\n",
342                                         indexes[i + 1], name, type);
343
344                         retval = rpaphp_register_pci_slot(slot);
345                 }
346         }
347 exit:
348         dbg("%s - Exit: num_slots=%d rc[%d]\n",
349             __FUNCTION__, num_slots, retval);
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_type(dn, "pci")))
380                 rpaphp_add_slot(dn);
381
382         if (!num_slots)
383                 return -ENODEV;
384
385         return 0;
386 }
387
388 static void __exit rpaphp_exit(void)
389 {
390         cleanup_slots();
391 }
392
393 static int __enable_slot(struct slot *slot)
394 {
395         int state;
396         int retval;
397
398         if (slot->state == CONFIGURED)
399                 return 0;
400
401         retval = rpaphp_get_sensor_state(slot, &state);
402         if (retval)
403                 return retval;
404
405         if (state == PRESENT) {
406                 pcibios_add_pci_devices(slot->bus);
407                 slot->state = CONFIGURED;
408         } else if (state == EMPTY) {
409                 slot->state = EMPTY;
410         } else {
411                 err("%s: slot[%s] is in invalid state\n", __FUNCTION__, slot->name);
412                 slot->state = NOT_VALID;
413                 return -EINVAL;
414         }
415         return 0;
416 }
417
418 static int enable_slot(struct hotplug_slot *hotplug_slot)
419 {
420         int retval;
421         struct slot *slot = (struct slot *)hotplug_slot->private;
422
423         down(&rpaphp_sem);
424         retval = __enable_slot(slot);
425         up(&rpaphp_sem);
426
427         return retval;
428 }
429
430 static int __disable_slot(struct slot *slot)
431 {
432         struct pci_dev *dev, *tmp;
433
434         if (slot->state == NOT_CONFIGURED)
435                 return -EINVAL;
436
437         list_for_each_entry_safe(dev, tmp, &slot->bus->devices, bus_list) {
438                 eeh_remove_bus_device(dev);
439                 pci_remove_bus_device(dev);
440         }
441
442         slot->state = NOT_CONFIGURED;
443         return 0;
444 }
445
446 static int disable_slot(struct hotplug_slot *hotplug_slot)
447 {
448         struct slot *slot = (struct slot *)hotplug_slot->private;
449         int retval;
450
451         down(&rpaphp_sem);
452         retval = __disable_slot (slot);
453         up(&rpaphp_sem);
454
455         return retval;
456 }
457
458 module_init(rpaphp_init);
459 module_exit(rpaphp_exit);
460
461 EXPORT_SYMBOL_GPL(rpaphp_add_slot);
462 EXPORT_SYMBOL_GPL(rpaphp_slot_head);
463 EXPORT_SYMBOL_GPL(rpaphp_get_drc_props);