Commit | Line | Data |
---|---|---|
7328c8f4 | 1 | // SPDX-License-Identifier: GPL-2.0 |
f46753c5 | 2 | /* |
f46753c5 | 3 | * Copyright (C) 2006 Matthew Wilcox <matthew@wil.cx> |
62795041 AC |
4 | * Copyright (C) 2006-2009 Hewlett-Packard Development Company, L.P. |
5 | * Alex Chiang <achiang@hp.com> | |
f46753c5 AC |
6 | */ |
7 | ||
8 | #include <linux/kobject.h> | |
5a0e3ad6 | 9 | #include <linux/slab.h> |
eefa9cfc | 10 | #include <linux/module.h> |
f46753c5 AC |
11 | #include <linux/pci.h> |
12 | #include <linux/err.h> | |
13 | #include "pci.h" | |
14 | ||
15 | struct kset *pci_slots_kset; | |
16 | EXPORT_SYMBOL_GPL(pci_slots_kset); | |
67546762 | 17 | static DEFINE_MUTEX(pci_slot_mutex); |
f46753c5 AC |
18 | |
19 | static ssize_t pci_slot_attr_show(struct kobject *kobj, | |
20 | struct attribute *attr, char *buf) | |
21 | { | |
22 | struct pci_slot *slot = to_pci_slot(kobj); | |
23 | struct pci_slot_attribute *attribute = to_pci_slot_attr(attr); | |
24 | return attribute->show ? attribute->show(slot, buf) : -EIO; | |
25 | } | |
26 | ||
27 | static ssize_t pci_slot_attr_store(struct kobject *kobj, | |
28 | struct attribute *attr, const char *buf, size_t len) | |
29 | { | |
30 | struct pci_slot *slot = to_pci_slot(kobj); | |
31 | struct pci_slot_attribute *attribute = to_pci_slot_attr(attr); | |
32 | return attribute->store ? attribute->store(slot, buf, len) : -EIO; | |
33 | } | |
34 | ||
52cf25d0 | 35 | static const struct sysfs_ops pci_slot_sysfs_ops = { |
f46753c5 AC |
36 | .show = pci_slot_attr_show, |
37 | .store = pci_slot_attr_store, | |
38 | }; | |
39 | ||
40 | static ssize_t address_read_file(struct pci_slot *slot, char *buf) | |
41 | { | |
42 | if (slot->number == 0xff) | |
43 | return sprintf(buf, "%04x:%02x\n", | |
44 | pci_domain_nr(slot->bus), | |
45 | slot->bus->number); | |
46 | else | |
47 | return sprintf(buf, "%04x:%02x:%02x\n", | |
48 | pci_domain_nr(slot->bus), | |
49 | slot->bus->number, | |
50 | slot->number); | |
51 | } | |
52 | ||
3749c51a | 53 | /* these strings match up with the values in pci_bus_speed */ |
17134d96 | 54 | static const char *pci_bus_speed_strings[] = { |
3749c51a MW |
55 | "33 MHz PCI", /* 0x00 */ |
56 | "66 MHz PCI", /* 0x01 */ | |
f7625980 | 57 | "66 MHz PCI-X", /* 0x02 */ |
3749c51a MW |
58 | "100 MHz PCI-X", /* 0x03 */ |
59 | "133 MHz PCI-X", /* 0x04 */ | |
60 | NULL, /* 0x05 */ | |
61 | NULL, /* 0x06 */ | |
62 | NULL, /* 0x07 */ | |
63 | NULL, /* 0x08 */ | |
64 | "66 MHz PCI-X 266", /* 0x09 */ | |
65 | "100 MHz PCI-X 266", /* 0x0a */ | |
66 | "133 MHz PCI-X 266", /* 0x0b */ | |
45b4cdd5 MW |
67 | "Unknown AGP", /* 0x0c */ |
68 | "1x AGP", /* 0x0d */ | |
69 | "2x AGP", /* 0x0e */ | |
70 | "4x AGP", /* 0x0f */ | |
71 | "8x AGP", /* 0x10 */ | |
3749c51a MW |
72 | "66 MHz PCI-X 533", /* 0x11 */ |
73 | "100 MHz PCI-X 533", /* 0x12 */ | |
74 | "133 MHz PCI-X 533", /* 0x13 */ | |
75 | "2.5 GT/s PCIe", /* 0x14 */ | |
76 | "5.0 GT/s PCIe", /* 0x15 */ | |
9dfd97fe | 77 | "8.0 GT/s PCIe", /* 0x16 */ |
1acfb9b7 | 78 | "16.0 GT/s PCIe", /* 0x17 */ |
3749c51a MW |
79 | }; |
80 | ||
81 | static ssize_t bus_speed_read(enum pci_bus_speed speed, char *buf) | |
82 | { | |
83 | const char *speed_string; | |
84 | ||
85 | if (speed < ARRAY_SIZE(pci_bus_speed_strings)) | |
86 | speed_string = pci_bus_speed_strings[speed]; | |
87 | else | |
88 | speed_string = "Unknown"; | |
89 | ||
90 | return sprintf(buf, "%s\n", speed_string); | |
91 | } | |
92 | ||
93 | static ssize_t max_speed_read_file(struct pci_slot *slot, char *buf) | |
94 | { | |
95 | return bus_speed_read(slot->bus->max_bus_speed, buf); | |
96 | } | |
97 | ||
98 | static ssize_t cur_speed_read_file(struct pci_slot *slot, char *buf) | |
99 | { | |
100 | return bus_speed_read(slot->bus->cur_bus_speed, buf); | |
101 | } | |
102 | ||
f46753c5 AC |
103 | static void pci_slot_release(struct kobject *kobj) |
104 | { | |
cef354db | 105 | struct pci_dev *dev; |
f46753c5 AC |
106 | struct pci_slot *slot = to_pci_slot(kobj); |
107 | ||
62795041 AC |
108 | dev_dbg(&slot->bus->dev, "dev %02x, released physical slot %s\n", |
109 | slot->number, pci_slot_name(slot)); | |
f46753c5 | 110 | |
67546762 | 111 | down_read(&pci_bus_sem); |
cef354db AC |
112 | list_for_each_entry(dev, &slot->bus->devices, bus_list) |
113 | if (PCI_SLOT(dev->devfn) == slot->number) | |
114 | dev->slot = NULL; | |
67546762 | 115 | up_read(&pci_bus_sem); |
cef354db | 116 | |
f46753c5 AC |
117 | list_del(&slot->list); |
118 | ||
119 | kfree(slot); | |
120 | } | |
121 | ||
122 | static struct pci_slot_attribute pci_slot_attr_address = | |
58f86cc8 | 123 | __ATTR(address, S_IRUGO, address_read_file, NULL); |
3749c51a | 124 | static struct pci_slot_attribute pci_slot_attr_max_speed = |
58f86cc8 | 125 | __ATTR(max_bus_speed, S_IRUGO, max_speed_read_file, NULL); |
3749c51a | 126 | static struct pci_slot_attribute pci_slot_attr_cur_speed = |
58f86cc8 | 127 | __ATTR(cur_bus_speed, S_IRUGO, cur_speed_read_file, NULL); |
f46753c5 AC |
128 | |
129 | static struct attribute *pci_slot_default_attrs[] = { | |
130 | &pci_slot_attr_address.attr, | |
3749c51a MW |
131 | &pci_slot_attr_max_speed.attr, |
132 | &pci_slot_attr_cur_speed.attr, | |
f46753c5 AC |
133 | NULL, |
134 | }; | |
135 | ||
136 | static struct kobj_type pci_slot_ktype = { | |
137 | .sysfs_ops = &pci_slot_sysfs_ops, | |
138 | .release = &pci_slot_release, | |
139 | .default_attrs = pci_slot_default_attrs, | |
140 | }; | |
141 | ||
5fe6cc60 AC |
142 | static char *make_slot_name(const char *name) |
143 | { | |
144 | char *new_name; | |
145 | int len, max, dup; | |
146 | ||
147 | new_name = kstrdup(name, GFP_KERNEL); | |
148 | if (!new_name) | |
149 | return NULL; | |
150 | ||
151 | /* | |
152 | * Make sure we hit the realloc case the first time through the | |
153 | * loop. 'len' will be strlen(name) + 3 at that point which is | |
154 | * enough space for "name-X" and the trailing NUL. | |
155 | */ | |
156 | len = strlen(name) + 2; | |
157 | max = 1; | |
158 | dup = 1; | |
159 | ||
160 | for (;;) { | |
161 | struct kobject *dup_slot; | |
162 | dup_slot = kset_find_obj(pci_slots_kset, new_name); | |
163 | if (!dup_slot) | |
164 | break; | |
165 | kobject_put(dup_slot); | |
166 | if (dup == max) { | |
167 | len++; | |
168 | max *= 10; | |
169 | kfree(new_name); | |
170 | new_name = kmalloc(len, GFP_KERNEL); | |
171 | if (!new_name) | |
172 | break; | |
173 | } | |
174 | sprintf(new_name, "%s-%d", name, dup++); | |
175 | } | |
176 | ||
177 | return new_name; | |
178 | } | |
179 | ||
180 | static int rename_slot(struct pci_slot *slot, const char *name) | |
181 | { | |
182 | int result = 0; | |
183 | char *slot_name; | |
184 | ||
0ad772ec | 185 | if (strcmp(pci_slot_name(slot), name) == 0) |
5fe6cc60 AC |
186 | return result; |
187 | ||
188 | slot_name = make_slot_name(name); | |
189 | if (!slot_name) | |
190 | return -ENOMEM; | |
191 | ||
192 | result = kobject_rename(&slot->kobj, slot_name); | |
193 | kfree(slot_name); | |
194 | ||
195 | return result; | |
196 | } | |
197 | ||
017ffe64 YW |
198 | void pci_dev_assign_slot(struct pci_dev *dev) |
199 | { | |
200 | struct pci_slot *slot; | |
201 | ||
202 | mutex_lock(&pci_slot_mutex); | |
203 | list_for_each_entry(slot, &dev->bus->slots, list) | |
204 | if (PCI_SLOT(dev->devfn) == slot->number) | |
205 | dev->slot = slot; | |
206 | mutex_unlock(&pci_slot_mutex); | |
207 | } | |
208 | ||
5fe6cc60 AC |
209 | static struct pci_slot *get_slot(struct pci_bus *parent, int slot_nr) |
210 | { | |
211 | struct pci_slot *slot; | |
67546762 YW |
212 | |
213 | /* We already hold pci_slot_mutex */ | |
5fe6cc60 AC |
214 | list_for_each_entry(slot, &parent->slots, list) |
215 | if (slot->number == slot_nr) { | |
216 | kobject_get(&slot->kobj); | |
217 | return slot; | |
218 | } | |
219 | ||
220 | return NULL; | |
221 | } | |
222 | ||
f46753c5 AC |
223 | /** |
224 | * pci_create_slot - create or increment refcount for physical PCI slot | |
225 | * @parent: struct pci_bus of parent bridge | |
226 | * @slot_nr: PCI_SLOT(pci_dev->devfn) or -1 for placeholder | |
227 | * @name: user visible string presented in /sys/bus/pci/slots/<name> | |
828f3768 | 228 | * @hotplug: set if caller is hotplug driver, NULL otherwise |
f46753c5 AC |
229 | * |
230 | * PCI slots have first class attributes such as address, speed, width, | |
231 | * and a &struct pci_slot is used to manage them. This interface will | |
232 | * either return a new &struct pci_slot to the caller, or if the pci_slot | |
233 | * already exists, its refcount will be incremented. | |
234 | * | |
5fe6cc60 AC |
235 | * Slots are uniquely identified by a @pci_bus, @slot_nr tuple. |
236 | * | |
237 | * There are known platforms with broken firmware that assign the same | |
238 | * name to multiple slots. Workaround these broken platforms by renaming | |
239 | * the slots on behalf of the caller. If firmware assigns name N to | |
240 | * multiple slots: | |
241 | * | |
242 | * The first slot is assigned N | |
243 | * The second slot is assigned N-1 | |
244 | * The third slot is assigned N-2 | |
245 | * etc. | |
f46753c5 AC |
246 | * |
247 | * Placeholder slots: | |
248 | * In most cases, @pci_bus, @slot_nr will be sufficient to uniquely identify | |
249 | * a slot. There is one notable exception - pSeries (rpaphp), where the | |
250 | * @slot_nr cannot be determined until a device is actually inserted into | |
251 | * the slot. In this scenario, the caller may pass -1 for @slot_nr. | |
252 | * | |
253 | * The following semantics are imposed when the caller passes @slot_nr == | |
5fe6cc60 AC |
254 | * -1. First, we no longer check for an existing %struct pci_slot, as there |
255 | * may be many slots with @slot_nr of -1. The other change in semantics is | |
f46753c5 AC |
256 | * user-visible, which is the 'address' parameter presented in sysfs will |
257 | * consist solely of a dddd:bb tuple, where dddd is the PCI domain of the | |
258 | * %struct pci_bus and bb is the bus number. In other words, the devfn of | |
259 | * the 'placeholder' slot will not be displayed. | |
260 | */ | |
f46753c5 | 261 | struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr, |
828f3768 AC |
262 | const char *name, |
263 | struct hotplug_slot *hotplug) | |
f46753c5 | 264 | { |
cef354db | 265 | struct pci_dev *dev; |
f46753c5 | 266 | struct pci_slot *slot; |
5fe6cc60 AC |
267 | int err = 0; |
268 | char *slot_name = NULL; | |
f46753c5 | 269 | |
67546762 | 270 | mutex_lock(&pci_slot_mutex); |
f46753c5 AC |
271 | |
272 | if (slot_nr == -1) | |
273 | goto placeholder; | |
274 | ||
5fe6cc60 AC |
275 | /* |
276 | * Hotplug drivers are allowed to rename an existing slot, | |
277 | * but only if not already claimed. | |
278 | */ | |
279 | slot = get_slot(parent, slot_nr); | |
280 | if (slot) { | |
281 | if (hotplug) { | |
282 | if ((err = slot->hotplug ? -EBUSY : 0) | |
283 | || (err = rename_slot(slot, name))) { | |
284 | kobject_put(&slot->kobj); | |
285 | slot = NULL; | |
286 | goto err; | |
287 | } | |
f46753c5 | 288 | } |
5fe6cc60 | 289 | goto out; |
f46753c5 AC |
290 | } |
291 | ||
292 | placeholder: | |
293 | slot = kzalloc(sizeof(*slot), GFP_KERNEL); | |
294 | if (!slot) { | |
5fe6cc60 AC |
295 | err = -ENOMEM; |
296 | goto err; | |
f46753c5 AC |
297 | } |
298 | ||
299 | slot->bus = parent; | |
300 | slot->number = slot_nr; | |
301 | ||
302 | slot->kobj.kset = pci_slots_kset; | |
5fe6cc60 AC |
303 | |
304 | slot_name = make_slot_name(name); | |
305 | if (!slot_name) { | |
306 | err = -ENOMEM; | |
f46753c5 AC |
307 | goto err; |
308 | } | |
309 | ||
5fe6cc60 AC |
310 | err = kobject_init_and_add(&slot->kobj, &pci_slot_ktype, NULL, |
311 | "%s", slot_name); | |
312 | if (err) | |
313 | goto err; | |
314 | ||
f46753c5 AC |
315 | INIT_LIST_HEAD(&slot->list); |
316 | list_add(&slot->list, &parent->slots); | |
317 | ||
67546762 | 318 | down_read(&pci_bus_sem); |
cef354db AC |
319 | list_for_each_entry(dev, &parent->devices, bus_list) |
320 | if (PCI_SLOT(dev->devfn) == slot_nr) | |
321 | dev->slot = slot; | |
67546762 | 322 | up_read(&pci_bus_sem); |
cef354db | 323 | |
62795041 AC |
324 | dev_dbg(&parent->dev, "dev %02x, created physical slot %s\n", |
325 | slot_nr, pci_slot_name(slot)); | |
f46753c5 | 326 | |
5fe6cc60 | 327 | out: |
3b5dd45e | 328 | kfree(slot_name); |
67546762 | 329 | mutex_unlock(&pci_slot_mutex); |
f46753c5 | 330 | return slot; |
5fe6cc60 | 331 | err: |
f46753c5 AC |
332 | kfree(slot); |
333 | slot = ERR_PTR(err); | |
334 | goto out; | |
335 | } | |
336 | EXPORT_SYMBOL_GPL(pci_create_slot); | |
337 | ||
f46753c5 AC |
338 | /** |
339 | * pci_destroy_slot - decrement refcount for physical PCI slot | |
340 | * @slot: struct pci_slot to decrement | |
341 | * | |
342 | * %struct pci_slot is refcounted, so destroying them is really easy; we | |
343 | * just call kobject_put on its kobj and let our release methods do the | |
344 | * rest. | |
345 | */ | |
f46753c5 AC |
346 | void pci_destroy_slot(struct pci_slot *slot) |
347 | { | |
62795041 | 348 | dev_dbg(&slot->bus->dev, "dev %02x, dec refcount to %d\n", |
2c935bc5 | 349 | slot->number, kref_read(&slot->kobj.kref) - 1); |
f46753c5 | 350 | |
67546762 | 351 | mutex_lock(&pci_slot_mutex); |
f46753c5 | 352 | kobject_put(&slot->kobj); |
67546762 | 353 | mutex_unlock(&pci_slot_mutex); |
f46753c5 AC |
354 | } |
355 | EXPORT_SYMBOL_GPL(pci_destroy_slot); | |
356 | ||
c825bc94 KK |
357 | #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE) |
358 | #include <linux/pci_hotplug.h> | |
359 | /** | |
360 | * pci_hp_create_link - create symbolic link to the hotplug driver module. | |
503998ca | 361 | * @pci_slot: struct pci_slot |
c825bc94 KK |
362 | * |
363 | * Helper function for pci_hotplug_core.c to create symbolic link to | |
364 | * the hotplug driver module. | |
365 | */ | |
366 | void pci_hp_create_module_link(struct pci_slot *pci_slot) | |
367 | { | |
368 | struct hotplug_slot *slot = pci_slot->hotplug; | |
369 | struct kobject *kobj = NULL; | |
9fc9eea0 | 370 | int ret; |
c825bc94 KK |
371 | |
372 | if (!slot || !slot->ops) | |
373 | return; | |
374 | kobj = kset_find_obj(module_kset, slot->ops->mod_name); | |
375 | if (!kobj) | |
376 | return; | |
9fc9eea0 BH |
377 | ret = sysfs_create_link(&pci_slot->kobj, kobj, "module"); |
378 | if (ret) | |
379 | dev_err(&pci_slot->bus->dev, "Error creating sysfs link (%d)\n", | |
380 | ret); | |
c825bc94 KK |
381 | kobject_put(kobj); |
382 | } | |
383 | EXPORT_SYMBOL_GPL(pci_hp_create_module_link); | |
384 | ||
385 | /** | |
386 | * pci_hp_remove_link - remove symbolic link to the hotplug driver module. | |
503998ca | 387 | * @pci_slot: struct pci_slot |
c825bc94 KK |
388 | * |
389 | * Helper function for pci_hotplug_core.c to remove symbolic link to | |
390 | * the hotplug driver module. | |
391 | */ | |
392 | void pci_hp_remove_module_link(struct pci_slot *pci_slot) | |
393 | { | |
394 | sysfs_remove_link(&pci_slot->kobj, "module"); | |
395 | } | |
396 | EXPORT_SYMBOL_GPL(pci_hp_remove_module_link); | |
397 | #endif | |
398 | ||
f46753c5 AC |
399 | static int pci_slot_init(void) |
400 | { | |
401 | struct kset *pci_bus_kset; | |
402 | ||
403 | pci_bus_kset = bus_get_kset(&pci_bus_type); | |
404 | pci_slots_kset = kset_create_and_add("slots", NULL, | |
405 | &pci_bus_kset->kobj); | |
406 | if (!pci_slots_kset) { | |
407 | printk(KERN_ERR "PCI: Slot initialization failure\n"); | |
408 | return -ENOMEM; | |
409 | } | |
410 | return 0; | |
411 | } | |
412 | ||
413 | subsys_initcall(pci_slot_init); |