xref: /freebsd/sys/dev/acpica/acpi_package.c (revision ec65e4f8d0654361df5e97d4de3518edebf76b46)
1 /*-
2  * Copyright (c) 2003 Nate Lawson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/bus.h>
33 #include <sys/sbuf.h>
34 
35 #include <machine/bus.h>
36 #include <machine/resource.h>
37 #include <sys/rman.h>
38 
39 #include <contrib/dev/acpica/include/acpi.h>
40 
41 #include <dev/acpica/acpivar.h>
42 
43 /*
44  * Package manipulation convenience functions
45  */
46 
47 int
48 acpi_PkgInt(ACPI_OBJECT *res, int idx, UINT64 *dst)
49 {
50     ACPI_OBJECT		*obj;
51 
52     obj = &res->Package.Elements[idx];
53     if (obj == NULL || obj->Type != ACPI_TYPE_INTEGER)
54 	return (EINVAL);
55     *dst = obj->Integer.Value;
56 
57     return (0);
58 }
59 
60 int
61 acpi_PkgInt32(ACPI_OBJECT *res, int idx, uint32_t *dst)
62 {
63     UINT64		tmp;
64     int			error;
65 
66     error = acpi_PkgInt(res, idx, &tmp);
67     if (error == 0)
68 	*dst = (uint32_t)tmp;
69 
70     return (error);
71 }
72 
73 int
74 acpi_PkgStr(ACPI_OBJECT *res, int idx, void *dst, size_t size)
75 {
76     ACPI_OBJECT		*obj;
77     void		*ptr;
78     size_t		 length;
79 
80     obj = &res->Package.Elements[idx];
81     if (obj == NULL)
82 	return (EINVAL);
83 
84     switch (obj->Type) {
85     case ACPI_TYPE_STRING:
86 	ptr = obj->String.Pointer;
87 	length = obj->String.Length;
88 	break;
89     case ACPI_TYPE_BUFFER:
90 	ptr = obj->Buffer.Pointer;
91 	length = obj->Buffer.Length;
92 	break;
93     default:
94 	return (EINVAL);
95     }
96 
97     /* Make sure string will fit, including terminating NUL */
98     if (++length > size)
99 	return (E2BIG);
100 
101     strlcpy(dst, ptr, length);
102     return (0);
103 }
104 
105 int
106 acpi_PkgGas(device_t dev, ACPI_OBJECT *res, int idx, int *type, int *rid,
107     struct resource **dst, u_int flags)
108 {
109     ACPI_GENERIC_ADDRESS gas;
110     ACPI_OBJECT *obj;
111 
112     obj = &res->Package.Elements[idx];
113     if (obj == NULL || obj->Type != ACPI_TYPE_BUFFER ||
114 	obj->Buffer.Length < sizeof(ACPI_GENERIC_ADDRESS) + 3)
115 	return (EINVAL);
116 
117     memcpy(&gas, obj->Buffer.Pointer + 3, sizeof(gas));
118 
119     return (acpi_bus_alloc_gas(dev, type, rid, &gas, dst, flags));
120 }
121 
122 int
123 acpi_PkgFFH_IntelCpu(ACPI_OBJECT *res, int idx, int *vendor, int *class,
124     uint64_t *address, int *accsize)
125 {
126     ACPI_GENERIC_ADDRESS gas;
127     ACPI_OBJECT *obj;
128 
129     obj = &res->Package.Elements[idx];
130     if (obj == NULL || obj->Type != ACPI_TYPE_BUFFER ||
131 	obj->Buffer.Length < sizeof(ACPI_GENERIC_ADDRESS) + 3)
132 	return (EINVAL);
133 
134     memcpy(&gas, obj->Buffer.Pointer + 3, sizeof(gas));
135     if (gas.SpaceId != ACPI_ADR_SPACE_FIXED_HARDWARE)
136 	return (ERESTART);
137     *vendor = gas.BitWidth;
138     *class = gas.BitOffset;
139     *address = gas.Address;
140     *accsize = gas.AccessWidth;
141     return (0);
142 }
143 
144 ACPI_HANDLE
145 acpi_GetReference(ACPI_HANDLE scope, ACPI_OBJECT *obj)
146 {
147     ACPI_HANDLE h;
148 
149     if (obj == NULL)
150 	return (NULL);
151 
152     switch (obj->Type) {
153     case ACPI_TYPE_LOCAL_REFERENCE:
154     case ACPI_TYPE_ANY:
155 	h = obj->Reference.Handle;
156 	break;
157     case ACPI_TYPE_STRING:
158 	/*
159 	 * The String object usually contains a fully-qualified path, so
160 	 * scope can be NULL.
161 	 *
162 	 * XXX This may not always be the case.
163 	 */
164 	if (ACPI_FAILURE(AcpiGetHandle(scope, obj->String.Pointer, &h)))
165 	    h = NULL;
166 	break;
167     default:
168 	h = NULL;
169 	break;
170     }
171 
172     return (h);
173 }
174