xref: /openbmc/linux/drivers/acpi/acpica/acconvert.h (revision f1575595)
1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
3  *
4  * Module Name: acapps - common include for ACPI applications/tools
5  *
6  * Copyright (C) 2000 - 2018, Intel Corp.
7  *
8  *****************************************************************************/
9 
10 #ifndef _ACCONVERT
11 #define _ACCONVERT
12 
13 /* Definitions for comment state */
14 
15 #define ASL_COMMENT_STANDARD    1
16 #define ASLCOMMENT_INLINE       2
17 #define ASL_COMMENT_OPEN_PAREN  3
18 #define ASL_COMMENT_CLOSE_PAREN 4
19 #define ASL_COMMENT_CLOSE_BRACE 5
20 
21 /* Definitions for comment print function*/
22 
23 #define AML_COMMENT_STANDARD    1
24 #define AMLCOMMENT_INLINE       2
25 #define AML_COMMENT_END_NODE    3
26 #define AML_NAMECOMMENT         4
27 #define AML_COMMENT_CLOSE_BRACE 5
28 #define AML_COMMENT_ENDBLK      6
29 #define AML_COMMENT_INCLUDE     7
30 
31 #ifdef ACPI_ASL_COMPILER
32 /*
33  * cvcompiler
34  */
35 void
36 cv_process_comment(struct asl_comment_state current_state,
37 		   char *string_buffer, int c1);
38 
39 void
40 cv_process_comment_type2(struct asl_comment_state current_state,
41 			 char *string_buffer);
42 
43 u32 cv_calculate_comment_lengths(union acpi_parse_object *op);
44 
45 void cv_process_comment_state(char input);
46 
47 char *cv_append_inline_comment(char *inline_comment, char *to_add);
48 
49 void cv_add_to_comment_list(char *to_add);
50 
51 void cv_place_comment(u8 type, char *comment_string);
52 
53 u32 cv_parse_op_block_type(union acpi_parse_object *op);
54 
55 struct acpi_comment_node *cv_comment_node_calloc(void);
56 
57 void cg_write_aml_def_block_comment(union acpi_parse_object *op);
58 
59 void
60 cg_write_one_aml_comment(union acpi_parse_object *op,
61 			 char *comment_to_print, u8 input_option);
62 
63 void cg_write_aml_comment(union acpi_parse_object *op);
64 
65 /*
66  * cvparser
67  */
68 void
69 cv_init_file_tree(struct acpi_table_header *table,
70 		  u8 *aml_start, u32 aml_length);
71 
72 void cv_clear_op_comments(union acpi_parse_object *op);
73 
74 struct acpi_file_node *cv_filename_exists(char *filename,
75 					  struct acpi_file_node *head);
76 
77 void cv_label_file_node(union acpi_parse_object *op);
78 
79 void
80 cv_capture_list_comments(struct acpi_parse_state *parser_state,
81 			 struct acpi_comment_node *list_head,
82 			 struct acpi_comment_node *list_tail);
83 
84 void cv_capture_comments_only(struct acpi_parse_state *parser_state);
85 
86 void cv_capture_comments(struct acpi_walk_state *walk_state);
87 
88 void cv_transfer_comments(union acpi_parse_object *op);
89 
90 /*
91  * cvdisasm
92  */
93 void cv_switch_files(u32 level, union acpi_parse_object *op);
94 
95 u8 cv_file_has_switched(union acpi_parse_object *op);
96 
97 void cv_close_paren_write_comment(union acpi_parse_object *op, u32 level);
98 
99 void cv_close_brace_write_comment(union acpi_parse_object *op, u32 level);
100 
101 void
102 cv_print_one_comment_list(struct acpi_comment_node *comment_list, u32 level);
103 
104 void
105 cv_print_one_comment_type(union acpi_parse_object *op,
106 			  u8 comment_type, char *end_str, u32 level);
107 
108 #endif
109 
110 #endif				/* _ACCONVERT */
111