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