blob: db4e6f677855293c1533c142ea575ce1a1306b00 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070047/* 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
Len Brown4be44fc2005-08-05 00:44:28 -040056#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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Linus Torvalds1da177e2005-04-16 15:20:36 -070059/* 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
Bob Moore83135242006-10-03 00:00:00 -040066#define ACPI_NS_PREFIX_IS_SCOPE 0x10
Bob Moore958dd242006-05-12 17:12:00 -040067#define ACPI_NS_EXTERNAL 0x20
Bob Moored1fdda832007-02-02 19:48:21 +030068#define ACPI_NS_TEMPORARY 0x40
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Bob Moored1fdda832007-02-02 19:48:21 +030070/* Flags for acpi_ns_walk_namespace */
71
72#define ACPI_NS_WALK_NO_UNLOCK 0
73#define ACPI_NS_WALK_UNLOCK 0x01
74#define ACPI_NS_WALK_TEMP_NODES 0x02
Linus Torvalds1da177e2005-04-16 15:20:36 -070075
Robert Moore44f6c012005-04-18 22:49:35 -040076/*
77 * nsinit - Namespace initialization
78 */
Len Brown4be44fc2005-08-05 00:44:28 -040079acpi_status acpi_ns_initialize_objects(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Len Brown4be44fc2005-08-05 00:44:28 -040081acpi_status acpi_ns_initialize_devices(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Robert Moore44f6c012005-04-18 22:49:35 -040083/*
84 * nsload - Namespace loading
85 */
Len Brown4be44fc2005-08-05 00:44:28 -040086acpi_status acpi_ns_load_namespace(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
88acpi_status
Bob Moore67a119f2008-06-10 13:42:13 +080089acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Robert Moore44f6c012005-04-18 22:49:35 -040091/*
92 * nswalk - walk the namespace
93 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040095acpi_ns_walk_namespace(acpi_object_type type,
96 acpi_handle start_object,
97 u32 max_depth,
Bob Moored1fdda832007-02-02 19:48:21 +030098 u32 flags,
Len Brown4be44fc2005-08-05 00:44:28 -040099 acpi_walk_callback user_function,
100 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Len Brownfd350942007-05-09 23:34:35 -0400102struct acpi_namespace_node *acpi_ns_get_next_node(acpi_object_type type, struct acpi_namespace_node
103 *parent, struct acpi_namespace_node
Len Brown4be44fc2005-08-05 00:44:28 -0400104 *child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Robert Moore44f6c012005-04-18 22:49:35 -0400106/*
107 * nsparse - table parsing
108 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109acpi_status
Bob Moore67a119f2008-06-10 13:42:13 +0800110acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
112acpi_status
Bob Moore67a119f2008-06-10 13:42:13 +0800113acpi_ns_one_complete_parse(u32 pass_number,
114 u32 table_index,
Bob Moore7f4ac9f2008-04-10 19:06:39 +0400115 struct acpi_namespace_node *start_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117/*
Robert Moore44f6c012005-04-18 22:49:35 -0400118 * nsaccess - Top-level namespace access
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
Len Brown4be44fc2005-08-05 00:44:28 -0400120acpi_status acpi_ns_root_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400123acpi_ns_lookup(union acpi_generic_state *scope_info,
124 char *name,
125 acpi_object_type type,
126 acpi_interpreter_mode interpreter_mode,
127 u32 flags,
128 struct acpi_walk_state *walk_state,
129 struct acpi_namespace_node **ret_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131/*
Robert Moore44f6c012005-04-18 22:49:35 -0400132 * nsalloc - Named object allocation/deallocation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 */
Len Brown4be44fc2005-08-05 00:44:28 -0400134struct acpi_namespace_node *acpi_ns_create_node(u32 name);
135
136void acpi_ns_delete_node(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138void
Len Brown4be44fc2005-08-05 00:44:28 -0400139acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Len Brown4be44fc2005-08-05 00:44:28 -0400141void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Len Brown4be44fc2005-08-05 00:44:28 -0400143void acpi_ns_detach_object(struct acpi_namespace_node *node);
Robert Moore44f6c012005-04-18 22:49:35 -0400144
Len Brown4be44fc2005-08-05 00:44:28 -0400145void acpi_ns_delete_children(struct acpi_namespace_node *parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Len Brown4be44fc2005-08-05 00:44:28 -0400147int acpi_ns_compare_names(char *name1, char *name2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149/*
Robert Moore44f6c012005-04-18 22:49:35 -0400150 * nsdump - Namespace dump/print utilities
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 */
Robert Moore44f6c012005-04-18 22:49:35 -0400152#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400153void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
154#endif /* ACPI_FUTURE_USAGE */
155
156void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158void
Len Brown4be44fc2005-08-05 00:44:28 -0400159acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Len Brown4be44fc2005-08-05 00:44:28 -0400161void acpi_ns_print_pathname(u32 num_segments, char *pathname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400164acpi_ns_dump_one_object(acpi_handle obj_handle,
165 u32 level, void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Robert Moore44f6c012005-04-18 22:49:35 -0400167#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168void
Len Brown4be44fc2005-08-05 00:44:28 -0400169acpi_ns_dump_objects(acpi_object_type type,
170 u8 display_type,
171 u32 max_depth,
172 acpi_owner_id owner_id, acpi_handle start_handle);
173#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175/*
Robert Moore44f6c012005-04-18 22:49:35 -0400176 * nseval - Namespace evaluation functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 */
Bob Moore41195322006-05-26 16:36:00 -0400178acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180/*
Bob Mooree8707b32008-09-28 15:26:17 +0800181 * nspredef - Support for predefined/reserved names
182 */
183acpi_status
184acpi_ns_check_predefined_names(struct acpi_namespace_node *node,
185 union acpi_operand_object *return_object);
186
187const union acpi_predefined_info *acpi_ns_check_for_predefined_name(struct
188 acpi_namespace_node
189 *node);
190
191void
192acpi_ns_check_parameter_count(char *pathname,
193 struct acpi_namespace_node *node,
194 const union acpi_predefined_info *info);
195
196/*
Robert Moore44f6c012005-04-18 22:49:35 -0400197 * nsnames - Name and Scope manipulation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 */
Len Brown4be44fc2005-08-05 00:44:28 -0400199u32 acpi_ns_opens_scope(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Bob Moore3c7db222008-08-04 11:13:01 +0800201acpi_status
Bob Moore83135242006-10-03 00:00:00 -0400202acpi_ns_build_external_path(struct acpi_namespace_node *node,
203 acpi_size size, char *name_buffer);
204
Len Brown4be44fc2005-08-05 00:44:28 -0400205char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Len Brown4be44fc2005-08-05 00:44:28 -0400207char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400210acpi_ns_handle_to_pathname(acpi_handle target_handle,
211 struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213u8
Len Brown4be44fc2005-08-05 00:44:28 -0400214acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216acpi_status
Bob Moore41195322006-05-26 16:36:00 -0400217acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
Bob Moore4b8ed632008-06-10 13:55:53 +0800218 const char *external_pathname,
Bob Moore41195322006-05-26 16:36:00 -0400219 u32 flags, struct acpi_namespace_node **out_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Len Brown4be44fc2005-08-05 00:44:28 -0400221acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223/*
Robert Moore44f6c012005-04-18 22:49:35 -0400224 * nsobject - Object management for namespace nodes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400227acpi_ns_attach_object(struct acpi_namespace_node *node,
228 union acpi_operand_object *object, acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Len Brown4be44fc2005-08-05 00:44:28 -0400230union acpi_operand_object *acpi_ns_get_attached_object(struct
231 acpi_namespace_node
232 *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Len Brown4be44fc2005-08-05 00:44:28 -0400234union acpi_operand_object *acpi_ns_get_secondary_object(union
235 acpi_operand_object
236 *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400239acpi_ns_attach_data(struct acpi_namespace_node *node,
240 acpi_object_handler handler, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400243acpi_ns_detach_data(struct acpi_namespace_node *node,
244 acpi_object_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400247acpi_ns_get_attached_data(struct acpi_namespace_node *node,
248 acpi_object_handler handler, void **data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250/*
Robert Moore44f6c012005-04-18 22:49:35 -0400251 * nssearch - Namespace searching and entry
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400254acpi_ns_search_and_enter(u32 entry_name,
255 struct acpi_walk_state *walk_state,
256 struct acpi_namespace_node *node,
257 acpi_interpreter_mode interpreter_mode,
258 acpi_object_type type,
259 u32 flags, struct acpi_namespace_node **ret_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261acpi_status
Bob Moore41195322006-05-26 16:36:00 -0400262acpi_ns_search_one_scope(u32 entry_name,
263 struct acpi_namespace_node *node,
264 acpi_object_type type,
265 struct acpi_namespace_node **ret_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267void
Len Brown4be44fc2005-08-05 00:44:28 -0400268acpi_ns_install_node(struct acpi_walk_state *walk_state,
269 struct acpi_namespace_node *parent_node,
270 struct acpi_namespace_node *node, acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272/*
Robert Moore44f6c012005-04-18 22:49:35 -0400273 * nsutils - Utility functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 */
Len Brown4be44fc2005-08-05 00:44:28 -0400275u8 acpi_ns_valid_root_prefix(char prefix);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Len Brown4be44fc2005-08-05 00:44:28 -0400277acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Len Brown4be44fc2005-08-05 00:44:28 -0400279u32 acpi_ns_local(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
281void
Bob Moore4b8ed632008-06-10 13:55:53 +0800282acpi_ns_report_error(const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400283 u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800284 const char *internal_name, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286void
Bob Moore4b8ed632008-06-10 13:55:53 +0800287acpi_ns_report_method_error(const char *module_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400288 u32 line_number,
Bob Moore4b8ed632008-06-10 13:55:53 +0800289 const char *message,
Len Brown4be44fc2005-08-05 00:44:28 -0400290 struct acpi_namespace_node *node,
Bob Moore4b8ed632008-06-10 13:55:53 +0800291 const char *path, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Bob Moore4b8ed632008-06-10 13:55:53 +0800293void
294acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
Len Brown4be44fc2005-08-05 00:44:28 -0400295
296acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
297
298void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
299
Bob Moore4b8ed632008-06-10 13:55:53 +0800300acpi_status
301acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400304acpi_ns_externalize_name(u32 internal_name_length,
Bob Moore4b8ed632008-06-10 13:55:53 +0800305 const char *internal_name,
Len Brown4be44fc2005-08-05 00:44:28 -0400306 u32 * converted_name_length, char **converted_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
Len Brown4be44fc2005-08-05 00:44:28 -0400308struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Len Brown4be44fc2005-08-05 00:44:28 -0400310acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Len Brown4be44fc2005-08-05 00:44:28 -0400312void acpi_ns_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Len Brown4be44fc2005-08-05 00:44:28 -0400314struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node
315 *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Len Brown4be44fc2005-08-05 00:44:28 -0400317struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct
318 acpi_namespace_node
319 *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Len Brown4be44fc2005-08-05 00:44:28 -0400321#endif /* __ACNAMESP_H__ */