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