1/*******************************************************************************
2 *
3 * Module Name: nsobject - Utilities for objects attached to namespace
4 *                         table entries
5 *
6 ******************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************
116 *
117 * Alternatively, you may choose to be licensed under the terms of the
118 * following license:
119 *
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
122 * are met:
123 * 1. Redistributions of source code must retain the above copyright
124 *    notice, this list of conditions, and the following disclaimer,
125 *    without modification.
126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127 *    substantially similar to the "NO WARRANTY" disclaimer below
128 *    ("Disclaimer") and any redistribution must be conditioned upon
129 *    including a substantially similar Disclaimer requirement for further
130 *    binary redistribution.
131 * 3. Neither the names of the above-listed copyright holders nor the names
132 *    of any contributors may be used to endorse or promote products derived
133 *    from this software without specific prior written permission.
134 *
135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146 *
147 * Alternatively, you may choose to be licensed under the terms of the
148 * GNU General Public License ("GPL") version 2 as published by the Free
149 * Software Foundation.
150 *
151 *****************************************************************************/
152
153#include "acpi.h"
154#include "accommon.h"
155#include "acnamesp.h"
156
157
158#define _COMPONENT          ACPI_NAMESPACE
159        ACPI_MODULE_NAME    ("nsobject")
160
161
162/*******************************************************************************
163 *
164 * FUNCTION:    AcpiNsAttachObject
165 *
166 * PARAMETERS:  Node                - Parent Node
167 *              Object              - Object to be attached
168 *              Type                - Type of object, or ACPI_TYPE_ANY if not
169 *                                    known
170 *
171 * RETURN:      Status
172 *
173 * DESCRIPTION: Record the given object as the value associated with the
174 *              name whose ACPI_HANDLE is passed. If Object is NULL
175 *              and Type is ACPI_TYPE_ANY, set the name as having no value.
176 *              Note: Future may require that the Node->Flags field be passed
177 *              as a parameter.
178 *
179 * MUTEX:       Assumes namespace is locked
180 *
181 ******************************************************************************/
182
183ACPI_STATUS
184AcpiNsAttachObject (
185    ACPI_NAMESPACE_NODE     *Node,
186    ACPI_OPERAND_OBJECT     *Object,
187    ACPI_OBJECT_TYPE        Type)
188{
189    ACPI_OPERAND_OBJECT     *ObjDesc;
190    ACPI_OPERAND_OBJECT     *LastObjDesc;
191    ACPI_OBJECT_TYPE        ObjectType = ACPI_TYPE_ANY;
192
193
194    ACPI_FUNCTION_TRACE (NsAttachObject);
195
196
197    /*
198     * Parameter validation
199     */
200    if (!Node)
201    {
202        /* Invalid handle */
203
204        ACPI_ERROR ((AE_INFO, "Null NamedObj handle"));
205        return_ACPI_STATUS (AE_BAD_PARAMETER);
206    }
207
208    if (!Object && (ACPI_TYPE_ANY != Type))
209    {
210        /* Null object */
211
212        ACPI_ERROR ((AE_INFO,
213            "Null object, but type not ACPI_TYPE_ANY"));
214        return_ACPI_STATUS (AE_BAD_PARAMETER);
215    }
216
217    if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
218    {
219        /* Not a name handle */
220
221        ACPI_ERROR ((AE_INFO, "Invalid handle %p [%s]",
222            Node, AcpiUtGetDescriptorName (Node)));
223        return_ACPI_STATUS (AE_BAD_PARAMETER);
224    }
225
226    /* Check if this object is already attached */
227
228    if (Node->Object == Object)
229    {
230        ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
231            "Obj %p already installed in NameObj %p\n",
232            Object, Node));
233
234        return_ACPI_STATUS (AE_OK);
235    }
236
237    /* If null object, we will just install it */
238
239    if (!Object)
240    {
241        ObjDesc    = NULL;
242        ObjectType = ACPI_TYPE_ANY;
243    }
244
245    /*
246     * If the source object is a namespace Node with an attached object,
247     * we will use that (attached) object
248     */
249    else if ((ACPI_GET_DESCRIPTOR_TYPE (Object) == ACPI_DESC_TYPE_NAMED) &&
250            ((ACPI_NAMESPACE_NODE *) Object)->Object)
251    {
252        /*
253         * Value passed is a name handle and that name has a
254         * non-null value. Use that name's value and type.
255         */
256        ObjDesc = ((ACPI_NAMESPACE_NODE *) Object)->Object;
257        ObjectType = ((ACPI_NAMESPACE_NODE *) Object)->Type;
258    }
259
260    /*
261     * Otherwise, we will use the parameter object, but we must type
262     * it first
263     */
264    else
265    {
266        ObjDesc = (ACPI_OPERAND_OBJECT  *) Object;
267
268        /* Use the given type */
269
270        ObjectType = Type;
271    }
272
273    ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Installing %p into Node %p [%4.4s]\n",
274        ObjDesc, Node, AcpiUtGetNodeName (Node)));
275
276    /* Detach an existing attached object if present */
277
278    if (Node->Object)
279    {
280        AcpiNsDetachObject (Node);
281    }
282
283    if (ObjDesc)
284    {
285        /*
286         * Must increment the new value's reference count
287         * (if it is an internal object)
288         */
289        AcpiUtAddReference (ObjDesc);
290
291        /*
292         * Handle objects with multiple descriptors - walk
293         * to the end of the descriptor list
294         */
295        LastObjDesc = ObjDesc;
296        while (LastObjDesc->Common.NextObject)
297        {
298            LastObjDesc = LastObjDesc->Common.NextObject;
299        }
300
301        /* Install the object at the front of the object list */
302
303        LastObjDesc->Common.NextObject = Node->Object;
304    }
305
306    Node->Type = (UINT8) ObjectType;
307    Node->Object = ObjDesc;
308
309    return_ACPI_STATUS (AE_OK);
310}
311
312
313/*******************************************************************************
314 *
315 * FUNCTION:    AcpiNsDetachObject
316 *
317 * PARAMETERS:  Node           - A Namespace node whose object will be detached
318 *
319 * RETURN:      None.
320 *
321 * DESCRIPTION: Detach/delete an object associated with a namespace node.
322 *              if the object is an allocated object, it is freed.
323 *              Otherwise, the field is simply cleared.
324 *
325 ******************************************************************************/
326
327void
328AcpiNsDetachObject (
329    ACPI_NAMESPACE_NODE     *Node)
330{
331    ACPI_OPERAND_OBJECT     *ObjDesc;
332
333
334    ACPI_FUNCTION_TRACE (NsDetachObject);
335
336
337    ObjDesc = Node->Object;
338
339    if (!ObjDesc ||
340        (ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA))
341    {
342        return_VOID;
343    }
344
345    if (Node->Flags & ANOBJ_ALLOCATED_BUFFER)
346    {
347        /* Free the dynamic aml buffer */
348
349        if (ObjDesc->Common.Type == ACPI_TYPE_METHOD)
350        {
351            ACPI_FREE (ObjDesc->Method.AmlStart);
352        }
353    }
354
355    /* Clear the Node entry in all cases */
356
357    Node->Object = NULL;
358    if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND)
359    {
360        /* Unlink object from front of possible object list */
361
362        Node->Object = ObjDesc->Common.NextObject;
363
364        /* Handle possible 2-descriptor object */
365
366        if (Node->Object &&
367           (Node->Object->Common.Type != ACPI_TYPE_LOCAL_DATA))
368        {
369            Node->Object = Node->Object->Common.NextObject;
370        }
371
372        /*
373         * Detach the object from any data objects (which are still held by
374         * the namespace node)
375         */
376        if (ObjDesc->Common.NextObject &&
377           ((ObjDesc->Common.NextObject)->Common.Type == ACPI_TYPE_LOCAL_DATA))
378        {
379           ObjDesc->Common.NextObject = NULL;
380        }
381    }
382
383    /* Reset the node type to untyped */
384
385    Node->Type = ACPI_TYPE_ANY;
386
387    ACPI_DEBUG_PRINT ((ACPI_DB_NAMES, "Node %p [%4.4s] Object %p\n",
388        Node, AcpiUtGetNodeName (Node), ObjDesc));
389
390    /* Remove one reference on the object (and all subobjects) */
391
392    AcpiUtRemoveReference (ObjDesc);
393    return_VOID;
394}
395
396
397/*******************************************************************************
398 *
399 * FUNCTION:    AcpiNsGetAttachedObject
400 *
401 * PARAMETERS:  Node             - Namespace node
402 *
403 * RETURN:      Current value of the object field from the Node whose
404 *              handle is passed
405 *
406 * DESCRIPTION: Obtain the object attached to a namespace node.
407 *
408 ******************************************************************************/
409
410ACPI_OPERAND_OBJECT *
411AcpiNsGetAttachedObject (
412    ACPI_NAMESPACE_NODE     *Node)
413{
414    ACPI_FUNCTION_TRACE_PTR (NsGetAttachedObject, Node);
415
416
417    if (!Node)
418    {
419        ACPI_WARNING ((AE_INFO, "Null Node ptr"));
420        return_PTR (NULL);
421    }
422
423    if (!Node->Object ||
424            ((ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_OPERAND) &&
425             (ACPI_GET_DESCRIPTOR_TYPE (Node->Object) != ACPI_DESC_TYPE_NAMED))  ||
426        ((Node->Object)->Common.Type == ACPI_TYPE_LOCAL_DATA))
427    {
428        return_PTR (NULL);
429    }
430
431    return_PTR (Node->Object);
432}
433
434
435/*******************************************************************************
436 *
437 * FUNCTION:    AcpiNsGetSecondaryObject
438 *
439 * PARAMETERS:  Node             - Namespace node
440 *
441 * RETURN:      Current value of the object field from the Node whose
442 *              handle is passed.
443 *
444 * DESCRIPTION: Obtain a secondary object associated with a namespace node.
445 *
446 ******************************************************************************/
447
448ACPI_OPERAND_OBJECT *
449AcpiNsGetSecondaryObject (
450    ACPI_OPERAND_OBJECT     *ObjDesc)
451{
452    ACPI_FUNCTION_TRACE_PTR (NsGetSecondaryObject, ObjDesc);
453
454
455    if ((!ObjDesc)                                     ||
456        (ObjDesc->Common.Type== ACPI_TYPE_LOCAL_DATA)  ||
457        (!ObjDesc->Common.NextObject)                  ||
458        ((ObjDesc->Common.NextObject)->Common.Type == ACPI_TYPE_LOCAL_DATA))
459    {
460        return_PTR (NULL);
461    }
462
463    return_PTR (ObjDesc->Common.NextObject);
464}
465
466
467/*******************************************************************************
468 *
469 * FUNCTION:    AcpiNsAttachData
470 *
471 * PARAMETERS:  Node            - Namespace node
472 *              Handler         - Handler to be associated with the data
473 *              Data            - Data to be attached
474 *
475 * RETURN:      Status
476 *
477 * DESCRIPTION: Low-level attach data. Create and attach a Data object.
478 *
479 ******************************************************************************/
480
481ACPI_STATUS
482AcpiNsAttachData (
483    ACPI_NAMESPACE_NODE     *Node,
484    ACPI_OBJECT_HANDLER     Handler,
485    void                    *Data)
486{
487    ACPI_OPERAND_OBJECT     *PrevObjDesc;
488    ACPI_OPERAND_OBJECT     *ObjDesc;
489    ACPI_OPERAND_OBJECT     *DataDesc;
490
491
492    /* We only allow one attachment per handler */
493
494    PrevObjDesc = NULL;
495    ObjDesc = Node->Object;
496    while (ObjDesc)
497    {
498        if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) &&
499            (ObjDesc->Data.Handler == Handler))
500        {
501            return (AE_ALREADY_EXISTS);
502        }
503
504        PrevObjDesc = ObjDesc;
505        ObjDesc = ObjDesc->Common.NextObject;
506    }
507
508    /* Create an internal object for the data */
509
510    DataDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_DATA);
511    if (!DataDesc)
512    {
513        return (AE_NO_MEMORY);
514    }
515
516    DataDesc->Data.Handler = Handler;
517    DataDesc->Data.Pointer = Data;
518
519    /* Install the data object */
520
521    if (PrevObjDesc)
522    {
523        PrevObjDesc->Common.NextObject = DataDesc;
524    }
525    else
526    {
527        Node->Object = DataDesc;
528    }
529
530    return (AE_OK);
531}
532
533
534/*******************************************************************************
535 *
536 * FUNCTION:    AcpiNsDetachData
537 *
538 * PARAMETERS:  Node            - Namespace node
539 *              Handler         - Handler associated with the data
540 *
541 * RETURN:      Status
542 *
543 * DESCRIPTION: Low-level detach data. Delete the data node, but the caller
544 *              is responsible for the actual data.
545 *
546 ******************************************************************************/
547
548ACPI_STATUS
549AcpiNsDetachData (
550    ACPI_NAMESPACE_NODE     *Node,
551    ACPI_OBJECT_HANDLER     Handler)
552{
553    ACPI_OPERAND_OBJECT     *ObjDesc;
554    ACPI_OPERAND_OBJECT     *PrevObjDesc;
555
556
557    PrevObjDesc = NULL;
558    ObjDesc = Node->Object;
559    while (ObjDesc)
560    {
561        if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) &&
562            (ObjDesc->Data.Handler == Handler))
563        {
564            if (PrevObjDesc)
565            {
566                PrevObjDesc->Common.NextObject = ObjDesc->Common.NextObject;
567            }
568            else
569            {
570                Node->Object = ObjDesc->Common.NextObject;
571            }
572
573            AcpiUtRemoveReference (ObjDesc);
574            return (AE_OK);
575        }
576
577        PrevObjDesc = ObjDesc;
578        ObjDesc = ObjDesc->Common.NextObject;
579    }
580
581    return (AE_NOT_FOUND);
582}
583
584
585/*******************************************************************************
586 *
587 * FUNCTION:    AcpiNsGetAttachedData
588 *
589 * PARAMETERS:  Node            - Namespace node
590 *              Handler         - Handler associated with the data
591 *              Data            - Where the data is returned
592 *
593 * RETURN:      Status
594 *
595 * DESCRIPTION: Low level interface to obtain data previously associated with
596 *              a namespace node.
597 *
598 ******************************************************************************/
599
600ACPI_STATUS
601AcpiNsGetAttachedData (
602    ACPI_NAMESPACE_NODE     *Node,
603    ACPI_OBJECT_HANDLER     Handler,
604    void                    **Data)
605{
606    ACPI_OPERAND_OBJECT     *ObjDesc;
607
608
609    ObjDesc = Node->Object;
610    while (ObjDesc)
611    {
612        if ((ObjDesc->Common.Type == ACPI_TYPE_LOCAL_DATA) &&
613            (ObjDesc->Data.Handler == Handler))
614        {
615            *Data = ObjDesc->Data.Pointer;
616            return (AE_OK);
617        }
618
619        ObjDesc = ObjDesc->Common.NextObject;
620    }
621
622    return (AE_NOT_FOUND);
623}
624