slot.c 9.7 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
A
Alex Chiang 已提交
2 3
/*
 * Copyright (C) 2006 Matthew Wilcox <matthew@wil.cx>
4 5
 * Copyright (C) 2006-2009 Hewlett-Packard Development Company, L.P.
 *	Alex Chiang <achiang@hp.com>
A
Alex Chiang 已提交
6 7 8
 */

#include <linux/kobject.h>
9
#include <linux/slab.h>
10
#include <linux/module.h>
A
Alex Chiang 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
#include <linux/pci.h>
#include <linux/err.h>
#include "pci.h"

struct kset *pci_slots_kset;
EXPORT_SYMBOL_GPL(pci_slots_kset);

static ssize_t pci_slot_attr_show(struct kobject *kobj,
					struct attribute *attr, char *buf)
{
	struct pci_slot *slot = to_pci_slot(kobj);
	struct pci_slot_attribute *attribute = to_pci_slot_attr(attr);
	return attribute->show ? attribute->show(slot, buf) : -EIO;
}

static ssize_t pci_slot_attr_store(struct kobject *kobj,
			struct attribute *attr, const char *buf, size_t len)
{
	struct pci_slot *slot = to_pci_slot(kobj);
	struct pci_slot_attribute *attribute = to_pci_slot_attr(attr);
	return attribute->store ? attribute->store(slot, buf, len) : -EIO;
}

34
static const struct sysfs_ops pci_slot_sysfs_ops = {
A
Alex Chiang 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
	.show = pci_slot_attr_show,
	.store = pci_slot_attr_store,
};

static ssize_t address_read_file(struct pci_slot *slot, char *buf)
{
	if (slot->number == 0xff)
		return sprintf(buf, "%04x:%02x\n",
				pci_domain_nr(slot->bus),
				slot->bus->number);
	else
		return sprintf(buf, "%04x:%02x:%02x\n",
				pci_domain_nr(slot->bus),
				slot->bus->number,
				slot->number);
}

52 53
static ssize_t bus_speed_read(enum pci_bus_speed speed, char *buf)
{
B
Bjorn Helgaas 已提交
54
	return sprintf(buf, "%s\n", pci_speed_string(speed));
55 56 57 58 59 60 61 62 63 64 65 66
}

static ssize_t max_speed_read_file(struct pci_slot *slot, char *buf)
{
	return bus_speed_read(slot->bus->max_bus_speed, buf);
}

static ssize_t cur_speed_read_file(struct pci_slot *slot, char *buf)
{
	return bus_speed_read(slot->bus->cur_bus_speed, buf);
}

A
Alex Chiang 已提交
67 68
static void pci_slot_release(struct kobject *kobj)
{
69
	struct pci_dev *dev;
A
Alex Chiang 已提交
70 71
	struct pci_slot *slot = to_pci_slot(kobj);

72 73
	dev_dbg(&slot->bus->dev, "dev %02x, released physical slot %s\n",
		slot->number, pci_slot_name(slot));
A
Alex Chiang 已提交
74

75
	down_read(&pci_bus_sem);
76 77 78
	list_for_each_entry(dev, &slot->bus->devices, bus_list)
		if (PCI_SLOT(dev->devfn) == slot->number)
			dev->slot = NULL;
79
	up_read(&pci_bus_sem);
80

A
Alex Chiang 已提交
81 82 83 84 85 86
	list_del(&slot->list);

	kfree(slot);
}

static struct pci_slot_attribute pci_slot_attr_address =
87
	__ATTR(address, S_IRUGO, address_read_file, NULL);
88
static struct pci_slot_attribute pci_slot_attr_max_speed =
89
	__ATTR(max_bus_speed, S_IRUGO, max_speed_read_file, NULL);
90
static struct pci_slot_attribute pci_slot_attr_cur_speed =
91
	__ATTR(cur_bus_speed, S_IRUGO, cur_speed_read_file, NULL);
