shpchp: cleanup shpchp.h
[sfrench/cifs-2.6.git] / 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_address          (struct hotplug_slot *slot, u32 *value);
69 static int get_max_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
70 static int get_cur_bus_speed    (struct hotplug_slot *slot, enum pci_bus_speed *value);
71
72 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
73         .owner =                THIS_MODULE,
74         .set_attention_status = set_attention_status,
75         .enable_slot =          enable_slot,
76         .disable_slot =         disable_slot,
77         .get_power_status =     get_power_status,
78         .get_attention_status = get_attention_status,
79         .get_latch_status =     get_latch_status,
80         .get_adapter_status =   get_adapter_status,
81         .get_address =          get_address,
82         .get_max_bus_speed =    get_max_bus_speed,
83         .get_cur_bus_speed =    get_cur_bus_speed,
84 };
85
86 /**
87  * release_slot - free up the memory used by a slot
88  * @hotplug_slot: slot to free
89  */
90 static void release_slot(struct hotplug_slot *hotplug_slot)
91 {
92         struct slot *slot = hotplug_slot->private;
93
94         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
95
96         kfree(slot->hotplug_slot->info);
97         kfree(slot->hotplug_slot);
98         kfree(slot);
99 }
100
101 static void make_slot_name(struct slot *slot)
102 {
103         snprintf(slot->hotplug_slot->name, SLOT_NAME_SIZE, "%04d_%04d",
104                  slot->bus, slot->number);
105 }
106
107 static int init_slots(struct controller *ctrl)
108 {
109         struct slot *slot;
110         struct hotplug_slot *hotplug_slot;
111         struct hotplug_slot_info *info;
112         int retval = -ENOMEM;
113         int i;
114
115         for (i = 0; i < ctrl->num_slots; i++) {
116                 slot = kzalloc(sizeof(*slot), GFP_KERNEL);
117                 if (!slot)
118                         goto error;
119
120                 hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
121                 if (!hotplug_slot)
122                         goto error_slot;
123                 slot->hotplug_slot = hotplug_slot;
124
125                 info = kzalloc(sizeof(*info), GFP_KERNEL);
126                 if (!info)
127                         goto error_hpslot;
128                 hotplug_slot->info = info;
129
130                 hotplug_slot->name = slot->name;
131
132                 slot->hp_slot = i;
133                 slot->ctrl = ctrl;
134                 slot->bus = ctrl->pci_dev->subordinate->number;
135                 slot->device = ctrl->slot_device_offset + i;
136                 slot->hpc_ops = ctrl->hpc_ops;
137                 slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
138                 mutex_init(&slot->lock);
139                 INIT_DELAYED_WORK(&slot->work, queue_pushbutton_work);
140
141                 /* register this slot with the hotplug pci core */
142                 hotplug_slot->private = slot;
143                 hotplug_slot->release = &release_slot;
144                 make_slot_name(slot);
145                 hotplug_slot->ops = &shpchp_hotplug_slot_ops;
146
147                 get_power_status(hotplug_slot, &info->power_status);
148                 get_attention_status(hotplug_slot, &info->attention_status);
149                 get_latch_status(hotplug_slot, &info->latch_status);
150                 get_adapter_status(hotplug_slot, &info->adapter_status);
151
152                 dbg("Registering bus=%x dev=%x hp_slot=%x sun=%x "
153                     "slot_device_offset=%x\n", slot->bus, slot->device,
154                     slot->hp_slot, slot->number, ctrl->slot_device_offset);
155                 retval = pci_hp_register(slot->hotplug_slot);
156                 if (retval) {
157                         err("pci_hp_register failed with error %d\n", retval);
158                         goto error_info;
159                 }
160
161                 list_add(&slot->slot_list, &ctrl->slot_list);
162         }
163
164         return 0;
165 error_info:
166         kfree(info);
167 error_hpslot:
168         kfree(hotplug_slot);
169 error_slot:
170         kfree(slot);
171 error:
172         return retval;
173 }
174
175 void cleanup_slots(struct controller *ctrl)
176 {
177         struct list_head *tmp;
178         struct list_head *next;
179         struct slot *slot;
180
181         list_for_each_safe(tmp, next, &ctrl->slot_list) {
182                 slot = list_entry(tmp, struct slot, slot_list);
183                 list_del(&slot->slot_list);
184                 cancel_delayed_work(&slot->work);
185                 flush_scheduled_work();
186                 flush_workqueue(shpchp_wq);
187                 pci_hp_deregister(slot->hotplug_slot);
188         }
189 }
190
191 /*
192  * set_attention_status - Turns the Amber LED for a slot on, off or blink
193  */
194 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
195 {
196         struct slot *slot = get_slot(hotplug_slot);
197
198         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
199
200         hotplug_slot->info->attention_status = status;
201         slot->hpc_ops->set_attention_status(slot, status);
202
203         return 0;
204 }
205
206 static int enable_slot (struct hotplug_slot *hotplug_slot)
207 {
208         struct slot *slot = get_slot(hotplug_slot);
209
210         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
211
212         return shpchp_sysfs_enable_slot(slot);
213 }
214
215 static int disable_slot (struct hotplug_slot *hotplug_slot)
216 {
217         struct slot *slot = get_slot(hotplug_slot);
218
219         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
220
221         return shpchp_sysfs_disable_slot(slot);
222 }
223
224 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
225 {
226         struct slot *slot = get_slot(hotplug_slot);
227         int retval;
228
229         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
230
231         retval = slot->hpc_ops->get_power_status(slot, value);
232         if (retval < 0)
233                 *value = hotplug_slot->info->power_status;
234
235         return 0;
236 }
237
238 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
239 {
240         struct slot *slot = get_slot(hotplug_slot);
241         int retval;
242
243         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
244
245         retval = slot->hpc_ops->get_attention_status(slot, value);
246         if (retval < 0)
247                 *value = hotplug_slot->info->attention_status;
248
249         return 0;
250 }
251
252 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
253 {
254         struct slot *slot = get_slot(hotplug_slot);
255         int retval;
256
257         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
258
259         retval = slot->hpc_ops->get_latch_status(slot, value);
260         if (retval < 0)
261                 *value = hotplug_slot->info->latch_status;
262
263         return 0;
264 }
265
266 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
267 {
268         struct slot *slot = get_slot(hotplug_slot);
269         int retval;
270
271         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
272
273         retval = slot->hpc_ops->get_adapter_status(slot, value);
274         if (retval < 0)
275                 *value = hotplug_slot->info->adapter_status;
276
277         return 0;
278 }
279
280 static int get_address (struct hotplug_slot *hotplug_slot, u32 *value)
281 {
282         struct slot *slot = get_slot(hotplug_slot);
283         struct pci_bus *bus = slot->ctrl->pci_dev->subordinate;
284
285         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
286
287         *value = (pci_domain_nr(bus) << 16) | (slot->bus << 8) | slot->device;
288
289         return 0;
290 }
291
292 static int get_max_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
293 {
294         struct slot *slot = get_slot(hotplug_slot);
295         int retval;
296
297         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
298
299         retval = slot->hpc_ops->get_max_bus_speed(slot, value);
300         if (retval < 0)
301                 *value = PCI_SPEED_UNKNOWN;
302
303         return 0;
304 }
305
306 static int get_cur_bus_speed (struct hotplug_slot *hotplug_slot, enum pci_bus_speed *value)
307 {
308         struct slot *slot = get_slot(hotplug_slot);
309         int retval;
310
311         dbg("%s - physical_slot = %s\n", __FUNCTION__, hotplug_slot->name);
312
313         retval = slot->hpc_ops->get_cur_bus_speed(slot, value);
314         if (retval < 0)
315                 *value = PCI_SPEED_UNKNOWN;
316
317         return 0;
318 }
319
320 static int is_shpc_capable(struct pci_dev *dev)
321 {
322        if ((dev->vendor == PCI_VENDOR_ID_AMD) || (dev->device ==
323                                PCI_DEVICE_ID_AMD_GOLAM_7450))
324                return 1;
325        if (pci_find_capability(dev, PCI_CAP_ID_SHPC))
326                return 1;
327
328        return 0;
329 }
330
331 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
332 {
333         int rc;
334         struct controller *ctrl;
335
336         if (!is_shpc_capable(pdev))
337                 return -ENODEV;
338
339         ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
340         if (!ctrl) {
341                 err("%s : out of memory\n", __FUNCTION__);
342                 goto err_out_none;
343         }
344         INIT_LIST_HEAD(&ctrl->slot_list);
345
346         rc = shpc_init(ctrl, pdev);
347         if (rc) {
348                 dbg("%s: controller initialization failed\n",
349                     SHPC_MODULE_NAME);
350                 goto err_out_free_ctrl;
351         }
352
353         pci_set_drvdata(pdev, ctrl);
354
355         /* Setup the slot information structures */
356         rc = init_slots(ctrl);
357         if (rc) {
358                 err("%s: slot initialization failed\n", SHPC_MODULE_NAME);
359                 goto err_out_release_ctlr;
360         }
361
362         rc = shpchp_create_ctrl_files(ctrl);
363         if (rc)
364                 goto err_cleanup_slots;
365
366         return 0;
367
368 err_cleanup_slots:
369         cleanup_slots(ctrl);
370 err_out_release_ctlr:
371         ctrl->hpc_ops->release_ctlr(ctrl);
372 err_out_free_ctrl:
373         kfree(ctrl);
374 err_out_none:
375         return -ENODEV;
376 }
377
378 static void shpc_remove(struct pci_dev *dev)
379 {
380         struct controller *ctrl = pci_get_drvdata(dev);
381
382         shpchp_remove_ctrl_files(ctrl);
383         ctrl->hpc_ops->release_ctlr(ctrl);
384         kfree(ctrl);
385 }
386
387 static struct pci_device_id shpcd_pci_tbl[] = {
388         {PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
389         { /* end: all zeroes */ }
390 };
391 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
392
393 static struct pci_driver shpc_driver = {
394         .name =         SHPC_MODULE_NAME,
395         .id_table =     shpcd_pci_tbl,
396         .probe =        shpc_probe,
397         .remove =       shpc_remove,
398 };
399
400 static int __init shpcd_init(void)
401 {
402         int retval = 0;
403
404 #ifdef CONFIG_HOTPLUG_PCI_SHPC_POLL_EVENT_MODE
405         shpchp_poll_mode = 1;
406 #endif
407
408         retval = pci_register_driver(&shpc_driver);
409         dbg("%s: pci_register_driver = %d\n", __FUNCTION__, retval);
410         info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
411         return retval;
412 }
413
414 static void __exit shpcd_cleanup(void)
415 {
416         dbg("unload_shpchpd()\n");
417         pci_unregister_driver(&shpc_driver);
418         info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
419 }
420
421 module_init(shpcd_init);
422 module_exit(shpcd_cleanup);