]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/acpi/acpica/acnamesp.h
Merge tag 'xfs-for-linus-4.10-rc6-5' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / acnamesp.h
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
c8100dc4 8 * Copyright (C) 2000 - 2016, Intel Corp.
1da177e4
LT
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#ifndef __ACNAMESP_H__
45#define __ACNAMESP_H__
46
1da177e4
LT
47/* To search the entire name space, pass this as search_base */
48
49#define ACPI_NS_ALL ((acpi_handle)0)
50
51/*
52 * Elements of acpi_ns_properties are bit significant
53 * and should be one-to-one with values of acpi_object_type
54 */
55#define ACPI_NS_NORMAL 0
4be44fcd
LB
56#define ACPI_NS_NEWSCOPE 1 /* a definition of this type opens a name scope */
57#define ACPI_NS_LOCAL 2 /* suppress search of enclosing scopes */
1da177e4 58
1da177e4
LT
59/* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */
60
61#define ACPI_NS_NO_UPSEARCH 0
62#define ACPI_NS_SEARCH_PARENT 0x01
63#define ACPI_NS_DONT_OPEN_SCOPE 0x02
64#define ACPI_NS_NO_PEER_SEARCH 0x04
65#define ACPI_NS_ERROR_IF_FOUND 0x08
8313524a 66#define ACPI_NS_PREFIX_IS_SCOPE 0x10
958dd242 67#define ACPI_NS_EXTERNAL 0x20
d1fdda83 68#define ACPI_NS_TEMPORARY 0x40
8f6f0361 69#define ACPI_NS_OVERRIDE_IF_FOUND 0x80
1da177e4 70
d1fdda83
BM
71/* Flags for acpi_ns_walk_namespace */
72
73#define ACPI_NS_WALK_NO_UNLOCK 0
74#define ACPI_NS_WALK_UNLOCK 0x01
75#define ACPI_NS_WALK_TEMP_NODES 0x02
1da177e4 76
b2deadd5
BM
77/* Object is not a package element */
78
79#define ACPI_NOT_PACKAGE_ELEMENT ACPI_UINT32_MAX
ee387409 80#define ACPI_ALL_PACKAGE_ELEMENTS (ACPI_UINT32_MAX-1)
b2deadd5
BM
81
82/* Always emit warning message, not dependent on node flags */
83
84#define ACPI_WARN_ALWAYS 0
85
44f6c012
RM
86/*
87 * nsinit - Namespace initialization
88 */
4be44fcd 89acpi_status acpi_ns_initialize_objects(void);
1da177e4 90
ced04366 91acpi_status acpi_ns_initialize_devices(u32 flags);
1da177e4 92
44f6c012
RM
93/*
94 * nsload - Namespace loading
95 */
4be44fcd 96acpi_status acpi_ns_load_namespace(void);
1da177e4
LT
97
98acpi_status
67a119f9 99acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
1da177e4 100
44f6c012
RM
101/*
102 * nswalk - walk the namespace
103 */
1da177e4 104acpi_status
4be44fcd
LB
105acpi_ns_walk_namespace(acpi_object_type type,
106 acpi_handle start_object,
107 u32 max_depth,
d1fdda83 108 u32 flags,
4ef17507
BM
109 acpi_walk_callback descending_callback,
110 acpi_walk_callback ascending_callback,
4be44fcd
LB
111 void *context, void **return_value);
112
8c725bf9
BM
113struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node
114 *parent,
115 struct acpi_namespace_node
4be44fcd 116 *child);
1da177e4 117
8c725bf9
BM
118struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type,
119 struct
120 acpi_namespace_node
121 *parent,
122 struct
123 acpi_namespace_node
124 *child);
125
44f6c012
RM
126/*
127 * nsparse - table parsing
128 */
1da177e4 129acpi_status
67a119f9 130acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
1da177e4 131
de56ba95
LZ
132acpi_status
133acpi_ns_execute_table(u32 table_index, struct acpi_namespace_node *start_node);
134
1da177e4 135acpi_status
67a119f9
BM
136acpi_ns_one_complete_parse(u32 pass_number,
137 u32 table_index,
7f4ac9f9 138 struct acpi_namespace_node *start_node);
1da177e4
LT
139
140/*
44f6c012 141 * nsaccess - Top-level namespace access
1da177e4 142 */
4be44fcd 143acpi_status acpi_ns_root_initialize(void);
1da177e4
LT
144
145acpi_status
4be44fcd
LB
146acpi_ns_lookup(union acpi_generic_state *scope_info,
147 char *name,
148 acpi_object_type type,
149 acpi_interpreter_mode interpreter_mode,
150 u32 flags,
151 struct acpi_walk_state *walk_state,
152 struct acpi_namespace_node **ret_node);
1da177e4
LT
153
154/*
44f6c012 155 * nsalloc - Named object allocation/deallocation
1da177e4 156 */
4be44fcd 157struct acpi_namespace_node *acpi_ns_create_node(u32 name);
1da177e4 158
4be44fcd 159void acpi_ns_delete_node(struct acpi_namespace_node *node);
1da177e4 160
8e4319c4
BM
161void acpi_ns_remove_node(struct acpi_namespace_node *node);
162
44f6c012 163void
4be44fcd 164acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
44f6c012 165
4be44fcd 166void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
1da177e4 167
4be44fcd 168void acpi_ns_detach_object(struct acpi_namespace_node *node);
1da177e4 169
4be44fcd 170void acpi_ns_delete_children(struct acpi_namespace_node *parent);
1da177e4 171
4be44fcd 172int acpi_ns_compare_names(char *name1, char *name2);
1da177e4 173
76a6225b
BM
174/*
175 * nsconvert - Dynamic object conversion routines
176 */
177acpi_status
178acpi_ns_convert_to_integer(union acpi_operand_object *original_object,
179 union acpi_operand_object **return_object);
180
181acpi_status
182acpi_ns_convert_to_string(union acpi_operand_object *original_object,
183 union acpi_operand_object **return_object);
184
185acpi_status
186acpi_ns_convert_to_buffer(union acpi_operand_object *original_object,
187 union acpi_operand_object **return_object);
188
96b44cc6 189acpi_status
4debda53
LZ
190acpi_ns_convert_to_unicode(struct acpi_namespace_node *scope,
191 union acpi_operand_object *original_object,
96b44cc6
LZ
192 union acpi_operand_object **return_object);
193
88fd0ac8 194acpi_status
4debda53
LZ
195acpi_ns_convert_to_resource(struct acpi_namespace_node *scope,
196 union acpi_operand_object *original_object,
88fd0ac8
LZ
197 union acpi_operand_object **return_object);
198
ee387409
LZ
199acpi_status
200acpi_ns_convert_to_reference(struct acpi_namespace_node *scope,
201 union acpi_operand_object *original_object,
202 union acpi_operand_object **return_object);
203
1da177e4 204/*
44f6c012 205 * nsdump - Namespace dump/print utilities
1da177e4 206 */
4be44fcd 207void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
1da177e4 208
4be44fcd 209void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
1da177e4
LT
210
211void
0dfaaa3d
BM
212acpi_ns_dump_pathname(acpi_handle handle,
213 const char *msg, u32 level, u32 component);
1da177e4 214
0dfaaa3d 215void acpi_ns_print_pathname(u32 num_segments, const char *pathname);
1da177e4 216
1da177e4 217acpi_status
4be44fcd
LB
218acpi_ns_dump_one_object(acpi_handle obj_handle,
219 u32 level, void *context, void **return_value);
1da177e4 220
1da177e4 221void
4be44fcd
LB
222acpi_ns_dump_objects(acpi_object_type type,
223 u8 display_type,
224 u32 max_depth,
225 acpi_owner_id owner_id, acpi_handle start_handle);
424deb38
BM
226
227void
228acpi_ns_dump_object_paths(acpi_object_type type,
229 u8 display_type,
230 u32 max_depth,
231 acpi_owner_id owner_id, acpi_handle start_handle);
1da177e4
LT
232
233/*
44f6c012 234 * nseval - Namespace evaluation functions
1da177e4 235 */
4119532c 236acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
1da177e4 237
7f0c826a
LM
238void acpi_ns_exec_module_code_list(void);
239
e8707b34 240/*
29a241cc 241 * nsarguments - Argument count/type checking for predefined/reserved names
e8707b34 242 */
29a241cc
BM
243void
244acpi_ns_check_argument_count(char *pathname,
245 struct acpi_namespace_node *node,
246 u32 user_param_count,
247 const union acpi_predefined_info *info);
e8707b34 248
e8707b34 249void
29a241cc 250acpi_ns_check_acpi_compliance(char *pathname,
e8707b34 251 struct acpi_namespace_node *node,
29a241cc
BM
252 const union acpi_predefined_info *predefined);
253
254void acpi_ns_check_argument_types(struct acpi_evaluate_info *info);
255
256/*
257 * nspredef - Return value checking for predefined/reserved names
258 */
259acpi_status
260acpi_ns_check_return_value(struct acpi_namespace_node *node,
261 struct acpi_evaluate_info *info,
262 u32 user_param_count,
263 acpi_status return_status,
264 union acpi_operand_object **return_object);
e8707b34 265
42f8fb75 266acpi_status
29a241cc 267acpi_ns_check_object_type(struct acpi_evaluate_info *info,
42f8fb75
BM
268 union acpi_operand_object **return_object_ptr,
269 u32 expected_btypes, u32 package_index);
270
271/*
272 * nsprepkg - Validation of predefined name packages
273 */
274acpi_status
29a241cc 275acpi_ns_check_package(struct acpi_evaluate_info *info,
42f8fb75
BM
276 union acpi_operand_object **return_object_ptr);
277
1da177e4 278/*
44f6c012 279 * nsnames - Name and Scope manipulation
1da177e4 280 */
4be44fcd 281u32 acpi_ns_opens_scope(acpi_object_type type);
1da177e4 282
4be44fcd 283char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
1da177e4 284
d1e7ffe5
LZ
285u32
286acpi_ns_build_normalized_path(struct acpi_namespace_node *node,
287 char *full_path, u32 path_size, u8 no_trailing);
288
289char *acpi_ns_get_normalized_pathname(struct acpi_namespace_node *node,
290 u8 no_trailing);
291
4be44fcd 292char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
1da177e4 293
523db19b
LZ
294acpi_status
295acpi_ns_handle_to_name(acpi_handle target_handle, struct acpi_buffer *buffer);
296
1da177e4 297acpi_status
4be44fcd 298acpi_ns_handle_to_pathname(acpi_handle target_handle,
d1e7ffe5 299 struct acpi_buffer *buffer, u8 no_trailing);
1da177e4
LT
300
301u8
4be44fcd 302acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
1da177e4 303
c2d981aa
LZ
304acpi_status
305acpi_ns_get_node_unlocked(struct acpi_namespace_node *prefix_node,
306 const char *external_pathname,
307 u32 flags, struct acpi_namespace_node **out_node);
308
1da177e4 309acpi_status
4119532c 310acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
4b8ed631 311 const char *external_pathname,
4119532c 312 u32 flags, struct acpi_namespace_node **out_node);
1da177e4 313
4be44fcd 314acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
1da177e4
LT
315
316/*
44f6c012 317 * nsobject - Object management for namespace nodes
1da177e4 318 */
1da177e4 319acpi_status
4be44fcd
LB
320acpi_ns_attach_object(struct acpi_namespace_node *node,
321 union acpi_operand_object *object, acpi_object_type type);
1da177e4 322
4be44fcd
LB
323union acpi_operand_object *acpi_ns_get_attached_object(struct
324 acpi_namespace_node
325 *node);
1da177e4 326
4be44fcd
LB
327union acpi_operand_object *acpi_ns_get_secondary_object(union
328 acpi_operand_object
329 *obj_desc);
1da177e4
LT
330
331acpi_status
4be44fcd
LB
332acpi_ns_attach_data(struct acpi_namespace_node *node,
333 acpi_object_handler handler, void *data);
1da177e4
LT
334
335acpi_status
4be44fcd
LB
336acpi_ns_detach_data(struct acpi_namespace_node *node,
337 acpi_object_handler handler);
1da177e4
LT
338
339acpi_status
4be44fcd
LB
340acpi_ns_get_attached_data(struct acpi_namespace_node *node,
341 acpi_object_handler handler, void **data);
1da177e4 342
b2deadd5 343/*
ad5babee
BM
344 * nsrepair - General return object repair for all
345 * predefined methods/objects
b2deadd5
BM
346 */
347acpi_status
29a241cc 348acpi_ns_simple_repair(struct acpi_evaluate_info *info,
b2deadd5
BM
349 u32 expected_btypes,
350 u32 package_index,
351 union acpi_operand_object **return_object_ptr);
352
e5f69d6e 353acpi_status
29a241cc 354acpi_ns_wrap_with_package(struct acpi_evaluate_info *info,
6a99b1c9
BM
355 union acpi_operand_object *original_object,
356 union acpi_operand_object **obj_desc_ptr);
e5f69d6e 357
091f4d71 358acpi_status
29a241cc 359acpi_ns_repair_null_element(struct acpi_evaluate_info *info,
091f4d71
BM
360 u32 expected_btypes,
361 u32 package_index,
362 union acpi_operand_object **return_object_ptr);
363
364void
29a241cc 365acpi_ns_remove_null_elements(struct acpi_evaluate_info *info,
091f4d71
BM
366 u8 package_type,
367 union acpi_operand_object *obj_desc);
368
ad5babee
BM
369/*
370 * nsrepair2 - Return object repair for specific
371 * predefined methods/objects
372 */
373acpi_status
29a241cc 374acpi_ns_complex_repairs(struct acpi_evaluate_info *info,
ad5babee
BM
375 struct acpi_namespace_node *node,
376 acpi_status validate_status,
377 union acpi_operand_object **return_object_ptr);
378
1da177e4 379/*
44f6c012 380 * nssearch - Namespace searching and entry
1da177e4 381 */
1da177e4 382acpi_status
4be44fcd
LB
383acpi_ns_search_and_enter(u32 entry_name,
384 struct acpi_walk_state *walk_state,
385 struct acpi_namespace_node *node,
386 acpi_interpreter_mode interpreter_mode,
387 acpi_object_type type,
388 u32 flags, struct acpi_namespace_node **ret_node);
1da177e4
LT
389
390acpi_status
4119532c
BM
391acpi_ns_search_one_scope(u32 entry_name,
392 struct acpi_namespace_node *node,
393 acpi_object_type type,
394 struct acpi_namespace_node **ret_node);
1da177e4
LT
395
396void
4be44fcd
LB
397acpi_ns_install_node(struct acpi_walk_state *walk_state,
398 struct acpi_namespace_node *parent_node,
399 struct acpi_namespace_node *node, acpi_object_type type);
1da177e4
LT
400
401/*
44f6c012 402 * nsutils - Utility functions
1da177e4 403 */
4be44fcd 404acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
1da177e4 405
4be44fcd 406u32 acpi_ns_local(acpi_object_type type);
1da177e4 407
4b8ed631
BM
408void
409acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
1da177e4 410
4be44fcd 411acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
1da177e4 412
4be44fcd 413void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
1da177e4 414
4b8ed631
BM
415acpi_status
416acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
1da177e4
LT
417
418acpi_status
4be44fcd 419acpi_ns_externalize_name(u32 internal_name_length,
4b8ed631 420 const char *internal_name,
4be44fcd 421 u32 * converted_name_length, char **converted_name);
1da177e4 422
f24b664d 423struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle);
1da177e4 424
4be44fcd 425void acpi_ns_terminate(void);
1da177e4 426
4be44fcd 427#endif /* __ACNAMESP_H__ */