A
Alex Chiang 已提交
92 93 94

static struct attribute *pci_slot_default_attrs[] = {
	&pci_slot_attr_address.attr,
95 96
	&pci_slot_attr_max_speed.attr,
	&pci_slot_attr_cur_speed.attr,
A
Alex Chiang 已提交
97 98 99 100 101 102 103 104 105
	NULL,
};

static struct kobj_type pci_slot_ktype = {
	.sysfs_ops = &pci_slot_sysfs_ops,
	.release = &pci_slot_release,
	.default_attrs = pci_slot_default_attrs,
};

A
Alex Chiang 已提交
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
static char *make_slot_name(const char *name)
{
	char *new_name;
	int len, max, dup;

	new_name = kstrdup(name, GFP_KERNEL);
	if (!new_name)
		return NULL;

	/*
	 * Make sure we hit the realloc case the first time through the
	 * loop.  'len' will be strlen(name) + 3 at that point which is
	 * enough space for "name-X" and the trailing NUL.
	 */
	len = strlen(name) + 2;
	max = 1;
	dup = 1;

	for (;;) {
		struct kobject *dup_slot;
		dup_slot = kset_find_obj(pci_slots_kset, new_name);
		if (!dup_slot)
			break;
		kobject_put(dup_slot);
		if (dup == max) {
			len++;
			max *= 10;
			kfree(new_name);
			new_name = kmalloc(len, GFP_KERNEL);
			if (!new_name)
				break;
		}
		sprintf(new_name, "%s-%d", name, dup++);
	}

	return new_name;
}

static int rename_slot(struct pci_slot *slot, const char *name)
{
	int result = 0;
	char *slot_name;

149
	if (strcmp(pci_slot_name(slot), name) == 0)
A
Alex Chiang 已提交
150 151 152 153 154 155 156 157 158 159 160 161
		return result;

	slot_name = make_slot_name(name);
	if (!slot_name)
		return -ENOMEM;

	result = kobject_rename(&slot->kobj, slot_name);
	kfree(slot_name);

	return result;
}

162 163 164 165 166 167 168 169 170 171 172
void pci_dev_assign_slot(struct pci_dev *dev)
{
	struct pci_slot *slot;

	mutex_lock(&pci_slot_mutex);
	list_for_each_entry(slot, &dev->bus->slots, list)
		if (PCI_SLOT(dev->devfn) == slot->number)
			dev->slot = slot;
	mutex_unlock(&pci_slot_mutex);
}

A
Alex Chiang 已提交
173 174 175
static struct pci_slot *get_slot(struct pci_bus *parent, int slot_nr)
{
	struct pci_slot *slot;
176 177

	/* We already hold pci_slot_mutex */
A
Alex Chiang 已提交
178 179 180 181 182 183 184 185 186
	list_for_each_entry(slot, &parent->slots, list)
		if (slot->number == slot_nr) {
			kobject_get(&slot->kobj);
			return slot;
		}

	return NULL;
}

