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