ACK: [PATCH] acpi: uniqueid: add tests for _HID/_CID vs. _UID
Colin Ian King
colin.king at canonical.com
Mon Mar 29 08:16:40 UTC 2021
On 13/03/2021 03:16, Alex Hung wrote:
> ACPI spec requires "The _UID must be unique across all devices
> with either a common _HID or _CID."
>
> BugLink: https://bugs.launchpad.net/bugs/1912532
>
> Signed-off-by: Alex Hung <alex.hung at canonical.com>
> ---
> src/Makefile.am | 1 +
> src/acpi/method/method.c | 9 +-
> src/acpi/uniqueid/uniqueid.c | 224 ++++++++++++++++++++++++
> src/lib/include/fwts_acpi_object_eval.h | 1 +
> 4 files changed, 229 insertions(+), 6 deletions(-)
> create mode 100644 src/acpi/uniqueid/uniqueid.c
>
> diff --git a/src/Makefile.am b/src/Makefile.am
> index b7f3f7db..b0f096fc 100644
> --- a/src/Makefile.am
> +++ b/src/Makefile.am
> @@ -140,6 +140,7 @@ fwts_SOURCES = main.c \
> acpi/tcpa/tcpa.c \
> acpi/tpm2/tpm2.c \
> acpi/uefi/uefi.c \
> + acpi/uniqueid/uniqueid.c \
> acpi/waet/waet.c \
> acpi/wakealarm/wakealarm.c \
> acpi/wdat/wdat.c \
> diff --git a/src/acpi/method/method.c b/src/acpi/method/method.c
> index 9be75caa..f5253de9 100644
> --- a/src/acpi/method/method.c
> +++ b/src/acpi/method/method.c
> @@ -278,9 +278,6 @@ static int method_test ## name(fwts_framework *fw) \
> NULL, 0, fwts_method_test_integer_return, # name); \
> }
>
> -typedef void (*method_test_return)(fwts_framework *fw, char *name,
> - ACPI_BUFFER *ret_buff, ACPI_OBJECT *ret_obj, void *private);
> -
> /*
> * Helper functions to facilitate the evaluations
> */
> @@ -340,10 +337,10 @@ static int method_deinit(fwts_framework *fw)
> * method_evaluate_found_method
> * find a given object name and evaluate it
> */
> -static void method_evaluate_found_method(
> +void method_evaluate_found_method(
> fwts_framework *fw,
> char *name,
> - method_test_return check_func,
> + fwts_method_return check_func,
> void *private,
> ACPI_OBJECT_LIST *arg_list)
> {
> @@ -393,7 +390,7 @@ static int method_evaluate_method(fwts_framework *fw,
> char *name,
> ACPI_OBJECT *args,
> int num_args,
> - method_test_return check_func,
> + fwts_method_return check_func,
> void *private)
> {
> fwts_list *methods;
> diff --git a/src/acpi/uniqueid/uniqueid.c b/src/acpi/uniqueid/uniqueid.c
> new file mode 100644
> index 00000000..7dcbf6a6
> --- /dev/null
> +++ b/src/acpi/uniqueid/uniqueid.c
> @@ -0,0 +1,224 @@
> +/*
> + * Copyright (C) 2015-2021 Canonical
> + *
> + * This program is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU General Public License
> + * as published by the Free Software Foundation; either version 2
> + * of the License, or (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
> + *
> + */
> +#include "fwts.h"
> +
> +#if defined(FWTS_HAS_ACPI)
> +
> +#include <stdlib.h>
> +#include <stdio.h>
> +#include <unistd.h>
> +#include <inttypes.h>
> +#include <string.h>
> +#include <bsd/string.h>
> +
> +#include "fwts_acpi_object_eval.h"
> +
> +typedef struct {
> + char *hid_name;
> + ACPI_OBJECT *hid_obj; /* this can be _HID or _CID */
> + ACPI_OBJECT *uid_obj;
> +} acpi_ids;
> +
> +static fwts_list *hid_list;
> +
> +static int uniqueid_init(fwts_framework *fw)
> +{
> + if (fwts_acpi_init(fw) != FWTS_OK) {
> + fwts_log_error(fw, "Cannot initialise ACPI.");
> + return FWTS_ERROR;
> + }
> +
> + if ((hid_list = fwts_list_new()) == NULL)
> + return FWTS_ERROR;
> +
> + return FWTS_OK;
> +}
> +
> +static int uniqueid_deinit(fwts_framework *fw)
> +{
> + fwts_keymap_free(hid_list);
> + return fwts_acpi_deinit(fw);
> +}
> +
> +static int uniqueid_evaluate_method(fwts_framework *fw,
> + char *name,
> + ACPI_OBJECT *args,
> + int num_args,
> + fwts_method_return check_func,
> + void *private)
> +{
> + fwts_list *methods;
> + size_t name_len = strlen(name);
> +
> + if ((methods = fwts_acpi_object_get_names()) != NULL) {
> + fwts_list_link *item;
> +
> + fwts_list_foreach(item, methods) {
> + char *method_name = fwts_list_data(char*, item);
> + ACPI_HANDLE method_handle;
> + ACPI_OBJECT_TYPE type;
> + ACPI_STATUS status;
> +
> + size_t len = strlen(method_name);
> + if (strncmp(name, method_name + len - name_len, name_len) == 0) {
> + ACPI_OBJECT_LIST arg_list;
> +
> + status = AcpiGetHandle (NULL, method_name, &method_handle);
> + if (ACPI_FAILURE(status)) {
> + fwts_warning(fw, "Failed to get handle for object %s.", name);
> + continue;
> + }
> + status = AcpiGetType(method_handle, &type);
> + if (ACPI_FAILURE(status)) {
> + fwts_warning(fw, "Failed to get object type for %s.",name);
> + continue;
> + }
> +
> + if (type == ACPI_TYPE_LOCAL_SCOPE)
> + continue;
> +
> + arg_list.Count = num_args;
> + arg_list.Pointer = args;
> + method_evaluate_found_method(fw, method_name,
> + check_func, private, &arg_list);
> + }
> + }
> + }
> +
> + return FWTS_OK;
> +}
> +
> +static bool is_uniqueid_equal(acpi_ids *obj1, acpi_ids *obj2)
> +{
> + bool hid_match = false;
> +
> + if (obj1 == NULL || obj2 == NULL)
> + return false;
> +
> + if ((obj1->hid_obj->Type != obj2->hid_obj->Type) || (obj1->uid_obj->Type != obj2->uid_obj->Type))
> + return false;
> +
> + switch (obj1->hid_obj->Type) {
> + case ACPI_TYPE_STRING:
> + if (strcmp(obj1->hid_obj->String.Pointer, obj2->hid_obj->String.Pointer))
> + return false;
> + hid_match = true;
> + break;
> + case ACPI_TYPE_INTEGER:
> + if (obj1->hid_obj->Integer.Value != obj2->hid_obj->Integer.Value)
> + return false;
> + hid_match = true;
> + break;
> + }
> +
> + switch (obj1->uid_obj->Type) {
> + case ACPI_TYPE_STRING:
> + if (strcmp(obj1->uid_obj->String.Pointer, obj2->uid_obj->String.Pointer) && hid_match)
> + return false;
> + break;
> + case ACPI_TYPE_INTEGER:
> + if (obj1->uid_obj->Integer.Value != obj2->uid_obj->Integer.Value && hid_match)
> + return false;
> + break;
> + }
> +
> + return true;
> +}
> +
> +static void unique_HID_return(
> + fwts_framework *fw,
> + char *name,
> + ACPI_BUFFER *buf,
> + ACPI_OBJECT *obj,
> + void *private)
> +{
> + char *uid_name = (char*) malloc(strlen(name) + 1);
> + ACPI_OBJECT *hid_obj, *uid_obj;
> + ACPI_BUFFER hid_buf, uid_buf;
> + fwts_list_link *item;
> + bool passed = true;
> + ACPI_STATUS status;
> + acpi_ids *obj1;
> +
> + FWTS_UNUSED(buf);
> + FWTS_UNUSED(obj);
> + FWTS_UNUSED(private);
> +
> + strlcpy(uid_name, name, strlen(name) + 1);
> + uid_name[strlen(name) - 3] = 'U';
> +
> + status = fwts_acpi_object_evaluate(fw, name, NULL, &hid_buf);
> + if (ACPI_FAILURE(status))
> + return;
> + hid_obj = hid_buf.Pointer;
> +
> + status = fwts_acpi_object_evaluate(fw, uid_name, NULL, &uid_buf);
> + if (ACPI_FAILURE(status))
> + return;
> + uid_obj = uid_buf.Pointer;
> +
> + if ((obj1 = (acpi_ids*)calloc(1, sizeof(acpi_ids))) != NULL) {
> + obj1->hid_name = name;
> + obj1->hid_obj = hid_obj;
> + obj1->uid_obj = uid_obj;
> + }
> +
> + fwts_list_foreach(item, hid_list) {
> + acpi_ids *obj2 = fwts_list_data(acpi_ids*, item);
> + if(is_uniqueid_equal(obj1, obj2)) {
> + passed = false;
> + fwts_failed(fw, LOG_LEVEL_HIGH, "HardwareIDNotUnique",
> + "%s/_UID conflict with %s/_UID", name, obj2->hid_name);
> + break;
> + }
> + }
> +
> + free(uid_name);
> + if (passed) {
> + fwts_list_append(hid_list, obj1);
> + fwts_passed(fw, "%s/_UID is unique.", name);
> + }
> +}
> +
> +static int uniqueid_test1(fwts_framework *fw)
> +{
> + return uniqueid_evaluate_method(fw, "_HID", NULL, 0, unique_HID_return, NULL);
> +}
> +
> +static int uniqueid_test2(fwts_framework *fw)
> +{
> + return uniqueid_evaluate_method(fw, "_CID", NULL, 0, unique_HID_return, NULL);
> +}
> +
> +static fwts_framework_minor_test uniqueid_tests[] = {
> + { uniqueid_test1, "ACPI _HID unique ID test." },
> + { uniqueid_test2, "ACPI _CID unique ID test." },
> + { NULL, NULL }
> +};
> +
> +static fwts_framework_ops uniqueid_ops = {
> + .description = "ACPI Unique IDs test.",
> + .init = uniqueid_init,
> + .deinit = uniqueid_deinit,
> + .minor_tests = uniqueid_tests
> +};
> +
> +FWTS_REGISTER("uniqueid", &uniqueid_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH)
> +
> +#endif
> diff --git a/src/lib/include/fwts_acpi_object_eval.h b/src/lib/include/fwts_acpi_object_eval.h
> index 9328f984..32c8f6bf 100644
> --- a/src/lib/include/fwts_acpi_object_eval.h
> +++ b/src/lib/include/fwts_acpi_object_eval.h
> @@ -139,6 +139,7 @@ void fwts_method_test_package_integer_return(fwts_framework *fw, char *name, ACP
> void fwts_method_test_passed_failed_return(fwts_framework *fw, char *name, ACPI_BUFFER *buf, ACPI_OBJECT *obj, void *private);
> void fwts_method_test_polling_return( fwts_framework *fw, char *name, ACPI_BUFFER *buf, ACPI_OBJECT *obj, void *private);
>
> +void method_evaluate_found_method(fwts_framework *fw, char *name, fwts_method_return check_func, void *private, ACPI_OBJECT_LIST *arg_list);
> void fwts_evaluate_found_method(fwts_framework *fw, ACPI_HANDLE *parent, char *name, fwts_method_return check_func, void *private, ACPI_OBJECT_LIST *arg_list);
> int fwts_evaluate_method(fwts_framework *fw, uint32_t test_type, ACPI_HANDLE *parent, char *name, ACPI_OBJECT *args, uint32_t num_args, fwts_method_return check_func, void *private);
>
>
Thanks Alex,
Acked-by: Colin Ian King <colin.king at canonical.com>
More information about the fwts-devel
mailing list