[linux-2.6-block.git] / drivers / pci / hotplug / acpiphp_core.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * ACPI PCI Hot Plug Controller Driver
 *
 * Copyright (C) 1995,2001 Compaq Computer Corporation
 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
 * Copyright (C) 2001 IBM Corp.
 * Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
 * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
 * Copyright (C) 2002,2003 NEC Corporation
 * Copyright (C) 2003-2005 Matthew Wilcox (willy@infradead.org)
 * Copyright (C) 2003-2005 Hewlett Packard
 *
 * All rights reserved.
 *
 * Send feedback to <kristen.c.accardi@intel.com>
 *
 */

#define pr_fmt(fmt) "acpiphp: " fmt

#include <linux/init.h>
#include <linux/module.h>
#include <linux/moduleparam.h>

#include <linux/kernel.h>
#include <linux/pci.h>
#include <linux/pci-acpi.h>
#include <linux/pci_hotplug.h>
#include <linux/slab.h>
#include <linux/smp.h>
#include "acpiphp.h"

/* name size which is used for entries in pcihpfs */
#define SLOT_NAME_SIZE  21              /* {_SUN} */

bool acpiphp_disabled;

/* local variables */
static struct acpiphp_attention_info *attention_info;

#define DRIVER_VERSION	"0.5"
#define DRIVER_AUTHOR	"Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@infradead.org>"
#define DRIVER_DESC	"ACPI Hot Plug PCI Controller Driver"

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_PARM_DESC(disable, "disable acpiphp driver");
module_param_named(disable, acpiphp_disabled, bool, 0444);

static int enable_slot(struct hotplug_slot *slot);
static int disable_slot(struct hotplug_slot *slot);
static int set_attention_status(struct hotplug_slot *slot, u8 value);
static int get_power_status(struct hotplug_slot *slot, u8 *value);
static int get_attention_status(struct hotplug_slot *slot, u8 *value);
static int get_latch_status(struct hotplug_slot *slot, u8 *value);
static int get_adapter_status(struct hotplug_slot *slot, u8 *value);

static const struct hotplug_slot_ops acpi_hotplug_slot_ops = {
	.enable_slot		= enable_slot,
	.disable_slot		= disable_slot,
	.set_attention_status	= set_attention_status,
	.get_power_status	= get_power_status,
	.get_attention_status	= get_attention_status,
	.get_latch_status	= get_latch_status,
	.get_adapter_status	= get_adapter_status,
};

/**
 * acpiphp_register_attention - set attention LED callback
 * @info: must be completely filled with LED callbacks
 *
 * Description: This is used to register a hardware specific ACPI
 * driver that manipulates the attention LED.  All the fields in
 * info must be set.
 */
int acpiphp_register_attention(struct acpiphp_attention_info *info)
{
	int retval = -EINVAL;

	if (info && info->set_attn && info->get_attn && !attention_info) {
		retval = 0;
		attention_info = info;
	}
	return retval;
}
EXPORT_SYMBOL_GPL(acpiphp_register_attention);


/**
 * acpiphp_unregister_attention - unset attention LED callback
 * @info: must match the pointer used to register
 *
 * Description: This is used to un-register a hardware specific acpi
 * driver that manipulates the attention LED.  The pointer to the
 * info struct must be the same as the one used to set it.
 */
int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
{
	int retval = -EINVAL;

	if (info && attention_info == info) {
		attention_info = NULL;
		retval = 0;
	}
	return retval;
}
EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);


/**
 * enable_slot - power on and enable a slot
 * @hotplug_slot: slot to enable
 *
 * Actual tasks are done in acpiphp_enable_slot()
 */
static int enable_slot(struct hotplug_slot *hotplug_slot)
{
	struct slot *slot = to_slot(hotplug_slot);

	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));

	/* enable the specified slot */
	return acpiphp_enable_slot(slot->acpi_slot);
}


/**
 * disable_slot - disable and power off a slot
 * @hotplug_slot: slot to disable
 *
 * Actual tasks are done in acpiphp_disable_slot()
 */
static int disable_slot(struct hotplug_slot *hotplug_slot)
{
	struct slot *slot = to_slot(hotplug_slot);

	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));

	/* disable the specified slot */
	return acpiphp_disable_slot(slot->acpi_slot);
}


