[mirror_ubuntu-bionic-kernel.git] / include / linux / pci_hotplug.h

/*
 * PCI HotPlug Core Functions
 *
 * Copyright (C) 1995,2001 Compaq Computer Corporation
 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
 * Copyright (C) 2001 IBM Corp.
 *
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
 * NON INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * Send feedback to <kristen.c.accardi@intel.com>
 *
 */
#ifndef _PCI_HOTPLUG_H
#define _PCI_HOTPLUG_H

/**
 * struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
 * @owner: The module owner of this structure
 * @mod_name: The module name (KBUILD_MODNAME) of this structure
 * @enable_slot: Called when the user wants to enable a specific pci slot
 * @disable_slot: Called when the user wants to disable a specific pci slot
 * @set_attention_status: Called to set the specific slot's attention LED to
 * the specified value
 * @hardware_test: Called to run a specified hardware test on the specified
 * slot.
 * @get_power_status: Called to get the current power status of a slot.
 *	If this field is NULL, the value passed in the struct hotplug_slot_info
 *	will be used when this value is requested by a user.
 * @get_attention_status: Called to get the current attention status of a slot.
 *	If this field is NULL, the value passed in the struct hotplug_slot_info
 *	will be used when this value is requested by a user.
 * @get_latch_status: Called to get the current latch status of a slot.
 *	If this field is NULL, the value passed in the struct hotplug_slot_info
 *	will be used when this value is requested by a user.
 * @get_adapter_status: Called to get see if an adapter is present in the slot or not.
 *	If this field is NULL, the value passed in the struct hotplug_slot_info
 *	will be used when this value is requested by a user.
 * @reset_slot: Optional interface to allow override of a bus reset for the
 *	slot for cases where a secondary bus reset can result in spurious
 *	hotplug events or where a slot can be reset independent of the bus.
 *
 * The table of function pointers that is passed to the hotplug pci core by a
 * hotplug pci driver.  These functions are called by the hotplug pci core when
 * the user wants to do something to a specific slot (query it for information,
 * set an LED, enable / disable power, etc.)
 */
struct hotplug_slot_ops {
	struct module *owner;
	const char *mod_name;
	int (*enable_slot)		(struct hotplug_slot *slot);
	int (*disable_slot)		(struct hotplug_slot *slot);
	int (*set_attention_status)	(struct hotplug_slot *slot, u8 value);
	int (*hardware_test)		(struct hotplug_slot *slot, u32 value);
	int (*get_power_status)		(struct hotplug_slot *slot, u8 *value);
	int (*get_attention_status)	(struct hotplug_slot *slot, u8 *value);
	int (*get_latch_status)		(struct hotplug_slot *slot, u8 *value);
	int (*get_adapter_status)	(struct hotplug_slot *slot, u8 *value);
	int (*reset_slot)		(struct hotplug_slot *slot, int probe);
};

/**
 * struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
 * @power_status: if power is enabled or not (1/0)
 * @attention_status: if the attention light is enabled or not (1/0)
 * @latch_status: if the latch (if any) is open or closed (1/0)
 * @adapter_status: if there is a pci board present in the slot or not (1/0)
 *
 * Used to notify the hotplug pci core of the status of a specific slot.
 */
struct hotplug_slot_info {
	u8	power_status;
	u8	attention_status;
	u8	latch_status;
	u8	adapter_status;
};

/**
 * struct hotplug_slot - used to register a physical slot with the hotplug pci core
 * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
 * @info: pointer to the &struct hotplug_slot_info for the initial values for
 * this slot.
 * @release: called during pci_hp_deregister to free memory allocated in a
 * hotplug_slot structure.
 * @private: used by the hotplug pci controller driver to store whatever it
 * needs.
 */
struct hotplug_slot {
	struct hotplug_slot_ops		*ops;
	struct hotplug_slot_info	*info;
	void (*release) (struct hotplug_slot *slot);
	void				*private;

