1*4882a593Smuzhiyun /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */ 2*4882a593Smuzhiyun /****************************************************************************** 3*4882a593Smuzhiyun * 4*4882a593Smuzhiyun * Module Name: acapps - common include for ACPI applications/tools 5*4882a593Smuzhiyun * 6*4882a593Smuzhiyun * Copyright (C) 2000 - 2020, Intel Corp. 7*4882a593Smuzhiyun * 8*4882a593Smuzhiyun *****************************************************************************/ 9*4882a593Smuzhiyun 10*4882a593Smuzhiyun #ifndef _ACAPPS 11*4882a593Smuzhiyun #define _ACAPPS 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun #ifdef ACPI_USE_STANDARD_HEADERS 14*4882a593Smuzhiyun #include <sys/stat.h> 15*4882a593Smuzhiyun #endif /* ACPI_USE_STANDARD_HEADERS */ 16*4882a593Smuzhiyun 17*4882a593Smuzhiyun /* Common info for tool signons */ 18*4882a593Smuzhiyun 19*4882a593Smuzhiyun #define ACPICA_NAME "Intel ACPI Component Architecture" 20*4882a593Smuzhiyun #define ACPICA_COPYRIGHT "Copyright (c) 2000 - 2020 Intel Corporation" 21*4882a593Smuzhiyun 22*4882a593Smuzhiyun #if ACPI_MACHINE_WIDTH == 64 23*4882a593Smuzhiyun #define ACPI_WIDTH " (64-bit version)" 24*4882a593Smuzhiyun 25*4882a593Smuzhiyun #elif ACPI_MACHINE_WIDTH == 32 26*4882a593Smuzhiyun #define ACPI_WIDTH " (32-bit version)" 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun #else 29*4882a593Smuzhiyun #error unknown ACPI_MACHINE_WIDTH 30*4882a593Smuzhiyun #define ACPI_WIDTH " (unknown bit width, not 32 or 64)" 31*4882a593Smuzhiyun 32*4882a593Smuzhiyun #endif 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun /* Macros for signons and file headers */ 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun #define ACPI_COMMON_SIGNON(utility_name) \ 37*4882a593Smuzhiyun "\n%s\n%s version %8.8X\n%s\n\n", \ 38*4882a593Smuzhiyun ACPICA_NAME, \ 39*4882a593Smuzhiyun utility_name, ((u32) ACPI_CA_VERSION), \ 40*4882a593Smuzhiyun ACPICA_COPYRIGHT 41*4882a593Smuzhiyun 42*4882a593Smuzhiyun #define ACPI_COMMON_HEADER(utility_name, prefix) \ 43*4882a593Smuzhiyun "%s%s\n%s%s version %8.8X%s\n%s%s\n%s\n", \ 44*4882a593Smuzhiyun prefix, ACPICA_NAME, \ 45*4882a593Smuzhiyun prefix, utility_name, ((u32) ACPI_CA_VERSION), ACPI_WIDTH, \ 46*4882a593Smuzhiyun prefix, ACPICA_COPYRIGHT, \ 47*4882a593Smuzhiyun prefix 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun #define ACPI_COMMON_BUILD_TIME \ 50*4882a593Smuzhiyun "Build date/time: %s %s\n", __DATE__, __TIME__ 51*4882a593Smuzhiyun 52*4882a593Smuzhiyun /* Macros for usage messages */ 53*4882a593Smuzhiyun 54*4882a593Smuzhiyun #define ACPI_USAGE_HEADER(usage) \ 55*4882a593Smuzhiyun printf ("Usage: %s\nOptions:\n", usage); 56*4882a593Smuzhiyun 57*4882a593Smuzhiyun #define ACPI_USAGE_TEXT(description) \ 58*4882a593Smuzhiyun printf (description); 59*4882a593Smuzhiyun 60*4882a593Smuzhiyun #define ACPI_OPTION(name, description) \ 61*4882a593Smuzhiyun printf (" %-20s%s\n", name, description); 62*4882a593Smuzhiyun 63*4882a593Smuzhiyun /* Check for unexpected exceptions */ 64*4882a593Smuzhiyun 65*4882a593Smuzhiyun #define ACPI_CHECK_STATUS(name, status, expected) \ 66*4882a593Smuzhiyun if (status != expected) \ 67*4882a593Smuzhiyun { \ 68*4882a593Smuzhiyun acpi_os_printf ("Unexpected %s from %s (%s-%d)\n", \ 69*4882a593Smuzhiyun acpi_format_exception (status), #name, _acpi_module_name, __LINE__); \ 70*4882a593Smuzhiyun } 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun /* Check for unexpected non-AE_OK errors */ 73*4882a593Smuzhiyun 74*4882a593Smuzhiyun #define ACPI_CHECK_OK(name, status) ACPI_CHECK_STATUS (name, status, AE_OK); 75*4882a593Smuzhiyun 76*4882a593Smuzhiyun #define FILE_SUFFIX_DISASSEMBLY "dsl" 77*4882a593Smuzhiyun #define FILE_SUFFIX_BINARY_TABLE ".dat" /* Needs the dot */ 78*4882a593Smuzhiyun 79*4882a593Smuzhiyun /* acfileio */ 80*4882a593Smuzhiyun 81*4882a593Smuzhiyun acpi_status 82*4882a593Smuzhiyun ac_get_all_tables_from_file(char *filename, 83*4882a593Smuzhiyun u8 get_only_aml_tables, 84*4882a593Smuzhiyun struct acpi_new_table_desc **return_list_head); 85*4882a593Smuzhiyun 86*4882a593Smuzhiyun void ac_delete_table_list(struct acpi_new_table_desc *list_head); 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun u8 ac_is_file_binary(FILE * file); 89*4882a593Smuzhiyun 90*4882a593Smuzhiyun acpi_status ac_validate_table_header(FILE * file, long table_offset); 91*4882a593Smuzhiyun 92*4882a593Smuzhiyun /* Values for get_only_aml_tables */ 93*4882a593Smuzhiyun 94*4882a593Smuzhiyun #define ACPI_GET_ONLY_AML_TABLES TRUE 95*4882a593Smuzhiyun #define ACPI_GET_ALL_TABLES FALSE 96*4882a593Smuzhiyun 97*4882a593Smuzhiyun /* 98*4882a593Smuzhiyun * getopt 99*4882a593Smuzhiyun */ 100*4882a593Smuzhiyun int acpi_getopt(int argc, char **argv, char *opts); 101*4882a593Smuzhiyun 102*4882a593Smuzhiyun int acpi_getopt_argument(int argc, char **argv); 103*4882a593Smuzhiyun 104*4882a593Smuzhiyun extern int acpi_gbl_optind; 105*4882a593Smuzhiyun extern int acpi_gbl_opterr; 106*4882a593Smuzhiyun extern int acpi_gbl_sub_opt_char; 107*4882a593Smuzhiyun extern char *acpi_gbl_optarg; 108*4882a593Smuzhiyun 109*4882a593Smuzhiyun /* 110*4882a593Smuzhiyun * cmfsize - Common get file size function 111*4882a593Smuzhiyun */ 112*4882a593Smuzhiyun u32 cm_get_file_size(ACPI_FILE file); 113*4882a593Smuzhiyun 114*4882a593Smuzhiyun /* 115*4882a593Smuzhiyun * adwalk 116*4882a593Smuzhiyun */ 117*4882a593Smuzhiyun void 118*4882a593Smuzhiyun acpi_dm_cross_reference_namespace(union acpi_parse_object *parse_tree_root, 119*4882a593Smuzhiyun struct acpi_namespace_node *namespace_root, 120*4882a593Smuzhiyun acpi_owner_id owner_id); 121*4882a593Smuzhiyun 122*4882a593Smuzhiyun void acpi_dm_dump_tree(union acpi_parse_object *origin); 123*4882a593Smuzhiyun 124*4882a593Smuzhiyun void acpi_dm_find_orphan_methods(union acpi_parse_object *origin); 125*4882a593Smuzhiyun 126*4882a593Smuzhiyun void 127*4882a593Smuzhiyun acpi_dm_finish_namespace_load(union acpi_parse_object *parse_tree_root, 128*4882a593Smuzhiyun struct acpi_namespace_node *namespace_root, 129*4882a593Smuzhiyun acpi_owner_id owner_id); 130*4882a593Smuzhiyun 131*4882a593Smuzhiyun void 132*4882a593Smuzhiyun acpi_dm_convert_parse_objects(union acpi_parse_object *parse_tree_root, 133*4882a593Smuzhiyun struct acpi_namespace_node *namespace_root); 134*4882a593Smuzhiyun 135*4882a593Smuzhiyun /* 136*4882a593Smuzhiyun * adfile 137*4882a593Smuzhiyun */ 138*4882a593Smuzhiyun acpi_status ad_initialize(void); 139*4882a593Smuzhiyun 140*4882a593Smuzhiyun char *fl_generate_filename(char *input_filename, char *suffix); 141*4882a593Smuzhiyun 142*4882a593Smuzhiyun acpi_status 143*4882a593Smuzhiyun fl_split_input_pathname(char *input_path, 144*4882a593Smuzhiyun char **out_directory_path, char **out_filename); 145*4882a593Smuzhiyun 146*4882a593Smuzhiyun char *fl_get_file_basename(char *file_pathname); 147*4882a593Smuzhiyun 148*4882a593Smuzhiyun char *ad_generate_filename(char *prefix, char *table_id); 149*4882a593Smuzhiyun 150*4882a593Smuzhiyun void 151*4882a593Smuzhiyun ad_write_table(struct acpi_table_header *table, 152*4882a593Smuzhiyun u32 length, char *table_name, char *oem_table_id); 153*4882a593Smuzhiyun 154*4882a593Smuzhiyun #endif /* _ACAPPS */ 155