/**
 * set_attention_status - set attention LED
 * @hotplug_slot: slot to set attention LED on
 * @status: value to set attention LED to (0 or 1)
 *
 * attention status LED, so we use a callback that
 * was registered with us.  This allows hardware specific
 * ACPI implementations to blink the light for us.
 */
static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
{
	int retval = -ENODEV;

	pr_debug("%s - physical_slot = %s\n", __func__,
		hotplug_slot_name(hotplug_slot));

	if (attention_info && try_module_get(attention_info->owner)) {
		retval = attention_info->set_attn(hotplug_slot, status);
		module_put(attention_info->owner);
	} else
		attention_info = NULL;
	return retval;
}


/**
 * get_power_status - get power status of a slot
 * @hotplug_slot: slot to get status
 * @value: pointer to store status
 *
 * Some platforms may not implement _STA method properly.
 * In that case, the value returned may not be reliable.
 */
static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
	struct slot *slot = to_slot(hotplug_slot);

	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));

	*value = acpiphp_get_power_status(slot->acpi_slot);

	return 0;
}


/**
 * get_attention_status - get attention LED status
 * @hotplug_slot: slot to get status from
 * @value: returns with value of attention LED
 *
 * ACPI doesn't have known method to determine the state
 * of the attention status LED, so we use a callback that
 * was registered with us.  This allows hardware specific
 * ACPI implementations to determine its state.
 */
static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
	int retval = -EINVAL;

	pr_debug("%s - physical_slot = %s\n", __func__,
		hotplug_slot_name(hotplug_slot));

	if (attention_info && try_module_get(attention_info->owner)) {
		retval = attention_info->get_attn(hotplug_slot, value);
		module_put(attention_info->owner);
	} else
		attention_info = NULL;
	return retval;
}


/**
 * get_latch_status - get latch status of a slot
 * @hotplug_slot: slot to get status
 * @value: pointer to store status
 *
 * ACPI doesn't provide any formal means to access latch status.
 * Instead, we fake latch status from _STA.
 */
static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
	struct slot *slot = to_slot(hotplug_slot);

	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));

	*value = acpiphp_get_latch_status(slot->acpi_slot);

	return 0;
}


/**
 * get_adapter_status - get adapter status of a slot
 * @hotplug_slot: slot to get status
 * @value: pointer to store status
 *
 * ACPI doesn't provide any formal means to access adapter status.
 * Instead, we fake adapter status from _STA.
 */
static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
	struct slot *slot = to_slot(hotplug_slot);

	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));

	*value = acpiphp_get_adapter_status(slot->acpi_slot);

	return 0;
}

/* callback routine to initialize 'struct slot' for each slot */
int acpiphp_register_hotplug_slot(struct acpiphp_slot *acpiphp_slot,
				  unsigned int sun)
{
	struct slot *slot;
	int retval = -ENOMEM;
	char name[SLOT_NAME_SIZE];

	slot = kzalloc(sizeof(*slot), GFP_KERNEL);
	if (!slot)
		goto error;

	slot->hotplug_slot.ops = &acpi_hotplug_slot_ops;

	slot->acpi_slot = acpiphp_slot;

	acpiphp_slot->slot = slot;
	slot->sun = sun;
	snprintf(name, SLOT_NAME_SIZE, "%u", sun);

	retval = pci_hp_register(&slot->hotplug_slot, acpiphp_slot->bus,
				 acpiphp_slot->device, name);
	if (retval == -EBUSY)
		goto error_slot;
	if (retval) {
		pr_err("pci_hp_register failed with error %d\n", retval);
		goto error_slot;
	}

	pr_info("Slot [%s] registered\n", slot_name(slot));

	return 0;
error_slot:
	kfree(slot);
error:
	return retval;
}


void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
{
	struct slot *slot = acpiphp_slot->slot;

	pr_info("Slot [%s] unregistered\n", slot_name(slot));

	pci_hp_deregister(&slot->hotplug_slot);
	kfree(slot);
}


