Loading...
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 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 */
102struct 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 */
123struct 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 */
141struct 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 */
190extern int acpiphp_register_attention(struct acpiphp_attention_info*info);
191extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
192extern int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot);
193extern void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
194
195/* acpiphp_glue.c */
196extern int acpiphp_glue_init (void);
197extern void acpiphp_glue_exit (void);
198extern int acpiphp_get_num_slots (void);
199typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data);
200
201extern int acpiphp_enable_slot (struct acpiphp_slot *slot);
202extern int acpiphp_disable_slot (struct acpiphp_slot *slot);
203extern int acpiphp_eject_slot (struct acpiphp_slot *slot);
204extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot);
205extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot);
206extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot);
207extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot);
208
209/* variables */
210extern int acpiphp_debug;
211
212#endif /* _ACPIPHP_H */
1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * ACPI PCI Hot Plug Controller Driver
4 *
5 * Copyright (C) 1995,2001 Compaq Computer Corporation
6 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
7 * Copyright (C) 2001 IBM Corp.
8 * Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com)
9 * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com)
10 * Copyright (C) 2002,2003 NEC Corporation
11 * Copyright (C) 2003-2005 Matthew Wilcox (willy@infradead.org)
12 * Copyright (C) 2003-2005 Hewlett Packard
13 *
14 * All rights reserved.
15 *
16 * Send feedback to <gregkh@us.ibm.com>,
17 * <t-kochi@bq.jp.nec.com>
18 *
19 */
20
21#ifndef _ACPIPHP_H
22#define _ACPIPHP_H
23
24#include <linux/acpi.h>
25#include <linux/mutex.h>
26#include <linux/pci_hotplug.h>
27
28struct acpiphp_context;
29struct acpiphp_bridge;
30struct acpiphp_slot;
31
32/*
33 * struct slot - slot information for each *physical* slot
34 */
35struct slot {
36 struct hotplug_slot hotplug_slot;
37 struct acpiphp_slot *acpi_slot;
38 unsigned int sun; /* ACPI _SUN (Slot User Number) value */
39};
40
41static inline const char *slot_name(struct slot *slot)
42{
43 return hotplug_slot_name(&slot->hotplug_slot);
44}
45
46static inline struct slot *to_slot(struct hotplug_slot *hotplug_slot)
47{
48 return container_of(hotplug_slot, struct slot, hotplug_slot);
49}
50
51/*
52 * struct acpiphp_bridge - PCI bridge information
53 *
54 * for each bridge device in ACPI namespace
55 */
56struct acpiphp_bridge {
57 struct list_head list;
58 struct list_head slots;
59 struct kref ref;
60
61 struct acpiphp_context *context;
62
63 int nr_slots;
64
65 /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */
66 struct pci_bus *pci_bus;
67
68 /* PCI-to-PCI bridge device */
69 struct pci_dev *pci_dev;
70
71 bool is_going_away;
72};
73
74
75/*
76 * struct acpiphp_slot - PCI slot information
77 *
78 * PCI slot information for each *physical* PCI slot
79 */
80struct acpiphp_slot {
81 struct list_head node;
82 struct pci_bus *bus;
83 struct list_head funcs; /* one slot may have different
84 objects (i.e. for each function) */
85 struct slot *slot;
86
87 u8 device; /* pci device# */
88 u32 flags; /* see below */
89};
90
91
92/*
93 * struct acpiphp_func - PCI function information
94 *
95 * PCI function information for each object in ACPI namespace
96 * typically 8 objects per slot (i.e. for each PCI function)
97 */
98struct acpiphp_func {
99 struct acpiphp_bridge *parent;
100 struct acpiphp_slot *slot;
101
102 struct list_head sibling;
103
104 u8 function; /* pci function# */
105 u32 flags; /* see below */
106};
107
108struct acpiphp_context {
109 struct acpi_hotplug_context hp;
110 struct acpiphp_func func;
111 struct acpiphp_bridge *bridge;
112 unsigned int refcount;
113};
114
115static inline struct acpiphp_context *to_acpiphp_context(struct acpi_hotplug_context *hp)
116{
117 return container_of(hp, struct acpiphp_context, hp);
118}
119
120static inline struct acpiphp_context *func_to_context(struct acpiphp_func *func)
121{
122 return container_of(func, struct acpiphp_context, func);
123}
124
125static inline struct acpi_device *func_to_acpi_device(struct acpiphp_func *func)
126{
127 return func_to_context(func)->hp.self;
128}
129
130static inline acpi_handle func_to_handle(struct acpiphp_func *func)
131{
132 return func_to_acpi_device(func)->handle;
133}
134
135struct acpiphp_root_context {
136 struct acpi_hotplug_context hp;
137 struct acpiphp_bridge *root_bridge;
138};
139
140static inline struct acpiphp_root_context *to_acpiphp_root_context(struct acpi_hotplug_context *hp)
141{
142 return container_of(hp, struct acpiphp_root_context, hp);
143}
144
145/*
146 * struct acpiphp_attention_info - device specific attention registration
147 *
148 * ACPI has no generic method of setting/getting attention status
149 * this allows for device specific driver registration
150 */
151struct acpiphp_attention_info {
152 int (*set_attn)(struct hotplug_slot *slot, u8 status);
153 int (*get_attn)(struct hotplug_slot *slot, u8 *status);
154 struct module *owner;
155};
156
157/* ACPI _STA method value (ignore bit 4; battery present) */
158#define ACPI_STA_ALL (0x0000000f)
159
160/* slot flags */
161
162#define SLOT_ENABLED (0x00000001)
163#define SLOT_IS_GOING_AWAY (0x00000002)
164
165/* function flags */
166
167#define FUNC_HAS_STA (0x00000001)
168#define FUNC_HAS_EJ0 (0x00000002)
169
170/* function prototypes */
171
172/* acpiphp_core.c */
173int acpiphp_register_attention(struct acpiphp_attention_info *info);
174int acpiphp_unregister_attention(struct acpiphp_attention_info *info);
175int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot, unsigned int sun);
176void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot);
177
178int acpiphp_enable_slot(struct acpiphp_slot *slot);
179int acpiphp_disable_slot(struct acpiphp_slot *slot);
180u8 acpiphp_get_power_status(struct acpiphp_slot *slot);
181u8 acpiphp_get_attention_status(struct acpiphp_slot *slot);
182u8 acpiphp_get_latch_status(struct acpiphp_slot *slot);
183u8 acpiphp_get_adapter_status(struct acpiphp_slot *slot);
184
185/* variables */
186extern bool acpiphp_disabled;
187
188#endif /* _ACPIPHP_H */