tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
52struct acpiphp_bridge;
53struct acpiphp_slot;
54
55/*
56 * struct slot - slot information for each *physical* slot
57 */
58struct slot {
59 struct hotplug_slot *hotplug_slot;
60 struct acpiphp_slot *acpi_slot;
61 struct hotplug_slot_info info;
62};
63
64static 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 */
74struct 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
94
95/*
96 * struct acpiphp_slot - PCI slot information
97 *
98 * PCI slot information for each *physical* PCI slot
99 */
100struct acpiphp_slot {
101 struct acpiphp_slot *next;
102 struct acpiphp_bridge *bridge; /* parent */
103 struct list_head funcs; /* one slot may have different
104 objects (i.e. for each function) */
105 struct slot *slot;
106 struct mutex crit_sect;
107
108 u8 device; /* pci device# */
109
110 unsigned long long sun; /* ACPI _SUN (slot unique number) */
111 u32 flags; /* see below */
112};
113
114
115/*
116 * struct acpiphp_func - PCI function information
117 *
118 * PCI function information for each object in ACPI namespace
119 * typically 8 objects per slot (i.e. for each PCI function)
120 */
121struct acpiphp_func {
122 struct acpiphp_slot *slot; /* parent */
123 struct acpiphp_bridge *bridge; /* Ejectable PCI-to-PCI bridge */
124
125 struct list_head sibling;
126 struct notifier_block nb;
127 acpi_handle handle;
128
129 u8 function; /* pci function# */
130 u32 flags; /* see below */
131};
132
133/*
134 * struct acpiphp_attention_info - device specific attention registration
135 *
136 * ACPI has no generic method of setting/getting attention status
137 * this allows for device specific driver registration
138 */
139struct acpiphp_attention_info
140{
141 int (*set_attn)(struct hotplug_slot *slot, u8 status);
142 int (*get_attn)(struct hotplug_slot *slot, u8 *status);
143 struct module *owner;
144};
145
146/* PCI bus bridge HID */
147#define ACPI_PCI_HOST_HID "PNP0A03"
148
149/* PCI BRIDGE type */
150#define BRIDGE_TYPE_HOST 0
151#define BRIDGE_TYPE_P2P 1
152
153/* ACPI _STA method value (ignore bit 4; battery present) */
154#define ACPI_STA_PRESENT (0x00000001)
155#define ACPI_STA_ENABLED (0x00000002)
156#define ACPI_STA_SHOW_IN_UI (0x00000004)
157#define ACPI_STA_FUNCTIONING (0x00000008)
158#define ACPI_STA_ALL (0x0000000f)
159
160/* bridge flags */
161#define BRIDGE_HAS_STA (0x00000001)
162#define BRIDGE_HAS_EJ0 (0x00000002)
163#define BRIDGE_HAS_HPP (0x00000004)
164#define BRIDGE_HAS_PS0 (0x00000010)
165#define BRIDGE_HAS_PS1 (0x00000020)
166#define BRIDGE_HAS_PS2 (0x00000040)
167#define BRIDGE_HAS_PS3 (0x00000080)
168
169/* slot flags */
170
171#define SLOT_POWEREDON (0x00000001)
172#define SLOT_ENABLED (0x00000002)
173#define SLOT_MULTIFUNCTION (0x00000004)
174
175/* function flags */
176
177#define FUNC_HAS_STA (0x00000001)
178#define FUNC_HAS_EJ0 (0x00000002)
179#define FUNC_HAS_PS0 (0x00000010)
180#define FUNC_HAS_PS1 (0x00000020)
181#define FUNC_HAS_PS2 (0x00000040)
182#define FUNC_HAS_PS3 (0x00000080)
183#define FUNC_HAS_DCK (0x00000100)
184
185/* function prototypes */
186
187/* acpiphp_core.c */
188extern int acpiphp_register_attention(struct acpiphp_attention_info*info);
189extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
190extern int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot);
191extern void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
192
193/* acpiphp_glue.c */
194extern int acpiphp_glue_init (void);
195extern void acpiphp_glue_exit (void);
196extern int acpiphp_get_num_slots (void);
197typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
198
199extern int acpiphp_enable_slot (struct acpiphp_slot *slot);
200extern int acpiphp_disable_slot (struct acpiphp_slot *slot);
201extern int acpiphp_eject_slot (struct acpiphp_slot *slot);
202extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot);
203extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot);
204extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot);
205extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot);
206
207/* variables */
208extern bool acpiphp_debug;
209
210#endif /* _ACPIPHP_H */