acpi_util.c revision 1.5.2.2 1 1.5.2.2 yamt /* $NetBSD: acpi_util.c,v 1.5.2.2 2010/08/11 22:53:16 yamt Exp $ */
2 1.5.2.2 yamt
3 1.5.2.2 yamt /*-
4 1.5.2.2 yamt * Copyright (c) 2003, 2007 The NetBSD Foundation, Inc.
5 1.5.2.2 yamt * All rights reserved.
6 1.5.2.2 yamt *
7 1.5.2.2 yamt * This code is derived from software contributed to The NetBSD Foundation
8 1.5.2.2 yamt * by Charles M. Hannum of By Noon Software, Inc.
9 1.5.2.2 yamt *
10 1.5.2.2 yamt * Redistribution and use in source and binary forms, with or without
11 1.5.2.2 yamt * modification, are permitted provided that the following conditions
12 1.5.2.2 yamt * are met:
13 1.5.2.2 yamt * 1. Redistributions of source code must retain the above copyright
14 1.5.2.2 yamt * notice, this list of conditions and the following disclaimer.
15 1.5.2.2 yamt * 2. Redistributions in binary form must reproduce the above copyright
16 1.5.2.2 yamt * notice, this list of conditions and the following disclaimer in the
17 1.5.2.2 yamt * documentation and/or other materials provided with the distribution.
18 1.5.2.2 yamt *
19 1.5.2.2 yamt * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.5.2.2 yamt * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.5.2.2 yamt * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.5.2.2 yamt * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.5.2.2 yamt * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.5.2.2 yamt * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.5.2.2 yamt * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.5.2.2 yamt * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.5.2.2 yamt * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.5.2.2 yamt * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.5.2.2 yamt * POSSIBILITY OF SUCH DAMAGE.
30 1.5.2.2 yamt */
31 1.5.2.2 yamt
32 1.5.2.2 yamt /*
33 1.5.2.2 yamt * Copyright 2001, 2003 Wasabi Systems, Inc.
34 1.5.2.2 yamt * All rights reserved.
35 1.5.2.2 yamt *
36 1.5.2.2 yamt * Written by Jason R. Thorpe for Wasabi Systems, Inc.
37 1.5.2.2 yamt *
38 1.5.2.2 yamt * Redistribution and use in source and binary forms, with or without
39 1.5.2.2 yamt * modification, are permitted provided that the following conditions
40 1.5.2.2 yamt * are met:
41 1.5.2.2 yamt * 1. Redistributions of source code must retain the above copyright
42 1.5.2.2 yamt * notice, this list of conditions and the following disclaimer.
43 1.5.2.2 yamt * 2. Redistributions in binary form must reproduce the above copyright
44 1.5.2.2 yamt * notice, this list of conditions and the following disclaimer in the
45 1.5.2.2 yamt * documentation and/or other materials provided with the distribution.
46 1.5.2.2 yamt * 3. All advertising materials mentioning features or use of this software
47 1.5.2.2 yamt * must display the following acknowledgement:
48 1.5.2.2 yamt * This product includes software developed for the NetBSD Project by
49 1.5.2.2 yamt * Wasabi Systems, Inc.
50 1.5.2.2 yamt * 4. The name of Wasabi Systems, Inc. may not be used to endorse
51 1.5.2.2 yamt * or promote products derived from this software without specific prior
52 1.5.2.2 yamt * written permission.
53 1.5.2.2 yamt *
54 1.5.2.2 yamt * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
55 1.5.2.2 yamt * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
56 1.5.2.2 yamt * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
57 1.5.2.2 yamt * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
58 1.5.2.2 yamt * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
59 1.5.2.2 yamt * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
60 1.5.2.2 yamt * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
61 1.5.2.2 yamt * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
62 1.5.2.2 yamt * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
63 1.5.2.2 yamt * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
64 1.5.2.2 yamt * POSSIBILITY OF SUCH DAMAGE.
65 1.5.2.2 yamt */
66 1.5.2.2 yamt
67 1.5.2.2 yamt #include <sys/cdefs.h>
68 1.5.2.2 yamt __KERNEL_RCSID(0, "$NetBSD: acpi_util.c,v 1.5.2.2 2010/08/11 22:53:16 yamt Exp $");
69 1.5.2.2 yamt
70 1.5.2.2 yamt #include <sys/param.h>
71 1.5.2.2 yamt
72 1.5.2.2 yamt #include <dev/acpi/acpireg.h>
73 1.5.2.2 yamt #include <dev/acpi/acpivar.h>
74 1.5.2.2 yamt
75 1.5.2.2 yamt #define _COMPONENT ACPI_BUS_COMPONENT
76 1.5.2.2 yamt ACPI_MODULE_NAME ("acpi_util")
77 1.5.2.2 yamt
78 1.5.2.2 yamt static void acpi_clean_node(ACPI_HANDLE, void *);
79 1.5.2.2 yamt
80 1.5.2.2 yamt /*
81 1.5.2.2 yamt * Evaluate an integer object.
82 1.5.2.2 yamt */
83 1.5.2.2 yamt ACPI_STATUS
84 1.5.2.2 yamt acpi_eval_integer(ACPI_HANDLE handle, const char *path, ACPI_INTEGER *valp)
85 1.5.2.2 yamt {
86 1.5.2.2 yamt ACPI_OBJECT obj;
87 1.5.2.2 yamt ACPI_BUFFER buf;
88 1.5.2.2 yamt ACPI_STATUS rv;
89 1.5.2.2 yamt
90 1.5.2.2 yamt if (handle == NULL)
91 1.5.2.2 yamt handle = ACPI_ROOT_OBJECT;
92 1.5.2.2 yamt
93 1.5.2.2 yamt buf.Pointer = &obj;
94 1.5.2.2 yamt buf.Length = sizeof(obj);
95 1.5.2.2 yamt
96 1.5.2.2 yamt rv = AcpiEvaluateObject(handle, path, NULL, &buf);
97 1.5.2.2 yamt
98 1.5.2.2 yamt if (ACPI_FAILURE(rv))
99 1.5.2.2 yamt return rv;
100 1.5.2.2 yamt
101 1.5.2.2 yamt if (obj.Type != ACPI_TYPE_INTEGER)
102 1.5.2.2 yamt return AE_TYPE;
103 1.5.2.2 yamt
104 1.5.2.2 yamt if (valp != NULL)
105 1.5.2.2 yamt *valp = obj.Integer.Value;
106 1.5.2.2 yamt
107 1.5.2.2 yamt return AE_OK;
108 1.5.2.2 yamt }
109 1.5.2.2 yamt
110 1.5.2.2 yamt /*
111 1.5.2.2 yamt * Evaluate an integer object with a single integer input parameter.
112 1.5.2.2 yamt */
113 1.5.2.2 yamt ACPI_STATUS
114 1.5.2.2 yamt acpi_eval_set_integer(ACPI_HANDLE handle, const char *path, ACPI_INTEGER val)
115 1.5.2.2 yamt {
116 1.5.2.2 yamt ACPI_OBJECT_LIST arg;
117 1.5.2.2 yamt ACPI_OBJECT obj;
118 1.5.2.2 yamt
119 1.5.2.2 yamt if (handle == NULL)
120 1.5.2.2 yamt handle = ACPI_ROOT_OBJECT;
121 1.5.2.2 yamt
122 1.5.2.2 yamt obj.Type = ACPI_TYPE_INTEGER;
123 1.5.2.2 yamt obj.Integer.Value = val;
124 1.5.2.2 yamt
125 1.5.2.2 yamt arg.Count = 1;
126 1.5.2.2 yamt arg.Pointer = &obj;
127 1.5.2.2 yamt
128 1.5.2.2 yamt return AcpiEvaluateObject(handle, path, &arg, NULL);
129 1.5.2.2 yamt }
130 1.5.2.2 yamt
131 1.5.2.2 yamt /*
132 1.5.2.2 yamt * Evaluate a (Unicode) string object.
133 1.5.2.2 yamt */
134 1.5.2.2 yamt ACPI_STATUS
135 1.5.2.2 yamt acpi_eval_string(ACPI_HANDLE handle, const char *path, char **stringp)
136 1.5.2.2 yamt {
137 1.5.2.2 yamt ACPI_OBJECT *obj;
138 1.5.2.2 yamt ACPI_BUFFER buf;
139 1.5.2.2 yamt ACPI_STATUS rv;
140 1.5.2.2 yamt
141 1.5.2.2 yamt rv = acpi_eval_struct(handle, path, &buf);
142 1.5.2.2 yamt
143 1.5.2.2 yamt if (ACPI_FAILURE(rv))
144 1.5.2.2 yamt return rv;
145 1.5.2.2 yamt
146 1.5.2.2 yamt obj = buf.Pointer;
147 1.5.2.2 yamt
148 1.5.2.2 yamt if (obj->Type != ACPI_TYPE_STRING) {
149 1.5.2.2 yamt rv = AE_TYPE;
150 1.5.2.2 yamt goto out;
151 1.5.2.2 yamt }
152 1.5.2.2 yamt
153 1.5.2.2 yamt if (obj->String.Length == 0) {
154 1.5.2.2 yamt rv = AE_BAD_DATA;
155 1.5.2.2 yamt goto out;
156 1.5.2.2 yamt }
157 1.5.2.2 yamt
158 1.5.2.2 yamt *stringp = ACPI_ALLOCATE(obj->String.Length + 1);
159 1.5.2.2 yamt
160 1.5.2.2 yamt if (*stringp == NULL) {
161 1.5.2.2 yamt rv = AE_NO_MEMORY;
162 1.5.2.2 yamt goto out;
163 1.5.2.2 yamt }
164 1.5.2.2 yamt
165 1.5.2.2 yamt (void)memcpy(*stringp, obj->String.Pointer, obj->String.Length);
166 1.5.2.2 yamt
167 1.5.2.2 yamt (*stringp)[obj->String.Length] = '\0';
168 1.5.2.2 yamt
169 1.5.2.2 yamt out:
170 1.5.2.2 yamt ACPI_FREE(buf.Pointer);
171 1.5.2.2 yamt
172 1.5.2.2 yamt return rv;
173 1.5.2.2 yamt }
174 1.5.2.2 yamt
175 1.5.2.2 yamt /*
176 1.5.2.2 yamt * Evaluate a structure. Caller must free buf.Pointer by ACPI_FREE().
177 1.5.2.2 yamt */
178 1.5.2.2 yamt ACPI_STATUS
179 1.5.2.2 yamt acpi_eval_struct(ACPI_HANDLE handle, const char *path, ACPI_BUFFER *buf)
180 1.5.2.2 yamt {
181 1.5.2.2 yamt
182 1.5.2.2 yamt if (handle == NULL)
183 1.5.2.2 yamt handle = ACPI_ROOT_OBJECT;
184 1.5.2.2 yamt
185 1.5.2.2 yamt buf->Pointer = NULL;
186 1.5.2.2 yamt buf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
187 1.5.2.2 yamt
188 1.5.2.2 yamt return AcpiEvaluateObject(handle, path, NULL, buf);
189 1.5.2.2 yamt }
190 1.5.2.2 yamt
191 1.5.2.2 yamt /*
192 1.5.2.2 yamt * Evaluate a reference handle from an element in a package.
193 1.5.2.2 yamt */
194 1.5.2.2 yamt ACPI_STATUS
195 1.5.2.2 yamt acpi_eval_reference_handle(ACPI_OBJECT *elm, ACPI_HANDLE *handle)
196 1.5.2.2 yamt {
197 1.5.2.2 yamt
198 1.5.2.2 yamt if (elm == NULL || handle == NULL)
199 1.5.2.2 yamt return AE_BAD_PARAMETER;
200 1.5.2.2 yamt
201 1.5.2.2 yamt switch (elm->Type) {
202 1.5.2.2 yamt
203 1.5.2.2 yamt case ACPI_TYPE_ANY:
204 1.5.2.2 yamt case ACPI_TYPE_LOCAL_REFERENCE:
205 1.5.2.2 yamt
206 1.5.2.2 yamt if (elm->Reference.Handle == NULL)
207 1.5.2.2 yamt return AE_NULL_ENTRY;
208 1.5.2.2 yamt
209 1.5.2.2 yamt *handle = elm->Reference.Handle;
210 1.5.2.2 yamt
211 1.5.2.2 yamt return AE_OK;
212 1.5.2.2 yamt
213 1.5.2.2 yamt case ACPI_TYPE_STRING:
214 1.5.2.2 yamt return AcpiGetHandle(NULL, elm->String.Pointer, handle);
215 1.5.2.2 yamt
216 1.5.2.2 yamt default:
217 1.5.2.2 yamt return AE_TYPE;
218 1.5.2.2 yamt }
219 1.5.2.2 yamt }
220 1.5.2.2 yamt
221 1.5.2.2 yamt /*
222 1.5.2.2 yamt * Iterate over all objects in a package, and pass them all
223 1.5.2.2 yamt * to a function. If the called function returns non-AE_OK,
224 1.5.2.2 yamt * the iteration is stopped and that value is returned.
225 1.5.2.2 yamt */
226 1.5.2.2 yamt ACPI_STATUS
227 1.5.2.2 yamt acpi_foreach_package_object(ACPI_OBJECT *pkg,
228 1.5.2.2 yamt ACPI_STATUS (*func)(ACPI_OBJECT *, void *), void *arg)
229 1.5.2.2 yamt {
230 1.5.2.2 yamt ACPI_STATUS rv = AE_OK;
231 1.5.2.2 yamt uint32_t i;
232 1.5.2.2 yamt
233 1.5.2.2 yamt if (pkg == NULL)
234 1.5.2.2 yamt return AE_BAD_PARAMETER;
235 1.5.2.2 yamt
236 1.5.2.2 yamt if (pkg->Type != ACPI_TYPE_PACKAGE)
237 1.5.2.2 yamt return AE_TYPE;
238 1.5.2.2 yamt
239 1.5.2.2 yamt for (i = 0; i < pkg->Package.Count; i++) {
240 1.5.2.2 yamt
241 1.5.2.2 yamt rv = (*func)(&pkg->Package.Elements[i], arg);
242 1.5.2.2 yamt
243 1.5.2.2 yamt if (ACPI_FAILURE(rv))
244 1.5.2.2 yamt break;
245 1.5.2.2 yamt }
246 1.5.2.2 yamt
247 1.5.2.2 yamt return rv;
248 1.5.2.2 yamt }
249 1.5.2.2 yamt
250 1.5.2.2 yamt /*
251 1.5.2.2 yamt * Fetch data info the specified (empty) ACPI buffer.
252 1.5.2.2 yamt * Caller must free buf.Pointer by ACPI_FREE().
253 1.5.2.2 yamt */
254 1.5.2.2 yamt ACPI_STATUS
255 1.5.2.2 yamt acpi_get(ACPI_HANDLE handle, ACPI_BUFFER *buf,
256 1.5.2.2 yamt ACPI_STATUS (*getit)(ACPI_HANDLE, ACPI_BUFFER *))
257 1.5.2.2 yamt {
258 1.5.2.2 yamt
259 1.5.2.2 yamt buf->Pointer = NULL;
260 1.5.2.2 yamt buf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
261 1.5.2.2 yamt
262 1.5.2.2 yamt return (*getit)(handle, buf);
263 1.5.2.2 yamt }
264 1.5.2.2 yamt
265 1.5.2.2 yamt /*
266 1.5.2.2 yamt * Get a device node from a handle.
267 1.5.2.2 yamt */
268 1.5.2.2 yamt struct acpi_devnode *
269 1.5.2.2 yamt acpi_get_node(ACPI_HANDLE handle)
270 1.5.2.2 yamt {
271 1.5.2.2 yamt struct acpi_devnode *ad;
272 1.5.2.2 yamt ACPI_STATUS rv;
273 1.5.2.2 yamt
274 1.5.2.2 yamt if (handle == NULL)
275 1.5.2.2 yamt return NULL;
276 1.5.2.2 yamt
277 1.5.2.2 yamt rv = AcpiGetData(handle, acpi_clean_node, (void **)&ad);
278 1.5.2.2 yamt
279 1.5.2.2 yamt if (ACPI_FAILURE(rv))
280 1.5.2.2 yamt return NULL;
281 1.5.2.2 yamt
282 1.5.2.2 yamt return ad;
283 1.5.2.2 yamt }
284 1.5.2.2 yamt
285 1.5.2.2 yamt /*
286 1.5.2.2 yamt * Associate a device node with a handle.
287 1.5.2.2 yamt */
288 1.5.2.2 yamt void
289 1.5.2.2 yamt acpi_set_node(struct acpi_devnode *ad)
290 1.5.2.2 yamt {
291 1.5.2.2 yamt
292 1.5.2.2 yamt (void)AcpiAttachData(ad->ad_handle, acpi_clean_node, ad);
293 1.5.2.2 yamt }
294 1.5.2.2 yamt
295 1.5.2.2 yamt static void
296 1.5.2.2 yamt acpi_clean_node(ACPI_HANDLE handle, void *aux)
297 1.5.2.2 yamt {
298 1.5.2.2 yamt /* Nothing. */
299 1.5.2.2 yamt }
300 1.5.2.2 yamt
301 1.5.2.2 yamt /*
302 1.5.2.2 yamt * Return a complete pathname from a handle.
303 1.5.2.2 yamt *
304 1.5.2.2 yamt * Note that the function uses static data storage;
305 1.5.2.2 yamt * if the data is needed for future use, it should be
306 1.5.2.2 yamt * copied before any subsequent calls overwrite it.
307 1.5.2.2 yamt */
308 1.5.2.2 yamt const char *
309 1.5.2.2 yamt acpi_name(ACPI_HANDLE handle)
310 1.5.2.2 yamt {
311 1.5.2.2 yamt static char name[80];
312 1.5.2.2 yamt ACPI_BUFFER buf;
313 1.5.2.2 yamt ACPI_STATUS rv;
314 1.5.2.2 yamt
315 1.5.2.2 yamt if (handle == NULL)
316 1.5.2.2 yamt handle = ACPI_ROOT_OBJECT;
317 1.5.2.2 yamt
318 1.5.2.2 yamt buf.Pointer = name;
319 1.5.2.2 yamt buf.Length = sizeof(name);
320 1.5.2.2 yamt
321 1.5.2.2 yamt rv = AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf);
322 1.5.2.2 yamt
323 1.5.2.2 yamt if (ACPI_FAILURE(rv))
324 1.5.2.2 yamt return "UNKNOWN";
325 1.5.2.2 yamt
326 1.5.2.2 yamt return name;
327 1.5.2.2 yamt }
328 1.5.2.2 yamt
329 1.5.2.2 yamt /*
330 1.5.2.2 yamt * Match given IDs against _HID and _CIDs.
331 1.5.2.2 yamt */
332 1.5.2.2 yamt int
333 1.5.2.2 yamt acpi_match_hid(ACPI_DEVICE_INFO *ad, const char * const *ids)
334 1.5.2.2 yamt {
335 1.5.2.2 yamt uint32_t i, n;
336 1.5.2.2 yamt char *id;
337 1.5.2.2 yamt
338 1.5.2.2 yamt while (*ids) {
339 1.5.2.2 yamt
340 1.5.2.2 yamt if ((ad->Valid & ACPI_VALID_HID) != 0) {
341 1.5.2.2 yamt
342 1.5.2.2 yamt if (pmatch(ad->HardwareId.String, *ids, NULL) == 2)
343 1.5.2.2 yamt return 1;
344 1.5.2.2 yamt }
345 1.5.2.2 yamt
346 1.5.2.2 yamt if ((ad->Valid & ACPI_VALID_CID) != 0) {
347 1.5.2.2 yamt
348 1.5.2.2 yamt n = ad->CompatibleIdList.Count;
349 1.5.2.2 yamt
350 1.5.2.2 yamt for (i = 0; i < n; i++) {
351 1.5.2.2 yamt
352 1.5.2.2 yamt id = ad->CompatibleIdList.Ids[i].String;
353 1.5.2.2 yamt
354 1.5.2.2 yamt if (pmatch(id, *ids, NULL) == 2)
355 1.5.2.2 yamt return 1;
356 1.5.2.2 yamt }
357 1.5.2.2 yamt }
358 1.5.2.2 yamt
359 1.5.2.2 yamt ids++;
360 1.5.2.2 yamt }
361 1.5.2.2 yamt
362 1.5.2.2 yamt return 0;
363 1.5.2.2 yamt }
364 1.5.2.2 yamt
365