A
Alex Chiang 已提交
187 188 189 190 191
/**
 * pci_create_slot - create or increment refcount for physical PCI slot
 * @parent: struct pci_bus of parent bridge
 * @slot_nr: PCI_SLOT(pci_dev->devfn) or -1 for placeholder
 * @name: user visible string presented in /sys/bus/pci/slots/<name>
192
 * @hotplug: set if caller is hotplug driver, NULL otherwise
A
Alex Chiang 已提交
193 194 195 196 197 198
 *
 * PCI slots have first class attributes such as address, speed, width,
 * and a &struct pci_slot is used to manage them. This interface will
 * either return a new &struct pci_slot to the caller, or if the pci_slot
 * already exists, its refcount will be incremented.
 *
A
Alex Chiang 已提交
199 200 201 202 203 204 205 206 207 208 209
 * Slots are uniquely identified by a @pci_bus, @slot_nr tuple.
 *
 * There are known platforms with broken firmware that assign the same
 * name to multiple slots. Workaround these broken platforms by renaming
 * the slots on behalf of the caller. If firmware assigns name N to
 * multiple slots:
 *
 * The first slot is assigned N
 * The second slot is assigned N-1
 * The third slot is assigned N-2
 * etc.
A
Alex Chiang 已提交
210 211 212 213 214 215 216 217
 *
 * Placeholder slots:
 * In most cases, @pci_bus, @slot_nr will be sufficient to uniquely identify
 * a slot. There is one notable exception - pSeries (rpaphp), where the
 * @slot_nr cannot be determined until a device is actually inserted into
 * the slot. In this scenario, the caller may pass -1 for @slot_nr.
 *
 * The following semantics are imposed when the caller passes @slot_nr ==
A
Alex Chiang 已提交
218 219
 * -1. First, we no longer check for an existing %struct pci_slot, as there
 * may be many slots with @slot_nr of -1.  The other change in semantics is
A
Alex Chiang 已提交
220 221 222 223 224 225
 * user-visible, which is the 'address' parameter presented in sysfs will
 * consist solely of a dddd:bb tuple, where dddd is the PCI domain of the
 * %struct pci_bus and bb is the bus number. In other words, the devfn of
 * the 'placeholder' slot will not be displayed.
 */
struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
226 227
				 const char *name,
				 struct hotplug_slot *hotplug)
A
Alex Chiang 已提交
228
{
229
	struct pci_dev *dev;
A
Alex Chiang 已提交
230
	struct pci_slot *slot;
A
Alex Chiang 已提交
231 232
	int err = 0;
	char *slot_name = NULL;
A
Alex Chiang 已提交
233

234
	mutex_lock(&pci_slot_mutex);
A
Alex Chiang 已提交
235 236 237 238

	if (slot_nr == -1)
		goto placeholder;

A
Alex Chiang 已提交
239 240 241 242 243 244 245 246 247 248 249 250 251
	/*
	 * Hotplug drivers are allowed to rename an existing slot,
	 * but only if not already claimed.
	 */
	slot = get_slot(parent, slot_nr);
	if (slot) {
		if (hotplug) {
			if ((err = slot->hotplug ? -EBUSY : 0)
			     || (err = rename_slot(slot, name))) {
				kobject_put(&slot->kobj);
				slot = NULL;
				goto err;
			}
A
Alex Chiang 已提交
252
		}
A
Alex Chiang 已提交
253
		goto out;
A
Alex Chiang 已提交
254 255 256 257 258
	}

placeholder:
	slot = kzalloc(sizeof(*slot), GFP_KERNEL);
	if (!slot) {
A
Alex Chiang 已提交
259 260
		err = -ENOMEM;
		goto err;
A
Alex Chiang 已提交
261 262 263 264 265 266
	}

	slot->bus = parent;
	slot->number = slot_nr;

	slot->kobj.kset = pci_slots_kset;
A
Alex Chiang 已提交
267 268 269 270

	slot_name = make_slot_name(name);
	if (!slot_name) {
		err = -ENOMEM;
271
		kfree(slot);
A
Alex Chiang 已提交
272 273 274
		goto err;
	}

275 276 277
	INIT_LIST_HEAD(&slot->list);
	list_add(&slot->list, &parent->slots);

A
Alex Chiang 已提交
278 279
	err = kobject_init_and_add(&slot->kobj, &pci_slot_ktype, NULL,
				   "%s", slot_name);
280 281
	if (err) {
		kobject_put(&slot->kobj);
A
Alex Chiang 已提交
282
		goto err;
283
	}
A
Alex Chiang 已提交
284

285
	down_read(&pci_bus_sem);
286 287 288
	list_for_each_entry(dev, &parent->devices, bus_list)
		if (PCI_SLOT(dev->devfn) == slot_nr)
			dev->slot = slot;
289
	up_read(&pci_bus_sem);
290

291 292
	dev_dbg(&parent->dev, "dev %02x, created physical slot %s\n",
		slot_nr, pci_slot_name(slot));
A
Alex Chiang 已提交
293

A
Alex Chiang 已提交
294
out:
295
	kfree(slot_name);
296
	mutex_unlock(&pci_slot_mutex);
A
Alex Chiang 已提交
297
	return slot;
A
Alex Chiang 已提交
298
err:
A
Alex Chiang 已提交
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
	slot = ERR_PTR(err);
	goto out;
}
EXPORT_SYMBOL_GPL(pci_create_slot);

