drivers/acpi/acpica/psutils.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psutils - Parser miscellaneous utilities (Parser only)
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2017, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include "accommon.h"
  46 #include "acparser.h"
  47 #include "amlcode.h"
  48 #include "acconvert.h"
  49
  50 #define _COMPONENT          ACPI_PARSER
  51 ACPI_MODULE_NAME("psutils")
  52
  53 /*******************************************************************************
  54  *
  55  * FUNCTION:    acpi_ps_create_scope_op
  56  *
  57  * PARAMETERS:  None
  58  *
  59  * RETURN:      A new Scope object, null on failure
  60  *
  61  * DESCRIPTION: Create a Scope and associated namepath op with the root name
  62  *
  63  ******************************************************************************/
  64 union acpi_parse_object *acpi_ps_create_scope_op(u8 *aml)
  65 {
  66         union acpi_parse_object *scope_op;
  67
  68         scope_op = acpi_ps_alloc_op(AML_SCOPE_OP, aml);
  69         if (!scope_op) {
  70                 return (NULL);
  71         }
  72
  73         scope_op->named.name = ACPI_ROOT_NAME;
  74         return (scope_op);
  75 }
  76
  77 /*******************************************************************************
  78  *
  79  * FUNCTION:    acpi_ps_init_op
  80  *
  81  * PARAMETERS:  op              - A newly allocated Op object
  82  *              opcode          - Opcode to store in the Op
  83  *
  84  * RETURN:      None
  85  *
  86  * DESCRIPTION: Initialize a parse (Op) object
  87  *
  88  ******************************************************************************/
  89
  90 void acpi_ps_init_op(union acpi_parse_object *op, u16 opcode)
  91 {
  92         ACPI_FUNCTION_ENTRY();
  93
  94         op->common.descriptor_type = ACPI_DESC_TYPE_PARSER;
  95         op->common.aml_opcode = opcode;
  96
  97         ACPI_DISASM_ONLY_MEMBERS(strncpy(op->common.aml_op_name,
  98                                          (acpi_ps_get_opcode_info(opcode))->
  99                                          name, sizeof(op->common.aml_op_name)));
 100 }
 101
 102 /*******************************************************************************
 103  *
 104  * FUNCTION:    acpi_ps_alloc_op
 105  *
 106  * PARAMETERS:  opcode          - Opcode that will be stored in the new Op
 107  *              aml             - Address of the opcode
 108  *
 109  * RETURN:      Pointer to the new Op, null on failure
 110  *
 111  * DESCRIPTION: Allocate an acpi_op, choose op type (and thus size) based on
 112  *              opcode. A cache of opcodes is available for the pure
 113  *              GENERIC_OP, since this is by far the most commonly used.
 114  *
 115  ******************************************************************************/
 116
 117 union acpi_parse_object *acpi_ps_alloc_op(u16 opcode, u8 *aml)
 118 {
 119         union acpi_parse_object *op;
 120         const struct acpi_opcode_info *op_info;
 121         u8 flags = ACPI_PARSEOP_GENERIC;
 122
 123         ACPI_FUNCTION_ENTRY();
 124
 125         op_info = acpi_ps_get_opcode_info(opcode);
 126
 127         /* Determine type of parse_op required */
 128
 129         if (op_info->flags & AML_DEFER) {
 130                 flags = ACPI_PARSEOP_DEFERRED;
 131         } else if (op_info->flags & AML_NAMED) {
 132                 flags = ACPI_PARSEOP_NAMED_OBJECT;
 133         } else if (opcode == AML_INT_BYTELIST_OP) {
 134                 flags = ACPI_PARSEOP_BYTELIST;
 135         }
 136
 137         /* Allocate the minimum required size object */
 138
 139         if (flags == ACPI_PARSEOP_GENERIC) {
 140
 141                 /* The generic op (default) is by far the most common (16 to 1) */
 142
 143                 op = acpi_os_acquire_object(acpi_gbl_ps_node_cache);
 144         } else {
 145                 /* Extended parseop */
 146
 147                 op = acpi_os_acquire_object(acpi_gbl_ps_node_ext_cache);
 148         }
 149
 150         /* Initialize the Op */
 151
 152         if (op) {
 153                 acpi_ps_init_op(op, opcode);
 154                 op->common.aml = aml;
 155                 op->common.flags = flags;
 156                 ASL_CV_CLEAR_OP_COMMENTS(op);
 157
 158                 if (opcode == AML_SCOPE_OP) {
 159                         acpi_gbl_current_scope = op;
 160                 }
 161         }
 162
 163         if (gbl_capture_comments) {
 164                 ASL_CV_TRANSFER_COMMENTS(op);
 165         }
 166
 167         return (op);
 168 }
 169
 170 /*******************************************************************************
 171  *
 172  * FUNCTION:    acpi_ps_free_op
 173  *
 174  * PARAMETERS:  op              - Op to be freed
 175  *
 176  * RETURN:      None.
 177  *
 178  * DESCRIPTION: Free an Op object. Either put it on the GENERIC_OP cache list
 179  *              or actually free it.
 180  *
 181  ******************************************************************************/
 182
 183 void acpi_ps_free_op(union acpi_parse_object *op)
 184 {
 185         ACPI_FUNCTION_NAME(ps_free_op);
 186
 187         ASL_CV_CLEAR_OP_COMMENTS(op);
 188         if (op->common.aml_opcode == AML_INT_RETURN_VALUE_OP) {
 189                 ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS,
 190                                   "Free retval op: %p\n", op));
 191         }
 192
 193         if (op->common.flags & ACPI_PARSEOP_GENERIC) {
 194                 (void)acpi_os_release_object(acpi_gbl_ps_node_cache, op);
 195         } else {
 196                 (void)acpi_os_release_object(acpi_gbl_ps_node_ext_cache, op);
 197         }
 198 }
 199
 200 /*******************************************************************************
 201  *
 202  * FUNCTION:    Utility functions
 203  *
 204  * DESCRIPTION: Low level character and object functions
 205  *
 206  ******************************************************************************/
 207
 208 /*
 209  * Is "c" a namestring lead character?
 210  */
 211 u8 acpi_ps_is_leading_char(u32 c)
 212 {
 213         return ((u8) (c == '_' || (c >= 'A' && c <= 'Z')));
 214 }
 215
 216 /*
 217  * Get op's name (4-byte name segment) or 0 if unnamed
 218  */
 219 u32 acpi_ps_get_name(union acpi_parse_object * op)
 220 {
 221
 222         /* The "generic" object has no name associated with it */
 223
 224         if (op->common.flags & ACPI_PARSEOP_GENERIC) {
 225                 return (0);
 226         }
 227
 228         /* Only the "Extended" parse objects have a name */
 229
 230         return (op->named.name);
 231 }
 232
 233 /*
 234  * Set op's name
 235  */
 236 void acpi_ps_set_name(union acpi_parse_object *op, u32 name)
 237 {
 238
 239         /* The "generic" object has no name associated with it */
 240
 241         if (op->common.flags & ACPI_PARSEOP_GENERIC) {
 242                 return;
 243         }
 244
 245         op->named.name = name;
 246 }