Merge branch 'for-linus' of git://git390.osdl.marist.edu/pub/scm/linux-2.6
[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 struct workqueue_struct *shpchp_wq;
43
44 #define DRIVER_VERSION  "0.4"
45 #define DRIVER_AUTHOR   "Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
46 #define DRIVER_DESC     "Standard Hot Plug PCI Controller Driver"
47
48 MODULE_AUTHOR(DRIVER_AUTHOR);
49 MODULE_DESCRIPTION(DRIVER_DESC);
50 MODULE_LICENSE("GPL");
51
52 module_param(shpchp_debug, bool, 0644);
53 module_param(shpchp_poll_mode, bool, 0644);
54 module_param(shpchp_poll_time, int, 0644);
55 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
56 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
57 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
58
59 #define SHPC_MODULE_NAME "shpchp"
60
61 static int set_attention_status (struct hotplug_slot *slot, u8 value);
62 static int enable_slot          (struct hotplug_slot *slot);
63 static int disable_slot         (struct hotplug_slot *slot);
64 static int get_power_status     (struct hotplug_slot *slot, u8 *value);
65 static int get_attention_status (struct hotplug_slot *slot, u8 *value);
66 static int get_latch_status     (struct hotplug_slot *slot, u8 *value);
67 static int get_adapter_status   (struct hotplug_slot *slot, u8 *value);
68 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
69 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
70
71 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
72         .owner =                THIS_MODULE,
73         .set_attention_status = set_attention_status,
74         .enable_slot =          enable_slot,
75         .disable_slot =         disable_slot,
76         .get_power_status =     get_power_status,
77         .get_attention_status = get_attention_status,
78         .get_latch_status =     get_latch_status,
79         .get_adapter_status =   get_adapter_status,
80         .get_max_bus_speed =    get_max_bus_speed,
81         .get_cur_bus_speed =    get_cur_bus_speed,
82 };
83
84 /**
85  * release_slot - free up the memory used by a slot
86  * @hotplug_slot: slot to free
87  */
88 static void release_slot(struct hotplug_slot *hotplug_slot)
89 {
90         struct slot *slot = hotplug_slot->private;
91
92         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
93
94         kfree(slot->hotplug_slot->info);
95         kfree(slot->hotplug_slot);
96         kfree(slot);
97 }
98
99 static int init_slots(struct controller *ctrl)
100 {
101         struct slot *slot;
102         struct hotplug_slot *hotplug_slot;
103         struct hotplug_slot_info *info;
104         int retval = -ENOMEM;
105         int i, len, dup = 1;
106
107         for (i = 0; i < ctrl->num_slots; i++) {
108                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
109                 if (!slot)
110                         goto error;
111
112                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
113                 if (!hotplug_slot)
114                         goto error_slot;
115                 slot->hotplug_slot = hotplug_slot;
116
117                 info = kzalloc(sizeof(*info), GFP_KERNEL);
118                 if (!info)
119                         goto error_hpslot;
120                 hotplug_slot->info = info;
121
122                 hotplug_slot->name = slot->name;
123
124                 slot->hp_slot = i;
125                 slot->ctrl = ctrl;
126                 slot->bus = ctrl->pci_dev->subordinate->number;
127                 slot->device = ctrl->slot_device_offset + i;
128                 slot->hpc_ops = ctrl->hpc_ops;
129                 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
130                 mutex_init(&slot->lock);
131                 INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
132
133                 /* register this slot with the hotplug pci core */
134                 hotplug_slot->private = slot;
135                 hotplug_slot->release = &release_slot;
136                 snprintf(slot->name, SLOT_NAME_SIZE, "%d", slot->number);
137                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
138
139                 get_power_status(hotplug_slot, &info->power_status);
140                 get_attention_status(hotplug_slot, &info->attention_status);
141                 get_latch_status(hotplug_slot, &info->latch_status);
142                 get_adapter_status(hotplug_slot, &info->adapter_status);
143
144                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
145                     "slot_device_offset=%x\n", slot->bus, slot->device,
146                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
147 duplicate_name:
148                 retval = pci_hp_register(slot->hotplug_slot,
149                                 ctrl->pci_dev->subordinate, slot->device);
150                 if (retval) {
151                         /*
152                          * If slot N already exists, we'll try to create
153                          * slot N-1, N-2 ... N-M, until we overflow.
154                          */
155                         if (retval == -EEXIST) {
156                                 len = snprintf(slot->name, SLOT_NAME_SIZE,
157                                                "%d-%d", slot->number, dup++);
158                                 if (len < SLOT_NAME_SIZE)
159                                         goto duplicate_name;
160                                 else
161                                         err("duplicate slot name overflow\n");
162                         }
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_scheduled_work();
192                 flush_workqueue(shpchp_wq);
193                 pci_hp_deregister(slot->hotplug_slot);
194         }
195 }
196
197 /*
198  * set_attention_status - Turns the Amber LED for a slot on, off or blink
199  */
200 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
201 {
202         struct slot *slot = get_slot(hotplug_slot);
203
204         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
205
206         hotplug_slot->info->attention_status = status;
207         slot->hpc_ops->set_attention_status(slot, status);
208
209         return 0;
210 }
211
212 static int enable_slot (struct hotplug_slot *hotplug_slot)
213 {
214         struct slot *slot = get_slot(hotplug_slot);
215
216         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
217
218         return shpchp_sysfs_enable_slot(slot);
219 }
220
221 static int disable_slot (struct hotplug_slot *hotplug_slot)
222 {
223         struct slot *slot = get_slot(hotplug_slot);
224
225         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
226
227         return shpchp_sysfs_disable_slot(slot);
228 }
229
230 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
231 {
232         struct slot *slot = get_slot(hotplug_slot);
233         int retval;
234
235         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
236
237         retval = slot->hpc_ops->get_power_status(slot, value);
238         if (retval < 0)
239                 *value = hotplug_slot->info->power_status;
240
241         return 0;
242 }
243
244 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
245 {
246         struct slot *slot = get_slot(hotplug_slot);
247         int retval;
248
249         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
250
251         retval = slot->hpc_ops->get_attention_status(slot, value);
252         if (retval < 0)
253                 *value = hotplug_slot->info->attention_status;
254
255         return 0;
256 }
257
258 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
259 {
260         struct slot *slot = get_slot(hotplug_slot);
261         int retval;
262
263         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
264
265         retval = slot->hpc_ops->get_latch_status(slot, value);
266         if (retval < 0)
267                 *value = hotplug_slot->info->latch_status;
268
269         return 0;
270 }
271
272 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
273 {
274         struct slot *slot = get_slot(hotplug_slot);
275         int retval;
276
277         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
278
279         retval = slot->hpc_ops->get_adapter_status(slot, value);
280         if (retval < 0)
281                 *value = hotplug_slot->info->adapter_status;
282
283         return 0;
284 }
285
286 static int get_max_bus_speed(struct hotplug_slot *hotplug_slot,
287                                 enum pci_bus_speed *value)
288 {
289         struct slot *slot = get_slot(hotplug_slot);
290         int retval;
291
292         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
293
294         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
295         if (retval < 0)
296                 *value = PCI_SPEED_UNKNOWN;
297
298         return 0;
299 }
300
301 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
302 {
303         struct slot *slot = get_slot(hotplug_slot);
304         int retval;
305
306         dbg("%s - physical_slot = %s\n", __func__, hotplug_slot->name);
307
308         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
309         if (retval < 0)
310                 *value = PCI_SPEED_UNKNOWN;
311
312         return 0;
313 }
314
315 static int is_shpc_capable(struct pci_dev *dev)
316 {
317         if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
318                                                 PCI_DEVICE_ID_AMD_GOLAM_7450))
319                 return 1;
320         if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
321                 return 0;
322         if (get_hp_hw_control_from_firmware(dev))
323                 return 0;
324         return 1;
325 }
326
327 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
328 {
329         int rc;
330         struct controller *ctrl;
331
332         if (!is_shpc_capable(pdev))
333                 return -ENODEV;
334
335         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
336         if (!ctrl) {
337                 err("%s : out of memory\n", __func__);
338                 goto err_out_none;
339         }
340         INIT_LIST_HEAD(&ctrl->slot_list);
341
342         rc = shpc_init(ctrl, pdev);
343         if (rc) {
344                 dbg("%s: controller initialization failed\n",
345                     SHPC_MODULE_NAME);
346                 goto err_out_free_ctrl;
347         }
348
349         pci_set_drvdata(pdev, ctrl);
350
351         /* Setup the slot information structures */
352         rc = init_slots(ctrl);
353         if (rc) {
354                 err("%s: slot initialization failed\n", SHPC_MODULE_NAME);
355                 goto err_out_release_ctlr;
356         }
357
358         rc = shpchp_create_ctrl_files(ctrl);
359         if (rc)
360                 goto err_cleanup_slots;
361
362         return 0;
363
364 err_cleanup_slots:
365         cleanup_slots(ctrl);
366 err_out_release_ctlr:
367         ctrl->hpc_ops->release_ctlr(ctrl);
368 err_out_free_ctrl:
369         kfree(ctrl);
370 err_out_none:
371         return -ENODEV;
372 }
373
374 static void shpc_remove(struct pci_dev *dev)
375 {
376         struct controller *ctrl = pci_get_drvdata(dev);
377
378         shpchp_remove_ctrl_files(ctrl);
379         ctrl->hpc_ops->release_ctlr(ctrl);
380         kfree(ctrl);
381 }
382
383 static struct pci_device_id shpcd_pci_tbl[] = {
384         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
385         { /* end: all zeroes */ }
386 };
387 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
388
389 static struct pci_driver shpc_driver = {
390         .name =         SHPC_MODULE_NAME,
391         .id_table =     shpcd_pci_tbl,
392         .probe =        shpc_probe,
393         .remove =       shpc_remove,
394 };
395
396 static int __init shpcd_init(void)
397 {
398         int retval = 0;
399
400         retval = pci_register_driver(&shpc_driver);
401         dbg("%s: pci_register_driver = %d\n", __func__, retval);
402         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
403         return retval;
404 }
405
406 static void __exit shpcd_cleanup(void)
407 {
408         dbg("unload_shpchpd()\n");
409         pci_unregister_driver(&shpc_driver);
410         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
411 }
412
413 module_init(shpcd_init);
414 module_exit(shpcd_cleanup);