Linux Audio

Check our new training course

Loading...
v3.1
 
  1/******************************************************************************
  2 *
  3 * Module Name: utids - support for device IDs - HID, UID, CID
 
 
  4 *
  5 *****************************************************************************/
  6
  7/*
  8 * Copyright (C) 2000 - 2011, 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 "acinterp.h"
 47
 48#define _COMPONENT          ACPI_UTILITIES
 49ACPI_MODULE_NAME("utids")
 50
 51/*******************************************************************************
 52 *
 53 * FUNCTION:    acpi_ut_execute_HID
 54 *
 55 * PARAMETERS:  device_node         - Node for the device
 56 *              return_id           - Where the string HID is returned
 57 *
 58 * RETURN:      Status
 59 *
 60 * DESCRIPTION: Executes the _HID control method that returns the hardware
 61 *              ID of the device. The HID is either an 32-bit encoded EISAID
 62 *              Integer or a String. A string is always returned. An EISAID
 63 *              is converted to a string.
 64 *
 65 *              NOTE: Internal function, no parameter validation
 66 *
 67 ******************************************************************************/
 68acpi_status
 69acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
 70		    struct acpica_device_id **return_id)
 71{
 72	union acpi_operand_object *obj_desc;
 73	struct acpica_device_id *hid;
 74	u32 length;
 75	acpi_status status;
 76
 77	ACPI_FUNCTION_TRACE(ut_execute_HID);
 78
 79	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__HID,
 80					 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING,
 81					 &obj_desc);
 82	if (ACPI_FAILURE(status)) {
 83		return_ACPI_STATUS(status);
 84	}
 85
 86	/* Get the size of the String to be returned, includes null terminator */
 87
 88	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
 89		length = ACPI_EISAID_STRING_SIZE;
 90	} else {
 91		length = obj_desc->string.length + 1;
 92	}
 93
 94	/* Allocate a buffer for the HID */
 95
 96	hid =
 97	    ACPI_ALLOCATE_ZEROED(sizeof(struct acpica_device_id) +
 98				 (acpi_size) length);
 99	if (!hid) {
100		status = AE_NO_MEMORY;
101		goto cleanup;
102	}
103
104	/* Area for the string starts after DEVICE_ID struct */
105
106	hid->string = ACPI_ADD_PTR(char, hid, sizeof(struct acpica_device_id));
 
107
108	/* Convert EISAID to a string or simply copy existing string */
109
110	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
111		acpi_ex_eisa_id_to_string(hid->string, obj_desc->integer.value);
112	} else {
113		ACPI_STRCPY(hid->string, obj_desc->string.pointer);
114	}
115
116	hid->length = length;
117	*return_id = hid;
118
119cleanup:
120
121	/* On exit, we must delete the return object */
122
123	acpi_ut_remove_reference(obj_desc);
124	return_ACPI_STATUS(status);
125}
126
127/*******************************************************************************
128 *
129 * FUNCTION:    acpi_ut_execute_UID
130 *
131 * PARAMETERS:  device_node         - Node for the device
132 *              return_id           - Where the string UID is returned
133 *
134 * RETURN:      Status
135 *
136 * DESCRIPTION: Executes the _UID control method that returns the unique
137 *              ID of the device. The UID is either a 64-bit Integer (NOT an
138 *              EISAID) or a string. Always returns a string. A 64-bit integer
139 *              is converted to a decimal string.
140 *
141 *              NOTE: Internal function, no parameter validation
142 *
143 ******************************************************************************/
144
145acpi_status
146acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
147		    struct acpica_device_id **return_id)
148{
149	union acpi_operand_object *obj_desc;
150	struct acpica_device_id *uid;
151	u32 length;
152	acpi_status status;
153
154	ACPI_FUNCTION_TRACE(ut_execute_UID);
155
156	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__UID,
157					 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING,
158					 &obj_desc);
159	if (ACPI_FAILURE(status)) {
160		return_ACPI_STATUS(status);
161	}
162
163	/* Get the size of the String to be returned, includes null terminator */
164
165	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
166		length = ACPI_MAX64_DECIMAL_DIGITS + 1;
167	} else {
168		length = obj_desc->string.length + 1;
169	}
170
171	/* Allocate a buffer for the UID */
172
173	uid =
174	    ACPI_ALLOCATE_ZEROED(sizeof(struct acpica_device_id) +
175				 (acpi_size) length);
176	if (!uid) {
177		status = AE_NO_MEMORY;
178		goto cleanup;
179	}
180
181	/* Area for the string starts after DEVICE_ID struct */
182
183	uid->string = ACPI_ADD_PTR(char, uid, sizeof(struct acpica_device_id));
 
