utownerid.c revision 1.1.1.1.10.2 1 1.1.1.1.10.2 tls /*******************************************************************************
2 1.1.1.1.10.2 tls *
3 1.1.1.1.10.2 tls * Module Name: utownerid - Support for Table/Method Owner IDs
4 1.1.1.1.10.2 tls *
5 1.1.1.1.10.2 tls ******************************************************************************/
6 1.1.1.1.10.2 tls
7 1.1.1.1.10.2 tls /*
8 1.1.1.1.10.2 tls * Copyright (C) 2000 - 2013, Intel Corp.
9 1.1.1.1.10.2 tls * All rights reserved.
10 1.1.1.1.10.2 tls *
11 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without
12 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions
13 1.1.1.1.10.2 tls * are met:
14 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright
15 1.1.1.1.10.2 tls * notice, this list of conditions, and the following disclaimer,
16 1.1.1.1.10.2 tls * without modification.
17 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.1.10.2 tls * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.1.10.2 tls * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.1.10.2 tls * including a substantially similar Disclaimer requirement for further
21 1.1.1.1.10.2 tls * binary redistribution.
22 1.1.1.1.10.2 tls * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.1.10.2 tls * of any contributors may be used to endorse or promote products derived
24 1.1.1.1.10.2 tls * from this software without specific prior written permission.
25 1.1.1.1.10.2 tls *
26 1.1.1.1.10.2 tls * Alternatively, this software may be distributed under the terms of the
27 1.1.1.1.10.2 tls * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.1.10.2 tls * Software Foundation.
29 1.1.1.1.10.2 tls *
30 1.1.1.1.10.2 tls * NO WARRANTY
31 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.1.10.2 tls * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.1.10.2 tls * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.1.10.2 tls * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.1.10.2 tls * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.1.10.2 tls * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.1.10.2 tls * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.1.10.2 tls * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.1.10.2 tls */
43 1.1.1.1.10.2 tls
44 1.1.1.1.10.2 tls
45 1.1.1.1.10.2 tls #define __UTOWNERID_C__
46 1.1.1.1.10.2 tls
47 1.1.1.1.10.2 tls #include "acpi.h"
48 1.1.1.1.10.2 tls #include "accommon.h"
49 1.1.1.1.10.2 tls #include "acnamesp.h"
50 1.1.1.1.10.2 tls
51 1.1.1.1.10.2 tls
52 1.1.1.1.10.2 tls #define _COMPONENT ACPI_UTILITIES
53 1.1.1.1.10.2 tls ACPI_MODULE_NAME ("utownerid")
54 1.1.1.1.10.2 tls
55 1.1.1.1.10.2 tls
56 1.1.1.1.10.2 tls /*******************************************************************************
57 1.1.1.1.10.2 tls *
58 1.1.1.1.10.2 tls * FUNCTION: AcpiUtAllocateOwnerId
59 1.1.1.1.10.2 tls *
60 1.1.1.1.10.2 tls * PARAMETERS: OwnerId - Where the new owner ID is returned
61 1.1.1.1.10.2 tls *
62 1.1.1.1.10.2 tls * RETURN: Status
63 1.1.1.1.10.2 tls *
64 1.1.1.1.10.2 tls * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
65 1.1.1.1.10.2 tls * track objects created by the table or method, to be deleted
66 1.1.1.1.10.2 tls * when the method exits or the table is unloaded.
67 1.1.1.1.10.2 tls *
68 1.1.1.1.10.2 tls ******************************************************************************/
69 1.1.1.1.10.2 tls
70 1.1.1.1.10.2 tls ACPI_STATUS
71 1.1.1.1.10.2 tls AcpiUtAllocateOwnerId (
72 1.1.1.1.10.2 tls ACPI_OWNER_ID *OwnerId)
73 1.1.1.1.10.2 tls {
74 1.1.1.1.10.2 tls UINT32 i;
75 1.1.1.1.10.2 tls UINT32 j;
76 1.1.1.1.10.2 tls UINT32 k;
77 1.1.1.1.10.2 tls ACPI_STATUS Status;
78 1.1.1.1.10.2 tls
79 1.1.1.1.10.2 tls
80 1.1.1.1.10.2 tls ACPI_FUNCTION_TRACE (UtAllocateOwnerId);
81 1.1.1.1.10.2 tls
82 1.1.1.1.10.2 tls
83 1.1.1.1.10.2 tls /* Guard against multiple allocations of ID to the same location */
84 1.1.1.1.10.2 tls
85 1.1.1.1.10.2 tls if (*OwnerId)
86 1.1.1.1.10.2 tls {
87 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO, "Owner ID [0x%2.2X] already exists", *OwnerId));
88 1.1.1.1.10.2 tls return_ACPI_STATUS (AE_ALREADY_EXISTS);
89 1.1.1.1.10.2 tls }
90 1.1.1.1.10.2 tls
91 1.1.1.1.10.2 tls /* Mutex for the global ID mask */
92 1.1.1.1.10.2 tls
93 1.1.1.1.10.2 tls Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
94 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status))
95 1.1.1.1.10.2 tls {
96 1.1.1.1.10.2 tls return_ACPI_STATUS (Status);
97 1.1.1.1.10.2 tls }
98 1.1.1.1.10.2 tls
99 1.1.1.1.10.2 tls /*
100 1.1.1.1.10.2 tls * Find a free owner ID, cycle through all possible IDs on repeated
101 1.1.1.1.10.2 tls * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index may have
102 1.1.1.1.10.2 tls * to be scanned twice.
103 1.1.1.1.10.2 tls */
104 1.1.1.1.10.2 tls for (i = 0, j = AcpiGbl_LastOwnerIdIndex;
105 1.1.1.1.10.2 tls i < (ACPI_NUM_OWNERID_MASKS + 1);
106 1.1.1.1.10.2 tls i++, j++)
107 1.1.1.1.10.2 tls {
108 1.1.1.1.10.2 tls if (j >= ACPI_NUM_OWNERID_MASKS)
109 1.1.1.1.10.2 tls {
110 1.1.1.1.10.2 tls j = 0; /* Wraparound to start of mask array */
111 1.1.1.1.10.2 tls }
112 1.1.1.1.10.2 tls
113 1.1.1.1.10.2 tls for (k = AcpiGbl_NextOwnerIdOffset; k < 32; k++)
114 1.1.1.1.10.2 tls {
115 1.1.1.1.10.2 tls if (AcpiGbl_OwnerIdMask[j] == ACPI_UINT32_MAX)
116 1.1.1.1.10.2 tls {
117 1.1.1.1.10.2 tls /* There are no free IDs in this mask */
118 1.1.1.1.10.2 tls
119 1.1.1.1.10.2 tls break;
120 1.1.1.1.10.2 tls }
121 1.1.1.1.10.2 tls
122 1.1.1.1.10.2 tls if (!(AcpiGbl_OwnerIdMask[j] & (1 << k)))
123 1.1.1.1.10.2 tls {
124 1.1.1.1.10.2 tls /*
125 1.1.1.1.10.2 tls * Found a free ID. The actual ID is the bit index plus one,
126 1.1.1.1.10.2 tls * making zero an invalid Owner ID. Save this as the last ID
127 1.1.1.1.10.2 tls * allocated and update the global ID mask.
128 1.1.1.1.10.2 tls */
129 1.1.1.1.10.2 tls AcpiGbl_OwnerIdMask[j] |= (1 << k);
130 1.1.1.1.10.2 tls
131 1.1.1.1.10.2 tls AcpiGbl_LastOwnerIdIndex = (UINT8) j;
132 1.1.1.1.10.2 tls AcpiGbl_NextOwnerIdOffset = (UINT8) (k + 1);
133 1.1.1.1.10.2 tls
134 1.1.1.1.10.2 tls /*
135 1.1.1.1.10.2 tls * Construct encoded ID from the index and bit position
136 1.1.1.1.10.2 tls *
137 1.1.1.1.10.2 tls * Note: Last [j].k (bit 255) is never used and is marked
138 1.1.1.1.10.2 tls * permanently allocated (prevents +1 overflow)
139 1.1.1.1.10.2 tls */
140 1.1.1.1.10.2 tls *OwnerId = (ACPI_OWNER_ID) ((k + 1) + ACPI_MUL_32 (j));
141 1.1.1.1.10.2 tls
142 1.1.1.1.10.2 tls ACPI_DEBUG_PRINT ((ACPI_DB_VALUES,
143 1.1.1.1.10.2 tls "Allocated OwnerId: %2.2X\n", (unsigned int) *OwnerId));
144 1.1.1.1.10.2 tls goto Exit;
145 1.1.1.1.10.2 tls }
146 1.1.1.1.10.2 tls }
147 1.1.1.1.10.2 tls
148 1.1.1.1.10.2 tls AcpiGbl_NextOwnerIdOffset = 0;
149 1.1.1.1.10.2 tls }
150 1.1.1.1.10.2 tls
151 1.1.1.1.10.2 tls /*
152 1.1.1.1.10.2 tls * All OwnerIds have been allocated. This typically should
153 1.1.1.1.10.2 tls * not happen since the IDs are reused after deallocation. The IDs are
154 1.1.1.1.10.2 tls * allocated upon table load (one per table) and method execution, and
155 1.1.1.1.10.2 tls * they are released when a table is unloaded or a method completes
156 1.1.1.1.10.2 tls * execution.
157 1.1.1.1.10.2 tls *
158 1.1.1.1.10.2 tls * If this error happens, there may be very deep nesting of invoked control
159 1.1.1.1.10.2 tls * methods, or there may be a bug where the IDs are not released.
160 1.1.1.1.10.2 tls */
161 1.1.1.1.10.2 tls Status = AE_OWNER_ID_LIMIT;
162 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO,
163 1.1.1.1.10.2 tls "Could not allocate new OwnerId (255 max), AE_OWNER_ID_LIMIT"));
164 1.1.1.1.10.2 tls
165 1.1.1.1.10.2 tls Exit:
166 1.1.1.1.10.2 tls (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
167 1.1.1.1.10.2 tls return_ACPI_STATUS (Status);
168 1.1.1.1.10.2 tls }
169 1.1.1.1.10.2 tls
170 1.1.1.1.10.2 tls
171 1.1.1.1.10.2 tls /*******************************************************************************
172 1.1.1.1.10.2 tls *
173 1.1.1.1.10.2 tls * FUNCTION: AcpiUtReleaseOwnerId
174 1.1.1.1.10.2 tls *
175 1.1.1.1.10.2 tls * PARAMETERS: OwnerIdPtr - Pointer to a previously allocated OwnerID
176 1.1.1.1.10.2 tls *
177 1.1.1.1.10.2 tls * RETURN: None. No error is returned because we are either exiting a
178 1.1.1.1.10.2 tls * control method or unloading a table. Either way, we would
179 1.1.1.1.10.2 tls * ignore any error anyway.
180 1.1.1.1.10.2 tls *
181 1.1.1.1.10.2 tls * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255
182 1.1.1.1.10.2 tls *
183 1.1.1.1.10.2 tls ******************************************************************************/
184 1.1.1.1.10.2 tls
185 1.1.1.1.10.2 tls void
186 1.1.1.1.10.2 tls AcpiUtReleaseOwnerId (
187 1.1.1.1.10.2 tls ACPI_OWNER_ID *OwnerIdPtr)
188 1.1.1.1.10.2 tls {
189 1.1.1.1.10.2 tls ACPI_OWNER_ID OwnerId = *OwnerIdPtr;
190 1.1.1.1.10.2 tls ACPI_STATUS Status;
191 1.1.1.1.10.2 tls UINT32 Index;
192 1.1.1.1.10.2 tls UINT32 Bit;
193 1.1.1.1.10.2 tls
194 1.1.1.1.10.2 tls
195 1.1.1.1.10.2 tls ACPI_FUNCTION_TRACE_U32 (UtReleaseOwnerId, OwnerId);
196 1.1.1.1.10.2 tls
197 1.1.1.1.10.2 tls
198 1.1.1.1.10.2 tls /* Always clear the input OwnerId (zero is an invalid ID) */
199 1.1.1.1.10.2 tls
200 1.1.1.1.10.2 tls *OwnerIdPtr = 0;
201 1.1.1.1.10.2 tls
202 1.1.1.1.10.2 tls /* Zero is not a valid OwnerID */
203 1.1.1.1.10.2 tls
204 1.1.1.1.10.2 tls if (OwnerId == 0)
205 1.1.1.1.10.2 tls {
206 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO, "Invalid OwnerId: 0x%2.2X", OwnerId));
207 1.1.1.1.10.2 tls return_VOID;
208 1.1.1.1.10.2 tls }
209 1.1.1.1.10.2 tls
210 1.1.1.1.10.2 tls /* Mutex for the global ID mask */
211 1.1.1.1.10.2 tls
212 1.1.1.1.10.2 tls Status = AcpiUtAcquireMutex (ACPI_MTX_CACHES);
213 1.1.1.1.10.2 tls if (ACPI_FAILURE (Status))
214 1.1.1.1.10.2 tls {
215 1.1.1.1.10.2 tls return_VOID;
216 1.1.1.1.10.2 tls }
217 1.1.1.1.10.2 tls
218 1.1.1.1.10.2 tls /* Normalize the ID to zero */
219 1.1.1.1.10.2 tls
220 1.1.1.1.10.2 tls OwnerId--;
221 1.1.1.1.10.2 tls
222 1.1.1.1.10.2 tls /* Decode ID to index/offset pair */
223 1.1.1.1.10.2 tls
224 1.1.1.1.10.2 tls Index = ACPI_DIV_32 (OwnerId);
225 1.1.1.1.10.2 tls Bit = 1 << ACPI_MOD_32 (OwnerId);
226 1.1.1.1.10.2 tls
227 1.1.1.1.10.2 tls /* Free the owner ID only if it is valid */
228 1.1.1.1.10.2 tls
229 1.1.1.1.10.2 tls if (AcpiGbl_OwnerIdMask[Index] & Bit)
230 1.1.1.1.10.2 tls {
231 1.1.1.1.10.2 tls AcpiGbl_OwnerIdMask[Index] ^= Bit;
232 1.1.1.1.10.2 tls }
233 1.1.1.1.10.2 tls else
234 1.1.1.1.10.2 tls {
235 1.1.1.1.10.2 tls ACPI_ERROR ((AE_INFO,
236 1.1.1.1.10.2 tls "Release of non-allocated OwnerId: 0x%2.2X", OwnerId + 1));
237 1.1.1.1.10.2 tls }
238 1.1.1.1.10.2 tls
239 1.1.1.1.10.2 tls (void) AcpiUtReleaseMutex (ACPI_MTX_CACHES);
240 1.1.1.1.10.2 tls return_VOID;
241 1.1.1.1.10.2 tls }
242