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 slot *slot, *next;
182 
183 	list_for_each_entry_safe(slot, next, &ctrl->slot_list, slot_list) {
184 		list_del(&slot->slot_list);
185 		cancel_delayed_work(&slot->work);
186 		destroy_workqueue(slot->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 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
199 		 __func__, slot_name(slot));
200 
201 	hotplug_slot->info->attention_status = status;
202 	slot->hpc_ops->set_attention_status(slot, status);
203 
204 	return 0;
205 }
206 
207 static int enable_slot(struct hotplug_slot *hotplug_slot)
208 {
209 	struct slot *slot = get_slot(hotplug_slot);
210 
211 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
212 		 __func__, slot_name(slot));
213 
214 	return shpchp_sysfs_enable_slot(slot);
215 }
216 
217 static int disable_slot(struct hotplug_slot *hotplug_slot)
218 {
219 	struct slot *slot = get_slot(hotplug_slot);
220 
221 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
222 		 __func__, slot_name(slot));
223 
224 	return shpchp_sysfs_disable_slot(slot);
225 }
226 
227 static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
228 {
229 	struct slot *slot = get_slot(hotplug_slot);
230 	int retval;
231 
232 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
233 		 __func__, slot_name(slot));
234 
235 	retval = slot->hpc_ops->get_power_status(slot, value);
236 	if (retval < 0)
237 		*value = hotplug_slot->info->power_status;
238 
239 	return 0;
240 }
241 
242 static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
243 {
244 	struct slot *slot = get_slot(hotplug_slot);
245 	int retval;
246 
247 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
248 		 __func__, slot_name(slot));
249 
250 	retval = slot->hpc_ops->get_attention_status(slot, value);
251 	if (retval < 0)
252 		*value = hotplug_slot->info->attention_status;
253 
254 	return 0;
255 }
256 
257 static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
258 {
259 	struct slot *slot = get_slot(hotplug_slot);
260 	int retval;
261 
262 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
263 		 __func__, slot_name(slot));
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 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
278 		 __func__, slot_name(slot));
279 
280 	retval = slot->hpc_ops->get_adapter_status(slot, value);
281 	if (retval < 0)
282 		*value = hotplug_slot->info->adapter_status;
283 
284 	return 0;
285 }
286 
287 static int is_shpc_capable(struct pci_dev *dev)
288 {
289 	if (dev->vendor == PCI_VENDOR_ID_AMD &&
290 	    dev->device == PCI_DEVICE_ID_AMD_GOLAM_7450)
291 		return 1;
292 	if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
293 		return 0;
294 	if (get_hp_hw_control_from_firmware(dev))
295 		return 0;
296 	return 1;
297 }
298 
299 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
300 {
301 	int rc;
302 	struct controller *ctrl;
303 
304 	if (!is_shpc_capable(pdev))
305 		return -ENODEV;
306 
307 	ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
308 	if (!ctrl) {
309 		dev_err(&pdev->dev, "%s: Out of memory\n", __func__);
310 		goto err_out_none;
311 	}
312 	INIT_LIST_HEAD(&ctrl->slot_list);
313 
314 	rc = shpc_init(ctrl, pdev);
315 	if (rc) {
316 		ctrl_dbg(ctrl, "Controller initialization failed\n");
317 		goto err_out_free_ctrl;
318 	}
319 
320 	pci_set_drvdata(pdev, ctrl);
321 
322 	/* Setup the slot information structures */
323 	rc = init_slots(ctrl);
324 	if (rc) {
325 		ctrl_err(ctrl, "Slot initialization failed\n");
326 		goto err_out_release_ctlr;
327 	}
328 
329 	rc = shpchp_create_ctrl_files(ctrl);
330 	if (rc)
331 		goto err_cleanup_slots;
332 
333 	return 0;
334 
335 err_cleanup_slots:
336 	cleanup_slots(ctrl);
337 err_out_release_ctlr:
338 	ctrl->hpc_ops->release_ctlr(ctrl);
339 err_out_free_ctrl:
340 	kfree(ctrl);
341 err_out_none:
342 	return -ENODEV;
343 }
344 
345 static void shpc_remove(struct pci_dev *dev)
346 {
347 	struct controller *ctrl = pci_get_drvdata(dev);
348 
349 	shpchp_remove_ctrl_files(ctrl);
350 	ctrl->hpc_ops->release_ctlr(ctrl);
351 	kfree(ctrl);
352 }
353 
354 static const struct pci_device_id shpcd_pci_tbl[] = {
355 	{PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
356 	{ /* end: all zeroes */ }
357 };
358 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
359 
360 static struct pci_driver shpc_driver = {
361 	.name =		SHPC_MODULE_NAME,
362 	.id_table =	shpcd_pci_tbl,
363 	.probe =	shpc_probe,
364 	.remove =	shpc_remove,
365 };
366 
367 static int __init shpcd_init(void)
368 {
369 	int retval;
370 
371 	retval = pci_register_driver(&shpc_driver);
372 	dbg("%s: pci_register_driver = %d\n", __func__, retval);
373 	info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
374 
375 	return retval;
376 }
377 
378 static void __exit shpcd_cleanup(void)
379 {
380 	dbg("unload_shpchpd()\n");
381 	pci_unregister_driver(&shpc_driver);
382 	info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
383 }
384 
385 module_init(shpcd_init);
386 module_exit(shpcd_cleanup);
387