184
185	/* Convert an Integer to string, or just copy an existing string */
186
187	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
188		acpi_ex_integer_to_string(uid->string, obj_desc->integer.value);
189	} else {
190		ACPI_STRCPY(uid->string, obj_desc->string.pointer);
191	}
192
193	uid->length = length;
194	*return_id = uid;
195
196cleanup:
197
198	/* On exit, we must delete the return object */
199
200	acpi_ut_remove_reference(obj_desc);
201	return_ACPI_STATUS(status);
202}
203
204/*******************************************************************************
205 *
206 * FUNCTION:    acpi_ut_execute_CID
207 *
208 * PARAMETERS:  device_node         - Node for the device
209 *              return_cid_list     - Where the CID list is returned
210 *
211 * RETURN:      Status, list of CID strings
212 *
213 * DESCRIPTION: Executes the _CID control method that returns one or more
214 *              compatible hardware IDs for the device.
215 *
216 *              NOTE: Internal function, no parameter validation
217 *
218 * A _CID method can return either a single compatible ID or a package of
219 * compatible IDs. Each compatible ID can be one of the following:
220 * 1) Integer (32 bit compressed EISA ID) or
221 * 2) String (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss")
222 *
223 * The Integer CIDs are converted to string format by this function.
224 *
225 ******************************************************************************/
226
227acpi_status
228acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
229		    struct acpica_device_id_list **return_cid_list)
230{
231	union acpi_operand_object **cid_objects;
232	union acpi_operand_object *obj_desc;
233	struct acpica_device_id_list *cid_list;
234	char *next_id_string;
235	u32 string_area_size;
236	u32 length;
237	u32 cid_list_size;
238	acpi_status status;
239	u32 count;
240	u32 i;
241
242	ACPI_FUNCTION_TRACE(ut_execute_CID);
243
244	/* Evaluate the _CID method for this device */
245
246	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__CID,
247					 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING
248					 | ACPI_BTYPE_PACKAGE, &obj_desc);
249	if (ACPI_FAILURE(status)) {
250		return_ACPI_STATUS(status);
251	}
252
253	/*
254	 * Get the count and size of the returned _CIDs. _CID can return either
255	 * a Package of Integers/Strings or a single Integer or String.
256	 * Note: This section also validates that all CID elements are of the
257	 * correct type (Integer or String).
258	 */
259	if (obj_desc->common.type == ACPI_TYPE_PACKAGE) {
260		count = obj_desc->package.count;
261		cid_objects = obj_desc->package.elements;
262	} else {		/* Single Integer or String CID */
263
264		count = 1;
265		cid_objects = &obj_desc;
266	}
267
268	string_area_size = 0;
269	for (i = 0; i < count; i++) {
270
271		/* String lengths include null terminator */
272
273		switch (cid_objects[i]->common.type) {
274		case ACPI_TYPE_INTEGER:
 
275			string_area_size += ACPI_EISAID_STRING_SIZE;
276			break;
277
278		case ACPI_TYPE_STRING:
 
279			string_area_size += cid_objects[i]->string.length + 1;
280			break;
281
282		default:
 
283			status = AE_TYPE;
284			goto cleanup;
285		}
286	}
287
288	/*
289	 * Now that we know the length of the CIDs, allocate return buffer:
290	 * 1) Size of the base structure +
291	 * 2) Size of the CID DEVICE_ID array +
292	 * 3) Size of the actual CID strings
293	 */
294	cid_list_size = sizeof(struct acpica_device_id_list) +
295	    ((count - 1) * sizeof(struct acpica_device_id)) + string_area_size;
 