void __init acpiphp_init(void)
{
	pr_info(DRIVER_DESC " version: " DRIVER_VERSION "%s\n",
		acpiphp_disabled ? ", disabled by user; please report a bug"
				 : "");
}
Commit	Line	Data
736759ef	1	// SPDX-License-Identifier: GPL-2.0+
1da177e4 LT	2	/*
	3	* ACPI PCI Hot Plug Controller Driver
	4	*
	5	* Copyright (C) 1995,2001 Compaq Computer Corporation
	6	* Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
	7	* Copyright (C) 2001 IBM Corp.
	8	* Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
	9	* Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
	10	* Copyright (C) 2002,2003 NEC Corporation
3d0186bb	11	* Copyright (C) 2003-2005 Matthew Wilcox (willy@infradead.org)
42f49a6a	12	* Copyright (C) 2003-2005 Hewlett Packard
1da177e4 LT	13	*
	14	* All rights reserved.
	15	*
998be20f	16	* Send feedback to <kristen.c.accardi@intel.com>
1da177e4 LT	17	*
	18	*/
	19
bd950799 LT	20	#define pr_fmt(fmt) "acpiphp: " fmt
bd950799 LT	21
1da177e4 LT	22	#include <linux/init.h>
	23	#include <linux/module.h>
	24	#include <linux/moduleparam.h>
	25
	26	#include <linux/kernel.h>
	27	#include <linux/pci.h>
3b63aaa7	28	#include <linux/pci-acpi.h>
7a54f25c	29	#include <linux/pci_hotplug.h>
1da177e4 LT	30	#include <linux/slab.h>
1da177e4 LT	31	#include <linux/smp.h>
1da177e4 LT	32	#include "acpiphp.h"
1da177e4 LT	33
df77cd10 AC	34	/* name size which is used for entries in pcihpfs */
	35	#define SLOT_NAME_SIZE 21 /* {_SUN} */
	36
6037a803	37	bool acpiphp_disabled;
1da177e4 LT	38
1da177e4 LT	39	/* local variables */
1da177e4 LT	40	static struct acpiphp_attention_info *attention_info;
1da177e4 LT	41
42f49a6a	42	#define DRIVER_VERSION "0.5"
3d0186bb	43	#define DRIVER_AUTHOR "Greg Kroah-Hartman <gregkh@us.ibm.com>, Takayoshi Kochi <t-kochi@bq.jp.nec.com>, Matthew Wilcox <willy@infradead.org>"
1da177e4 LT	44	#define DRIVER_DESC "ACPI Hot Plug PCI Controller Driver"
	45
	46	MODULE_AUTHOR(DRIVER_AUTHOR);
	47	MODULE_DESCRIPTION(DRIVER_DESC);
6037a803	48	MODULE_PARM_DESC(disable, "disable acpiphp driver");
6037a803	49	module_param_named(disable, acpiphp_disabled, bool, 0444);
1da177e4	50
ff3ce480 BS	51	static int enable_slot(struct hotplug_slot *slot);
	52	static int disable_slot(struct hotplug_slot *slot);
	53	static int set_attention_status(struct hotplug_slot *slot, u8 value);
	54	static int get_power_status(struct hotplug_slot slot, u8 value);
	55	static int get_attention_status(struct hotplug_slot slot, u8 value);
	56	static int get_latch_status(struct hotplug_slot slot, u8 value);
	57	static int get_adapter_status(struct hotplug_slot slot, u8 value);
1da177e4	58
81c4b5bf	59	static const struct hotplug_slot_ops acpi_hotplug_slot_ops = {
1da177e4 LT	60	.enable_slot = enable_slot,
	61	.disable_slot = disable_slot,
	62	.set_attention_status = set_attention_status,
	63	.get_power_status = get_power_status,
	64	.get_attention_status = get_attention_status,
	65	.get_latch_status = get_latch_status,
	66	.get_adapter_status = get_adapter_status,
1da177e4 LT	67	};
1da177e4 LT	68
1da177e4 LT	69	/**
	70	* acpiphp_register_attention - set attention LED callback
	71	* @info: must be completely filled with LED callbacks
	72	*
26e6c66e	73	* Description: This is used to register a hardware specific ACPI
1da177e4 LT	74	* driver that manipulates the attention LED. All the fields in
1da177e4 LT	75	* info must be set.
26e6c66e	76	*/
1da177e4 LT	77	int acpiphp_register_attention(struct acpiphp_attention_info *info)
	78	{
	79	int retval = -EINVAL;
	80
33883eed	81	if (info && info->set_attn && info->get_attn && !attention_info) {
1da177e4 LT	82	retval = 0;
	83	attention_info = info;
	84	}
	85	return retval;
	86	}
