xref: /freebsd/sys/contrib/dev/acpica/components/resources/rsmemory.c (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
1 /*******************************************************************************
2  *
3  * Module Name: rsmem24 - Memory resource descriptors
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acresrc.h>
155 
156 #define _COMPONENT          ACPI_RESOURCES
157         ACPI_MODULE_NAME    ("rsmemory")
158 
159 
160 /*******************************************************************************
161  *
162  * AcpiRsConvertMemory24
163  *
164  ******************************************************************************/
165 
166 ACPI_RSCONVERT_INFO     AcpiRsConvertMemory24[4] =
167 {
168     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_MEMORY24,
169                         ACPI_RS_SIZE (ACPI_RESOURCE_MEMORY24),
170                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertMemory24)},
171 
172     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_MEMORY24,
173                         sizeof (AML_RESOURCE_MEMORY24),
174                         0},
175 
176     /* Read/Write bit */
177 
178     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Memory24.WriteProtect),
179                         AML_OFFSET (Memory24.Flags),
180                         0},
181     /*
182      * These fields are contiguous in both the source and destination:
183      * Minimum Base Address
184      * Maximum Base Address
185      * Address Base Alignment
186      * Range Length
187      */
188     {ACPI_RSC_MOVE16,   ACPI_RS_OFFSET (Data.Memory24.Minimum),
189                         AML_OFFSET (Memory24.Minimum),
190                         4}
191 };
192 
193 
194 /*******************************************************************************
195  *
196  * AcpiRsConvertMemory32
197  *
198  ******************************************************************************/
199 
200 ACPI_RSCONVERT_INFO     AcpiRsConvertMemory32[4] =
201 {
202     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_MEMORY32,
203                         ACPI_RS_SIZE (ACPI_RESOURCE_MEMORY32),
204                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertMemory32)},
205 
206     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_MEMORY32,
207                         sizeof (AML_RESOURCE_MEMORY32),
208                         0},
209 
210     /* Read/Write bit */
211 
212     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.Memory32.WriteProtect),
213                         AML_OFFSET (Memory32.Flags),
214                         0},
215     /*
216      * These fields are contiguous in both the source and destination:
217      * Minimum Base Address
218      * Maximum Base Address
219      * Address Base Alignment
220      * Range Length
221      */
222     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.Memory32.Minimum),
223                         AML_OFFSET (Memory32.Minimum),
224                         4}
225 };
226 
227 
228 /*******************************************************************************
229  *
230  * AcpiRsConvertFixedMemory32
231  *
232  ******************************************************************************/
233 
234 ACPI_RSCONVERT_INFO     AcpiRsConvertFixedMemory32[4] =
235 {
236     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_FIXED_MEMORY32,
237                         ACPI_RS_SIZE (ACPI_RESOURCE_FIXED_MEMORY32),
238                         ACPI_RSC_TABLE_SIZE (AcpiRsConvertFixedMemory32)},
239 
240     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_FIXED_MEMORY32,
241                         sizeof (AML_RESOURCE_FIXED_MEMORY32),
242                         0},
243 
244     /* Read/Write bit */
245 
246     {ACPI_RSC_1BITFLAG, ACPI_RS_OFFSET (Data.FixedMemory32.WriteProtect),
247                         AML_OFFSET (FixedMemory32.Flags),
248                         0},
249     /*
250      * These fields are contiguous in both the source and destination:
251      * Base Address
252      * Range Length
253      */
254     {ACPI_RSC_MOVE32,   ACPI_RS_OFFSET (Data.FixedMemory32.Address),
255                         AML_OFFSET (FixedMemory32.Address),
256                         2}
257 };
258 
259 
260 /*******************************************************************************
261  *
262  * AcpiRsGetVendorSmall
263  *
264  ******************************************************************************/
265 
266 ACPI_RSCONVERT_INFO     AcpiRsGetVendorSmall[3] =
267 {
268     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_VENDOR,
269                         ACPI_RS_SIZE (ACPI_RESOURCE_VENDOR),
270                         ACPI_RSC_TABLE_SIZE (AcpiRsGetVendorSmall)},
271 
272     /* Length of the vendor data (byte count) */
273 
274     {ACPI_RSC_COUNT16,  ACPI_RS_OFFSET (Data.Vendor.ByteLength),
275                         0,
276                         sizeof (UINT8)},
277 
278     /* Vendor data */
279 
280     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Vendor.ByteData[0]),
281                         sizeof (AML_RESOURCE_SMALL_HEADER),
282                         0}
283 };
284 
285 
286 /*******************************************************************************
287  *
288  * AcpiRsGetVendorLarge
289  *
290  ******************************************************************************/
291 
292 ACPI_RSCONVERT_INFO     AcpiRsGetVendorLarge[3] =
293 {
294     {ACPI_RSC_INITGET,  ACPI_RESOURCE_TYPE_VENDOR,
295                         ACPI_RS_SIZE (ACPI_RESOURCE_VENDOR),
296                         ACPI_RSC_TABLE_SIZE (AcpiRsGetVendorLarge)},
297 
298     /* Length of the vendor data (byte count) */
299 
300     {ACPI_RSC_COUNT16,  ACPI_RS_OFFSET (Data.Vendor.ByteLength),
301                         0,
302                         sizeof (UINT8)},
303 
304     /* Vendor data */
305 
306     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Vendor.ByteData[0]),
307                         sizeof (AML_RESOURCE_LARGE_HEADER),
308                         0}
309 };
310 
311 
312 /*******************************************************************************
313  *
314  * AcpiRsSetVendor
315  *
316  ******************************************************************************/
317 
318 ACPI_RSCONVERT_INFO     AcpiRsSetVendor[7] =
319 {
320     /* Default is a small vendor descriptor */
321 
322     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_VENDOR_SMALL,
323                         sizeof (AML_RESOURCE_SMALL_HEADER),
324                         ACPI_RSC_TABLE_SIZE (AcpiRsSetVendor)},
325 
326     /* Get the length and copy the data */
327 
328     {ACPI_RSC_COUNT16,  ACPI_RS_OFFSET (Data.Vendor.ByteLength),
329                         0,
330                         0},
331 
332     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Vendor.ByteData[0]),
333                         sizeof (AML_RESOURCE_SMALL_HEADER),
334                         0},
335 
336     /*
337      * All done if the Vendor byte length is 7 or less, meaning that it will
338      * fit within a small descriptor
339      */
340     {ACPI_RSC_EXIT_LE,  0, 0, 7},
341 
342     /* Must create a large vendor descriptor */
343 
344     {ACPI_RSC_INITSET,  ACPI_RESOURCE_NAME_VENDOR_LARGE,
345                         sizeof (AML_RESOURCE_LARGE_HEADER),
346                         0},
347 
348     {ACPI_RSC_COUNT16,  ACPI_RS_OFFSET (Data.Vendor.ByteLength),
349                         0,
350                         0},
351 
352     {ACPI_RSC_MOVE8,    ACPI_RS_OFFSET (Data.Vendor.ByteData[0]),
353                         sizeof (AML_RESOURCE_LARGE_HEADER),
354                         0}
355 };
356