/**
 * pci_destroy_slot - decrement refcount for physical PCI slot
 * @slot: struct pci_slot to decrement
 *
 * %struct pci_slot is refcounted, so destroying them is really easy; we
 * just call kobject_put on its kobj and let our release methods do the
 * rest.
 */
void pci_destroy_slot(struct pci_slot *slot)
{
314
	dev_dbg(&slot->bus->dev, "dev %02x, dec refcount to %d\n",
315
		slot->number, kref_read(&slot->kobj.kref) - 1);
A
Alex Chiang 已提交
316

317
	mutex_lock(&pci_slot_mutex);
A
Alex Chiang 已提交
318
	kobject_put(&slot->kobj);
319
	mutex_unlock(&pci_slot_mutex);
A
Alex Chiang 已提交
320 321 322
}
EXPORT_SYMBOL_GPL(pci_destroy_slot);

323 324 325
#if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
#include <linux/pci_hotplug.h>
/**
M
Mauro Carvalho Chehab 已提交
326
 * pci_hp_create_module_link - create symbolic link to hotplug driver module
R
Randy Dunlap 已提交
327
 * @pci_slot: struct pci_slot
328 329 330 331 332 333 334 335
 *
 * Helper function for pci_hotplug_core.c to create symbolic link to
 * the hotplug driver module.
 */
void pci_hp_create_module_link(struct pci_slot *pci_slot)
{
	struct hotplug_slot *slot = pci_slot->hotplug;
	struct kobject *kobj = NULL;
336
	int ret;
337 338 339

	if (!slot || !slot->ops)
		return;
340
	kobj = kset_find_obj(module_kset, slot->mod_name);
341 342
	if (!kobj)
		return;
343 344 345 346
	ret = sysfs_create_link(&pci_slot->kobj, kobj, "module");
	if (ret)
		dev_err(&pci_slot->bus->dev, "Error creating sysfs link (%d)\n",
			ret);
347 348 349 350 351
	kobject_put(kobj);
}
EXPORT_SYMBOL_GPL(pci_hp_create_module_link);

/**
M
Mauro Carvalho Chehab 已提交
352 353
 * pci_hp_remove_module_link - remove symbolic link to the hotplug driver
 * 	module.
R
Randy Dunlap 已提交
354
 * @pci_slot: struct pci_slot
355 356 357 358 359 360 361 362 363 364 365
 *
 * Helper function for pci_hotplug_core.c to remove symbolic link to
 * the hotplug driver module.
 */
void pci_hp_remove_module_link(struct pci_slot *pci_slot)
{
	sysfs_remove_link(&pci_slot->kobj, "module");
}
EXPORT_SYMBOL_GPL(pci_hp_remove_module_link);
#endif

A
Alex Chiang 已提交
366 367 368 369 370 371 372 373
static int pci_slot_init(void)
{
	struct kset *pci_bus_kset;

	pci_bus_kset = bus_get_kset(&pci_bus_type);
	pci_slots_kset = kset_create_and_add("slots", NULL,
						&pci_bus_kset->kobj);
	if (!pci_slots_kset) {
374
		pr_err("PCI: Slot initialization failure\n");
A
Alex Chiang 已提交
375 376 377 378 379 380
		return -ENOMEM;
	}
	return 0;
}

subsys_initcall(pci_slot_init);