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/slab.h>
35 #include <linux/pci.h>
36 #include "shpchp.h"
37 
38 /* Global variables */
39 bool shpchp_debug;
40 bool shpchp_poll_mode;
41 int shpchp_poll_time;
42 
43 #define DRIVER_VERSION	"0.4"
44 #define DRIVER_AUTHOR	"Dan Zink <dan.zink@compaq.com>, Greg Kroah-Hartman <greg@kroah.com>, Dely Sy <dely.l.sy@intel.com>"
45 #define DRIVER_DESC	"Standard Hot Plug PCI Controller Driver"
46 
47 MODULE_AUTHOR(DRIVER_AUTHOR);
48 MODULE_DESCRIPTION(DRIVER_DESC);
49 MODULE_LICENSE("GPL");
50 
51 module_param(shpchp_debug, bool, 0644);
52 module_param(shpchp_poll_mode, bool, 0644);
53 module_param(shpchp_poll_time, int, 0644);
54 MODULE_PARM_DESC(shpchp_debug, "Debugging mode enabled or not");
55 MODULE_PARM_DESC(shpchp_poll_mode, "Using polling mechanism for hot-plug events or not");
56 MODULE_PARM_DESC(shpchp_poll_time, "Polling mechanism frequency, in seconds");
57 
58 #define SHPC_MODULE_NAME "shpchp"
59 
60 static int set_attention_status (struct hotplug_slot *slot, u8 value);
61 static int enable_slot		(struct hotplug_slot *slot);
62 static int disable_slot		(struct hotplug_slot *slot);
63 static int get_power_status	(struct hotplug_slot *slot, u8 *value);
64 static int get_attention_status	(struct hotplug_slot *slot, u8 *value);
65 static int get_latch_status	(struct hotplug_slot *slot, u8 *value);
66 static int get_adapter_status	(struct hotplug_slot *slot, u8 *value);
67 
68 static struct hotplug_slot_ops shpchp_hotplug_slot_ops = {
69 	.set_attention_status =	set_attention_status,
70 	.enable_slot =		enable_slot,
71 	.disable_slot =		disable_slot,
72 	.get_power_status =	get_power_status,
73 	.get_attention_status =	get_attention_status,
74 	.get_latch_status =	get_latch_status,
75 	.get_adapter_status =	get_adapter_status,
76 };
77 
78 /**
79  * release_slot - free up the memory used by a slot
80  * @hotplug_slot: slot to free
81  */
82 static void release_slot(struct hotplug_slot *hotplug_slot)
83 {
84 	struct slot *slot = hotplug_slot->private;
85 
86 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
87 		 __func__, slot_name(slot));
88 
89 	kfree(slot->hotplug_slot->info);
90 	kfree(slot->hotplug_slot);
91 	kfree(slot);
92 }
93 
94 static int init_slots(struct controller *ctrl)
95 {
96 	struct slot *slot;
97 	struct hotplug_slot *hotplug_slot;
98 	struct hotplug_slot_info *info;
99 	char name[SLOT_NAME_SIZE];
100 	int retval;
101 	int i;
102 
103 	for (i = 0; i < ctrl->num_slots; i++) {
104 		slot = kzalloc(sizeof(*slot), GFP_KERNEL);
105 		if (!slot) {
106 			retval = -ENOMEM;
107 			goto error;
108 		}
109 
110 		hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
111 		if (!hotplug_slot) {
112 			retval = -ENOMEM;
113 			goto error_slot;
114 		}
115 		slot->hotplug_slot = hotplug_slot;
116 
117 		info = kzalloc(sizeof(*info), GFP_KERNEL);
118 		if (!info) {
119 			retval = -ENOMEM;
120 			goto error_hpslot;
121 		}
122 		hotplug_slot->info = info;
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 
131 		slot->wq = alloc_workqueue("shpchp-%d", 0, 0, slot->number);
132 		if (!slot->wq) {
133 			retval = -ENOMEM;
134 			goto error_info;
135 		}
136 
137 		mutex_init(&slot->lock);
138 		INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
139 
140 		/* register this slot with the hotplug pci core */
141 		hotplug_slot->private = slot;
142 		hotplug_slot->release = &release_slot;
143 		snprintf(name, SLOT_NAME_SIZE, "%d", slot->number);
144 		hotplug_slot->ops = &shpchp_hotplug_slot_ops;
145 
146 		ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:%02x hp_slot=%x sun=%x slot_device_offset=%x\n",
147 			 pci_domain_nr(ctrl->pci_dev->subordinate),
148 			 slot->bus, slot->device, slot->hp_slot, slot->number,
149 			 ctrl->slot_device_offset);
150 		retval = pci_hp_register(slot->hotplug_slot,
151 				ctrl->pci_dev->subordinate, slot->device, name);
152 		if (retval) {
153 			ctrl_err(ctrl, "pci_hp_register failed with error %d\n",
154 				 retval);
155 			goto error_slotwq;
156 		}
157 
158 		get_power_status(hotplug_slot, &info->power_status);
159 		get_attention_status(hotplug_slot, &info->attention_status);
160 		get_latch_status(hotplug_slot, &info->latch_status);
161 		get_adapter_status(hotplug_slot, &info->adapter_status);
162 
163 		list_add(&slot->slot_list, &ctrl->slot_list);
164 	}
165 
166 	return 0;
167 error_slotwq:
168 	destroy_workqueue(slot->wq);
169 error_info:
170 	kfree(info);
171 error_hpslot:
172 	kfree(hotplug_slot);
173 error_slot:
174 	kfree(slot);
175 error:
176 	return retval;
177 }
178 
179 void cleanup_slots(struct controller *ctrl)
180 {
181 	struct list_head *tmp;
182 	struct list_head *next;
183 	struct slot *slot;
184 
185 	list_for_each_safe(tmp, next, &ctrl->slot_list) {
186 		slot = list_entry(tmp, struct slot, slot_list);
187 		list_del(&slot->slot_list);
188 		cancel_delayed_work(&slot->work);
189 		destroy_workqueue(slot->wq);
190 		pci_hp_deregister(slot->hotplug_slot);
191 	}
192 }
193 
194 /*
195  * set_attention_status - Turns the Amber LED for a slot on, off or blink
196  */
197 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
198 {
199 	struct slot *slot = get_slot(hotplug_slot);
200 
201 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
202 		 __func__, slot_name(slot));
203 
204 	hotplug_slot->info->attention_status = status;
205 	slot->hpc_ops->set_attention_status(slot, status);
206 
207 	return 0;
208 }
209 
210 static int enable_slot (struct hotplug_slot *hotplug_slot)
211 {
212 	struct slot *slot = get_slot(hotplug_slot);
213 
214 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
215 		 __func__, slot_name(slot));
216 
217 	return shpchp_sysfs_enable_slot(slot);
218 }
219 
220 static int disable_slot (struct hotplug_slot *hotplug_slot)
221 {
222 	struct slot *slot = get_slot(hotplug_slot);
223 
224 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
225 		 __func__, slot_name(slot));
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 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
236 		 __func__, slot_name(slot));
237 
238 	retval = slot->hpc_ops->get_power_status(slot, value);
239 	if (retval < 0)
240 		*value = hotplug_slot->info->power_status;
241 
242 	return 0;
243 }
244 
245 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
246 {
247 	struct slot *slot = get_slot(hotplug_slot);
248 	int retval;
249 
250 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
251 		 __func__, slot_name(slot));
252 
253 	retval = slot->hpc_ops->get_attention_status(slot, value);
254 	if (retval < 0)
255 		*value = hotplug_slot->info->attention_status;
256 
257 	return 0;
258 }
259 
260 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
261 {
262 	struct slot *slot = get_slot(hotplug_slot);
263 	int retval;
264 
265 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
266 		 __func__, slot_name(slot));
267 
268 	retval = slot->hpc_ops->get_latch_status(slot, value);
269 	if (retval < 0)
270 		*value = hotplug_slot->info->latch_status;
271 
272 	return 0;
273 }
274 
275 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
276 {
277 	struct slot *slot = get_slot(hotplug_slot);
278 	int retval;
279 
280 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
281 		 __func__, slot_name(slot));
282 
283 	retval = slot->hpc_ops->get_adapter_status(slot, value);
284 	if (retval < 0)
285 		*value = hotplug_slot->info->adapter_status;
286 
287 	return 0;
288 }
289 
290 static int is_shpc_capable(struct pci_dev *dev)
291 {
292 	if (dev->vendor == PCI_VENDOR_ID_AMD &&
293 	    dev->device == PCI_DEVICE_ID_AMD_GOLAM_7450)
294 		return 1;
295 	if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
296 		return 0;
297 	if (get_hp_hw_control_from_firmware(dev))
298 		return 0;
299 	return 1;
300 }
301 
302 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
303 {
304 	int rc;
305 	struct controller *ctrl;
306 
307 	if (!is_shpc_capable(pdev))
308 		return -ENODEV;
309 
310 	ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
311 	if (!ctrl) {
312 		dev_err(&pdev->dev, "%s: Out of memory\n", __func__);
313 		goto err_out_none;
314 	}
315 	INIT_LIST_HEAD(&ctrl->slot_list);
316 
317 	rc = shpc_init(ctrl, pdev);
318 	if (rc) {
319 		ctrl_dbg(ctrl, "Controller initialization failed\n");
320 		goto err_out_free_ctrl;
321 	}
322 
323 	pci_set_drvdata(pdev, ctrl);
324 
325 	/* Setup the slot information structures */
326 	rc = init_slots(ctrl);
327 	if (rc) {
328 		ctrl_err(ctrl, "Slot initialization failed\n");
329 		goto err_out_release_ctlr;
330 	}
331 
332 	rc = shpchp_create_ctrl_files(ctrl);
333 	if (rc)
334 		goto err_cleanup_slots;
335 
336 	return 0;
337 
338 err_cleanup_slots:
339 	cleanup_slots(ctrl);
340 err_out_release_ctlr:
341 	ctrl->hpc_ops->release_ctlr(ctrl);
342 err_out_free_ctrl:
343 	kfree(ctrl);
344 err_out_none:
345 	return -ENODEV;
346 }
347 
348 static void shpc_remove(struct pci_dev *dev)
349 {
350 	struct controller *ctrl = pci_get_drvdata(dev);
351 
352 	shpchp_remove_ctrl_files(ctrl);
353 	ctrl->hpc_ops->release_ctlr(ctrl);
354 	kfree(ctrl);
355 }
356 
357 static struct pci_device_id shpcd_pci_tbl[] = {
358 	{PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
359 	{ /* end: all zeroes */ }
360 };
361 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
362 
363 static struct pci_driver shpc_driver = {
364 	.name =		SHPC_MODULE_NAME,
365 	.id_table =	shpcd_pci_tbl,
366 	.probe =	shpc_probe,
367 	.remove =	shpc_remove,
368 };
369 
370 static int __init shpcd_init(void)
371 {
372 	int retval;
373 
374 	retval = pci_register_driver(&shpc_driver);
375 	dbg("%s: pci_register_driver = %d\n", __func__, retval);
376 	info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
377 
378 	return retval;
379 }
380 
381 static void __exit shpcd_cleanup(void)
382 {
383 	dbg("unload_shpchpd()\n");
384 	pci_unregister_driver(&shpc_driver);
385 	info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
386 }
387 
388 module_init(shpcd_init);
389 module_exit(shpcd_cleanup);
390