xref: /illumos-gate/usr/src/uts/intel/sys/acpica.h (revision fa4a3e77edc40df6d92e8da6fc4961d275e9896d)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  * Copyright (c) 2018, Joyent, Inc.
25  */
26 /*
27  * Copyright (c) 2009-2010, Intel Corporation.
28  * All rights reserved.
29  * Copyright 2019 Western Digital Corporation.
30  */
31 
32 #ifndef _SYS_ACPICA_H
33 #define	_SYS_ACPICA_H
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 typedef struct {
40 	dev_info_t		*dip;
41 	kmutex_t		mutex;
42 	ddi_iblock_cookie_t	iblock_cookie;
43 } AcpiCA;
44 
45 /* acpi-user-options options property */
46 extern unsigned int acpi_options_prop;
47 #define	ACPI_OUSER_MASK		0x0003
48 #define	ACPI_OUSER_DFLT		0x0000
49 #define	ACPI_OUSER_ON		0x0001
50 #define	ACPI_OUSER_OFF		0x0002
51 #define	ACPI_OUSER_MADT		0x0004
52 #define	ACPI_OUSER_LEGACY	0x0008
53 
54 
55 /*
56  * Initialization state of the ACPI CA subsystem
57  */
58 #define	ACPICA_NOT_INITIALIZED	(0)
59 #define	ACPICA_INITIALIZED	(1)
60 
61 extern int acpica_init(void);
62 extern void acpica_ec_init(void);
63 
64 /*
65  * acpi_status property values
66  */
67 #define	ACPI_BOOT_INIT		0x00000001
68 #define	ACPI_BOOT_ENABLE	0x00000002
69 #define	ACPI_BOOT_BOOTCONF	0x00000010
70 
71 #define	SCI_IPL	(LOCK_LEVEL-1)
72 
73 /*
74  * definitions of Bus Type
75  */
76 #define	BUS_CBUS	1
77 #define	BUS_CBUSII	2
78 #define	BUS_EISA	3
79 #define	BUS_FUTURE	4
80 #define	BUS_INTERN	5
81 #define	BUS_ISA		6
82 #define	BUS_MBI		7
83 #define	BUS_MBII	8
84 #define	BUS_PCIE	9
85 #define	BUS_MPI		10
86 #define	BUS_MPSA	11
87 #define	BUS_NUBUS	12
88 #define	BUS_PCI		13
89 #define	BUS_PCMCIA	14
90 #define	BUS_TC		15
91 #define	BUS_VL		16
92 #define	BUS_VME		17
93 #define	BUS_XPRESS	18
94 
95 
96 /*
97  * intr_po - polarity definitions
98  */
99 #define	INTR_PO_CONFORM		0x00
100 #define	INTR_PO_ACTIVE_HIGH	0x01
101 #define	INTR_PO_RESERVED	0x02
102 #define	INTR_PO_ACTIVE_LOW	0x03
103 
104 /*
105  * intr_el edge or level definitions
106  */
107 #define	INTR_EL_CONFORM		0x00
108 #define	INTR_EL_EDGE		0x01
109 #define	INTR_EL_RESERVED	0x02
110 #define	INTR_EL_LEVEL		0x03
111 
112 /*
113  * interrupt flags structure
114  */
115 typedef struct iflag {
116 	uchar_t	intr_po: 2,
117 		intr_el: 2,
118 		bustype: 4;
119 } iflag_t;
120 
121 /* _HID for PCI bus object */
122 #define	HID_PCI_BUS		0x30AD041
123 #define	HID_PCI_EXPRESS_BUS	0x080AD041
124 
125 /* ACPICA subsystem has been fully initialized except SCI interrupt. */
126 #define	ACPI_FEATURE_FULL_INIT	0x1
127 /* ACPI SCI interrupt has been enabled. */
128 #define	ACPI_FEATURE_SCI_EVENT	0x2
129 /* ACPI device configuration has been enabled. */
130 #define	ACPI_FEATURE_DEVCFG	0x4
131 /* ACPI _OSI method should report support of ACPI Module Device. */
132 #define	ACPI_FEATURE_OSI_MODULE	0x8
133 
134 /* ACPI device configuration features. */
135 #define	ACPI_DEVCFG_CPU		0x1
136 #define	ACPI_DEVCFG_MEMORY	0x2
137 #define	ACPI_DEVCFG_CONTAINER	0x4
138 #define	ACPI_DEVCFG_PCI		0x8
139 
140 /*
141  * master_ops.c
142  */
143 typedef struct device_id {
144 	struct device_id *next;
145 	char	*id;
146 } device_id_t;
147 
148 typedef struct property {
149 	struct property *next;
150 	char *name;
151 	char *value;
152 } property_t;
153 
154 typedef struct master_rec {
155 	struct master_rec *next;
156 	device_id_t	*device_ids;
157 	char		*name;
158 	char		*description;
159 	property_t	*properties;
160 } master_rec_t;
161 
162 extern const master_rec_t *master_file_lookup(device_id_t *);
163 extern device_id_t *mf_alloc_device_id(void);
164 extern void mf_free_device_id(device_id_t *);
165 extern void process_master_file(void);
166 extern void free_master_data(void);
167 
168 /*
169  * Function prototypes
170  */
171 extern ACPI_STATUS acpica_get_sci(int *, iflag_t *);
172 extern int acpica_get_bdf(dev_info_t *, int *, int *, int *);
173 extern ACPI_STATUS acpica_eval_int(ACPI_HANDLE, char *, int *);
174 extern void acpica_ddi_save_resources(dev_info_t *);
175 extern void acpica_ddi_restore_resources(dev_info_t *);
176 extern void acpi_reset_system(void);
177 extern void acpica_get_global_FADT(ACPI_TABLE_FADT **);
178 extern void acpica_write_cpupm_capabilities(boolean_t, boolean_t);
179 
180 extern ACPI_STATUS acpica_tag_devinfo(dev_info_t *, ACPI_HANDLE);
181 extern ACPI_STATUS acpica_untag_devinfo(dev_info_t *, ACPI_HANDLE);
182 extern ACPI_STATUS acpica_get_devinfo(ACPI_HANDLE, dev_info_t **);
183 extern ACPI_STATUS acpica_get_handle(dev_info_t *, ACPI_HANDLE *);
184 extern ACPI_STATUS acpica_get_handle_cpu(int, ACPI_HANDLE *);
185 extern ACPI_STATUS acpica_build_processor_map(void);
186 extern ACPI_STATUS acpica_add_processor_to_map(UINT32, ACPI_HANDLE, UINT32);
187 extern ACPI_STATUS acpica_remove_processor_from_map(UINT32);
188 extern ACPI_STATUS acpica_map_cpu(processorid_t, UINT32);
189 extern ACPI_STATUS acpica_unmap_cpu(processorid_t);
190 extern ACPI_STATUS acpica_get_cpu_object_by_cpuid(processorid_t, ACPI_HANDLE *);
191 extern ACPI_STATUS acpica_get_cpu_object_by_procid(UINT32, ACPI_HANDLE *);
192 extern ACPI_STATUS acpica_get_cpu_object_by_apicid(UINT32, ACPI_HANDLE *);
193 extern ACPI_STATUS acpica_get_cpu_id_by_object(ACPI_HANDLE, processorid_t *);
194 extern ACPI_STATUS acpica_get_apicid_by_object(ACPI_HANDLE, UINT32 *);
195 extern ACPI_STATUS acpica_get_procid_by_object(ACPI_HANDLE, UINT32 *);
196 extern ACPI_STATUS acpica_get_busno(ACPI_HANDLE, int *);
197 
198 extern uint64_t acpica_get_core_feature(uint64_t);
199 extern void acpica_set_core_feature(uint64_t);
200 extern void acpica_clear_core_feature(uint64_t);
201 extern uint64_t acpica_get_devcfg_feature(uint64_t);
202 extern void acpica_set_devcfg_feature(uint64_t);
203 extern void acpica_clear_devcfg_feature(uint64_t);
204 
205 void scan_d2a_map(void);
206 
207 extern ACPI_STATUS acpica_get_object_status(ACPI_HANDLE, int *);
208 
209 #ifdef __cplusplus
210 }
211 #endif
212 
213 #endif /* _SYS_ACPICA_H */
214