1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: rsutils - Utilities for the resource manager
6 ******************************************************************************/
13 #define _COMPONENT ACPI_RESOURCES
14 ACPI_MODULE_NAME("rsutils")
16 /*******************************************************************************
18 * FUNCTION: acpi_rs_decode_bitmask
20 * PARAMETERS: mask - Bitmask to decode
21 * list - Where the converted list is returned
23 * RETURN: Count of bits set (length of list)
25 * DESCRIPTION: Convert a bit mask into a list of values
27 ******************************************************************************/
28 u8
acpi_rs_decode_bitmask(u16 mask
, u8
* list
)
33 ACPI_FUNCTION_ENTRY();
35 /* Decode the mask bits */
37 for (i
= 0, bit_count
= 0; mask
; i
++) {
49 /*******************************************************************************
51 * FUNCTION: acpi_rs_encode_bitmask
53 * PARAMETERS: list - List of values to encode
54 * count - Length of list
56 * RETURN: Encoded bitmask
58 * DESCRIPTION: Convert a list of values to an encoded bitmask
60 ******************************************************************************/
62 u16
acpi_rs_encode_bitmask(u8
* list
, u8 count
)
67 ACPI_FUNCTION_ENTRY();
69 /* Encode the list into a single bitmask */
71 for (i
= 0, mask
= 0; i
< count
; i
++) {
72 mask
|= (0x1 << list
[i
]);
78 /*******************************************************************************
80 * FUNCTION: acpi_rs_move_data
82 * PARAMETERS: destination - Pointer to the destination descriptor
83 * source - Pointer to the source descriptor
84 * item_count - How many items to move
85 * move_type - Byte width
89 * DESCRIPTION: Move multiple data items from one descriptor to another. Handles
90 * alignment issues and endian issues if necessary, as configured
91 * via the ACPI_MOVE_* macros. (This is why a memcpy is not used)
93 ******************************************************************************/
96 acpi_rs_move_data(void *destination
, void *source
, u16 item_count
, u8 move_type
)
100 ACPI_FUNCTION_ENTRY();
102 /* One move per item */
104 for (i
= 0; i
< item_count
; i
++) {
107 * For the 8-bit case, we can perform the move all at once
108 * since there are no alignment or endian issues
111 case ACPI_RSC_MOVE_GPIO_RES
:
112 case ACPI_RSC_MOVE_SERIAL_VEN
:
113 case ACPI_RSC_MOVE_SERIAL_RES
:
115 memcpy(destination
, source
, item_count
);
119 * 16-, 32-, and 64-bit cases must use the move macros that perform
120 * endian conversion and/or accommodate hardware that cannot perform
121 * misaligned memory transfers
123 case ACPI_RSC_MOVE16
:
124 case ACPI_RSC_MOVE_GPIO_PIN
:
126 ACPI_MOVE_16_TO_16(&ACPI_CAST_PTR(u16
, destination
)[i
],
127 &ACPI_CAST_PTR(u16
, source
)[i
]);
130 case ACPI_RSC_MOVE32
:
132 ACPI_MOVE_32_TO_32(&ACPI_CAST_PTR(u32
, destination
)[i
],
133 &ACPI_CAST_PTR(u32
, source
)[i
]);
136 case ACPI_RSC_MOVE64
:
138 ACPI_MOVE_64_TO_64(&ACPI_CAST_PTR(u64
, destination
)[i
],
139 &ACPI_CAST_PTR(u64
, source
)[i
]);
149 /*******************************************************************************
151 * FUNCTION: acpi_rs_set_resource_length
153 * PARAMETERS: total_length - Length of the AML descriptor, including
154 * the header and length fields.
155 * aml - Pointer to the raw AML descriptor
159 * DESCRIPTION: Set the resource_length field of an AML
160 * resource descriptor, both Large and Small descriptors are
161 * supported automatically. Note: Descriptor Type field must
164 ******************************************************************************/
167 acpi_rs_set_resource_length(acpi_rsdesc_size total_length
,
168 union aml_resource
*aml
)
170 acpi_rs_length resource_length
;
172 ACPI_FUNCTION_ENTRY();
174 /* Length is the total descriptor length minus the header length */
176 resource_length
= (acpi_rs_length
)
177 (total_length
- acpi_ut_get_resource_header_length(aml
));
179 /* Length is stored differently for large and small descriptors */
181 if (aml
->small_header
.descriptor_type
& ACPI_RESOURCE_NAME_LARGE
) {
183 /* Large descriptor -- bytes 1-2 contain the 16-bit length */
185 ACPI_MOVE_16_TO_16(&aml
->large_header
.resource_length
,
189 * Small descriptor -- bits 2:0 of byte 0 contain the length
190 * Clear any existing length, preserving descriptor type bits
192 aml
->small_header
.descriptor_type
= (u8
)
193 ((aml
->small_header
.descriptor_type
&
194 ~ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK
)
199 /*******************************************************************************
201 * FUNCTION: acpi_rs_set_resource_header
203 * PARAMETERS: descriptor_type - Byte to be inserted as the type
204 * total_length - Length of the AML descriptor, including
205 * the header and length fields.
206 * aml - Pointer to the raw AML descriptor
210 * DESCRIPTION: Set the descriptor_type and resource_length fields of an AML
211 * resource descriptor, both Large and Small descriptors are
212 * supported automatically
214 ******************************************************************************/
217 acpi_rs_set_resource_header(u8 descriptor_type
,
218 acpi_rsdesc_size total_length
,
219 union aml_resource
*aml
)
221 ACPI_FUNCTION_ENTRY();
223 /* Set the Resource Type */
225 aml
->small_header
.descriptor_type
= descriptor_type
;
227 /* Set the Resource Length */
229 acpi_rs_set_resource_length(total_length
, aml
);
232 /*******************************************************************************
234 * FUNCTION: acpi_rs_strcpy
236 * PARAMETERS: destination - Pointer to the destination string
237 * source - Pointer to the source string
239 * RETURN: String length, including NULL terminator
241 * DESCRIPTION: Local string copy that returns the string length, saving a
242 * strcpy followed by a strlen.
244 ******************************************************************************/
246 static u16
acpi_rs_strcpy(char *destination
, char *source
)
250 ACPI_FUNCTION_ENTRY();
252 for (i
= 0; source
[i
]; i
++) {
253 destination
[i
] = source
[i
];
258 /* Return string length including the NULL terminator */
260 return ((u16
) (i
+ 1));
263 /*******************************************************************************
265 * FUNCTION: acpi_rs_get_resource_source
267 * PARAMETERS: resource_length - Length field of the descriptor
268 * minimum_length - Minimum length of the descriptor (minus
269 * any optional fields)
270 * resource_source - Where the resource_source is returned
271 * aml - Pointer to the raw AML descriptor
272 * string_ptr - (optional) where to store the actual
273 * resource_source string
275 * RETURN: Length of the string plus NULL terminator, rounded up to native
278 * DESCRIPTION: Copy the optional resource_source data from a raw AML descriptor
279 * to an internal resource descriptor
281 ******************************************************************************/
284 acpi_rs_get_resource_source(acpi_rs_length resource_length
,
285 acpi_rs_length minimum_length
,
286 struct acpi_resource_source
* resource_source
,
287 union aml_resource
* aml
, char *string_ptr
)
289 acpi_rsdesc_size total_length
;
290 u8
*aml_resource_source
;
292 ACPI_FUNCTION_ENTRY();
295 resource_length
+ sizeof(struct aml_resource_large_header
);
296 aml_resource_source
= ACPI_ADD_PTR(u8
, aml
, minimum_length
);
299 * resource_source is present if the length of the descriptor is longer
300 * than the minimum length.
302 * Note: Some resource descriptors will have an additional null, so
303 * we add 1 to the minimum length.
305 if (total_length
> (acpi_rsdesc_size
)(minimum_length
+ 1)) {
307 /* Get the resource_source_index */
309 resource_source
->index
= aml_resource_source
[0];
311 resource_source
->string_ptr
= string_ptr
;
314 * String destination pointer is not specified; Set the String
315 * pointer to the end of the current resource_source structure.
317 resource_source
->string_ptr
=
318 ACPI_ADD_PTR(char, resource_source
,
319 sizeof(struct acpi_resource_source
));
323 * In order for the Resource length to be a multiple of the native
324 * word, calculate the length of the string (+1 for NULL terminator)
325 * and expand to the next word multiple.
327 * Zero the entire area of the buffer.
330 (u32
)strlen(ACPI_CAST_PTR(char, &aml_resource_source
[1])) +
333 total_length
= (u32
)ACPI_ROUND_UP_TO_NATIVE_WORD(total_length
);
335 memset(resource_source
->string_ptr
, 0, total_length
);
337 /* Copy the resource_source string to the destination */
339 resource_source
->string_length
=
340 acpi_rs_strcpy(resource_source
->string_ptr
,
342 &aml_resource_source
[1]));
344 return ((acpi_rs_length
)total_length
);
347 /* resource_source is not present */
349 resource_source
->index
= 0;
350 resource_source
->string_length
= 0;
351 resource_source
->string_ptr
= NULL
;
355 /*******************************************************************************
357 * FUNCTION: acpi_rs_set_resource_source
359 * PARAMETERS: aml - Pointer to the raw AML descriptor
360 * minimum_length - Minimum length of the descriptor (minus
361 * any optional fields)
362 * resource_source - Internal resource_source
365 * RETURN: Total length of the AML descriptor
367 * DESCRIPTION: Convert an optional resource_source from internal format to a
368 * raw AML resource descriptor
370 ******************************************************************************/
373 acpi_rs_set_resource_source(union aml_resource
*aml
,
374 acpi_rs_length minimum_length
,
375 struct acpi_resource_source
*resource_source
)
377 u8
*aml_resource_source
;
378 acpi_rsdesc_size descriptor_length
;
380 ACPI_FUNCTION_ENTRY();
382 descriptor_length
= minimum_length
;
384 /* Non-zero string length indicates presence of a resource_source */
386 if (resource_source
->string_length
) {
388 /* Point to the end of the AML descriptor */
390 aml_resource_source
= ACPI_ADD_PTR(u8
, aml
, minimum_length
);
392 /* Copy the resource_source_index */
394 aml_resource_source
[0] = (u8
) resource_source
->index
;
396 /* Copy the resource_source string */
398 strcpy(ACPI_CAST_PTR(char, &aml_resource_source
[1]),
399 resource_source
->string_ptr
);
402 * Add the length of the string (+ 1 for null terminator) to the
403 * final descriptor length
405 descriptor_length
+= ((acpi_rsdesc_size
)
406 resource_source
->string_length
+ 1);
409 /* Return the new total length of the AML descriptor */
411 return (descriptor_length
);
414 /*******************************************************************************
416 * FUNCTION: acpi_rs_get_prt_method_data
418 * PARAMETERS: node - Device node
419 * ret_buffer - Pointer to a buffer structure for the
424 * DESCRIPTION: This function is called to get the _PRT value of an object
425 * contained in an object specified by the handle passed in
427 * If the function fails an appropriate status will be returned
428 * and the contents of the callers buffer is undefined.
430 ******************************************************************************/
433 acpi_rs_get_prt_method_data(struct acpi_namespace_node
*node
,
434 struct acpi_buffer
*ret_buffer
)
436 union acpi_operand_object
*obj_desc
;
439 ACPI_FUNCTION_TRACE(rs_get_prt_method_data
);
441 /* Parameters guaranteed valid by caller */
443 /* Execute the method, no parameters */
446 acpi_ut_evaluate_object(node
, METHOD_NAME__PRT
, ACPI_BTYPE_PACKAGE
,
448 if (ACPI_FAILURE(status
)) {
449 return_ACPI_STATUS(status
);
453 * Create a resource linked list from the byte stream buffer that comes
454 * back from the _CRS method execution.
456 status
= acpi_rs_create_pci_routing_table(obj_desc
, ret_buffer
);
458 /* On exit, we must delete the object returned by evaluate_object */
460 acpi_ut_remove_reference(obj_desc
);
461 return_ACPI_STATUS(status
);
464 /*******************************************************************************
466 * FUNCTION: acpi_rs_get_crs_method_data
468 * PARAMETERS: node - Device node
469 * ret_buffer - Pointer to a buffer structure for the
474 * DESCRIPTION: This function is called to get the _CRS value of an object
475 * contained in an object specified by the handle passed in
477 * If the function fails an appropriate status will be returned
478 * and the contents of the callers buffer is undefined.
480 ******************************************************************************/
483 acpi_rs_get_crs_method_data(struct acpi_namespace_node
*node
,
484 struct acpi_buffer
*ret_buffer
)
486 union acpi_operand_object
*obj_desc
;
489 ACPI_FUNCTION_TRACE(rs_get_crs_method_data
);
491 /* Parameters guaranteed valid by caller */
493 /* Execute the method, no parameters */
496 acpi_ut_evaluate_object(node
, METHOD_NAME__CRS
, ACPI_BTYPE_BUFFER
,
498 if (ACPI_FAILURE(status
)) {
499 return_ACPI_STATUS(status
);
503 * Make the call to create a resource linked list from the
504 * byte stream buffer that comes back from the _CRS method
507 status
= acpi_rs_create_resource_list(obj_desc
, ret_buffer
);
509 /* On exit, we must delete the object returned by evaluateObject */
511 acpi_ut_remove_reference(obj_desc
);
512 return_ACPI_STATUS(status
);
515 /*******************************************************************************
517 * FUNCTION: acpi_rs_get_prs_method_data
519 * PARAMETERS: node - Device node
520 * ret_buffer - Pointer to a buffer structure for the
525 * DESCRIPTION: This function is called to get the _PRS value of an object
526 * contained in an object specified by the handle passed in
528 * If the function fails an appropriate status will be returned
529 * and the contents of the callers buffer is undefined.
531 ******************************************************************************/
534 acpi_rs_get_prs_method_data(struct acpi_namespace_node
*node
,
535 struct acpi_buffer
*ret_buffer
)
537 union acpi_operand_object
*obj_desc
;
540 ACPI_FUNCTION_TRACE(rs_get_prs_method_data
);
542 /* Parameters guaranteed valid by caller */
544 /* Execute the method, no parameters */
547 acpi_ut_evaluate_object(node
, METHOD_NAME__PRS
, ACPI_BTYPE_BUFFER
,
549 if (ACPI_FAILURE(status
)) {
550 return_ACPI_STATUS(status
);
554 * Make the call to create a resource linked list from the
555 * byte stream buffer that comes back from the _CRS method
558 status
= acpi_rs_create_resource_list(obj_desc
, ret_buffer
);
560 /* On exit, we must delete the object returned by evaluateObject */
562 acpi_ut_remove_reference(obj_desc
);
563 return_ACPI_STATUS(status
);
566 /*******************************************************************************
568 * FUNCTION: acpi_rs_get_aei_method_data
570 * PARAMETERS: node - Device node
571 * ret_buffer - Pointer to a buffer structure for the
576 * DESCRIPTION: This function is called to get the _AEI value of an object
577 * contained in an object specified by the handle passed in
579 * If the function fails an appropriate status will be returned
580 * and the contents of the callers buffer is undefined.
582 ******************************************************************************/
585 acpi_rs_get_aei_method_data(struct acpi_namespace_node
*node
,
586 struct acpi_buffer
*ret_buffer
)
588 union acpi_operand_object
*obj_desc
;
591 ACPI_FUNCTION_TRACE(rs_get_aei_method_data
);
593 /* Parameters guaranteed valid by caller */
595 /* Execute the method, no parameters */
598 acpi_ut_evaluate_object(node
, METHOD_NAME__AEI
, ACPI_BTYPE_BUFFER
,
600 if (ACPI_FAILURE(status
)) {
601 return_ACPI_STATUS(status
);
605 * Make the call to create a resource linked list from the
606 * byte stream buffer that comes back from the _CRS method
609 status
= acpi_rs_create_resource_list(obj_desc
, ret_buffer
);
611 /* On exit, we must delete the object returned by evaluateObject */
613 acpi_ut_remove_reference(obj_desc
);
614 return_ACPI_STATUS(status
);
617 /*******************************************************************************
619 * FUNCTION: acpi_rs_get_method_data
621 * PARAMETERS: handle - Handle to the containing object
622 * path - Path to method, relative to Handle
623 * ret_buffer - Pointer to a buffer structure for the
628 * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
629 * object contained in an object specified by the handle passed in
631 * If the function fails an appropriate status will be returned
632 * and the contents of the callers buffer is undefined.
634 ******************************************************************************/
637 acpi_rs_get_method_data(acpi_handle handle
,
638 const char *path
, struct acpi_buffer
*ret_buffer
)
640 union acpi_operand_object
*obj_desc
;
643 ACPI_FUNCTION_TRACE(rs_get_method_data
);
645 /* Parameters guaranteed valid by caller */
647 /* Execute the method, no parameters */
650 acpi_ut_evaluate_object(ACPI_CAST_PTR
651 (struct acpi_namespace_node
, handle
), path
,
652 ACPI_BTYPE_BUFFER
, &obj_desc
);
653 if (ACPI_FAILURE(status
)) {
654 return_ACPI_STATUS(status
);
658 * Make the call to create a resource linked list from the
659 * byte stream buffer that comes back from the method
662 status
= acpi_rs_create_resource_list(obj_desc
, ret_buffer
);
664 /* On exit, we must delete the object returned by evaluate_object */
666 acpi_ut_remove_reference(obj_desc
);
667 return_ACPI_STATUS(status
);
670 /*******************************************************************************
672 * FUNCTION: acpi_rs_set_srs_method_data
674 * PARAMETERS: node - Device node
675 * in_buffer - Pointer to a buffer structure of the
680 * DESCRIPTION: This function is called to set the _SRS of an object contained
681 * in an object specified by the handle passed in
683 * If the function fails an appropriate status will be returned
684 * and the contents of the callers buffer is undefined.
686 * Note: Parameters guaranteed valid by caller
688 ******************************************************************************/
691 acpi_rs_set_srs_method_data(struct acpi_namespace_node
*node
,
692 struct acpi_buffer
*in_buffer
)
694 struct acpi_evaluate_info
*info
;
695 union acpi_operand_object
*args
[2];
697 struct acpi_buffer buffer
;
699 ACPI_FUNCTION_TRACE(rs_set_srs_method_data
);
701 /* Allocate and initialize the evaluation information block */
703 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
705 return_ACPI_STATUS(AE_NO_MEMORY
);
708 info
->prefix_node
= node
;
709 info
->relative_pathname
= METHOD_NAME__SRS
;
710 info
->parameters
= args
;
711 info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
714 * The in_buffer parameter will point to a linked list of
715 * resource parameters. It needs to be formatted into a
716 * byte stream to be sent in as an input parameter to _SRS
718 * Convert the linked list into a byte stream
720 buffer
.length
= ACPI_ALLOCATE_LOCAL_BUFFER
;
721 status
= acpi_rs_create_aml_resources(in_buffer
, &buffer
);
722 if (ACPI_FAILURE(status
)) {
726 /* Create and initialize the method parameter object */
728 args
[0] = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER
);
731 * Must free the buffer allocated above (otherwise it is freed
734 ACPI_FREE(buffer
.pointer
);
735 status
= AE_NO_MEMORY
;
739 args
[0]->buffer
.length
= (u32
) buffer
.length
;
740 args
[0]->buffer
.pointer
= buffer
.pointer
;
741 args
[0]->common
.flags
= AOPOBJ_DATA_VALID
;
744 /* Execute the method, no return value is expected */
746 status
= acpi_ns_evaluate(info
);
748 /* Clean up and return the status from acpi_ns_evaluate */
750 acpi_ut_remove_reference(args
[0]);
754 return_ACPI_STATUS(status
);