[PATCH] shpchp: event handling rework
[safe/jmp/linux-2.6] / drivers / pci / hotplug / shpchp_core.c
1 /*
2  * Standard Hot Plug Controller Driver
3  *
4  * Copyright (C) 1995,2001 Compaq Computer Corporation
5  * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
6  * Copyright (C) 2001 IBM Corp.
7  * Copyright (C) 2003-2004 Intel Corporation
8  *
9  * All rights reserved.
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 as published by
13  * the Free Software Foundation; either version 2 of the License, or (at
14  * your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
19  * NON INFRINGEMENT.  See the GNU General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
27  *
28  */
29
30 #include <linux/module.h>
31 #include <linux/moduleparam.h>
32 #include <linux/kernel.h>
33 #include <linux/types.h>
34 #include <linux/pci.h>
35 #include <linux/workqueue.h>
36 #include "shpchp.h"
37
38 /* Global variables */
39 int shpchp_debug;
40 int shpchp_poll_mode;
41 int shpchp_poll_time;
42 LIST_HEAD(shpchp_ctrl_list);
43 struct workqueue_struct *shpchp_wq;
44
45 #define DRIVER_VERSION  "0.4"
46 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
47 #define DRIVER_DESC     "Standard Hot Plug PCI Controller Driver"
48
49 MODULE_AUTHOR(DRIVER_AUTHOR);
50 MODULE_DESCRIPTION(DRIVER_DESC);
51 MODULE_LICENSE("GPL");
52
53 module_param(shpchp_debug, bool, 0644);
54 module_param(shpchp_poll_mode, bool, 0644);
55 module_param(shpchp_poll_time, int, 0644);
56 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
57 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
58 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
59
60 #define SHPC_MODULE_NAME "shpchp"
61
62 static int set_attention_status (struct hotplug_slot *slot, u8 value);
63 static int enable_slot          (struct hotplug_slot *slot);
64 static int disable_slot         (struct hotplug_slot *slot);
65 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
66 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
67 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
68 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
69 static int get_address          (struct hotplug_slot *slot, u32 *value);
70 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
71 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
72
73 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
74         .owner =                THIS_MODULE,
75         .set_attention_status = set_attention_status,
76         .enable_slot =          enable_slot,
77         .disable_slot =         disable_slot,
78         .get_power_status =     get_power_status,
79         .get_attention_status = get_attention_status,
80         .get_latch_status =     get_latch_status,
81         .get_adapter_status =   get_adapter_status,
82         .get_address =          get_address,
83         .get_max_bus_speed =    get_max_bus_speed,
84         .get_cur_bus_speed =    get_cur_bus_speed,
85 };
86
87 /**
88  * release_slot - free up the memory used by a slot
89  * @hotplug_slot: slot to free
90  */
91 static void release_slot(struct hotplug_slot *hotplug_slot)
92 {
93         struct slot *slot = hotplug_slot->private;
94
95         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
96
97         kfree(slot->hotplug_slot->info);
98         kfree(slot->hotplug_slot);
99         kfree(slot);
100 }
101
102 static void make_slot_name(struct slot *slot)
103 {
104         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
105                  slot->bus, slot->number);
106 }
107
108 static int init_slots(struct controller *ctrl)
109 {
110         struct slot *slot;
111         struct hotplug_slot *hotplug_slot;
112         struct hotplug_slot_info *info;
113         int retval = -ENOMEM;
114         int i;
115         u32 sun;
116
117         for (i = 0; i < ctrl->num_slots; i++) {
118                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
119                 if (!slot)
120                         goto error;
121
122                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
123                 if (!hotplug_slot)
124                         goto error_slot;
125                 slot->hotplug_slot = hotplug_slot;
126
127                 info = kzalloc(sizeof(*info), GFP_KERNEL);
128                 if (!info)
129                         goto error_hpslot;
130                 hotplug_slot->info = info;
131
132                 hotplug_slot->name = slot->name;
133
134                 slot->hp_slot = i;
135                 slot->ctrl = ctrl;
136                 slot->bus = ctrl->slot_bus;
137                 slot->device = ctrl->slot_device_offset + i;
138                 slot->hpc_ops = ctrl->hpc_ops;
139
140                 if (shpchprm_get_physical_slot_number(ctrl, &sun,
141                                                       slot->bus, slot->device))
142                         goto error_info;
143
144                 slot->number = sun;
145                 INIT_WORK(&slot->work, shpchp_pushbutton_thread, slot);
146
147                 /* register this slot with the hotplug pci core */
148                 hotplug_slot->private = slot;
149                 hotplug_slot->release = &release_slot;
150                 make_slot_name(slot);
151                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
152
153                 get_power_status(hotplug_slot, &info->power_status);
154                 get_attention_status(hotplug_slot, &info->attention_status);
155                 get_latch_status(hotplug_slot, &info->latch_status);
156                 get_adapter_status(hotplug_slot, &info->adapter_status);
157
158                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
159                     "slot_device_offset=%x\n", slot->bus, slot->device,
160                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
161                 retval = pci_hp_register(slot->hotplug_slot);
162                 if (retval) {
163                         err("pci_hp_register failed with error %d\n", retval);
164                         goto error_info;
165                 }
166
167                 list_add(&slot->slot_list, &ctrl->slot_list);
168         }
169
170         return 0;
171 error_info:
172         kfree(info);
173 error_hpslot:
174         kfree(hotplug_slot);
175 error_slot:
176         kfree(slot);
177 error:
178         return retval;
179 }
180
181 void cleanup_slots(struct controller *ctrl)
182 {
183         struct list_head *tmp;
184         struct list_head *next;
185         struct slot *slot;
186
187         list_for_each_safe(tmp, next, &ctrl->slot_list) {
188                 slot = list_entry(tmp, struct slot, slot_list);
189                 list_del(&slot->slot_list);
190                 cancel_delayed_work(&slot->work);
191                 flush_workqueue(shpchp_wq);
192                 pci_hp_deregister(slot->hotplug_slot);
193         }
194 }
195
196 static int get_ctlr_slot_config(struct controller *ctrl)
197 {
198         int num_ctlr_slots;
199         int first_device_num;
200         int physical_slot_num;
201         int updown;
202         int rc;
203         int flags;
204
205         rc = shpc_get_ctlr_slot_config(ctrl, &num_ctlr_slots,
206                                        &first_device_num, &physical_slot_num,
207                                        &updown, &flags);
208         if (rc) {
209                 err("%s: get_ctlr_slot_config fail for b:d (%x:%x)\n",
210                     __FUNCTION__, ctrl->bus, ctrl->device);
211                 return -1;
212         }
213
214         ctrl->num_slots = num_ctlr_slots;
215         ctrl->slot_device_offset = first_device_num;
216         ctrl->first_slot = physical_slot_num;
217         ctrl->slot_num_inc = updown;            /* either -1 or 1 */
218
219         dbg("%s: num_slot(0x%x) 1st_dev(0x%x) psn(0x%x) updown(%d) for b:d "
220             "(%x:%x)\n", __FUNCTION__, num_ctlr_slots, first_device_num,
221             physical_slot_num, updown, ctrl->bus, ctrl->device);
222
223         return 0;
224 }
225
226 /*
227  * set_attention_status - Turns the Amber LED for a slot on, off or blink
228  */
229 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
230 {
231         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
232
233         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
234
235         hotplug_slot->info->attention_status = status;
236         slot->hpc_ops->set_attention_status(slot, status);
237
238         return 0;
239 }
240
241 static int enable_slot (struct hotplug_slot *hotplug_slot)
242 {
243         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
244
245         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
246
247         return shpchp_enable_slot(slot);
248 }
249
250 static int disable_slot (struct hotplug_slot *hotplug_slot)
251 {
252         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
253
254         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
255
256         return shpchp_disable_slot(slot);
257 }
258
259 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
260 {
261         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
262         int retval;
263
264         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
265
266         retval = slot->hpc_ops->get_power_status(slot, value);
267         if (retval < 0)
268                 *value = hotplug_slot->info->power_status;
269
270         return 0;
271 }
272
273 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
274 {
275         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
276         int retval;
277
278         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
279
280         retval = slot->hpc_ops->get_attention_status(slot, value);
281         if (retval < 0)
282                 *value = hotplug_slot->info->attention_status;
283
284         return 0;
285 }
286
287 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
288 {
289         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
290         int retval;
291
292         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
293
294         retval = slot->hpc_ops->get_latch_status(slot, value);
295         if (retval < 0)
296                 *value = hotplug_slot->info->latch_status;
297
298         return 0;
299 }
300
301 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
302 {
303         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
304         int retval;
305
306         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
307
308         retval = slot->hpc_ops->get_adapter_status(slot, value);
309         if (retval < 0)
310                 *value = hotplug_slot->info->adapter_status;
311
312         return 0;
313 }
314
315 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
316 {
317         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
318         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
319
320         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
321
322         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
323
324         return 0;
325 }
326
327 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
328 {
329         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
330         int retval;
331
332         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
333
334         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
335         if (retval < 0)
336                 *value = PCI_SPEED_UNKNOWN;
337
338         return 0;
339 }
340
341 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
342 {
343         struct slot *slot = get_slot(hotplug_slot, __FUNCTION__);
344         int retval;
345
346         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
347
348         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
349         if (retval < 0)
350                 *value = PCI_SPEED_UNKNOWN;
351
352         return 0;
353 }
354
355 static int is_shpc_capable(struct pci_dev *dev)
356 {
357        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
358                                PCI_DEVICE_ID_AMD_GOLAM_7450))
359                return 1;
360        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
361                return 1;
362
363        return 0;
364 }
365
366 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
367 {
368         int rc;
369         struct controller *ctrl;
370         struct slot *t_slot;
371         int first_device_num;   /* first PCI device number */
372         int num_ctlr_slots;     /* number of slots implemented */
373
374         if (!is_shpc_capable(pdev))
375                 return -ENODEV;
376
377         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
378         if (!ctrl) {
379                 err("%s : out of memory\n", __FUNCTION__);
380                 goto err_out_none;
381         }
382         INIT_LIST_HEAD(&ctrl->slot_list);
383
384         rc = shpc_init(ctrl, pdev);
385         if (rc) {
386                 dbg("%s: controller initialization failed\n",
387                     SHPC_MODULE_NAME);
388                 goto err_out_free_ctrl;
389         }
390
391         pci_set_drvdata(pdev, ctrl);
392
393         ctrl->bus = pdev->bus->number;
394         ctrl->slot_bus = pdev->subordinate->number;
395         ctrl->device = PCI_SLOT(pdev->devfn);
396         ctrl->function = PCI_FUNC(pdev->devfn);
397
398         dbg("ctrl bus=0x%x, device=%x, function=%x, irq=%x\n",
399             ctrl->bus, ctrl->device, ctrl->function, pdev->irq);
400
401         /*
402          * Save configuration headers for this and subordinate PCI buses
403          */
404         rc = get_ctlr_slot_config(ctrl);
405         if (rc) {
406                 err(msg_initialization_err, rc);
407                 goto err_out_release_ctlr;
408         }
409         first_device_num = ctrl->slot_device_offset;
410         num_ctlr_slots = ctrl->num_slots;
411
412         ctrl->add_support = 1;
413
414         /* Setup the slot information structures */
415         rc = init_slots(ctrl);
416         if (rc) {
417                 err(msg_initialization_err, 6);
418                 goto err_out_release_ctlr;
419         }
420
421         /* Now hpc_functions (slot->hpc_ops->functions) are ready  */
422         t_slot = shpchp_find_slot(ctrl, first_device_num);
423
424         /* Check for operation bus speed */
425         rc = t_slot->hpc_ops->get_cur_bus_speed(t_slot, &ctrl->speed);
426         dbg("%s: t_slot->hp_slot %x\n", __FUNCTION__,t_slot->hp_slot);
427
428         if (rc || ctrl->speed == PCI_SPEED_UNKNOWN) {
429                 err(SHPC_MODULE_NAME ": Can't get current bus speed. "
430                     "Set to 33MHz PCI.\n");
431                 ctrl->speed = PCI_SPEED_33MHz;
432         }
433
434         list_add(&ctrl->ctrl_list, &shpchp_ctrl_list);
435
436         shpchp_create_ctrl_files(ctrl);
437
438         return 0;
439
440 err_out_release_ctlr:
441         ctrl->hpc_ops->release_ctlr(ctrl);
442 err_out_free_ctrl:
443         kfree(ctrl);
444 err_out_none:
445         return -ENODEV;
446 }
447
448 static void __exit unload_shpchpd(void)
449 {
450         struct list_head *tmp;
451         struct list_head *next;
452         struct controller *ctrl;
453
454         list_for_each_safe(tmp, next, &shpchp_ctrl_list) {
455                 ctrl = list_entry(tmp, struct controller, ctrl_list);
456                 shpchp_remove_ctrl_files(ctrl);
457                 ctrl->hpc_ops->release_ctlr(ctrl);
458                 kfree(ctrl);
459         }
460
461         destroy_workqueue(shpchp_wq);
462 }
463
464 static struct pci_device_id shpcd_pci_tbl[] = {
465         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
466         { /* end: all zeroes */ }
467 };
468 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
469
470 static struct pci_driver shpc_driver = {
471         .name =         SHPC_MODULE_NAME,
472         .id_table =     shpcd_pci_tbl,
473         .probe =        shpc_probe,
474         /* remove:      shpc_remove_one, */
475 };
476
477 static int __init shpcd_init(void)
478 {
479         int retval = 0;
480
481 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
482         shpchp_poll_mode = 1;
483 #endif
484
485         shpchp_wq = create_singlethread_workqueue("shpchpd");
486         if (!shpchp_wq)
487                 return -ENOMEM;
488
489         retval = pci_register_driver(&shpc_driver);
490         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
491         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
492         if (retval) {
493                 destroy_workqueue(shpchp_wq);
494         }
495         return retval;
496 }
497
498 static void __exit shpcd_cleanup(void)
499 {
500         dbg("unload_shpchpd()\n");
501         unload_shpchpd();
502
503         pci_unregister_driver(&shpc_driver);
504
505         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
506 }
507
508 module_init(shpcd_init);
509 module_exit(shpcd_cleanup);