acpi/acpica/acapps.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Module Name: acapps - common include for ACPI applications/tools
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009
0010 #ifndef _ACAPPS
0011 #define _ACAPPS
0012
0013 #ifdef ACPI_USE_STANDARD_HEADERS
0014 #include <sys/stat.h>
0015 #endif              /* ACPI_USE_STANDARD_HEADERS */
0016
0017 /* Common info for tool signons */
0018
0019 #define ACPICA_NAME                 "Intel ACPI Component Architecture"
0020 #define ACPICA_COPYRIGHT            "Copyright (c) 2000 - 2022 Intel Corporation"
0021
0022 #if ACPI_MACHINE_WIDTH == 64
0023 #define ACPI_WIDTH          " (64-bit version)"
0024
0025 #elif ACPI_MACHINE_WIDTH == 32
0026 #define ACPI_WIDTH          " (32-bit version)"
0027
0028 #else
0029 #error unknown ACPI_MACHINE_WIDTH
0030 #define ACPI_WIDTH          " (unknown bit width, not 32 or 64)"
0031
0032 #endif
0033
0034 /* Macros for signons and file headers */
0035
0036 #define ACPI_COMMON_SIGNON(utility_name) \
0037     "\n%s\n%s version %8.8X\n%s\n\n", \
0038     ACPICA_NAME, \
0039     utility_name, ((u32) ACPI_CA_VERSION), \
0040     ACPICA_COPYRIGHT
0041
0042 #define ACPI_COMMON_HEADER(utility_name, prefix) \
0043     "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \
0044     prefix, ACPICA_NAME, \
0045     prefix, utility_name, ((u32) ACPI_CA_VERSION), ACPI_WIDTH, \
0046     prefix, ACPICA_COPYRIGHT, \
0047     prefix
0048
0049 #define ACPI_COMMON_BUILD_TIME \
0050     "Build date/time: %s %s\n", __DATE__, __TIME__
0051
0052 /* Macros for usage messages */
0053
0054 #define ACPI_USAGE_HEADER(usage) \
0055     printf ("Usage: %s\nOptions:\n", usage);
0056
0057 #define ACPI_USAGE_TEXT(description) \
0058     printf (description);
0059
0060 #define ACPI_OPTION(name, description) \
0061     printf ("  %-20s%s\n", name, description);
0062
0063 /* Check for unexpected exceptions */
0064
0065 #define ACPI_CHECK_STATUS(name, status, expected) \
0066     if (status != expected) \
0067     { \
0068         acpi_os_printf ("Unexpected %s from %s (%s-%d)\n", \
0069             acpi_format_exception (status), #name, _acpi_module_name, __LINE__); \
0070     }
0071
0072 /* Check for unexpected non-AE_OK errors */
0073
0074 #define ACPI_CHECK_OK(name, status)   ACPI_CHECK_STATUS (name, status, AE_OK);
0075
0076 #define FILE_SUFFIX_DISASSEMBLY     "dsl"
0077 #define FILE_SUFFIX_BINARY_TABLE    ".dat"  /* Needs the dot */
0078
0079 /* acfileio */
0080
0081 acpi_status
0082 ac_get_all_tables_from_file(char *filename,
0083                 u8 get_only_aml_tables,
0084                 struct acpi_new_table_desc **return_list_head);
0085
0086 void ac_delete_table_list(struct acpi_new_table_desc *list_head);
0087
0088 u8 ac_is_file_binary(FILE * file);
0089
0090 acpi_status ac_validate_table_header(FILE * file, long table_offset);
0091
0092 /* Values for get_only_aml_tables */
0093
0094 #define ACPI_GET_ONLY_AML_TABLES    TRUE
0095 #define ACPI_GET_ALL_TABLES         FALSE
0096
0097 /*
0098  * getopt
0099  */
0100 int acpi_getopt(int argc, char **argv, char *opts);
0101
0102 int acpi_getopt_argument(int argc, char **argv);
0103
0104 extern int acpi_gbl_optind;
0105 extern int acpi_gbl_opterr;
0106 extern int acpi_gbl_sub_opt_char;
0107 extern char *acpi_gbl_optarg;
0108
0109 /*
0110  * cmfsize - Common get file size function
0111  */
0112 u32 cm_get_file_size(ACPI_FILE file);
0113
0114 /*
0115  * adwalk
0116  */
0117 void
0118 acpi_dm_cross_reference_namespace(union acpi_parse_object *parse_tree_root,
0119                   struct acpi_namespace_node *namespace_root,
0120                   acpi_owner_id owner_id);
0121
0122 void acpi_dm_dump_tree(union acpi_parse_object *origin);
0123
0124 void acpi_dm_find_orphan_methods(union acpi_parse_object *origin);
0125
0126 void
0127 acpi_dm_finish_namespace_load(union acpi_parse_object *parse_tree_root,
0128                   struct acpi_namespace_node *namespace_root,
0129                   acpi_owner_id owner_id);
0130
0131 void
0132 acpi_dm_convert_parse_objects(union acpi_parse_object *parse_tree_root,
0133                   struct acpi_namespace_node *namespace_root);
0134
0135 /*
0136  * adfile
0137  */
0138 acpi_status ad_initialize(void);
0139
0140 char *fl_generate_filename(char *input_filename, char *suffix);
0141
0142 acpi_status
0143 fl_split_input_pathname(char *input_path,
0144             char **out_directory_path, char **out_filename);
0145
0146 char *fl_get_file_basename(char *file_pathname);
0147
0148 char *ad_generate_filename(char *prefix, char *table_id);
0149
0150 void
0151 ad_write_table(struct acpi_table_header *table,
0152            u32 length, char *table_name, char *oem_table_id);
0153
0154 #endif              /* _ACAPPS */