xref: /linux/drivers/acpi/acpica/acconvert.h (revision 1961b06c9126e5b2b949fab806c4e4304d1eae8b)
195857638SErik Schmauss /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
29cf7adecSBob Moore /******************************************************************************
39cf7adecSBob Moore  *
49cf7adecSBob Moore  * Module Name: acapps - common include for ACPI applications/tools
59cf7adecSBob Moore  *
6487ea80aSBob Moore  * Copyright (C) 2000 - 2022, Intel Corp.
79cf7adecSBob Moore  *
895857638SErik Schmauss  *****************************************************************************/
99cf7adecSBob Moore 
109cf7adecSBob Moore #ifndef _ACCONVERT
119cf7adecSBob Moore #define _ACCONVERT
129cf7adecSBob Moore 
139cf7adecSBob Moore /* Definitions for comment state */
149cf7adecSBob Moore 
159cf7adecSBob Moore #define ASL_COMMENT_STANDARD    1
169cf7adecSBob Moore #define ASLCOMMENT_INLINE       2
179cf7adecSBob Moore #define ASL_COMMENT_OPEN_PAREN  3
189cf7adecSBob Moore #define ASL_COMMENT_CLOSE_PAREN 4
199cf7adecSBob Moore #define ASL_COMMENT_CLOSE_BRACE 5
209cf7adecSBob Moore 
219cf7adecSBob Moore /* Definitions for comment print function*/
229cf7adecSBob Moore 
239cf7adecSBob Moore #define AML_COMMENT_STANDARD    1
249cf7adecSBob Moore #define AMLCOMMENT_INLINE       2
259cf7adecSBob Moore #define AML_COMMENT_END_NODE    3
269cf7adecSBob Moore #define AML_NAMECOMMENT         4
279cf7adecSBob Moore #define AML_COMMENT_CLOSE_BRACE 5
289cf7adecSBob Moore #define AML_COMMENT_ENDBLK      6
299cf7adecSBob Moore #define AML_COMMENT_INCLUDE     7
309cf7adecSBob Moore 
319cf7adecSBob Moore #ifdef ACPI_ASL_COMPILER
329cf7adecSBob Moore /*
339cf7adecSBob Moore  * cvcompiler
349cf7adecSBob Moore  */
359cf7adecSBob Moore void
369cf7adecSBob Moore cv_process_comment(struct asl_comment_state current_state,
379cf7adecSBob Moore 		   char *string_buffer, int c1);
389cf7adecSBob Moore 
399cf7adecSBob Moore void
409cf7adecSBob Moore cv_process_comment_type2(struct asl_comment_state current_state,
419cf7adecSBob Moore 			 char *string_buffer);
429cf7adecSBob Moore 
439cf7adecSBob Moore u32 cv_calculate_comment_lengths(union acpi_parse_object *op);
449cf7adecSBob Moore 
459cf7adecSBob Moore void cv_process_comment_state(char input);
469cf7adecSBob Moore 
479cf7adecSBob Moore char *cv_append_inline_comment(char *inline_comment, char *to_add);
489cf7adecSBob Moore 
499cf7adecSBob Moore void cv_add_to_comment_list(char *to_add);
509cf7adecSBob Moore 
519cf7adecSBob Moore void cv_place_comment(u8 type, char *comment_string);
529cf7adecSBob Moore 
539cf7adecSBob Moore u32 cv_parse_op_block_type(union acpi_parse_object *op);
549cf7adecSBob Moore 
559cf7adecSBob Moore struct acpi_comment_node *cv_comment_node_calloc(void);
569cf7adecSBob Moore 
579cf7adecSBob Moore void cg_write_aml_def_block_comment(union acpi_parse_object *op);
589cf7adecSBob Moore 
599cf7adecSBob Moore void
609cf7adecSBob Moore cg_write_one_aml_comment(union acpi_parse_object *op,
619cf7adecSBob Moore 			 char *comment_to_print, u8 input_option);
629cf7adecSBob Moore 
639cf7adecSBob Moore void cg_write_aml_comment(union acpi_parse_object *op);
649cf7adecSBob Moore 
659cf7adecSBob Moore /*
669cf7adecSBob Moore  * cvparser
679cf7adecSBob Moore  */
689e43f5d5SErik Kaneda void cv_init_file_tree(struct acpi_table_header *table, FILE * root_file);
699cf7adecSBob Moore 
709cf7adecSBob Moore void cv_clear_op_comments(union acpi_parse_object *op);
719cf7adecSBob Moore 
729cf7adecSBob Moore struct acpi_file_node *cv_filename_exists(char *filename,
739cf7adecSBob Moore 					  struct acpi_file_node *head);
749cf7adecSBob Moore 
759cf7adecSBob Moore void cv_label_file_node(union acpi_parse_object *op);
769cf7adecSBob Moore 
779cf7adecSBob Moore void
789cf7adecSBob Moore cv_capture_list_comments(struct acpi_parse_state *parser_state,
799cf7adecSBob Moore 			 struct acpi_comment_node *list_head,
809cf7adecSBob Moore 			 struct acpi_comment_node *list_tail);
819cf7adecSBob Moore 
829cf7adecSBob Moore void cv_capture_comments_only(struct acpi_parse_state *parser_state);
839cf7adecSBob Moore 
849cf7adecSBob Moore void cv_capture_comments(struct acpi_walk_state *walk_state);
859cf7adecSBob Moore 
869cf7adecSBob Moore void cv_transfer_comments(union acpi_parse_object *op);
879cf7adecSBob Moore 
889cf7adecSBob Moore /*
899cf7adecSBob Moore  * cvdisasm
909cf7adecSBob Moore  */
919cf7adecSBob Moore void cv_switch_files(u32 level, union acpi_parse_object *op);
929cf7adecSBob Moore 
939cf7adecSBob Moore u8 cv_file_has_switched(union acpi_parse_object *op);
949cf7adecSBob Moore 
959cf7adecSBob Moore void cv_close_paren_write_comment(union acpi_parse_object *op, u32 level);
969cf7adecSBob Moore 
979cf7adecSBob Moore void cv_close_brace_write_comment(union acpi_parse_object *op, u32 level);
989cf7adecSBob Moore 
999cf7adecSBob Moore void
1009cf7adecSBob Moore cv_print_one_comment_list(struct acpi_comment_node *comment_list, u32 level);
1019cf7adecSBob Moore 
1029cf7adecSBob Moore void
1039cf7adecSBob Moore cv_print_one_comment_type(union acpi_parse_object *op,
1049cf7adecSBob Moore 			  u8 comment_type, char *end_str, u32 level);
1059cf7adecSBob Moore 
1069cf7adecSBob Moore #endif
1079cf7adecSBob Moore 
1089cf7adecSBob Moore #endif				/* _ACCONVERT */
109