	/* Variables below this are for use only by the hotplug pci core. */
	struct list_head		slot_list;
	struct pci_slot			*pci_slot;
};

static inline const char *hotplug_slot_name(const struct hotplug_slot *slot)
{
	return pci_slot_name(slot->pci_slot);
}

int __pci_hp_register(struct hotplug_slot *slot, struct pci_bus *pbus, int nr,
		      const char *name, struct module *owner,
		      const char *mod_name);
int pci_hp_deregister(struct hotplug_slot *slot);
int __must_check pci_hp_change_slot_info(struct hotplug_slot *slot,
					 struct hotplug_slot_info *info);

/* use a define to avoid include chaining to get THIS_MODULE & friends */
#define pci_hp_register(slot, pbus, devnr, name) \
	__pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)

/* PCI Setting Record (Type 0) */
struct hpp_type0 {
	u32 revision;
	u8  cache_line_size;
	u8  latency_timer;
	u8  enable_serr;
	u8  enable_perr;
};

/* PCI-X Setting Record (Type 1) */
struct hpp_type1 {
	u32 revision;
	u8  max_mem_read;
	u8  avg_max_split;
	u16 tot_max_split;
};

/* PCI Express Setting Record (Type 2) */
struct hpp_type2 {
	u32 revision;
	u32 unc_err_mask_and;
	u32 unc_err_mask_or;
	u32 unc_err_sever_and;
	u32 unc_err_sever_or;
	u32 cor_err_mask_and;
	u32 cor_err_mask_or;
	u32 adv_err_cap_and;
	u32 adv_err_cap_or;
	u16 pci_exp_devctl_and;
	u16 pci_exp_devctl_or;
	u16 pci_exp_lnkctl_and;
	u16 pci_exp_lnkctl_or;
	u32 sec_unc_err_sever_and;
	u32 sec_unc_err_sever_or;
	u32 sec_unc_err_mask_and;
	u32 sec_unc_err_mask_or;
};

struct hotplug_params {
	struct hpp_type0 *t0;		/* Type0: NULL if not available */
	struct hpp_type1 *t1;		/* Type1: NULL if not available */
	struct hpp_type2 *t2;		/* Type2: NULL if not available */
	struct hpp_type0 type0_data;
	struct hpp_type1 type1_data;
	struct hpp_type2 type2_data;
};

