Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: acnamesp.h - Namespace subcomponent prototypes and defines | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
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 |
1da177e4 LT |
68 | |
69 | #define ACPI_NS_WALK_UNLOCK TRUE | |
70 | #define ACPI_NS_WALK_NO_UNLOCK FALSE | |
71 | ||
44f6c012 RM |
72 | /* |
73 | * nsinit - Namespace initialization | |
74 | */ | |
4be44fcd | 75 | acpi_status acpi_ns_initialize_objects(void); |
1da177e4 | 76 | |
4be44fcd | 77 | acpi_status acpi_ns_initialize_devices(void); |
1da177e4 | 78 | |
44f6c012 RM |
79 | /* |
80 | * nsload - Namespace loading | |
81 | */ | |
4be44fcd | 82 | acpi_status acpi_ns_load_namespace(void); |
1da177e4 LT |
83 | |
84 | acpi_status | |
f3d2e786 | 85 | acpi_ns_load_table(acpi_native_uint table_index, |
4be44fcd | 86 | struct acpi_namespace_node *node); |
1da177e4 | 87 | |
44f6c012 RM |
88 | /* |
89 | * nswalk - walk the namespace | |
90 | */ | |
1da177e4 | 91 | acpi_status |
4be44fcd LB |
92 | acpi_ns_walk_namespace(acpi_object_type type, |
93 | acpi_handle start_object, | |
94 | u32 max_depth, | |
95 | u8 unlock_before_callback, | |
96 | acpi_walk_callback user_function, | |
97 | void *context, void **return_value); | |
98 | ||
99 | struct acpi_namespace_node *acpi_ns_get_next_node(acpi_object_type type, | |
100 | struct acpi_namespace_node | |
101 | *parent, | |
102 | struct acpi_namespace_node | |
103 | *child); | |
1da177e4 | 104 | |
44f6c012 RM |
105 | /* |
106 | * nsparse - table parsing | |
107 | */ | |
1da177e4 | 108 | acpi_status |
f3d2e786 BM |
109 | acpi_ns_parse_table(acpi_native_uint table_index, |
110 | struct acpi_namespace_node *start_node); | |
1da177e4 LT |
111 | |
112 | acpi_status | |
f3d2e786 BM |
113 | acpi_ns_one_complete_parse(acpi_native_uint pass_number, |
114 | acpi_native_uint table_index); | |
1da177e4 LT |
115 | |
116 | /* | |
44f6c012 | 117 | * nsaccess - Top-level namespace access |
1da177e4 | 118 | */ |
4be44fcd | 119 | acpi_status acpi_ns_root_initialize(void); |
1da177e4 LT |
120 | |
121 | acpi_status | |
4be44fcd LB |
122 | acpi_ns_lookup(union acpi_generic_state *scope_info, |
123 | char *name, | |
124 | acpi_object_type type, | |
125 | acpi_interpreter_mode interpreter_mode, | |
126 | u32 flags, | |
127 | struct acpi_walk_state *walk_state, | |
128 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
129 | |
130 | /* | |
44f6c012 | 131 | * nsalloc - Named object allocation/deallocation |
1da177e4 | 132 | */ |
4be44fcd | 133 | struct acpi_namespace_node *acpi_ns_create_node(u32 name); |
1da177e4 | 134 | |
4be44fcd | 135 | void acpi_ns_delete_node(struct acpi_namespace_node *node); |
1da177e4 | 136 | |
44f6c012 | 137 | void |
4be44fcd | 138 | acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle); |
44f6c012 | 139 | |
4be44fcd | 140 | void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id); |
1da177e4 | 141 | |
4be44fcd | 142 | void acpi_ns_detach_object(struct acpi_namespace_node *node); |
1da177e4 | 143 | |
4be44fcd | 144 | void acpi_ns_delete_children(struct acpi_namespace_node *parent); |
1da177e4 | 145 | |
4be44fcd | 146 | int acpi_ns_compare_names(char *name1, char *name2); |
1da177e4 LT |
147 | |
148 | /* | |
44f6c012 | 149 | * nsdump - Namespace dump/print utilities |
1da177e4 | 150 | */ |
44f6c012 | 151 | #ifdef ACPI_FUTURE_USAGE |
4be44fcd LB |
152 | void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth); |
153 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 | 154 | |
4be44fcd | 155 | void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level); |
1da177e4 LT |
156 | |
157 | void | |
4be44fcd | 158 | acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component); |
1da177e4 | 159 | |
4be44fcd | 160 | void acpi_ns_print_pathname(u32 num_segments, char *pathname); |
1da177e4 | 161 | |
1da177e4 | 162 | acpi_status |
4be44fcd LB |
163 | acpi_ns_dump_one_object(acpi_handle obj_handle, |
164 | u32 level, void *context, void **return_value); | |
1da177e4 | 165 | |
44f6c012 | 166 | #ifdef ACPI_FUTURE_USAGE |
1da177e4 | 167 | void |
4be44fcd LB |
168 | acpi_ns_dump_objects(acpi_object_type type, |
169 | u8 display_type, | |
170 | u32 max_depth, | |
171 | acpi_owner_id owner_id, acpi_handle start_handle); | |
172 | #endif /* ACPI_FUTURE_USAGE */ | |
1da177e4 LT |
173 | |
174 | /* | |
44f6c012 | 175 | * nseval - Namespace evaluation functions |
1da177e4 | 176 | */ |
4119532c | 177 | acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info); |
1da177e4 LT |
178 | |
179 | /* | |
44f6c012 | 180 | * nsnames - Name and Scope manipulation |
1da177e4 | 181 | */ |
4be44fcd | 182 | u32 acpi_ns_opens_scope(acpi_object_type type); |
1da177e4 | 183 | |
8313524a BM |
184 | void |
185 | acpi_ns_build_external_path(struct acpi_namespace_node *node, | |
186 | acpi_size size, char *name_buffer); | |
187 | ||
4be44fcd | 188 | char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node); |
1da177e4 | 189 | |
4be44fcd | 190 | char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state); |
1da177e4 LT |
191 | |
192 | acpi_status | |
4be44fcd LB |
193 | acpi_ns_handle_to_pathname(acpi_handle target_handle, |
194 | struct acpi_buffer *buffer); | |
1da177e4 LT |
195 | |
196 | u8 | |
4be44fcd | 197 | acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for); |
1da177e4 LT |
198 | |
199 | acpi_status | |
4119532c BM |
200 | acpi_ns_get_node(struct acpi_namespace_node *prefix_node, |
201 | char *external_pathname, | |
202 | u32 flags, struct acpi_namespace_node **out_node); | |
1da177e4 | 203 | |
4be44fcd | 204 | acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node); |
1da177e4 LT |
205 | |
206 | /* | |
44f6c012 | 207 | * nsobject - Object management for namespace nodes |
1da177e4 | 208 | */ |
1da177e4 | 209 | acpi_status |
4be44fcd LB |
210 | acpi_ns_attach_object(struct acpi_namespace_node *node, |
211 | union acpi_operand_object *object, acpi_object_type type); | |
1da177e4 | 212 | |
4be44fcd LB |
213 | union acpi_operand_object *acpi_ns_get_attached_object(struct |
214 | acpi_namespace_node | |
215 | *node); | |
1da177e4 | 216 | |
4be44fcd LB |
217 | union acpi_operand_object *acpi_ns_get_secondary_object(union |
218 | acpi_operand_object | |
219 | *obj_desc); | |
1da177e4 LT |
220 | |
221 | acpi_status | |
4be44fcd LB |
222 | acpi_ns_attach_data(struct acpi_namespace_node *node, |
223 | acpi_object_handler handler, void *data); | |
1da177e4 LT |
224 | |
225 | acpi_status | |
4be44fcd LB |
226 | acpi_ns_detach_data(struct acpi_namespace_node *node, |
227 | acpi_object_handler handler); | |
1da177e4 LT |
228 | |
229 | acpi_status | |
4be44fcd LB |
230 | acpi_ns_get_attached_data(struct acpi_namespace_node *node, |
231 | acpi_object_handler handler, void **data); | |
1da177e4 LT |
232 | |
233 | /* | |
44f6c012 | 234 | * nssearch - Namespace searching and entry |
1da177e4 | 235 | */ |
1da177e4 | 236 | acpi_status |
4be44fcd LB |
237 | acpi_ns_search_and_enter(u32 entry_name, |
238 | struct acpi_walk_state *walk_state, | |
239 | struct acpi_namespace_node *node, | |
240 | acpi_interpreter_mode interpreter_mode, | |
241 | acpi_object_type type, | |
242 | u32 flags, struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
243 | |
244 | acpi_status | |
4119532c BM |
245 | acpi_ns_search_one_scope(u32 entry_name, |
246 | struct acpi_namespace_node *node, | |
247 | acpi_object_type type, | |
248 | struct acpi_namespace_node **ret_node); | |
1da177e4 LT |
249 | |
250 | void | |
4be44fcd LB |
251 | acpi_ns_install_node(struct acpi_walk_state *walk_state, |
252 | struct acpi_namespace_node *parent_node, | |
253 | struct acpi_namespace_node *node, acpi_object_type type); | |
1da177e4 LT |
254 | |
255 | /* | |
44f6c012 | 256 | * nsutils - Utility functions |
1da177e4 | 257 | */ |
4be44fcd | 258 | u8 acpi_ns_valid_root_prefix(char prefix); |
1da177e4 | 259 | |
4be44fcd | 260 | acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node); |
1da177e4 | 261 | |
4be44fcd | 262 | u32 acpi_ns_local(acpi_object_type type); |
1da177e4 LT |
263 | |
264 | void | |
4be44fcd LB |
265 | acpi_ns_report_error(char *module_name, |
266 | u32 line_number, | |
4be44fcd | 267 | char *internal_name, acpi_status lookup_status); |
1da177e4 LT |
268 | |
269 | void | |
4be44fcd LB |
270 | acpi_ns_report_method_error(char *module_name, |
271 | u32 line_number, | |
4be44fcd LB |
272 | char *message, |
273 | struct acpi_namespace_node *node, | |
274 | char *path, acpi_status lookup_status); | |
1da177e4 | 275 | |
4be44fcd | 276 | void acpi_ns_print_node_pathname(struct acpi_namespace_node *node, char *msg); |
1da177e4 | 277 | |
4be44fcd | 278 | acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info); |
1da177e4 | 279 | |
4be44fcd | 280 | void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info); |
1da177e4 | 281 | |
4be44fcd | 282 | acpi_status acpi_ns_internalize_name(char *dotted_name, char **converted_name); |
1da177e4 LT |
283 | |
284 | acpi_status | |
4be44fcd LB |
285 | acpi_ns_externalize_name(u32 internal_name_length, |
286 | char *internal_name, | |
287 | u32 * converted_name_length, char **converted_name); | |
1da177e4 | 288 | |
4be44fcd | 289 | struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle); |
1da177e4 | 290 | |
4be44fcd | 291 | acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node); |
1da177e4 | 292 | |
4be44fcd | 293 | void acpi_ns_terminate(void); |
1da177e4 | 294 | |
4be44fcd LB |
295 | struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node |
296 | *node); | |
1da177e4 | 297 | |
4be44fcd LB |
298 | struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct |
299 | acpi_namespace_node | |
300 | *node); | |
1da177e4 | 301 | |
4be44fcd | 302 | #endif /* __ACNAMESP_H__ */ |