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