blob: 5ef38a6c8a6154c3c4dc0a29c347a6e10b98079e [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/*
Bob Moore6c9deb72007-02-02 19:48:24 +03008 * Copyright (C) 2000 - 2007, R. Byron Moore
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 Moored1fdda82007-02-02 19:48:21 +030068#define ACPI_NS_TEMPORARY 0x40
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Bob Moored1fdda82007-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 Mooref3d2e782007-02-02 19:48:18 +030089acpi_ns_load_table(acpi_native_uint table_index,
Len Brown4be44fc2005-08-05 00:44:28 -040090 struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Robert Moore44f6c012005-04-18 22:49:35 -040092/*
93 * nswalk - walk the namespace
94 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040096acpi_ns_walk_namespace(acpi_object_type type,
97 acpi_handle start_object,
98 u32 max_depth,
Bob Moored1fdda82007-02-02 19:48:21 +030099 u32 flags,
Len Brown4be44fc2005-08-05 00:44:28 -0400100 acpi_walk_callback user_function,
101 void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Len Brownfd350942007-05-09 23:34:35 -0400103struct acpi_namespace_node *acpi_ns_get_next_node(acpi_object_type type, struct acpi_namespace_node
104 *parent, struct acpi_namespace_node
Len Brown4be44fc2005-08-05 00:44:28 -0400105 *child);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Robert Moore44f6c012005-04-18 22:49:35 -0400107/*
108 * nsparse - table parsing
109 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300111acpi_ns_parse_table(acpi_native_uint table_index,
112 struct acpi_namespace_node *start_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114acpi_status
Bob Mooref3d2e782007-02-02 19:48:18 +0300115acpi_ns_one_complete_parse(acpi_native_uint pass_number,
116 acpi_native_uint table_index);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
118/*
Robert Moore44f6c012005-04-18 22:49:35 -0400119 * nsaccess - Top-level namespace access
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 */
Len Brown4be44fc2005-08-05 00:44:28 -0400121acpi_status acpi_ns_root_initialize(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400124acpi_ns_lookup(union acpi_generic_state *scope_info,
125 char *name,
126 acpi_object_type type,
127 acpi_interpreter_mode interpreter_mode,
128 u32 flags,
129 struct acpi_walk_state *walk_state,
130 struct acpi_namespace_node **ret_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132/*
Robert Moore44f6c012005-04-18 22:49:35 -0400133 * nsalloc - Named object allocation/deallocation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 */
Len Brown4be44fc2005-08-05 00:44:28 -0400135struct acpi_namespace_node *acpi_ns_create_node(u32 name);
136
137void acpi_ns_delete_node(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139void
Len Brown4be44fc2005-08-05 00:44:28 -0400140acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Len Brown4be44fc2005-08-05 00:44:28 -0400142void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143
Len Brown4be44fc2005-08-05 00:44:28 -0400144void acpi_ns_detach_object(struct acpi_namespace_node *node);
Robert Moore44f6c012005-04-18 22:49:35 -0400145
Len Brown4be44fc2005-08-05 00:44:28 -0400146void acpi_ns_delete_children(struct acpi_namespace_node *parent);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Len Brown4be44fc2005-08-05 00:44:28 -0400148int acpi_ns_compare_names(char *name1, char *name2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150/*
Robert Moore44f6c012005-04-18 22:49:35 -0400151 * nsdump - Namespace dump/print utilities
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 */
Robert Moore44f6c012005-04-18 22:49:35 -0400153#ifdef ACPI_FUTURE_USAGE
Len Brown4be44fc2005-08-05 00:44:28 -0400154void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
155#endif /* ACPI_FUTURE_USAGE */
156
157void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159void
Len Brown4be44fc2005-08-05 00:44:28 -0400160acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Len Brown4be44fc2005-08-05 00:44:28 -0400162void acpi_ns_print_pathname(u32 num_segments, char *pathname);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400165acpi_ns_dump_one_object(acpi_handle obj_handle,
166 u32 level, void *context, void **return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Robert Moore44f6c012005-04-18 22:49:35 -0400168#ifdef ACPI_FUTURE_USAGE
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169void
Len Brown4be44fc2005-08-05 00:44:28 -0400170acpi_ns_dump_objects(acpi_object_type type,
171 u8 display_type,
172 u32 max_depth,
173 acpi_owner_id owner_id, acpi_handle start_handle);
174#endif /* ACPI_FUTURE_USAGE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
176/*
Robert Moore44f6c012005-04-18 22:49:35 -0400177 * nseval - Namespace evaluation functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 */
Bob Moore41195322006-05-26 16:36:00 -0400179acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181/*
Robert Moore44f6c012005-04-18 22:49:35 -0400182 * nsnames - Name and Scope manipulation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 */
Len Brown4be44fc2005-08-05 00:44:28 -0400184u32 acpi_ns_opens_scope(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Bob Moore83135242006-10-03 00:00:00 -0400186void
187acpi_ns_build_external_path(struct acpi_namespace_node *node,
188 acpi_size size, char *name_buffer);
189
Len Brown4be44fc2005-08-05 00:44:28 -0400190char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Len Brown4be44fc2005-08-05 00:44:28 -0400192char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400195acpi_ns_handle_to_pathname(acpi_handle target_handle,
196 struct acpi_buffer *buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198u8
Len Brown4be44fc2005-08-05 00:44:28 -0400199acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
201acpi_status
Bob Moore41195322006-05-26 16:36:00 -0400202acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
203 char *external_pathname,
204 u32 flags, struct acpi_namespace_node **out_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Len Brown4be44fc2005-08-05 00:44:28 -0400206acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/*
Robert Moore44f6c012005-04-18 22:49:35 -0400209 * nsobject - Object management for namespace nodes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400212acpi_ns_attach_object(struct acpi_namespace_node *node,
213 union acpi_operand_object *object, acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Len Brown4be44fc2005-08-05 00:44:28 -0400215union acpi_operand_object *acpi_ns_get_attached_object(struct
216 acpi_namespace_node
217 *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Len Brown4be44fc2005-08-05 00:44:28 -0400219union acpi_operand_object *acpi_ns_get_secondary_object(union
220 acpi_operand_object
221 *obj_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
223acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400224acpi_ns_attach_data(struct acpi_namespace_node *node,
225 acpi_object_handler handler, void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400228acpi_ns_detach_data(struct acpi_namespace_node *node,
229 acpi_object_handler handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400232acpi_ns_get_attached_data(struct acpi_namespace_node *node,
233 acpi_object_handler handler, void **data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235/*
Robert Moore44f6c012005-04-18 22:49:35 -0400236 * nssearch - Namespace searching and entry
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400239acpi_ns_search_and_enter(u32 entry_name,
240 struct acpi_walk_state *walk_state,
241 struct acpi_namespace_node *node,
242 acpi_interpreter_mode interpreter_mode,
243 acpi_object_type type,
244 u32 flags, struct acpi_namespace_node **ret_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246acpi_status
Bob Moore41195322006-05-26 16:36:00 -0400247acpi_ns_search_one_scope(u32 entry_name,
248 struct acpi_namespace_node *node,
249 acpi_object_type type,
250 struct acpi_namespace_node **ret_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252void
Len Brown4be44fc2005-08-05 00:44:28 -0400253acpi_ns_install_node(struct acpi_walk_state *walk_state,
254 struct acpi_namespace_node *parent_node,
255 struct acpi_namespace_node *node, acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257/*
Robert Moore44f6c012005-04-18 22:49:35 -0400258 * nsutils - Utility functions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 */
Len Brown4be44fc2005-08-05 00:44:28 -0400260u8 acpi_ns_valid_root_prefix(char prefix);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Len Brown4be44fc2005-08-05 00:44:28 -0400262acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Len Brown4be44fc2005-08-05 00:44:28 -0400264u32 acpi_ns_local(acpi_object_type type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266void
Len Brown4be44fc2005-08-05 00:44:28 -0400267acpi_ns_report_error(char *module_name,
268 u32 line_number,
Len Brown4be44fc2005-08-05 00:44:28 -0400269 char *internal_name, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271void
Len Brown4be44fc2005-08-05 00:44:28 -0400272acpi_ns_report_method_error(char *module_name,
273 u32 line_number,
Len Brown4be44fc2005-08-05 00:44:28 -0400274 char *message,
275 struct acpi_namespace_node *node,
276 char *path, acpi_status lookup_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Len Brown4be44fc2005-08-05 00:44:28 -0400278void acpi_ns_print_node_pathname(struct acpi_namespace_node *node, char *msg);
279
280acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
281
282void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
283
284acpi_status acpi_ns_internalize_name(char *dotted_name, char **converted_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400287acpi_ns_externalize_name(u32 internal_name_length,
288 char *internal_name,
289 u32 * converted_name_length, char **converted_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Len Brown4be44fc2005-08-05 00:44:28 -0400291struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Len Brown4be44fc2005-08-05 00:44:28 -0400293acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Len Brown4be44fc2005-08-05 00:44:28 -0400295void acpi_ns_terminate(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Len Brown4be44fc2005-08-05 00:44:28 -0400297struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node
298 *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Len Brown4be44fc2005-08-05 00:44:28 -0400300struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct
301 acpi_namespace_node
302 *node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
Len Brown4be44fc2005-08-05 00:44:28 -0400304#endif /* __ACNAMESP_H__ */