GNU Linux-libre 4.9.331-gnu1
[releases.git] / drivers / acpi / acpica / nsxfname.c
1 /******************************************************************************
2  *
3  * Module Name: nsxfname - Public interfaces to the ACPI subsystem
4  *                         ACPI Namespace oriented interfaces
5  *
6  *****************************************************************************/
7
8 /*
9  * Copyright (C) 2000 - 2016, Intel Corp.
10  * All rights reserved.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions, and the following disclaimer,
17  *    without modification.
18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19  *    substantially similar to the "NO WARRANTY" disclaimer below
20  *    ("Disclaimer") and any redistribution must be conditioned upon
21  *    including a substantially similar Disclaimer requirement for further
22  *    binary redistribution.
23  * 3. Neither the names of the above-listed copyright holders nor the names
24  *    of any contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * Alternatively, this software may be distributed under the terms of the
28  * GNU General Public License ("GPL") version 2 as published by the Free
29  * Software Foundation.
30  *
31  * NO WARRANTY
32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42  * POSSIBILITY OF SUCH DAMAGES.
43  */
44
45 #define EXPORT_ACPI_INTERFACES
46
47 #include <acpi/acpi.h>
48 #include "accommon.h"
49 #include "acnamesp.h"
50 #include "acparser.h"
51 #include "amlcode.h"
52
53 #define _COMPONENT          ACPI_NAMESPACE
54 ACPI_MODULE_NAME("nsxfname")
55
56 /* Local prototypes */
57 static char *acpi_ns_copy_device_id(struct acpi_pnp_device_id *dest,
58                                     struct acpi_pnp_device_id *source,
59                                     char *string_area);
60
61 /******************************************************************************
62  *
63  * FUNCTION:    acpi_get_handle
64  *
65  * PARAMETERS:  parent          - Object to search under (search scope).
66  *              pathname        - Pointer to an asciiz string containing the
67  *                                name
68  *              ret_handle      - Where the return handle is returned
69  *
70  * RETURN:      Status
71  *
72  * DESCRIPTION: This routine will search for a caller specified name in the
73  *              name space. The caller can restrict the search region by
74  *              specifying a non NULL parent. The parent value is itself a
75  *              namespace handle.
76  *
77  ******************************************************************************/
78
79 acpi_status
80 acpi_get_handle(acpi_handle parent,
81                 acpi_string pathname, acpi_handle *ret_handle)
82 {
83         acpi_status status;
84         struct acpi_namespace_node *node = NULL;
85         struct acpi_namespace_node *prefix_node = NULL;
86
87         ACPI_FUNCTION_ENTRY();
88
89         /* Parameter Validation */
90
91         if (!ret_handle || !pathname) {
92                 return (AE_BAD_PARAMETER);
93         }
94
95         /* Convert a parent handle to a prefix node */
96
97         if (parent) {
98                 prefix_node = acpi_ns_validate_handle(parent);
99                 if (!prefix_node) {
100                         return (AE_BAD_PARAMETER);
101                 }
102         }
103
104         /*
105          * Valid cases are:
106          * 1) Fully qualified pathname
107          * 2) Parent + Relative pathname
108          *
109          * Error for <null Parent + relative path>
110          */
111         if (ACPI_IS_ROOT_PREFIX(pathname[0])) {
112
113                 /* Pathname is fully qualified (starts with '\') */
114
115                 /* Special case for root-only, since we can't search for it */
116
117                 if (!strcmp(pathname, ACPI_NS_ROOT_PATH)) {
118                         *ret_handle =
119                             ACPI_CAST_PTR(acpi_handle, acpi_gbl_root_node);
120                         return (AE_OK);
121                 }
122         } else if (!prefix_node) {
123
124                 /* Relative path with null prefix is disallowed */
125
126                 return (AE_BAD_PARAMETER);
127         }
128
129         /* Find the Node and convert to a handle */
130
131         status =
132             acpi_ns_get_node(prefix_node, pathname, ACPI_NS_NO_UPSEARCH, &node);
133         if (ACPI_SUCCESS(status)) {
134                 *ret_handle = ACPI_CAST_PTR(acpi_handle, node);
135         }
136
137         return (status);
138 }
139
140 ACPI_EXPORT_SYMBOL(acpi_get_handle)
141
142 /******************************************************************************
143  *
144  * FUNCTION:    acpi_get_name
145  *
146  * PARAMETERS:  handle          - Handle to be converted to a pathname
147  *              name_type       - Full pathname or single segment
148  *              buffer          - Buffer for returned path
149  *
150  * RETURN:      Pointer to a string containing the fully qualified Name.
151  *
152  * DESCRIPTION: This routine returns the fully qualified name associated with
153  *              the Handle parameter. This and the acpi_pathname_to_handle are
154  *              complementary functions.
155  *
156  ******************************************************************************/
157 acpi_status
158 acpi_get_name(acpi_handle handle, u32 name_type, struct acpi_buffer *buffer)
159 {
160         acpi_status status;
161         struct acpi_namespace_node *node;
162         const char *node_name;
163
164         /* Parameter validation */
165
166         if (name_type > ACPI_NAME_TYPE_MAX) {
167                 return (AE_BAD_PARAMETER);
168         }
169
170         status = acpi_ut_validate_buffer(buffer);
171         if (ACPI_FAILURE(status)) {
172                 return (status);
173         }
174
175         if (name_type == ACPI_FULL_PATHNAME ||
176             name_type == ACPI_FULL_PATHNAME_NO_TRAILING) {
177
178                 /* Get the full pathname (From the namespace root) */
179
180                 status = acpi_ns_handle_to_pathname(handle, buffer,
181                                                     name_type ==
182                                                     ACPI_FULL_PATHNAME ? FALSE :
183                                                     TRUE);
184                 return (status);
185         }
186
187         /*
188          * Wants the single segment ACPI name.
189          * Validate handle and convert to a namespace Node
190          */
191         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
192         if (ACPI_FAILURE(status)) {
193                 return (status);
194         }
195
196         node = acpi_ns_validate_handle(handle);
197         if (!node) {
198                 status = AE_BAD_PARAMETER;
199                 goto unlock_and_exit;
200         }
201
202         /* Validate/Allocate/Clear caller buffer */
203
204         status = acpi_ut_initialize_buffer(buffer, ACPI_PATH_SEGMENT_LENGTH);
205         if (ACPI_FAILURE(status)) {
206                 goto unlock_and_exit;
207         }
208
209         /* Just copy the ACPI name from the Node and zero terminate it */
210
211         node_name = acpi_ut_get_node_name(node);
212         ACPI_MOVE_NAME(buffer->pointer, node_name);
213         ((char *)buffer->pointer)[ACPI_NAME_SIZE] = 0;
214         status = AE_OK;
215
216 unlock_and_exit:
217
218         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
219         return (status);
220 }
221
222 ACPI_EXPORT_SYMBOL(acpi_get_name)
223
224 /******************************************************************************
225  *
226  * FUNCTION:    acpi_ns_copy_device_id
227  *
228  * PARAMETERS:  dest                - Pointer to the destination PNP_DEVICE_ID
229  *              source              - Pointer to the source PNP_DEVICE_ID
230  *              string_area         - Pointer to where to copy the dest string
231  *
232  * RETURN:      Pointer to the next string area
233  *
234  * DESCRIPTION: Copy a single PNP_DEVICE_ID, including the string data.
235  *
236  ******************************************************************************/
237 static char *acpi_ns_copy_device_id(struct acpi_pnp_device_id *dest,
238                                     struct acpi_pnp_device_id *source,
239                                     char *string_area)
240 {
241         /* Create the destination PNP_DEVICE_ID */
242
243         dest->string = string_area;
244         dest->length = source->length;
245
246         /* Copy actual string and return a pointer to the next string area */
247
248         memcpy(string_area, source->string, source->length);
249         return (string_area + source->length);
250 }
251
252 /******************************************************************************
253  *
254  * FUNCTION:    acpi_get_object_info
255  *
256  * PARAMETERS:  handle              - Object Handle
257  *              return_buffer       - Where the info is returned
258  *
259  * RETURN:      Status
260  *
261  * DESCRIPTION: Returns information about an object as gleaned from the
262  *              namespace node and possibly by running several standard
263  *              control methods (Such as in the case of a device.)
264  *
265  * For Device and Processor objects, run the Device _HID, _UID, _CID, _STA,
266  * _CLS, _ADR, _sx_w, and _sx_d methods.
267  *
268  * Note: Allocates the return buffer, must be freed by the caller.
269  *
270  * Note: This interface is intended to be used during the initial device
271  * discovery namespace traversal. Therefore, no complex methods can be
272  * executed, especially those that access operation regions. Therefore, do
273  * not add any additional methods that could cause problems in this area.
274  * this was the fate of the _SUB method which was found to cause such
275  * problems and was removed (11/2015).
276  *
277  ******************************************************************************/
278
279 acpi_status
280 acpi_get_object_info(acpi_handle handle,
281                      struct acpi_device_info **return_buffer)
282 {
283         struct acpi_namespace_node *node;
284         struct acpi_device_info *info;
285         struct acpi_pnp_device_id_list *cid_list = NULL;
286         struct acpi_pnp_device_id *hid = NULL;
287         struct acpi_pnp_device_id *uid = NULL;
288         struct acpi_pnp_device_id *cls = NULL;
289         char *next_id_string;
290         acpi_object_type type;
291         acpi_name name;
292         u8 param_count = 0;
293         u16 valid = 0;
294         u32 info_size;
295         u32 i;
296         acpi_status status;
297
298         /* Parameter validation */
299
300         if (!handle || !return_buffer) {
301                 return (AE_BAD_PARAMETER);
302         }
303
304         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
305         if (ACPI_FAILURE(status)) {
306                 return (status);
307         }
308
309         node = acpi_ns_validate_handle(handle);
310         if (!node) {
311                 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
312                 return (AE_BAD_PARAMETER);
313         }
314
315         /* Get the namespace node data while the namespace is locked */
316
317         info_size = sizeof(struct acpi_device_info);
318         type = node->type;
319         name = node->name.integer;
320
321         if (node->type == ACPI_TYPE_METHOD) {
322                 param_count = node->object->method.param_count;
323         }
324
325         status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
326         if (ACPI_FAILURE(status)) {
327                 return (status);
328         }
329
330         if ((type == ACPI_TYPE_DEVICE) || (type == ACPI_TYPE_PROCESSOR)) {
331                 /*
332                  * Get extra info for ACPI Device/Processor objects only:
333                  * Run the Device _HID, _UID, _CLS, and _CID methods.
334                  *
335                  * Note: none of these methods are required, so they may or may
336                  * not be present for this device. The Info->Valid bitfield is used
337                  * to indicate which methods were found and run successfully.
338                  */
339
340                 /* Execute the Device._HID method */
341
342                 status = acpi_ut_execute_HID(node, &hid);
343                 if (ACPI_SUCCESS(status)) {
344                         info_size += hid->length;
345                         valid |= ACPI_VALID_HID;
346                 }
347
348                 /* Execute the Device._UID method */
349
350                 status = acpi_ut_execute_UID(node, &uid);
351                 if (ACPI_SUCCESS(status)) {
352                         info_size += uid->length;
353                         valid |= ACPI_VALID_UID;
354                 }
355
356                 /* Execute the Device._CID method */
357
358                 status = acpi_ut_execute_CID(node, &cid_list);
359                 if (ACPI_SUCCESS(status)) {
360
361                         /* Add size of CID strings and CID pointer array */
362
363                         info_size +=
364                             (cid_list->list_size -
365                              sizeof(struct acpi_pnp_device_id_list));
366                         valid |= ACPI_VALID_CID;
367                 }
368
369                 /* Execute the Device._CLS method */
370
371                 status = acpi_ut_execute_CLS(node, &cls);
372                 if (ACPI_SUCCESS(status)) {
373                         info_size += cls->length;
374                         valid |= ACPI_VALID_CLS;
375                 }
376         }
377
378         /*
379          * Now that we have the variable-length data, we can allocate the
380          * return buffer
381          */
382         info = ACPI_ALLOCATE_ZEROED(info_size);
383         if (!info) {
384                 status = AE_NO_MEMORY;
385                 goto cleanup;
386         }
387
388         /* Get the fixed-length data */
389
390         if ((type == ACPI_TYPE_DEVICE) || (type == ACPI_TYPE_PROCESSOR)) {
391                 /*
392                  * Get extra info for ACPI Device/Processor objects only:
393                  * Run the _STA, _ADR and, sx_w, and _sx_d methods.
394                  *
395                  * Notes: none of these methods are required, so they may or may
396                  * not be present for this device. The Info->Valid bitfield is used
397                  * to indicate which methods were found and run successfully.
398                  *
399                  * For _STA, if the method does not exist, then (as per the ACPI
400                  * specification), the returned current_status flags will indicate
401                  * that the device is present/functional/enabled. Otherwise, the
402                  * current_status flags reflect the value returned from _STA.
403                  */
404
405                 /* Execute the Device._STA method */
406
407                 status = acpi_ut_execute_STA(node, &info->current_status);
408                 if (ACPI_SUCCESS(status)) {
409                         valid |= ACPI_VALID_STA;
410                 }
411
412                 /* Execute the Device._ADR method */
413
414                 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR, node,
415                                                          &info->address);
416                 if (ACPI_SUCCESS(status)) {
417                         valid |= ACPI_VALID_ADR;
418                 }
419
420                 /* Execute the Device._sx_w methods */
421
422                 status = acpi_ut_execute_power_methods(node,
423                                                        acpi_gbl_lowest_dstate_names,
424                                                        ACPI_NUM_sx_w_METHODS,
425                                                        info->lowest_dstates);
426                 if (ACPI_SUCCESS(status)) {
427                         valid |= ACPI_VALID_SXWS;
428                 }
429
430                 /* Execute the Device._sx_d methods */
431
432                 status = acpi_ut_execute_power_methods(node,
433                                                        acpi_gbl_highest_dstate_names,
434                                                        ACPI_NUM_sx_d_METHODS,
435                                                        info->highest_dstates);
436                 if (ACPI_SUCCESS(status)) {
437                         valid |= ACPI_VALID_SXDS;
438                 }
439         }
440
441         /*
442          * Create a pointer to the string area of the return buffer.
443          * Point to the end of the base struct acpi_device_info structure.
444          */
445         next_id_string = ACPI_CAST_PTR(char, info->compatible_id_list.ids);
446         if (cid_list) {
447
448                 /* Point past the CID PNP_DEVICE_ID array */
449
450                 next_id_string +=
451                     ((acpi_size)cid_list->count *
452                      sizeof(struct acpi_pnp_device_id));
453         }
454
455         /*
456          * Copy the HID, UID, and CIDs to the return buffer. The variable-length
457          * strings are copied to the reserved area at the end of the buffer.
458          *
459          * For HID and CID, check if the ID is a PCI Root Bridge.
460          */
461         if (hid) {
462                 next_id_string = acpi_ns_copy_device_id(&info->hardware_id,
463                                                         hid, next_id_string);
464
465                 if (acpi_ut_is_pci_root_bridge(hid->string)) {
466                         info->flags |= ACPI_PCI_ROOT_BRIDGE;
467                 }
468         }
469
470         if (uid) {
471                 next_id_string = acpi_ns_copy_device_id(&info->unique_id,
472                                                         uid, next_id_string);
473         }
474
475         if (cid_list) {
476                 info->compatible_id_list.count = cid_list->count;
477                 info->compatible_id_list.list_size = cid_list->list_size;
478
479                 /* Copy each CID */
480
481                 for (i = 0; i < cid_list->count; i++) {
482                         next_id_string =
483                             acpi_ns_copy_device_id(&info->compatible_id_list.
484                                                    ids[i], &cid_list->ids[i],
485                                                    next_id_string);
486
487                         if (acpi_ut_is_pci_root_bridge(cid_list->ids[i].string)) {
488                                 info->flags |= ACPI_PCI_ROOT_BRIDGE;
489                         }
490                 }
491         }
492
493         if (cls) {
494                 next_id_string = acpi_ns_copy_device_id(&info->class_code,
495                                                         cls, next_id_string);
496         }
497
498         /* Copy the fixed-length data */
499
500         info->info_size = info_size;
501         info->type = type;
502         info->name = name;
503         info->param_count = param_count;
504         info->valid = valid;
505
506         *return_buffer = info;
507         status = AE_OK;
508
509 cleanup:
510         if (hid) {
511                 ACPI_FREE(hid);
512         }
513         if (uid) {
514                 ACPI_FREE(uid);
515         }
516         if (cid_list) {
517                 ACPI_FREE(cid_list);
518         }
519         if (cls) {
520                 ACPI_FREE(cls);
521         }
522         return (status);
523 }
524
525 ACPI_EXPORT_SYMBOL(acpi_get_object_info)
526
527 /******************************************************************************
528  *
529  * FUNCTION:    acpi_install_method
530  *
531  * PARAMETERS:  buffer         - An ACPI table containing one control method
532  *
533  * RETURN:      Status
534  *
535  * DESCRIPTION: Install a control method into the namespace. If the method
536  *              name already exists in the namespace, it is overwritten. The
537  *              input buffer must contain a valid DSDT or SSDT containing a
538  *              single control method.
539  *
540  ******************************************************************************/
541 acpi_status acpi_install_method(u8 *buffer)
542 {
543         struct acpi_table_header *table =
544             ACPI_CAST_PTR(struct acpi_table_header, buffer);
545         u8 *aml_buffer;
546         u8 *aml_start;
547         char *path;
548         struct acpi_namespace_node *node;
549         union acpi_operand_object *method_obj;
550         struct acpi_parse_state parser_state;
551         u32 aml_length;
552         u16 opcode;
553         u8 method_flags;
554         acpi_status status;
555
556         /* Parameter validation */
557
558         if (!buffer) {
559                 return (AE_BAD_PARAMETER);
560         }
561
562         /* Table must be a DSDT or SSDT */
563
564         if (!ACPI_COMPARE_NAME(table->signature, ACPI_SIG_DSDT) &&
565             !ACPI_COMPARE_NAME(table->signature, ACPI_SIG_SSDT)) {
566                 return (AE_BAD_HEADER);
567         }
568
569         /* First AML opcode in the table must be a control method */
570
571         parser_state.aml = buffer + sizeof(struct acpi_table_header);
572         opcode = acpi_ps_peek_opcode(&parser_state);
573         if (opcode != AML_METHOD_OP) {
574                 return (AE_BAD_PARAMETER);
575         }
576
577         /* Extract method information from the raw AML */
578
579         parser_state.aml += acpi_ps_get_opcode_size(opcode);
580         parser_state.pkg_end = acpi_ps_get_next_package_end(&parser_state);
581         path = acpi_ps_get_next_namestring(&parser_state);
582
583         method_flags = *parser_state.aml++;
584         aml_start = parser_state.aml;
585         aml_length = ACPI_PTR_DIFF(parser_state.pkg_end, aml_start);
586
587         /*
588          * Allocate resources up-front. We don't want to have to delete a new
589          * node from the namespace if we cannot allocate memory.
590          */
591         aml_buffer = ACPI_ALLOCATE(aml_length);
592         if (!aml_buffer) {
593                 return (AE_NO_MEMORY);
594         }
595
596         method_obj = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
597         if (!method_obj) {
598                 ACPI_FREE(aml_buffer);
599                 return (AE_NO_MEMORY);
600         }
601
602         /* Lock namespace for acpi_ns_lookup, we may be creating a new node */
603
604         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
605         if (ACPI_FAILURE(status)) {
606                 goto error_exit;
607         }
608
609         /* The lookup either returns an existing node or creates a new one */
610
611         status =
612             acpi_ns_lookup(NULL, path, ACPI_TYPE_METHOD, ACPI_IMODE_LOAD_PASS1,
613                            ACPI_NS_DONT_OPEN_SCOPE | ACPI_NS_ERROR_IF_FOUND,
614                            NULL, &node);
615
616         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
617
618         if (ACPI_FAILURE(status)) {     /* ns_lookup */
619                 if (status != AE_ALREADY_EXISTS) {
620                         goto error_exit;
621                 }
622
623                 /* Node existed previously, make sure it is a method node */
624
625                 if (node->type != ACPI_TYPE_METHOD) {
626                         status = AE_TYPE;
627                         goto error_exit;
628                 }
629         }
630
631         /* Copy the method AML to the local buffer */
632
633         memcpy(aml_buffer, aml_start, aml_length);
634
635         /* Initialize the method object with the new method's information */
636
637         method_obj->method.aml_start = aml_buffer;
638         method_obj->method.aml_length = aml_length;
639
640         method_obj->method.param_count = (u8)
641             (method_flags & AML_METHOD_ARG_COUNT);
642
643         if (method_flags & AML_METHOD_SERIALIZED) {
644                 method_obj->method.info_flags = ACPI_METHOD_SERIALIZED;
645
646                 method_obj->method.sync_level = (u8)
647                     ((method_flags & AML_METHOD_SYNC_LEVEL) >> 4);
648         }
649
650         /*
651          * Now that it is complete, we can attach the new method object to
652          * the method Node (detaches/deletes any existing object)
653          */
654         status = acpi_ns_attach_object(node, method_obj, ACPI_TYPE_METHOD);
655
656         /*
657          * Flag indicates AML buffer is dynamic, must be deleted later.
658          * Must be set only after attach above.
659          */
660         node->flags |= ANOBJ_ALLOCATED_BUFFER;
661
662         /* Remove local reference to the method object */
663
664         acpi_ut_remove_reference(method_obj);
665         return (status);
666
667 error_exit:
668
669         ACPI_FREE(aml_buffer);
670         ACPI_FREE(method_obj);
671         return (status);
672 }
673 ACPI_EXPORT_SYMBOL(acpi_install_method)