#ifdef CONFIG_ACPI
#include <linux/acpi.h>
int pci_get_hp_params(struct pci_dev *dev, struct hotplug_params *hpp);
bool pciehp_is_native(struct pci_dev *pdev);
int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags);
int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
int acpi_pci_detect_ejectable(acpi_handle handle);
#else
static inline int pci_get_hp_params(struct pci_dev *dev,
				    struct hotplug_params *hpp)
{
	return -ENODEV;
}
static inline bool pciehp_is_native(struct pci_dev *pdev) { return true; }
#endif
#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* PCI HotPlug Core Functions
	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	*
	8	* All rights reserved.
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or (at
	13	* your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful, but
	16	* WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	18	* NON INFRINGEMENT. See the GNU General Public License for more
	19	* details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	24	*
fb5f4d7a	25	* Send feedback to <kristen.c.accardi@intel.com>
1da177e4 LT	26	*
	27	*/
	28	#ifndef _PCI_HOTPLUG_H
	29	#define _PCI_HOTPLUG_H
	30
1da177e4 LT	31	/**
	32	* struct hotplug_slot_ops -the callbacks that the hotplug pci core can use
	33	* @owner: The module owner of this structure
c825bc94	34	* @mod_name: The module name (KBUILD_MODNAME) of this structure
1da177e4 LT	35	* @enable_slot: Called when the user wants to enable a specific pci slot
	36	* @disable_slot: Called when the user wants to disable a specific pci slot
	37	* @set_attention_status: Called to set the specific slot's attention LED to
	38	* the specified value
	39	* @hardware_test: Called to run a specified hardware test on the specified
	40	* slot.
	41	* @get_power_status: Called to get the current power status of a slot.
f7625980 BH	42	* If this field is NULL, the value passed in the struct hotplug_slot_info
f7625980 BH	43	* will be used when this value is requested by a user.
1da177e4 LT	44	* @get_attention_status: Called to get the current attention status of a slot.
	45	* If this field is NULL, the value passed in the struct hotplug_slot_info
	46	* will be used when this value is requested by a user.
	47	* @get_latch_status: Called to get the current latch status of a slot.
	48	* If this field is NULL, the value passed in the struct hotplug_slot_info
	49	* will be used when this value is requested by a user.
	50	* @get_adapter_status: Called to get see if an adapter is present in the slot or not.
	51	* If this field is NULL, the value passed in the struct hotplug_slot_info
	52	* will be used when this value is requested by a user.
5c32b35b AW	53	* @reset_slot: Optional interface to allow override of a bus reset for the
	54	* slot for cases where a secondary bus reset can result in spurious
	55	* hotplug events or where a slot can be reset independent of the bus.
1da177e4 LT	56	*
	57	* The table of function pointers that is passed to the hotplug pci core by a
	58	* hotplug pci driver. These functions are called by the hotplug pci core when
	59	* the user wants to do something to a specific slot (query it for information,
	60	* set an LED, enable / disable power, etc.)
	61	*/
	62	struct hotplug_slot_ops {
	63	struct module *owner;
c825bc94	64	const char *mod_name;
1da177e4 LT	65	int (enable_slot) (struct hotplug_slot slot);
	66	int (disable_slot) (struct hotplug_slot slot);
	67	int (set_attention_status) (struct hotplug_slot slot, u8 value);
	68	int (hardware_test) (struct hotplug_slot slot, u32 value);
	69	int (get_power_status) (struct hotplug_slot slot, u8 *value);
	70	int (get_attention_status) (struct hotplug_slot slot, u8 *value);
	71	int (get_latch_status) (struct hotplug_slot slot, u8 *value);
	72	int (get_adapter_status) (struct hotplug_slot slot, u8 *value);
5c32b35b	73	int (reset_slot) (struct hotplug_slot slot, int probe);
1da177e4 LT	74	};
	75
	76	/**
	77	* struct hotplug_slot_info - used to notify the hotplug pci core of the state of the slot
3749c51a	78	* @power_status: if power is enabled or not (1/0)
1da177e4 LT	79	* @attention_status: if the attention light is enabled or not (1/0)
1da177e4 LT	80	* @latch_status: if the latch (if any) is open or closed (1/0)
3749c51a	81	* @adapter_status: if there is a pci board present in the slot or not (1/0)
1da177e4 LT	82	*
	83	* Used to notify the hotplug pci core of the status of a specific slot.
	84	*/
	85	struct hotplug_slot_info {
	86	u8 power_status;
	87	u8 attention_status;
	88	u8 latch_status;
	89	u8 adapter_status;
1da177e4 LT	90	};
	91
	92	/**
	93	* struct hotplug_slot - used to register a physical slot with the hotplug pci core
1da177e4	94	* @ops: pointer to the &struct hotplug_slot_ops to be used for this slot
eaae4b3a	95	* @info: pointer to the &struct hotplug_slot_info for the initial values for
1da177e4 LT	96	* this slot.
	97	* @release: called during pci_hp_deregister to free memory allocated in a
	98	* hotplug_slot structure.
	99	* @private: used by the hotplug pci controller driver to store whatever it
	100	* needs.
	101	*/
	102	struct hotplug_slot {
1da177e4 LT	103	struct hotplug_slot_ops *ops;
	104	struct hotplug_slot_info *info;
	105	void (release) (struct hotplug_slot slot);
	106	void *private;
	107
	108	/* Variables below this are for use only by the hotplug pci core. */
	109	struct list_head slot_list;
f46753c5	110	struct pci_slot *pci_slot;
1da177e4	111	};
1da177e4	112
0ad772ec AC	113	static inline const char hotplug_slot_name(const struct hotplug_slot slot)
	114	{
	115	return pci_slot_name(slot->pci_slot);
	116	}
	117
f39d5b72 BH	118	int __pci_hp_register(struct hotplug_slot slot, struct pci_bus pbus, int nr,
	119	const char name, struct module owner,
	120	const char *mod_name);
	121	int pci_hp_deregister(struct hotplug_slot *slot);
	122	int __must_check pci_hp_change_slot_info(struct hotplug_slot *slot,
	123	struct hotplug_slot_info *info);
1da177e4	124
eb5589a8 PG	125	/* use a define to avoid include chaining to get THIS_MODULE & friends */
	126	#define pci_hp_register(slot, pbus, devnr, name) \
	127	__pci_hp_register(slot, pbus, devnr, name, THIS_MODULE, KBUILD_MODNAME)
c825bc94	128
e22b7350 KK	129	/* PCI Setting Record (Type 0) */
	130	struct hpp_type0 {
	131	u32 revision;
	132	u8 cache_line_size;
	133	u8 latency_timer;
	134	u8 enable_serr;
	135	u8 enable_perr;
	136	};
	137
	138	/* PCI-X Setting Record (Type 1) */
	139	struct hpp_type1 {
	140	u32 revision;
	141	u8 max_mem_read;
	142	u8 avg_max_split;
	143	u16 tot_max_split;
	144	};
	145
	146	/* PCI Express Setting Record (Type 2) */
	147	struct hpp_type2 {
	148	u32 revision;
	149	u32 unc_err_mask_and;
	150	u32 unc_err_mask_or;
	151	u32 unc_err_sever_and;
	152	u32 unc_err_sever_or;
	153	u32 cor_err_mask_and;
	154	u32 cor_err_mask_or;
	155	u32 adv_err_cap_and;
	156	u32 adv_err_cap_or;
	157	u16 pci_exp_devctl_and;
	158	u16 pci_exp_devctl_or;
	159	u16 pci_exp_lnkctl_and;
	160	u16 pci_exp_lnkctl_or;
	161	u32 sec_unc_err_sever_and;
	162	u32 sec_unc_err_sever_or;
	163	u32 sec_unc_err_mask_and;
	164	u32 sec_unc_err_mask_or;
	165	};
	166
783c49fc	167	struct hotplug_params {
e22b7350 KK	168	struct hpp_type0 t0; / Type0: NULL if not available */
	169	struct hpp_type1 t1; / Type1: NULL if not available */
	170	struct hpp_type2 t2; / Type2: NULL if not available */
	171	struct hpp_type0 type0_data;
	172	struct hpp_type1 type1_data;
	173	struct hpp_type2 type2_data;
783c49fc KA	174	};
	175
	176	#ifdef CONFIG_ACPI
8b48463f	177	#include <linux/acpi.h>
e81995bb	178	int pci_get_hp_params(struct pci_dev dev, struct hotplug_params hpp);
437eb7bf	179	bool pciehp_is_native(struct pci_dev *pdev);
ac9c052d	180	int acpi_get_hp_hw_control_from_firmware(struct pci_dev *dev, u32 flags);
e8c331e9	181	int acpi_pci_check_ejectable(struct pci_bus *pbus, acpi_handle handle);
7f538669	182	int acpi_pci_detect_ejectable(acpi_handle handle);
8838400d BH	183	#else
	184	static inline int pci_get_hp_params(struct pci_dev *dev,
	185	struct hotplug_params *hpp)
	186	{
	187	return -ENODEV;
	188	}
437eb7bf	189	static inline bool pciehp_is_native(struct pci_dev *pdev) { return true; }
783c49fc	190	#endif
1da177e4	191	#endif