Merge tag 'media/v4.14-2' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[sfrench/cifs-2.6.git] / drivers / acpi / acpica / utobject.c
1 /******************************************************************************
2  *
3  * Module Name: utobject - ACPI object create/delete/size/cache routines
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 "acnamesp.h"
47
48 #define _COMPONENT          ACPI_UTILITIES
49 ACPI_MODULE_NAME("utobject")
50
51 /* Local prototypes */
52 static acpi_status
53 acpi_ut_get_simple_object_size(union acpi_operand_object *obj,
54                                acpi_size *obj_length);
55
56 static acpi_status
57 acpi_ut_get_package_object_size(union acpi_operand_object *obj,
58                                 acpi_size *obj_length);
59
60 static acpi_status
61 acpi_ut_get_element_length(u8 object_type,
62                            union acpi_operand_object *source_object,
63                            union acpi_generic_state *state, void *context);
64
65 /*******************************************************************************
66  *
67  * FUNCTION:    acpi_ut_create_internal_object_dbg
68  *
69  * PARAMETERS:  module_name         - Source file name of caller
70  *              line_number         - Line number of caller
71  *              component_id        - Component type of caller
72  *              type                - ACPI Type of the new object
73  *
74  * RETURN:      A new internal object, null on failure
75  *
76  * DESCRIPTION: Create and initialize a new internal object.
77  *
78  * NOTE:        We always allocate the worst-case object descriptor because
79  *              these objects are cached, and we want them to be
80  *              one-size-satisifies-any-request. This in itself may not be
81  *              the most memory efficient, but the efficiency of the object
82  *              cache should more than make up for this!
83  *
84  ******************************************************************************/
85
86 union acpi_operand_object *acpi_ut_create_internal_object_dbg(const char
87                                                               *module_name,
88                                                               u32 line_number,
89                                                               u32 component_id,
90                                                               acpi_object_type
91                                                               type)
92 {
93         union acpi_operand_object *object;
94         union acpi_operand_object *second_object;
95
96         ACPI_FUNCTION_TRACE_STR(ut_create_internal_object_dbg,
97                                 acpi_ut_get_type_name(type));
98
99         /* Allocate the raw object descriptor */
100
101         object =
102             acpi_ut_allocate_object_desc_dbg(module_name, line_number,
103                                              component_id);
104         if (!object) {
105                 return_PTR(NULL);
106         }
107
108         switch (type) {
109         case ACPI_TYPE_REGION:
110         case ACPI_TYPE_BUFFER_FIELD:
111         case ACPI_TYPE_LOCAL_BANK_FIELD:
112
113                 /* These types require a secondary object */
114
115                 second_object =
116                     acpi_ut_allocate_object_desc_dbg(module_name, line_number,
117                                                      component_id);
118                 if (!second_object) {
119                         acpi_ut_delete_object_desc(object);
120                         return_PTR(NULL);
121                 }
122
123                 second_object->common.type = ACPI_TYPE_LOCAL_EXTRA;
124                 second_object->common.reference_count = 1;
125
126                 /* Link the second object to the first */
127
128                 object->common.next_object = second_object;
129                 break;
130
131         default:
132
133                 /* All others have no secondary object */
134                 break;
135         }
136
137         /* Save the object type in the object descriptor */
138
139         object->common.type = (u8) type;
140
141         /* Init the reference count */
142
143         object->common.reference_count = 1;
144
145         /* Any per-type initialization should go here */
146
147         return_PTR(object);
148 }
149
150 /*******************************************************************************
151  *
152  * FUNCTION:    acpi_ut_create_package_object
153  *
154  * PARAMETERS:  count               - Number of package elements
155  *
156  * RETURN:      Pointer to a new Package object, null on failure
157  *
158  * DESCRIPTION: Create a fully initialized package object
159  *
160  ******************************************************************************/
161
162 union acpi_operand_object *acpi_ut_create_package_object(u32 count)
163 {
164         union acpi_operand_object *package_desc;
165         union acpi_operand_object **package_elements;
166
167         ACPI_FUNCTION_TRACE_U32(ut_create_package_object, count);
168
169         /* Create a new Package object */
170
171         package_desc = acpi_ut_create_internal_object(ACPI_TYPE_PACKAGE);
172         if (!package_desc) {
173                 return_PTR(NULL);
174         }
175
176         /*
177          * Create the element array. Count+1 allows the array to be null
178          * terminated.
179          */
180         package_elements = ACPI_ALLOCATE_ZEROED(((acpi_size)count +
181                                                  1) * sizeof(void *));
182         if (!package_elements) {
183                 ACPI_FREE(package_desc);
184                 return_PTR(NULL);
185         }
186
187         package_desc->package.count = count;
188         package_desc->package.elements = package_elements;
189         return_PTR(package_desc);
190 }
191
192 /*******************************************************************************
193  *
194  * FUNCTION:    acpi_ut_create_integer_object
195  *
196  * PARAMETERS:  initial_value       - Initial value for the integer
197  *
198  * RETURN:      Pointer to a new Integer object, null on failure
199  *
200  * DESCRIPTION: Create an initialized integer object
201  *
202  ******************************************************************************/
203
204 union acpi_operand_object *acpi_ut_create_integer_object(u64 initial_value)
205 {
206         union acpi_operand_object *integer_desc;
207
208         ACPI_FUNCTION_TRACE(ut_create_integer_object);
209
210         /* Create and initialize a new integer object */
211
212         integer_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
213         if (!integer_desc) {
214                 return_PTR(NULL);
215         }
216
217         integer_desc->integer.value = initial_value;
218         return_PTR(integer_desc);
219 }
220
221 /*******************************************************************************
222  *
223  * FUNCTION:    acpi_ut_create_buffer_object
224  *
225  * PARAMETERS:  buffer_size            - Size of buffer to be created
226  *
227  * RETURN:      Pointer to a new Buffer object, null on failure
228  *
229  * DESCRIPTION: Create a fully initialized buffer object
230  *
231  ******************************************************************************/
232
233 union acpi_operand_object *acpi_ut_create_buffer_object(acpi_size buffer_size)
234 {
235         union acpi_operand_object *buffer_desc;
236         u8 *buffer = NULL;
237
238         ACPI_FUNCTION_TRACE_U32(ut_create_buffer_object, buffer_size);
239
240         /* Create a new Buffer object */
241
242         buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
243         if (!buffer_desc) {
244                 return_PTR(NULL);
245         }
246
247         /* Create an actual buffer only if size > 0 */
248
249         if (buffer_size > 0) {
250
251                 /* Allocate the actual buffer */
252
253                 buffer = ACPI_ALLOCATE_ZEROED(buffer_size);
254                 if (!buffer) {
255                         ACPI_ERROR((AE_INFO, "Could not allocate size %u",
256                                     (u32)buffer_size));
257
258                         acpi_ut_remove_reference(buffer_desc);
259                         return_PTR(NULL);
260                 }
261         }
262
263         /* Complete buffer object initialization */
264
265         buffer_desc->buffer.flags |= AOPOBJ_DATA_VALID;
266         buffer_desc->buffer.pointer = buffer;
267         buffer_desc->buffer.length = (u32) buffer_size;
268
269         /* Return the new buffer descriptor */
270
271         return_PTR(buffer_desc);
272 }
273
274 /*******************************************************************************
275  *
276  * FUNCTION:    acpi_ut_create_string_object
277  *
278  * PARAMETERS:  string_size         - Size of string to be created. Does not
279  *                                    include NULL terminator, this is added
280  *                                    automatically.
281  *
282  * RETURN:      Pointer to a new String object
283  *
284  * DESCRIPTION: Create a fully initialized string object
285  *
286  ******************************************************************************/
287
288 union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size)
289 {
290         union acpi_operand_object *string_desc;
291         char *string;
292
293         ACPI_FUNCTION_TRACE_U32(ut_create_string_object, string_size);
294
295         /* Create a new String object */
296
297         string_desc = acpi_ut_create_internal_object(ACPI_TYPE_STRING);
298         if (!string_desc) {
299                 return_PTR(NULL);
300         }
301
302         /*
303          * Allocate the actual string buffer -- (Size + 1) for NULL terminator.
304          * NOTE: Zero-length strings are NULL terminated
305          */
306         string = ACPI_ALLOCATE_ZEROED(string_size + 1);
307         if (!string) {
308                 ACPI_ERROR((AE_INFO, "Could not allocate size %u",
309                             (u32)string_size));
310
311                 acpi_ut_remove_reference(string_desc);
312                 return_PTR(NULL);
313         }
314
315         /* Complete string object initialization */
316
317         string_desc->string.pointer = string;
318         string_desc->string.length = (u32) string_size;
319
320         /* Return the new string descriptor */
321
322         return_PTR(string_desc);
323 }
324
325 /*******************************************************************************
326  *
327  * FUNCTION:    acpi_ut_valid_internal_object
328  *
329  * PARAMETERS:  object              - Object to be validated
330  *
331  * RETURN:      TRUE if object is valid, FALSE otherwise
332  *
333  * DESCRIPTION: Validate a pointer to be of type union acpi_operand_object
334  *
335  ******************************************************************************/
336
337 u8 acpi_ut_valid_internal_object(void *object)
338 {
339
340         ACPI_FUNCTION_NAME(ut_valid_internal_object);
341
342         /* Check for a null pointer */
343
344         if (!object) {
345                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "**** Null Object Ptr\n"));
346                 return (FALSE);
347         }
348
349         /* Check the descriptor type field */
350
351         switch (ACPI_GET_DESCRIPTOR_TYPE(object)) {
352         case ACPI_DESC_TYPE_OPERAND:
353
354                 /* The object appears to be a valid union acpi_operand_object */
355
356                 return (TRUE);
357
358         default:
359
360                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
361                                   "%p is not an ACPI operand obj [%s]\n",
362                                   object, acpi_ut_get_descriptor_name(object)));
363                 break;
364         }
365
366         return (FALSE);
367 }
368
369 /*******************************************************************************
370  *
371  * FUNCTION:    acpi_ut_allocate_object_desc_dbg
372  *
373  * PARAMETERS:  module_name         - Caller's module name (for error output)
374  *              line_number         - Caller's line number (for error output)
375  *              component_id        - Caller's component ID (for error output)
376  *
377  * RETURN:      Pointer to newly allocated object descriptor. Null on error
378  *
379  * DESCRIPTION: Allocate a new object descriptor. Gracefully handle
380  *              error conditions.
381  *
382  ******************************************************************************/
383
384 void *acpi_ut_allocate_object_desc_dbg(const char *module_name,
385                                        u32 line_number, u32 component_id)
386 {
387         union acpi_operand_object *object;
388
389         ACPI_FUNCTION_TRACE(ut_allocate_object_desc_dbg);
390
391         object = acpi_os_acquire_object(acpi_gbl_operand_cache);
392         if (!object) {
393                 ACPI_ERROR((module_name, line_number,
394                             "Could not allocate an object descriptor"));
395
396                 return_PTR(NULL);
397         }
398
399         /* Mark the descriptor type */
400
401         ACPI_SET_DESCRIPTOR_TYPE(object, ACPI_DESC_TYPE_OPERAND);
402
403         ACPI_DEBUG_PRINT((ACPI_DB_ALLOCATIONS, "%p Size %X\n",
404                           object, (u32) sizeof(union acpi_operand_object)));
405
406         return_PTR(object);
407 }
408
409 /*******************************************************************************
410  *
411  * FUNCTION:    acpi_ut_delete_object_desc
412  *
413  * PARAMETERS:  object          - An Acpi internal object to be deleted
414  *
415  * RETURN:      None.
416  *
417  * DESCRIPTION: Free an ACPI object descriptor or add it to the object cache
418  *
419  ******************************************************************************/
420
421 void acpi_ut_delete_object_desc(union acpi_operand_object *object)
422 {
423         ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc, object);
424
425         /* Object must be of type union acpi_operand_object */
426
427         if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
428                 ACPI_ERROR((AE_INFO,
429                             "%p is not an ACPI Operand object [%s]", object,
430                             acpi_ut_get_descriptor_name(object)));
431                 return_VOID;
432         }
433
434         (void)acpi_os_release_object(acpi_gbl_operand_cache, object);
435         return_VOID;
436 }
437
438 /*******************************************************************************
439  *
440  * FUNCTION:    acpi_ut_get_simple_object_size
441  *
442  * PARAMETERS:  internal_object    - An ACPI operand object
443  *              obj_length         - Where the length is returned
444  *
445  * RETURN:      Status
446  *
447  * DESCRIPTION: This function is called to determine the space required to
448  *              contain a simple object for return to an external user.
449  *
450  *              The length includes the object structure plus any additional
451  *              needed space.
452  *
453  ******************************************************************************/
454
455 static acpi_status
456 acpi_ut_get_simple_object_size(union acpi_operand_object *internal_object,
457                                acpi_size *obj_length)
458 {
459         acpi_size length;
460         acpi_size size;
461         acpi_status status = AE_OK;
462
463         ACPI_FUNCTION_TRACE_PTR(ut_get_simple_object_size, internal_object);
464
465         /* Start with the length of the (external) Acpi object */
466
467         length = sizeof(union acpi_object);
468
469         /* A NULL object is allowed, can be a legal uninitialized package element */
470
471         if (!internal_object) {
472         /*
473                  * Object is NULL, just return the length of union acpi_object
474                  * (A NULL union acpi_object is an object of all zeroes.)
475          */
476                 *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
477                 return_ACPI_STATUS(AE_OK);
478         }
479
480         /* A Namespace Node should never appear here */
481
482         if (ACPI_GET_DESCRIPTOR_TYPE(internal_object) == ACPI_DESC_TYPE_NAMED) {
483
484                 /* A namespace node should never get here */
485
486                 ACPI_ERROR((AE_INFO,
487                             "Received a namespace node [%4.4s] "
488                             "where an operand object is required",
489                             ACPI_CAST_PTR(struct acpi_namespace_node,
490                                           internal_object)->name.ascii));
491                 return_ACPI_STATUS(AE_AML_INTERNAL);
492         }
493
494         /*
495          * The final length depends on the object type
496          * Strings and Buffers are packed right up against the parent object and
497          * must be accessed bytewise or there may be alignment problems on
498          * certain processors
499          */
500         switch (internal_object->common.type) {
501         case ACPI_TYPE_STRING:
502
503                 length += (acpi_size)internal_object->string.length + 1;
504                 break;
505
506         case ACPI_TYPE_BUFFER:
507
508                 length += (acpi_size)internal_object->buffer.length;
509                 break;
510
511         case ACPI_TYPE_INTEGER:
512         case ACPI_TYPE_PROCESSOR:
513         case ACPI_TYPE_POWER:
514
515                 /* No extra data for these types */
516
517                 break;
518
519         case ACPI_TYPE_LOCAL_REFERENCE:
520
521                 switch (internal_object->reference.class) {
522                 case ACPI_REFCLASS_NAME:
523                         /*
524                          * Get the actual length of the full pathname to this object.
525                          * The reference will be converted to the pathname to the object
526                          */
527                         size =
528                             acpi_ns_get_pathname_length(internal_object->
529                                                         reference.node);
530                         if (!size) {
531                                 return_ACPI_STATUS(AE_BAD_PARAMETER);
532                         }
533
534                         length += ACPI_ROUND_UP_TO_NATIVE_WORD(size);
535                         break;
536
537                 default:
538                         /*
539                          * No other reference opcodes are supported.
540                          * Notably, Locals and Args are not supported, but this may be
541                          * required eventually.
542                          */
543                         ACPI_ERROR((AE_INFO,
544                                     "Cannot convert to external object - "
545                                     "unsupported Reference Class [%s] 0x%X in object %p",
546                                     acpi_ut_get_reference_name(internal_object),
547                                     internal_object->reference.class,
548                                     internal_object));
549                         status = AE_TYPE;
550                         break;
551                 }
552                 break;
553
554         default:
555
556                 ACPI_ERROR((AE_INFO, "Cannot convert to external object - "
557                             "unsupported type [%s] 0x%X in object %p",
558                             acpi_ut_get_object_type_name(internal_object),
559                             internal_object->common.type, internal_object));
560                 status = AE_TYPE;
561                 break;
562         }
563
564         /*
565          * Account for the space required by the object rounded up to the next
566          * multiple of the machine word size. This keeps each object aligned
567          * on a machine word boundary. (preventing alignment faults on some
568          * machines.)
569          */
570         *obj_length = ACPI_ROUND_UP_TO_NATIVE_WORD(length);
571         return_ACPI_STATUS(status);
572 }
573
574 /*******************************************************************************
575  *
576  * FUNCTION:    acpi_ut_get_element_length
577  *
578  * PARAMETERS:  acpi_pkg_callback
579  *
580  * RETURN:      Status
581  *
582  * DESCRIPTION: Get the length of one package element.
583  *
584  ******************************************************************************/
585
586 static acpi_status
587 acpi_ut_get_element_length(u8 object_type,
588                            union acpi_operand_object *source_object,
589                            union acpi_generic_state *state, void *context)
590 {
591         acpi_status status = AE_OK;
592         struct acpi_pkg_info *info = (struct acpi_pkg_info *)context;
593         acpi_size object_space;
594
595         switch (object_type) {
596         case ACPI_COPY_TYPE_SIMPLE:
597                 /*
598                  * Simple object - just get the size (Null object/entry is handled
599                  * here also) and sum it into the running package length
600                  */
601                 status =
602                     acpi_ut_get_simple_object_size(source_object,
603                                                    &object_space);
604                 if (ACPI_FAILURE(status)) {
605                         return (status);
606                 }
607
608                 info->length += object_space;
609                 break;
610
611         case ACPI_COPY_TYPE_PACKAGE:
612
613                 /* Package object - nothing much to do here, let the walk handle it */
614
615                 info->num_packages++;
616                 state->pkg.this_target_obj = NULL;
617                 break;
618
619         default:
620
621                 /* No other types allowed */
622
623                 return (AE_BAD_PARAMETER);
624         }
625
626         return (status);
627 }
628
629 /*******************************************************************************
630  *
631  * FUNCTION:    acpi_ut_get_package_object_size
632  *
633  * PARAMETERS:  internal_object     - An ACPI internal object
634  *              obj_length          - Where the length is returned
635  *
636  * RETURN:      Status
637  *
638  * DESCRIPTION: This function is called to determine the space required to
639  *              contain a package object for return to an external user.
640  *
641  *              This is moderately complex since a package contains other
642  *              objects including packages.
643  *
644  ******************************************************************************/
645
646 static acpi_status
647 acpi_ut_get_package_object_size(union acpi_operand_object *internal_object,
648                                 acpi_size *obj_length)
649 {
650         acpi_status status;
651         struct acpi_pkg_info info;
652
653         ACPI_FUNCTION_TRACE_PTR(ut_get_package_object_size, internal_object);
654
655         info.length = 0;
656         info.object_space = 0;
657         info.num_packages = 1;
658
659         status =
660             acpi_ut_walk_package_tree(internal_object, NULL,
661                                       acpi_ut_get_element_length, &info);
662         if (ACPI_FAILURE(status)) {
663                 return_ACPI_STATUS(status);
664         }
665
666         /*
667          * We have handled all of the objects in all levels of the package.
668          * just add the length of the package objects themselves.
669          * Round up to the next machine word.
670          */
671         info.length +=
672             ACPI_ROUND_UP_TO_NATIVE_WORD(sizeof(union acpi_object)) *
673             (acpi_size)info.num_packages;
674
675         /* Return the total package length */
676
677         *obj_length = info.length;
678         return_ACPI_STATUS(status);
679 }
680
681 /*******************************************************************************
682  *
683  * FUNCTION:    acpi_ut_get_object_size
684  *
685  * PARAMETERS:  internal_object     - An ACPI internal object
686  *              obj_length          - Where the length will be returned
687  *
688  * RETURN:      Status
689  *
690  * DESCRIPTION: This function is called to determine the space required to
691  *              contain an object for return to an API user.
692  *
693  ******************************************************************************/
694
695 acpi_status
696 acpi_ut_get_object_size(union acpi_operand_object *internal_object,
697                         acpi_size *obj_length)
698 {
699         acpi_status status;
700
701         ACPI_FUNCTION_ENTRY();
702
703         if ((ACPI_GET_DESCRIPTOR_TYPE(internal_object) ==
704              ACPI_DESC_TYPE_OPERAND) &&
705             (internal_object->common.type == ACPI_TYPE_PACKAGE)) {
706                 status =
707                     acpi_ut_get_package_object_size(internal_object,
708                                                     obj_length);
709         } else {
710                 status =
711                     acpi_ut_get_simple_object_size(internal_object, obj_length);
712         }
713
714         return (status);
715 }