xref: /openbmc/linux/drivers/pci/hotplug/acpiphp.h (revision 63dc02bd)
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 #define dbg(format, arg...)					\
43 	do {							\
44 		if (acpiphp_debug)				\
45 			printk(KERN_DEBUG "%s: " format,	\
46 				MY_NAME , ## arg);		\
47 	} while (0)
48 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg)
49 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg)
50 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg)
51 
52 struct acpiphp_bridge;
53 struct acpiphp_slot;
54 
55 /*
56  * struct slot - slot information for each *physical* slot
57  */
58 struct slot {
59 	struct hotplug_slot	*hotplug_slot;
60 	struct acpiphp_slot	*acpi_slot;
61 	struct hotplug_slot_info info;
62 };
63 
64 static inline const char *slot_name(struct slot *slot)
65 {
66 	return hotplug_slot_name(slot->hotplug_slot);
67 }
68 
69 /*
70  * struct acpiphp_bridge - PCI bridge information
71  *
72  * for each bridge device in ACPI namespace
73  */
74 struct acpiphp_bridge {
75 	struct list_head list;
76 	acpi_handle handle;
77 	struct acpiphp_slot *slots;
78 
79 	/* Ejectable PCI-to-PCI bridge (PCI bridge and PCI function) */
80 	struct acpiphp_func *func;
81 
82 	int type;
83 	int nr_slots;
84 
85 	u32 flags;
86 
87 	/* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
88 	struct pci_bus *pci_bus;
89 
90 	/* PCI-to-PCI bridge device */
91 	struct pci_dev *pci_dev;
92 
93 	spinlock_t res_lock;
94 };
95 
96 
97 /*
98  * struct acpiphp_slot - PCI slot information
99  *
100  * PCI slot information for each *physical* PCI slot
101  */
102 struct acpiphp_slot {
103 	struct acpiphp_slot *next;
104 	struct acpiphp_bridge *bridge;	/* parent */
105 	struct list_head funcs;		/* one slot may have different
106 					   objects (i.e. for each function) */
107 	struct slot *slot;
108 	struct mutex crit_sect;
109 
110 	u8		device;		/* pci device# */
111 
112 	unsigned long long sun;		/* ACPI _SUN (slot unique number) */
113 	u32		flags;		/* see below */
114 };
115 
116 
117 /*
118  * struct acpiphp_func - PCI function information
119  *
120  * PCI function information for each object in ACPI namespace
121  * typically 8 objects per slot (i.e. for each PCI function)
122  */
123 struct acpiphp_func {
124 	struct acpiphp_slot *slot;	/* parent */
125 	struct acpiphp_bridge *bridge;	/* Ejectable PCI-to-PCI bridge */
126 
127 	struct list_head sibling;
128 	struct notifier_block nb;
129 	acpi_handle	handle;
130 
131 	u8		function;	/* pci function# */
132 	u32		flags;		/* see below */
133 };
134 
135 /*
136  * struct acpiphp_attention_info - device specific attention registration
137  *
138  * ACPI has no generic method of setting/getting attention status
139  * this allows for device specific driver registration
140  */
141 struct acpiphp_attention_info
142 {
143 	int (*set_attn)(struct hotplug_slot *slot, u8 status);
144 	int (*get_attn)(struct hotplug_slot *slot, u8 *status);
145 	struct module *owner;
146 };
147 
148 /* PCI bus bridge HID */
149 #define ACPI_PCI_HOST_HID		"PNP0A03"
150 
151 /* PCI BRIDGE type */
152 #define BRIDGE_TYPE_HOST		0
153 #define BRIDGE_TYPE_P2P			1
154 
155 /* ACPI _STA method value (ignore bit 4; battery present) */
156 #define ACPI_STA_PRESENT		(0x00000001)
157 #define ACPI_STA_ENABLED		(0x00000002)
158 #define ACPI_STA_SHOW_IN_UI		(0x00000004)
159 #define ACPI_STA_FUNCTIONING		(0x00000008)
160 #define ACPI_STA_ALL			(0x0000000f)
161 
162 /* bridge flags */
163 #define BRIDGE_HAS_STA		(0x00000001)
164 #define BRIDGE_HAS_EJ0		(0x00000002)
165 #define BRIDGE_HAS_HPP		(0x00000004)
166 #define BRIDGE_HAS_PS0		(0x00000010)
167 #define BRIDGE_HAS_PS1		(0x00000020)
168 #define BRIDGE_HAS_PS2		(0x00000040)
169 #define BRIDGE_HAS_PS3		(0x00000080)
170 
171 /* slot flags */
172 
173 #define SLOT_POWEREDON		(0x00000001)
174 #define SLOT_ENABLED		(0x00000002)
175 #define SLOT_MULTIFUNCTION	(0x00000004)
176 
177 /* function flags */
178 
179 #define FUNC_HAS_STA		(0x00000001)
180 #define FUNC_HAS_EJ0		(0x00000002)
181 #define FUNC_HAS_PS0		(0x00000010)
182 #define FUNC_HAS_PS1		(0x00000020)
183 #define FUNC_HAS_PS2		(0x00000040)
184 #define FUNC_HAS_PS3		(0x00000080)
185 #define FUNC_HAS_DCK            (0x00000100)
186 
187 /* function prototypes */
188 
189 /* acpiphp_core.c */
190 extern int acpiphp_register_attention(struct acpiphp_attention_info*info);
191 extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
192 extern int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot);
193 extern void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
194 
195 /* acpiphp_glue.c */
196 extern int acpiphp_glue_init (void);
197 extern void acpiphp_glue_exit (void);
198 extern int acpiphp_get_num_slots (void);
199 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
200 
201 extern int acpiphp_enable_slot (struct acpiphp_slot *slot);
202 extern int acpiphp_disable_slot (struct acpiphp_slot *slot);
203 extern int acpiphp_eject_slot (struct acpiphp_slot *slot);
204 extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot);
205 extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot);
206 extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot);
207 extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot);
208 
209 /* variables */
210 extern int acpiphp_debug;
211 
212 #endif /* _ACPIPHP_H */
213