296
297	cid_list = ACPI_ALLOCATE_ZEROED(cid_list_size);
298	if (!cid_list) {
299		status = AE_NO_MEMORY;
300		goto cleanup;
301	}
302
303	/* Area for CID strings starts after the CID DEVICE_ID array */
304
305	next_id_string = ACPI_CAST_PTR(char, cid_list->ids) +
306	    ((acpi_size) count * sizeof(struct acpica_device_id));
307
308	/* Copy/convert the CIDs to the return buffer */
309
310	for (i = 0; i < count; i++) {
311		if (cid_objects[i]->common.type == ACPI_TYPE_INTEGER) {
312
313			/* Convert the Integer (EISAID) CID to a string */
314
315			acpi_ex_eisa_id_to_string(next_id_string,
316						  cid_objects[i]->integer.
317						  value);
318			length = ACPI_EISAID_STRING_SIZE;
319		} else {	/* ACPI_TYPE_STRING */
320
321			/* Copy the String CID from the returned object */
322
323			ACPI_STRCPY(next_id_string,
324				    cid_objects[i]->string.pointer);
325			length = cid_objects[i]->string.length + 1;
326		}
327
328		cid_list->ids[i].string = next_id_string;
329		cid_list->ids[i].length = length;
330		next_id_string += length;
331	}
332
333	/* Finish the CID list */
334
335	cid_list->count = count;
336	cid_list->list_size = cid_list_size;
337	*return_cid_list = cid_list;
338
339cleanup:
340
341	/* On exit, we must delete the _CID return object */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
342
343	acpi_ut_remove_reference(obj_desc);
344	return_ACPI_STATUS(status);
345}
v5.4
  1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
  2/******************************************************************************
  3 *
  4 * Module Name: utids - support for device Ids - HID, UID, CID, SUB, CLS
  5 *
  6 * Copyright (C) 2000 - 2019, Intel Corp.
  7 *
  8 *****************************************************************************/
  9
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 10#include <acpi/acpi.h>
 11#include "accommon.h"
 12#include "acinterp.h"
 13
 14#define _COMPONENT          ACPI_UTILITIES
 15ACPI_MODULE_NAME("utids")
 16
 17/*******************************************************************************
 18 *
 19 * FUNCTION:    acpi_ut_execute_HID
 20 *
 21 * PARAMETERS:  device_node         - Node for the device
 22 *              return_id           - Where the string HID is returned
 23 *
 24 * RETURN:      Status
 25 *
 26 * DESCRIPTION: Executes the _HID control method that returns the hardware
 27 *              ID of the device. The HID is either an 32-bit encoded EISAID
 28 *              Integer or a String. A string is always returned. An EISAID
 29 *              is converted to a string.
 30 *
 31 *              NOTE: Internal function, no parameter validation
 32 *
 33 ******************************************************************************/
 34acpi_status
 35acpi_ut_execute_HID(struct acpi_namespace_node *device_node,
 36		    struct acpi_pnp_device_id **return_id)
 37{
 38	union acpi_operand_object *obj_desc;
 39	struct acpi_pnp_device_id *hid;
 40	u32 length;
 41	acpi_status status;
 42
 43	ACPI_FUNCTION_TRACE(ut_execute_HID);
 44
 45	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__HID,
 46					 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING,
 47					 &obj_desc);
 48	if (ACPI_FAILURE(status)) {
 49		return_ACPI_STATUS(status);
 50	}
 51
 52	/* Get the size of the String to be returned, includes null terminator */
 53
 54	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
 55		length = ACPI_EISAID_STRING_SIZE;
 56	} else {
 57		length = obj_desc->string.length + 1;
 58	}
 59
 60	/* Allocate a buffer for the HID */
 61
 62	hid =
 63	    ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pnp_device_id) +
 64				 (acpi_size)length);
 65	if (!hid) {
 66		status = AE_NO_MEMORY;
 67		goto cleanup;
 68	}
 69
 70	/* Area for the string starts after PNP_DEVICE_ID struct */
 71
 72	hid->string =
 73	    ACPI_ADD_PTR(char, hid, sizeof(struct acpi_pnp_device_id));
 74
 75	/* Convert EISAID to a string or simply copy existing string */
 76
 77	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
 78		acpi_ex_eisa_id_to_string(hid->string, obj_desc->integer.value);
 79	} else {
 80		strcpy(hid->string, obj_desc->string.pointer);
 81	}
 82
 83	hid->length = length;
 84	*return_id = hid;
 85
 86cleanup:
 87
 88	/* On exit, we must delete the return object */
 89
 90	acpi_ut_remove_reference(obj_desc);
 91	return_ACPI_STATUS(status);
 92}
 93
 94/*******************************************************************************
 95 *
 96 * FUNCTION:    acpi_ut_execute_UID
 97 *
 98 * PARAMETERS:  device_node         - Node for the device
 99 *              return_id           - Where the string UID is returned
100 *
101 * RETURN:      Status
102 *
103 * DESCRIPTION: Executes the _UID control method that returns the unique
104 *              ID of the device. The UID is either a 64-bit Integer (NOT an
105 *              EISAID) or a string. Always returns a string. A 64-bit integer
106 *              is converted to a decimal string.
107 *
108 *              NOTE: Internal function, no parameter validation
109 *
110 ******************************************************************************/
111
112acpi_status
113acpi_ut_execute_UID(struct acpi_namespace_node *device_node,
114		    struct acpi_pnp_device_id **return_id)
115{
116	union acpi_operand_object *obj_desc;
117	struct acpi_pnp_device_id *uid;
118	u32 length;
119	acpi_status status;
120
121	ACPI_FUNCTION_TRACE(ut_execute_UID);
122
123	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__UID,
124					 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING,
125					 &obj_desc);
126	if (ACPI_FAILURE(status)) {
127		return_ACPI_STATUS(status);
128	}
129
130	/* Get the size of the String to be returned, includes null terminator */
131
132	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
133		length = ACPI_MAX64_DECIMAL_DIGITS + 1;
134	} else {
135		length = obj_desc->string.length + 1;
136	}
137
138	/* Allocate a buffer for the UID */
139
140	uid =
141	    ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pnp_device_id) +
142				 (acpi_size)length);
143	if (!uid) {
144		status = AE_NO_MEMORY;
145		goto cleanup;
146	}
147
148	/* Area for the string starts after PNP_DEVICE_ID struct */
149
150	uid->string =
151	    ACPI_ADD_PTR(char, uid, sizeof(struct acpi_pnp_device_id));
152
153	/* Convert an Integer to string, or just copy an existing string */
154
155	if (obj_desc->common.type == ACPI_TYPE_INTEGER) {
156		acpi_ex_integer_to_string(uid->string, obj_desc->integer.value);
157	} else {
158		strcpy(uid->string, obj_desc->string.pointer);
159	}
160
161	uid->length = length;
162	*return_id = uid;
163
164cleanup:
165
166	/* On exit, we must delete the return object */
167
168	acpi_ut_remove_reference(obj_desc);
169	return_ACPI_STATUS(status);
170}
171
172/*******************************************************************************
173 *
174 * FUNCTION:    acpi_ut_execute_CID
175 *
176 * PARAMETERS:  device_node         - Node for the device
177 *              return_cid_list     - Where the CID list is returned
178 *
179 * RETURN:      Status, list of CID strings
180 *
181 * DESCRIPTION: Executes the _CID control method that returns one or more
182 *              compatible hardware IDs for the device.
183 *
184 *              NOTE: Internal function, no parameter validation
185 *
186 * A _CID method can return either a single compatible ID or a package of
187 * compatible IDs. Each compatible ID can be one of the following:
188 * 1) Integer (32 bit compressed EISA ID) or
189 * 2) String (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss")
190 *
191 * The Integer CIDs are converted to string format by this function.
192 *
193 ******************************************************************************/
194
195acpi_status
196acpi_ut_execute_CID(struct acpi_namespace_node *device_node,
197		    struct acpi_pnp_device_id_list **return_cid_list)
198{
199	union acpi_operand_object **cid_objects;
200	union acpi_operand_object *obj_desc;
201	struct acpi_pnp_device_id_list *cid_list;
202	char *next_id_string;
203	u32 string_area_size;
204	u32 length;
205	u32 cid_list_size;
206	acpi_status status;
207	u32 count;
208	u32 i;
209
210	ACPI_FUNCTION_TRACE(ut_execute_CID);
211
212	/* Evaluate the _CID method for this device */
213
214	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__CID,
215					 ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING
216					 | ACPI_BTYPE_PACKAGE, &obj_desc);
217	if (ACPI_FAILURE(status)) {
218		return_ACPI_STATUS(status);
219	}
220
221	/*
222	 * Get the count and size of the returned _CIDs. _CID can return either
223	 * a Package of Integers/Strings or a single Integer or String.
224	 * Note: This section also validates that all CID elements are of the
225	 * correct type (Integer or String).
226	 */
227	if (obj_desc->common.type == ACPI_TYPE_PACKAGE) {
228		count = obj_desc->package.count;
229		cid_objects = obj_desc->package.elements;
230	} else {		/* Single Integer or String CID */
231
232		count = 1;
233		cid_objects = &obj_desc;
234	}
235
236	string_area_size = 0;
237	for (i = 0; i < count; i++) {
238
239		/* String lengths include null terminator */
240
241		switch (cid_objects[i]->common.type) {
242		case ACPI_TYPE_INTEGER:
243
244			string_area_size += ACPI_EISAID_STRING_SIZE;
245			break;
246
247		case ACPI_TYPE_STRING:
248
249			string_area_size += cid_objects[i]->string.length + 1;
250			break;
251
252		default:
253
254			status = AE_TYPE;
255			goto cleanup;
256		}
257	}
258
259	/*
260	 * Now that we know the length of the CIDs, allocate return buffer:
261	 * 1) Size of the base structure +
262	 * 2) Size of the CID PNP_DEVICE_ID array +
263	 * 3) Size of the actual CID strings
264	 */
265	cid_list_size = sizeof(struct acpi_pnp_device_id_list) +
266	    ((count - 1) * sizeof(struct acpi_pnp_device_id)) +
267	    string_area_size;
268
269	cid_list = ACPI_ALLOCATE_ZEROED(cid_list_size);
270	if (!cid_list) {
271		status = AE_NO_MEMORY;
272		goto cleanup;
273	}
274
275	/* Area for CID strings starts after the CID PNP_DEVICE_ID array */
276
277	next_id_string = ACPI_CAST_PTR(char, cid_list->ids) +
278	    ((acpi_size)count * sizeof(struct acpi_pnp_device_id));
279
280	/* Copy/convert the CIDs to the return buffer */
281
282	for (i = 0; i < count; i++) {
283		if (cid_objects[i]->common.type == ACPI_TYPE_INTEGER) {
284
285			/* Convert the Integer (EISAID) CID to a string */
286
287			acpi_ex_eisa_id_to_string(next_id_string,
288						  cid_objects[i]->integer.
289						  value);
290			length = ACPI_EISAID_STRING_SIZE;
291		} else {	/* ACPI_TYPE_STRING */
292
293			/* Copy the String CID from the returned object */
294
295			strcpy(next_id_string, cid_objects[i]->string.pointer);
 
296			length = cid_objects[i]->string.length + 1;
297		}
298
299		cid_list->ids[i].string = next_id_string;
300		cid_list->ids[i].length = length;
301		next_id_string += length;
302	}
303
304	/* Finish the CID list */
305
306	cid_list->count = count;
307	cid_list->list_size = cid_list_size;
308	*return_cid_list = cid_list;
309
310cleanup:
311
312	/* On exit, we must delete the _CID return object */
313
314	acpi_ut_remove_reference(obj_desc);
315	return_ACPI_STATUS(status);
316}
317
318/*******************************************************************************
319 *
320 * FUNCTION:    acpi_ut_execute_CLS
321 *
322 * PARAMETERS:  device_node         - Node for the device
323 *              return_id           - Where the _CLS is returned
324 *
325 * RETURN:      Status
326 *
327 * DESCRIPTION: Executes the _CLS control method that returns PCI-defined
328 *              class code of the device. The _CLS value is always a package
329 *              containing PCI class information as a list of integers.
330 *              The returned string has format "BBSSPP", where:
331 *                BB = Base-class code
332 *                SS = Sub-class code
333 *                PP = Programming Interface code
334 *
335 ******************************************************************************/
336
337acpi_status
338acpi_ut_execute_CLS(struct acpi_namespace_node *device_node,
339		    struct acpi_pnp_device_id **return_id)
340{
341	union acpi_operand_object *obj_desc;
342	union acpi_operand_object **cls_objects;
343	u32 count;
344	struct acpi_pnp_device_id *cls;
345	u32 length;
346	acpi_status status;
347	u8 class_code[3] = { 0, 0, 0 };
348
349	ACPI_FUNCTION_TRACE(ut_execute_CLS);
350
351	status = acpi_ut_evaluate_object(device_node, METHOD_NAME__CLS,
352					 ACPI_BTYPE_PACKAGE, &obj_desc);
353	if (ACPI_FAILURE(status)) {
354		return_ACPI_STATUS(status);
355	}
356
357	/* Get the size of the String to be returned, includes null terminator */
358
359	length = ACPI_PCICLS_STRING_SIZE;
360	cls_objects = obj_desc->package.elements;
361	count = obj_desc->package.count;
362
363	if (obj_desc->common.type == ACPI_TYPE_PACKAGE) {
364		if (count > 0
365		    && cls_objects[0]->common.type == ACPI_TYPE_INTEGER) {
366			class_code[0] = (u8)cls_objects[0]->integer.value;
367		}
368		if (count > 1
369		    && cls_objects[1]->common.type == ACPI_TYPE_INTEGER) {
370			class_code[1] = (u8)cls_objects[1]->integer.value;
371		}
372		if (count > 2
373		    && cls_objects[2]->common.type == ACPI_TYPE_INTEGER) {
374			class_code[2] = (u8)cls_objects[2]->integer.value;
375		}
376	}
377
378	/* Allocate a buffer for the CLS */
379
380	cls =
381	    ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pnp_device_id) +
382				 (acpi_size)length);
383	if (!cls) {
384		status = AE_NO_MEMORY;
385		goto cleanup;
386	}
387
388	/* Area for the string starts after PNP_DEVICE_ID struct */
389
390	cls->string =
391	    ACPI_ADD_PTR(char, cls, sizeof(struct acpi_pnp_device_id));
392
393	/* Simply copy existing string */
394
395	acpi_ex_pci_cls_to_string(cls->string, class_code);
396	cls->length = length;
397	*return_id = cls;
398
399cleanup:
400
401	/* On exit, we must delete the return object */
402
403	acpi_ut_remove_reference(obj_desc);
404	return_ACPI_STATUS(status);
405}