usbfs: don't store bad pointers in registration
[linux-2.6/mini2440.git] / include / acpi / acnamesp.h
blob9ed70a05058003034e275e8c8f13acff3124c2ed
1 /******************************************************************************
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2008, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 #ifndef __ACNAMESP_H__
45 #define __ACNAMESP_H__
47 /* To search the entire name space, pass this as search_base */
49 #define ACPI_NS_ALL ((acpi_handle)0)
52 * Elements of acpi_ns_properties are bit significant
53 * and should be one-to-one with values of acpi_object_type
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 */
59 /* Flags for acpi_ns_lookup, acpi_ns_search_and_enter */
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
70 /* Flags for acpi_ns_walk_namespace */
72 #define ACPI_NS_WALK_NO_UNLOCK 0
73 #define ACPI_NS_WALK_UNLOCK 0x01
74 #define ACPI_NS_WALK_TEMP_NODES 0x02
77 * nsinit - Namespace initialization
79 acpi_status acpi_ns_initialize_objects(void);
81 acpi_status acpi_ns_initialize_devices(void);
84 * nsload - Namespace loading
86 acpi_status acpi_ns_load_namespace(void);
88 acpi_status
89 acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
92 * nswalk - walk the namespace
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);
102 struct acpi_namespace_node *acpi_ns_get_next_node(acpi_object_type type, struct acpi_namespace_node
103 *parent, struct acpi_namespace_node
104 *child);
107 * nsparse - table parsing
109 acpi_status
110 acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
112 acpi_status
113 acpi_ns_one_complete_parse(u32 pass_number,
114 u32 table_index,
115 struct acpi_namespace_node *start_node);
118 * nsaccess - Top-level namespace access
120 acpi_status acpi_ns_root_initialize(void);
122 acpi_status
123 acpi_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);
132 * nsalloc - Named object allocation/deallocation
134 struct acpi_namespace_node *acpi_ns_create_node(u32 name);
136 void acpi_ns_delete_node(struct acpi_namespace_node *node);
138 void
139 acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
141 void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
143 void acpi_ns_detach_object(struct acpi_namespace_node *node);
145 void acpi_ns_delete_children(struct acpi_namespace_node *parent);
147 int acpi_ns_compare_names(char *name1, char *name2);
150 * nsdump - Namespace dump/print utilities
152 #ifdef ACPI_FUTURE_USAGE
153 void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
154 #endif /* ACPI_FUTURE_USAGE */
156 void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
158 void
159 acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component);
161 void acpi_ns_print_pathname(u32 num_segments, char *pathname);
163 acpi_status
164 acpi_ns_dump_one_object(acpi_handle obj_handle,
165 u32 level, void *context, void **return_value);
167 #ifdef ACPI_FUTURE_USAGE
168 void
169 acpi_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 */
176 * nseval - Namespace evaluation functions
178 acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
181 * nsnames - Name and Scope manipulation
183 u32 acpi_ns_opens_scope(acpi_object_type type);
185 void
186 acpi_ns_build_external_path(struct acpi_namespace_node *node,
187 acpi_size size, char *name_buffer);
189 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
191 char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
193 acpi_status
194 acpi_ns_handle_to_pathname(acpi_handle target_handle,
195 struct acpi_buffer *buffer);
198 acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
200 acpi_status
201 acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
202 const char *external_pathname,
203 u32 flags, struct acpi_namespace_node **out_node);
205 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
208 * nsobject - Object management for namespace nodes
210 acpi_status
211 acpi_ns_attach_object(struct acpi_namespace_node *node,
212 union acpi_operand_object *object, acpi_object_type type);
214 union acpi_operand_object *acpi_ns_get_attached_object(struct
215 acpi_namespace_node
216 *node);
218 union acpi_operand_object *acpi_ns_get_secondary_object(union
219 acpi_operand_object
220 *obj_desc);
222 acpi_status
223 acpi_ns_attach_data(struct acpi_namespace_node *node,
224 acpi_object_handler handler, void *data);
226 acpi_status
227 acpi_ns_detach_data(struct acpi_namespace_node *node,
228 acpi_object_handler handler);
230 acpi_status
231 acpi_ns_get_attached_data(struct acpi_namespace_node *node,
232 acpi_object_handler handler, void **data);
235 * nssearch - Namespace searching and entry
237 acpi_status
238 acpi_ns_search_and_enter(u32 entry_name,
239 struct acpi_walk_state *walk_state,
240 struct acpi_namespace_node *node,
241 acpi_interpreter_mode interpreter_mode,
242 acpi_object_type type,
243 u32 flags, struct acpi_namespace_node **ret_node);
245 acpi_status
246 acpi_ns_search_one_scope(u32 entry_name,
247 struct acpi_namespace_node *node,
248 acpi_object_type type,
249 struct acpi_namespace_node **ret_node);
251 void
252 acpi_ns_install_node(struct acpi_walk_state *walk_state,
253 struct acpi_namespace_node *parent_node,
254 struct acpi_namespace_node *node, acpi_object_type type);
257 * nsutils - Utility functions
259 u8 acpi_ns_valid_root_prefix(char prefix);
261 acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
263 u32 acpi_ns_local(acpi_object_type type);
265 void
266 acpi_ns_report_error(const char *module_name,
267 u32 line_number,
268 const char *internal_name, acpi_status lookup_status);
270 void
271 acpi_ns_report_method_error(const char *module_name,
272 u32 line_number,
273 const char *message,
274 struct acpi_namespace_node *node,
275 const char *path, acpi_status lookup_status);
277 void
278 acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
280 acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
282 void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
284 acpi_status
285 acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
287 acpi_status
288 acpi_ns_externalize_name(u32 internal_name_length,
289 const char *internal_name,
290 u32 * converted_name_length, char **converted_name);
292 struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle);
294 acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node);
296 void acpi_ns_terminate(void);
298 struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node
299 *node);
301 struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct
302 acpi_namespace_node
303 *node);
305 #endif /* __ACNAMESP_H__ */