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  */
release_slot(struct hotplug_slot * hotplug_slot)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 
init_slots(struct controller * ctrl)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 = -ENOMEM;
101 	int i;
102 
103 	for (i = 0; i < ctrl->num_slots; i++) {
104 		slot = kzalloc(sizeof(*slot), GFP_KERNEL);
105 		if (!slot)
106 			goto error;
107 
108 		hotplug_slot = kzalloc(sizeof(*hotplug_slot), GFP_KERNEL);
109 		if (!hotplug_slot)
110 			goto error_slot;
111 		slot->hotplug_slot = hotplug_slot;
112 
113 		info = kzalloc(sizeof(*info), GFP_KERNEL);
114 		if (!info)
115 			goto error_hpslot;
116 		hotplug_slot->info = info;
117 
118 		slot->hp_slot = i;
119 		slot->ctrl = ctrl;
120 		slot->bus = ctrl->pci_dev->subordinate->number;
121 		slot->device = ctrl->slot_device_offset + i;
122 		slot->hpc_ops = ctrl->hpc_ops;
123 		slot->number = ctrl->first_slot + (ctrl->slot_num_inc * i);
124 
125 		snprintf(name, sizeof(name), "shpchp-%d", slot->number);
126 		slot->wq = alloc_workqueue(name, 0, 0);
127 		if (!slot->wq) {
128 			retval = -ENOMEM;
129 			goto error_info;
130 		}
131 
132 		mutex_init(&slot->lock);
133 		INIT_DELAYED_WORK(&slot->work, shpchp_queue_pushbutton_work);
134 
135 		/* register this slot with the hotplug pci core */
136 		hotplug_slot->private = slot;
137 		hotplug_slot->release = &release_slot;
138 		snprintf(name, SLOT_NAME_SIZE, "%d", slot->number);
139 		hotplug_slot->ops = &shpchp_hotplug_slot_ops;
140 
141  		ctrl_dbg(ctrl, "Registering domain:bus:dev=%04x:%02x:%02x "
142  			 "hp_slot=%x sun=%x slot_device_offset=%x\n",
143  			 pci_domain_nr(ctrl->pci_dev->subordinate),
144  			 slot->bus, slot->device, slot->hp_slot, slot->number,
145  			 ctrl->slot_device_offset);
146 		retval = pci_hp_register(slot->hotplug_slot,
147 				ctrl->pci_dev->subordinate, slot->device, name);
148 		if (retval) {
149 			ctrl_err(ctrl, "pci_hp_register failed with error %d\n",
150 				 retval);
151 			goto error_slotwq;
152 		}
153 
154 		get_power_status(hotplug_slot, &info->power_status);
155 		get_attention_status(hotplug_slot, &info->attention_status);
156 		get_latch_status(hotplug_slot, &info->latch_status);
157 		get_adapter_status(hotplug_slot, &info->adapter_status);
158 
159 		list_add(&slot->slot_list, &ctrl->slot_list);
160 	}
161 
162 	return 0;
163 error_slotwq:
164 	destroy_workqueue(slot->wq);
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 
cleanup_slots(struct controller * ctrl)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 		destroy_workqueue(slot->wq);
186 		pci_hp_deregister(slot->hotplug_slot);
187 	}
188 }
189 
190 /*
191  * set_attention_status - Turns the Amber LED for a slot on, off or blink
192  */
set_attention_status(struct hotplug_slot * hotplug_slot,u8 status)193 static int set_attention_status (struct hotplug_slot *hotplug_slot, u8 status)
194 {
195 	struct slot *slot = get_slot(hotplug_slot);
196 
197 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
198 		 __func__, slot_name(slot));
199 
200 	hotplug_slot->info->attention_status = status;
201 	slot->hpc_ops->set_attention_status(slot, status);
202 
203 	return 0;
204 }
205 
enable_slot(struct hotplug_slot * hotplug_slot)206 static int enable_slot (struct hotplug_slot *hotplug_slot)
207 {
208 	struct slot *slot = get_slot(hotplug_slot);
209 
210 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
211 		 __func__, slot_name(slot));
212 
213 	return shpchp_sysfs_enable_slot(slot);
214 }
215 
disable_slot(struct hotplug_slot * hotplug_slot)216 static int disable_slot (struct hotplug_slot *hotplug_slot)
217 {
218 	struct slot *slot = get_slot(hotplug_slot);
219 
220 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
221 		 __func__, slot_name(slot));
222 
223 	return shpchp_sysfs_disable_slot(slot);
224 }
225 
get_power_status(struct hotplug_slot * hotplug_slot,u8 * value)226 static int get_power_status (struct hotplug_slot *hotplug_slot, u8 *value)
227 {
228 	struct slot *slot = get_slot(hotplug_slot);
229 	int retval;
230 
231 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
232 		 __func__, slot_name(slot));
233 
234 	retval = slot->hpc_ops->get_power_status(slot, value);
235 	if (retval < 0)
236 		*value = hotplug_slot->info->power_status;
237 
238 	return 0;
239 }
240 
get_attention_status(struct hotplug_slot * hotplug_slot,u8 * value)241 static int get_attention_status (struct hotplug_slot *hotplug_slot, u8 *value)
242 {
243 	struct slot *slot = get_slot(hotplug_slot);
244 	int retval;
245 
246 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
247 		 __func__, slot_name(slot));
248 
249 	retval = slot->hpc_ops->get_attention_status(slot, value);
250 	if (retval < 0)
251 		*value = hotplug_slot->info->attention_status;
252 
253 	return 0;
254 }
255 
get_latch_status(struct hotplug_slot * hotplug_slot,u8 * value)256 static int get_latch_status (struct hotplug_slot *hotplug_slot, u8 *value)
257 {
258 	struct slot *slot = get_slot(hotplug_slot);
259 	int retval;
260 
261 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
262 		 __func__, slot_name(slot));
263 
264 	retval = slot->hpc_ops->get_latch_status(slot, value);
265 	if (retval < 0)
266 		*value = hotplug_slot->info->latch_status;
267 
268 	return 0;
269 }
270 
get_adapter_status(struct hotplug_slot * hotplug_slot,u8 * value)271 static int get_adapter_status (struct hotplug_slot *hotplug_slot, u8 *value)
272 {
273 	struct slot *slot = get_slot(hotplug_slot);
274 	int retval;
275 
276 	ctrl_dbg(slot->ctrl, "%s: physical_slot = %s\n",
277 		 __func__, slot_name(slot));
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 
is_shpc_capable(struct pci_dev * dev)286 static int is_shpc_capable(struct pci_dev *dev)
287 {
288 	if (dev->vendor == PCI_VENDOR_ID_AMD &&
289 	    dev->device == PCI_DEVICE_ID_AMD_GOLAM_7450)
290 		return 1;
291 	if (!pci_find_capability(dev, PCI_CAP_ID_SHPC))
292 		return 0;
293 	if (get_hp_hw_control_from_firmware(dev))
294 		return 0;
295 	return 1;
296 }
297 
shpc_probe(struct pci_dev * pdev,const struct pci_device_id * ent)298 static int shpc_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
299 {
300 	int rc;
301 	struct controller *ctrl;
302 
303 	if (!is_shpc_capable(pdev))
304 		return -ENODEV;
305 
306 	ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
307 	if (!ctrl) {
308 		dev_err(&pdev->dev, "%s: Out of memory\n", __func__);
309 		goto err_out_none;
310 	}
311 	INIT_LIST_HEAD(&ctrl->slot_list);
312 
313 	rc = shpc_init(ctrl, pdev);
314 	if (rc) {
315 		ctrl_dbg(ctrl, "Controller initialization failed\n");
316 		goto err_out_free_ctrl;
317 	}
318 
319 	pci_set_drvdata(pdev, ctrl);
320 
321 	/* Setup the slot information structures */
322 	rc = init_slots(ctrl);
323 	if (rc) {
324 		ctrl_err(ctrl, "Slot initialization failed\n");
325 		goto err_out_release_ctlr;
326 	}
327 
328 	rc = shpchp_create_ctrl_files(ctrl);
329 	if (rc)
330 		goto err_cleanup_slots;
331 
332 	return 0;
333 
334 err_cleanup_slots:
335 	cleanup_slots(ctrl);
336 err_out_release_ctlr:
337 	ctrl->hpc_ops->release_ctlr(ctrl);
338 err_out_free_ctrl:
339 	kfree(ctrl);
340 err_out_none:
341 	return -ENODEV;
342 }
343 
shpc_remove(struct pci_dev * dev)344 static void shpc_remove(struct pci_dev *dev)
345 {
346 	struct controller *ctrl = pci_get_drvdata(dev);
347 
348 	shpchp_remove_ctrl_files(ctrl);
349 	ctrl->hpc_ops->release_ctlr(ctrl);
350 	kfree(ctrl);
351 }
352 
353 static struct pci_device_id shpcd_pci_tbl[] = {
354 	{PCI_DEVICE_CLASS(((PCI_CLASS_BRIDGE_PCI << 8) | 0x00), ~0)},
355 	{ /* end: all zeroes */ }
356 };
357 MODULE_DEVICE_TABLE(pci, shpcd_pci_tbl);
358 
359 static struct pci_driver shpc_driver = {
360 	.name =		SHPC_MODULE_NAME,
361 	.id_table =	shpcd_pci_tbl,
362 	.probe =	shpc_probe,
363 	.remove =	shpc_remove,
364 };
365 
shpcd_init(void)366 static int __init shpcd_init(void)
367 {
368 	int retval;
369 
370 	retval = pci_register_driver(&shpc_driver);
371 	dbg("%s: pci_register_driver = %d\n", __func__, retval);
372 	info(DRIVER_DESC " version: " DRIVER_VERSION "\n");
373 
374 	return retval;
375 }
376 
shpcd_cleanup(void)377 static void __exit shpcd_cleanup(void)
378 {
379 	dbg("unload_shpchpd()\n");
380 	pci_unregister_driver(&shpc_driver);
381 	info(DRIVER_DESC " version: " DRIVER_VERSION " unloaded\n");
382 }
383 
384 module_init(shpcd_init);
385 module_exit(shpcd_cleanup);
386