// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
/******************************************************************************
 *
 * Module Name: tbprint - Table output utilities
 *
 * Copyright (C) 2000 - 2025, Intel Corp.
 *
 *****************************************************************************/

#include <acpi/acpi.h>
#include "accommon.h"
#include "actables.h"
#include "acutils.h"

#define _COMPONENT          ACPI_TABLES
ACPI_MODULE_NAME("tbprint")

/* Local prototypes */
static void acpi_tb_fix_string(char *string, acpi_size length);

static void
acpi_tb_cleanup_table_header(struct acpi_table_header *out_header,
                             struct acpi_table_header *header);

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_fix_string
 *
 * PARAMETERS:  string              - String to be repaired
 *              length              - Maximum length
 *
 * RETURN:      None
 *
 * DESCRIPTION: Replace every non-printable or non-ascii byte in the string
 *              with a question mark '?'.
 *
 ******************************************************************************/

static void acpi_tb_fix_string(char *string, acpi_size length)
{

        while (length && *string) {
                if (!isprint((int)(u8)*string)) {
                        *string = '?';
                }

                string++;
                length--;
        }
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_cleanup_table_header
 *
 * PARAMETERS:  out_header          - Where the cleaned header is returned
 *              header              - Input ACPI table header
 *
 * RETURN:      Returns the cleaned header in out_header
 *
 * DESCRIPTION: Copy the table header and ensure that all "string" fields in
 *              the header consist of printable characters.
 *
 ******************************************************************************/

static void
acpi_tb_cleanup_table_header(struct acpi_table_header *out_header,
                             struct acpi_table_header *header)
{

        memcpy(out_header, header, sizeof(struct acpi_table_header));

        acpi_tb_fix_string(out_header->signature, ACPI_NAMESEG_SIZE);
        acpi_tb_fix_string(out_header->oem_id, ACPI_OEM_ID_SIZE);
        acpi_tb_fix_string(out_header->oem_table_id, ACPI_OEM_TABLE_ID_SIZE);
        acpi_tb_fix_string(out_header->asl_compiler_id, ACPI_NAMESEG_SIZE);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_tb_print_table_header
 *
 * PARAMETERS:  address             - Table physical address
 *              header              - Table header
 *
 * RETURN:      None
 *
 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
 *
 ******************************************************************************/

void
acpi_tb_print_table_header(acpi_physical_address address,
                           struct acpi_table_header *header)
{
        struct acpi_table_header local_header;

#pragma GCC diagnostic push
#if defined(__GNUC__) && __GNUC__ >= 11
#pragma GCC diagnostic ignored "-Wstringop-overread"
#endif

        if (ACPI_COMPARE_NAMESEG(header->signature, ACPI_SIG_FACS)) {

                /* FACS only has signature and length fields */

                ACPI_INFO(("%-4.4s 0x%8.8X%8.8X %06X",
                           header->signature, ACPI_FORMAT_UINT64(address),
                           header->length));
        } else if (ACPI_VALIDATE_RSDP_SIG(ACPI_CAST_PTR(struct acpi_table_rsdp,
                                                        header)->signature)) {

                /* RSDP has no common fields */

                memcpy(local_header.oem_id,
                       ACPI_CAST_PTR(struct acpi_table_rsdp, header)->oem_id,
                       ACPI_OEM_ID_SIZE);
                acpi_tb_fix_string(local_header.oem_id, ACPI_OEM_ID_SIZE);

                ACPI_INFO(("RSDP 0x%8.8X%8.8X %06X (v%.2d %-6.6s)",
                           ACPI_FORMAT_UINT64(address),
                           (ACPI_CAST_PTR(struct acpi_table_rsdp, header)->
                            revision >
                            0) ? ACPI_CAST_PTR(struct acpi_table_rsdp,
                                               header)->length : 20,
                           ACPI_CAST_PTR(struct acpi_table_rsdp,
                                         header)->revision,
                           local_header.oem_id));
        } else if (acpi_gbl_CDAT && !acpi_ut_valid_nameseg(header->signature)) {

                /* CDAT does not use the common ACPI table header */

                ACPI_INFO(("%-4.4s 0x%8.8X%8.8X %06X",
                           ACPI_SIG_CDAT, ACPI_FORMAT_UINT64(address),
                           ACPI_CAST_PTR(struct acpi_table_cdat,
                                         header)->length));
        } else {
                /* Standard ACPI table with full common header */

                acpi_tb_cleanup_table_header(&local_header, header);

                ACPI_INFO(("%-4.4s 0x%8.8X%8.8X"
                           " %06X (v%.2d %-6.6s %-8.8s %08X %-4.4s %08X)",
                           local_header.signature, ACPI_FORMAT_UINT64(address),
                           local_header.length, local_header.revision,
                           local_header.oem_id, local_header.oem_table_id,
                           local_header.oem_revision,
                           local_header.asl_compiler_id,
                           local_header.asl_compiler_revision));
        }
#pragma GCC diagnostic pop
}