b7fe9434	87	EXPORT_SYMBOL_GPL(acpiphp_register_attention);
1da177e4 LT	88
	89
	90	/**
	91	* acpiphp_unregister_attention - unset attention LED callback
	92	* @info: must match the pointer used to register
	93	*
26e6c66e	94	* Description: This is used to un-register a hardware specific acpi
f7625980	95	* driver that manipulates the attention LED. The pointer to the
1da177e4	96	* info struct must be the same as the one used to set it.
26e6c66e	97	*/
1da177e4 LT	98	int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
	99	{
	100	int retval = -EINVAL;
	101
	102	if (info && attention_info == info) {
	103	attention_info = NULL;
	104	retval = 0;
	105	}
	106	return retval;
	107	}
b7fe9434	108	EXPORT_SYMBOL_GPL(acpiphp_unregister_attention);
1da177e4 LT	109
	110
	111	/**
	112	* enable_slot - power on and enable a slot
	113	* @hotplug_slot: slot to enable
	114	*
	115	* Actual tasks are done in acpiphp_enable_slot()
1da177e4 LT	116	*/
	117	static int enable_slot(struct hotplug_slot *hotplug_slot)
	118	{
125450f8	119	struct slot *slot = to_slot(hotplug_slot);
1da177e4	120
bd950799	121	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));
1da177e4 LT	122
	123	/* enable the specified slot */
	124	return acpiphp_enable_slot(slot->acpi_slot);
	125	}
	126
	127
	128	/**
	129	* disable_slot - disable and power off a slot
	130	* @hotplug_slot: slot to disable
	131	*
	132	* Actual tasks are done in acpiphp_disable_slot()
1da177e4 LT	133	*/
	134	static int disable_slot(struct hotplug_slot *hotplug_slot)
	135	{
125450f8	136	struct slot *slot = to_slot(hotplug_slot);
1da177e4	137
bd950799	138	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));
1da177e4 LT	139
1da177e4 LT	140	/* disable the specified slot */
9217a984	141	return acpiphp_disable_slot(slot->acpi_slot);
1da177e4 LT	142	}
	143
	144
26e6c66e RD	145	/**
26e6c66e RD	146	* set_attention_status - set attention LED
1da177e4 LT	147	* @hotplug_slot: slot to set attention LED on
	148	* @status: value to set attention LED to (0 or 1)
	149	*
	150	* attention status LED, so we use a callback that
	151	* was registered with us. This allows hardware specific
	152	* ACPI implementations to blink the light for us.
26e6c66e	153	*/
f7625980 BH	154	static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
f7625980 BH	155	{
1da177e4 LT	156	int retval = -ENODEV;
1da177e4 LT	157
bd950799 LT	158	pr_debug("%s - physical_slot = %s\n", __func__,
	159	hotplug_slot_name(hotplug_slot));
	160
1da177e4 LT	161	if (attention_info && try_module_get(attention_info->owner)) {
	162	retval = attention_info->set_attn(hotplug_slot, status);
	163	module_put(attention_info->owner);
	164	} else
	165	attention_info = NULL;
	166	return retval;
f7625980 BH	167	}
f7625980 BH	168
1da177e4 LT	169
	170	/**
	171	* get_power_status - get power status of a slot
	172	* @hotplug_slot: slot to get status
	173	* @value: pointer to store status
	174	*
	175	* Some platforms may not implement _STA method properly.
	176	* In that case, the value returned may not be reliable.
1da177e4 LT	177	*/
	178	static int get_power_status(struct hotplug_slot hotplug_slot, u8 value)
	179	{
125450f8	180	struct slot *slot = to_slot(hotplug_slot);
1da177e4	181
bd950799	182	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));
1da177e4 LT	183
	184	*value = acpiphp_get_power_status(slot->acpi_slot);
	185
	186	return 0;
	187	}
	188
	189
