xref: /openbmc/linux/drivers/pci/hotplug/acpiphp.h (revision 930beb5a)
1 /*
2  * ACPI PCI 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) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
8  * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
9  * Copyright (C) 2002,2003 NEC Corporation
10  * Copyright (C) 2003-2005 Matthew Wilcox (matthew.wilcox@hp.com)
11  * Copyright (C) 2003-2005 Hewlett Packard
12  *
13  * All rights reserved.
14  *
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or (at
18  * your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful, but
21  * WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
23  * NON INFRINGEMENT.  See the GNU General Public License for more
24  * details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, write to the Free Software
28  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29  *
30  * Send feedback to <gregkh@us.ibm.com>,
31  *		    <t-kochi@bq.jp.nec.com>
32  *
33  */
34 
35 #ifndef _ACPIPHP_H
36 #define _ACPIPHP_H
37 
38 #include <linux/acpi.h>
39 #include <linux/mutex.h>
40 #include <linux/pci_hotplug.h>
41 
42 struct acpiphp_context;
43 struct acpiphp_bridge;
44 struct acpiphp_slot;
45 
46 /*
47  * struct slot - slot information for each *physical* slot
48  */
49 struct slot {
50 	struct hotplug_slot	*hotplug_slot;
51 	struct acpiphp_slot	*acpi_slot;
52 	struct hotplug_slot_info info;
53 	unsigned int sun;	/* ACPI _SUN (Slot User Number) value */
54 };
55 
56 static inline const char *slot_name(struct slot *slot)
57 {
58 	return hotplug_slot_name(slot->hotplug_slot);
59 }
60 
61 /*
62  * struct acpiphp_bridge - PCI bridge information
63  *
64  * for each bridge device in ACPI namespace
65  */
66 struct acpiphp_bridge {
67 	struct list_head list;
68 	struct list_head slots;
69 	struct kref ref;
70 
71 	struct acpiphp_context *context;
72 
73 	int nr_slots;
74 
75 	/* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
76 	struct pci_bus *pci_bus;
77 
78 	/* PCI-to-PCI bridge device */
79 	struct pci_dev *pci_dev;
80 };
81 
82 
83 /*
84  * struct acpiphp_slot - PCI slot information
85  *
86  * PCI slot information for each *physical* PCI slot
87  */
88 struct acpiphp_slot {
89 	struct list_head node;
90 	struct pci_bus *bus;
91 	struct list_head funcs;		/* one slot may have different
92 					   objects (i.e. for each function) */
93 	struct slot *slot;
94 	struct mutex crit_sect;
95 
96 	u8		device;		/* pci device# */
97 	u32		flags;		/* see below */
98 };
99 
100 
101 /*
102  * struct acpiphp_func - PCI function information
103  *
104  * PCI function information for each object in ACPI namespace
105  * typically 8 objects per slot (i.e. for each PCI function)
106  */
107 struct acpiphp_func {
108 	struct acpiphp_bridge *parent;
109 	struct acpiphp_slot *slot;
110 
111 	struct list_head sibling;
112 
113 	u8		function;	/* pci function# */
114 	u32		flags;		/* see below */
115 };
116 
117 struct acpiphp_context {
118 	acpi_handle handle;
119 	struct acpiphp_func func;
120 	struct acpiphp_bridge *bridge;
121 	unsigned int refcount;
122 };
123 
124 static inline struct acpiphp_context *func_to_context(struct acpiphp_func *func)
125 {
126 	return container_of(func, struct acpiphp_context, func);
127 }
128 
129 static inline acpi_handle func_to_handle(struct acpiphp_func *func)
130 {
131 	return func_to_context(func)->handle;
132 }
133 
134 /*
135  * struct acpiphp_attention_info - device specific attention registration
136  *
137  * ACPI has no generic method of setting/getting attention status
138  * this allows for device specific driver registration
139  */
140 struct acpiphp_attention_info
141 {
142 	int (*set_attn)(struct hotplug_slot *slot, u8 status);
143 	int (*get_attn)(struct hotplug_slot *slot, u8 *status);
144 	struct module *owner;
145 };
146 
147 /* ACPI _STA method value (ignore bit 4; battery present) */
148 #define ACPI_STA_ALL			(0x0000000f)
149 
150 /* slot flags */
151 
152 #define SLOT_ENABLED		(0x00000001)
153 
154 /* function flags */
155 
156 #define FUNC_HAS_STA		(0x00000001)
157 #define FUNC_HAS_EJ0		(0x00000002)
158 #define FUNC_HAS_DCK            (0x00000004)
159 
160 /* function prototypes */
161 
162 /* acpiphp_core.c */
163 int acpiphp_register_attention(struct acpiphp_attention_info*info);
164 int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
165 int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot, unsigned int sun);
166 void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
167 
168 /* acpiphp_glue.c */
169 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
170 
171 int acpiphp_enable_slot(struct acpiphp_slot *slot);
172 int acpiphp_disable_and_eject_slot(struct acpiphp_slot *slot);
173 u8 acpiphp_get_power_status(struct acpiphp_slot *slot);
174 u8 acpiphp_get_attention_status(struct acpiphp_slot *slot);
175 u8 acpiphp_get_latch_status(struct acpiphp_slot *slot);
176 u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot);
177 
178 /* variables */
179 extern bool acpiphp_disabled;
180 
181 #endif /* _ACPIPHP_H */
182