26e6c66e	190	/**
1da177e4 LT	191	* get_attention_status - get attention LED status
	192	* @hotplug_slot: slot to get status from
	193	* @value: returns with value of attention LED
	194	*
	195	* ACPI doesn't have known method to determine the state
	196	* of the attention status LED, so we use a callback that
	197	* was registered with us. This allows hardware specific
26e6c66e RD	198	* ACPI implementations to determine its state.
26e6c66e RD	199	*/
1da177e4 LT	200	static int get_attention_status(struct hotplug_slot hotplug_slot, u8 value)
	201	{
	202	int retval = -EINVAL;
	203
bd950799 LT	204	pr_debug("%s - physical_slot = %s\n", __func__,
bd950799 LT	205	hotplug_slot_name(hotplug_slot));
1da177e4 LT	206
	207	if (attention_info && try_module_get(attention_info->owner)) {
	208	retval = attention_info->get_attn(hotplug_slot, value);
	209	module_put(attention_info->owner);
	210	} else
	211	attention_info = NULL;
	212	return retval;
	213	}
	214
	215
	216	/**
	217	* get_latch_status - get latch status of a slot
	218	* @hotplug_slot: slot to get status
	219	* @value: pointer to store status
	220	*
	221	* ACPI doesn't provide any formal means to access latch status.
26e6c66e	222	* Instead, we fake latch status from _STA.
1da177e4 LT	223	*/
	224	static int get_latch_status(struct hotplug_slot hotplug_slot, u8 value)
	225	{
125450f8	226	struct slot *slot = to_slot(hotplug_slot);
1da177e4	227
bd950799	228	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));
1da177e4 LT	229
	230	*value = acpiphp_get_latch_status(slot->acpi_slot);
	231
	232	return 0;
	233	}
	234
	235
	236	/**
	237	* get_adapter_status - get adapter status of a slot
	238	* @hotplug_slot: slot to get status
	239	* @value: pointer to store status
	240	*
	241	* ACPI doesn't provide any formal means to access adapter status.
26e6c66e	242	* Instead, we fake adapter status from _STA.
1da177e4 LT	243	*/
	244	static int get_adapter_status(struct hotplug_slot hotplug_slot, u8 value)
	245	{
125450f8	246	struct slot *slot = to_slot(hotplug_slot);
1da177e4	247
bd950799	248	pr_debug("%s - physical_slot = %s\n", __func__, slot_name(slot));
1da177e4 LT	249
	250	*value = acpiphp_get_adapter_status(slot->acpi_slot);
	251
	252	return 0;
	253	}
	254
e27da381	255	/* callback routine to initialize 'struct slot' for each slot */
7342798d RW	256	int acpiphp_register_hotplug_slot(struct acpiphp_slot *acpiphp_slot,
7342798d RW	257	unsigned int sun)
1da177e4 LT	258	{
	259	struct slot *slot;
	260	int retval = -ENOMEM;
df77cd10	261	char name[SLOT_NAME_SIZE];
e27da381 MT	262
	263	slot = kzalloc(sizeof(*slot), GFP_KERNEL);
	264	if (!slot)
	265	goto error;
	266
125450f8	267	slot->hotplug_slot.ops = &acpi_hotplug_slot_ops;
e27da381 MT	268
e27da381 MT	269	slot->acpi_slot = acpiphp_slot;
e27da381 MT	270
e27da381 MT	271	acpiphp_slot->slot = slot;
7342798d RW	272	slot->sun = sun;
7342798d RW	273	snprintf(name, SLOT_NAME_SIZE, "%u", sun);
e27da381	274
125450f8	275	retval = pci_hp_register(&slot->hotplug_slot, acpiphp_slot->bus,
bda46dbb	276	acpiphp_slot->device, name);
f46753c5	277	if (retval == -EBUSY)
125450f8	278	goto error_slot;
e27da381	279	if (retval) {
bd950799	280	pr_err("pci_hp_register failed with error %d\n", retval);
125450f8	281	goto error_slot;
f7625980	282	}
e27da381	283
bd950799	284	pr_info("Slot [%s] registered\n", slot_name(slot));
1da177e4 LT	285
1da177e4 LT	286	return 0;
1da177e4 LT	287	error_slot:
	288	kfree(slot);
	289	error:
	290	return retval;
	291	}
	292
	293
e27da381	294	void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *acpiphp_slot)
1da177e4	295	{
e27da381	296	struct slot *slot = acpiphp_slot->slot;
1da177e4	297
bd950799	298	pr_info("Slot [%s] unregistered\n", slot_name(slot));
e27da381	299
125450f8	300	pci_hp_deregister(&slot->hotplug_slot);
51bbf9be	301	kfree(slot);
1da177e4 LT	302	}
	303
	304
3b63aaa7	305	void __init acpiphp_init(void)
1da177e4	306	{
bd950799	307	pr_info(DRIVER_DESC " version: " DRIVER_VERSION "%s\n",
6037a803 JL	308	acpiphp_disabled ? ", disabled by user; please report a bug"
6037a803 JL	309	: "");
1da177e4	310	}