1/******************************************************************************
2 *
3 * Name: acnamesp.h - Namespace subcomponent prototypes and defines
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2015, 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/* Object is not a package element */
77
78#define ACPI_NOT_PACKAGE_ELEMENT    ACPI_UINT32_MAX
79
80/* Always emit warning message, not dependent on node flags */
81
82#define ACPI_WARN_ALWAYS            0
83
84/*
85 * nsinit - Namespace initialization
86 */
87acpi_status acpi_ns_initialize_objects(void);
88
89acpi_status acpi_ns_initialize_devices(void);
90
91/*
92 * nsload -  Namespace loading
93 */
94acpi_status acpi_ns_load_namespace(void);
95
96acpi_status
97acpi_ns_load_table(u32 table_index, struct acpi_namespace_node *node);
98
99/*
100 * nswalk - walk the namespace
101 */
102acpi_status
103acpi_ns_walk_namespace(acpi_object_type type,
104		       acpi_handle start_object,
105		       u32 max_depth,
106		       u32 flags,
107		       acpi_walk_callback descending_callback,
108		       acpi_walk_callback ascending_callback,
109		       void *context, void **return_value);
110
111struct acpi_namespace_node *acpi_ns_get_next_node(struct acpi_namespace_node
112						  *parent,
113						  struct acpi_namespace_node
114						  *child);
115
116struct acpi_namespace_node *acpi_ns_get_next_node_typed(acpi_object_type type,
117							struct
118							acpi_namespace_node
119							*parent,
120							struct
121							acpi_namespace_node
122							*child);
123
124/*
125 * nsparse - table parsing
126 */
127acpi_status
128acpi_ns_parse_table(u32 table_index, struct acpi_namespace_node *start_node);
129
130acpi_status
131acpi_ns_one_complete_parse(u32 pass_number,
132			   u32 table_index,
133			   struct acpi_namespace_node *start_node);
134
135/*
136 * nsaccess - Top-level namespace access
137 */
138acpi_status acpi_ns_root_initialize(void);
139
140acpi_status
141acpi_ns_lookup(union acpi_generic_state *scope_info,
142	       char *name,
143	       acpi_object_type type,
144	       acpi_interpreter_mode interpreter_mode,
145	       u32 flags,
146	       struct acpi_walk_state *walk_state,
147	       struct acpi_namespace_node **ret_node);
148
149/*
150 * nsalloc - Named object allocation/deallocation
151 */
152struct acpi_namespace_node *acpi_ns_create_node(u32 name);
153
154void acpi_ns_delete_node(struct acpi_namespace_node *node);
155
156void acpi_ns_remove_node(struct acpi_namespace_node *node);
157
158void
159acpi_ns_delete_namespace_subtree(struct acpi_namespace_node *parent_handle);
160
161void acpi_ns_delete_namespace_by_owner(acpi_owner_id owner_id);
162
163void acpi_ns_detach_object(struct acpi_namespace_node *node);
164
165void acpi_ns_delete_children(struct acpi_namespace_node *parent);
166
167int acpi_ns_compare_names(char *name1, char *name2);
168
169/*
170 * nsconvert - Dynamic object conversion routines
171 */
172acpi_status
173acpi_ns_convert_to_integer(union acpi_operand_object *original_object,
174			   union acpi_operand_object **return_object);
175
176acpi_status
177acpi_ns_convert_to_string(union acpi_operand_object *original_object,
178			  union acpi_operand_object **return_object);
179
180acpi_status
181acpi_ns_convert_to_buffer(union acpi_operand_object *original_object,
182			  union acpi_operand_object **return_object);
183
184acpi_status
185acpi_ns_convert_to_unicode(union acpi_operand_object *original_object,
186			   union acpi_operand_object **return_object);
187
188acpi_status
189acpi_ns_convert_to_resource(union acpi_operand_object *original_object,
190			    union acpi_operand_object **return_object);
191
192/*
193 * nsdump - Namespace dump/print utilities
194 */
195#ifdef	ACPI_FUTURE_USAGE
196void acpi_ns_dump_tables(acpi_handle search_base, u32 max_depth);
197#endif				/* ACPI_FUTURE_USAGE */
198
199void acpi_ns_dump_entry(acpi_handle handle, u32 debug_level);
200
201void
202acpi_ns_dump_pathname(acpi_handle handle, char *msg, u32 level, u32 component);
203
204void acpi_ns_print_pathname(u32 num_segments, char *pathname);
205
206acpi_status
207acpi_ns_dump_one_object(acpi_handle obj_handle,
208			u32 level, void *context, void **return_value);
209
210#ifdef	ACPI_FUTURE_USAGE
211void
212acpi_ns_dump_objects(acpi_object_type type,
213		     u8 display_type,
214		     u32 max_depth,
215		     acpi_owner_id owner_id, acpi_handle start_handle);
216
217void
218acpi_ns_dump_object_paths(acpi_object_type type,
219			  u8 display_type,
220			  u32 max_depth,
221			  acpi_owner_id owner_id, acpi_handle start_handle);
222#endif				/* ACPI_FUTURE_USAGE */
223
224/*
225 * nseval - Namespace evaluation functions
226 */
227acpi_status acpi_ns_evaluate(struct acpi_evaluate_info *info);
228
229void acpi_ns_exec_module_code_list(void);
230
231/*
232 * nsarguments - Argument count/type checking for predefined/reserved names
233 */
234void
235acpi_ns_check_argument_count(char *pathname,
236			     struct acpi_namespace_node *node,
237			     u32 user_param_count,
238			     const union acpi_predefined_info *info);
239
240void
241acpi_ns_check_acpi_compliance(char *pathname,
242			      struct acpi_namespace_node *node,
243			      const union acpi_predefined_info *predefined);
244
245void acpi_ns_check_argument_types(struct acpi_evaluate_info *info);
246
247/*
248 * nspredef - Return value checking for predefined/reserved names
249 */
250acpi_status
251acpi_ns_check_return_value(struct acpi_namespace_node *node,
252			   struct acpi_evaluate_info *info,
253			   u32 user_param_count,
254			   acpi_status return_status,
255			   union acpi_operand_object **return_object);
256
257acpi_status
258acpi_ns_check_object_type(struct acpi_evaluate_info *info,
259			  union acpi_operand_object **return_object_ptr,
260			  u32 expected_btypes, u32 package_index);
261
262/*
263 * nsprepkg - Validation of predefined name packages
264 */
265acpi_status
266acpi_ns_check_package(struct acpi_evaluate_info *info,
267		      union acpi_operand_object **return_object_ptr);
268
269/*
270 * nsnames - Name and Scope manipulation
271 */
272u32 acpi_ns_opens_scope(acpi_object_type type);
273
274acpi_status
275acpi_ns_build_external_path(struct acpi_namespace_node *node,
276			    acpi_size size, char *name_buffer);
277
278char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node);
279
280char *acpi_ns_name_of_current_scope(struct acpi_walk_state *walk_state);
281
282acpi_status
283acpi_ns_handle_to_pathname(acpi_handle target_handle,
284			   struct acpi_buffer *buffer);
285
286u8
287acpi_ns_pattern_match(struct acpi_namespace_node *obj_node, char *search_for);
288
289acpi_status
290acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
291		 const char *external_pathname,
292		 u32 flags, struct acpi_namespace_node **out_node);
293
294acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node);
295
296/*
297 * nsobject - Object management for namespace nodes
298 */
299acpi_status
300acpi_ns_attach_object(struct acpi_namespace_node *node,
301		      union acpi_operand_object *object, acpi_object_type type);
302
303union acpi_operand_object *acpi_ns_get_attached_object(struct
304						       acpi_namespace_node
305						       *node);
306
307union acpi_operand_object *acpi_ns_get_secondary_object(union
308							acpi_operand_object
309							*obj_desc);
310
311acpi_status
312acpi_ns_attach_data(struct acpi_namespace_node *node,
313		    acpi_object_handler handler, void *data);
314
315acpi_status
316acpi_ns_detach_data(struct acpi_namespace_node *node,
317		    acpi_object_handler handler);
318
319acpi_status
320acpi_ns_get_attached_data(struct acpi_namespace_node *node,
321			  acpi_object_handler handler, void **data);
322
323/*
324 * nsrepair - General return object repair for all
325 * predefined methods/objects
326 */
327acpi_status
328acpi_ns_simple_repair(struct acpi_evaluate_info *info,
329		      u32 expected_btypes,
330		      u32 package_index,
331		      union acpi_operand_object **return_object_ptr);
332
333acpi_status
334acpi_ns_wrap_with_package(struct acpi_evaluate_info *info,
335			  union acpi_operand_object *original_object,
336			  union acpi_operand_object **obj_desc_ptr);
337
338acpi_status
339acpi_ns_repair_null_element(struct acpi_evaluate_info *info,
340			    u32 expected_btypes,
341			    u32 package_index,
342			    union acpi_operand_object **return_object_ptr);
343
344void
345acpi_ns_remove_null_elements(struct acpi_evaluate_info *info,
346			     u8 package_type,
347			     union acpi_operand_object *obj_desc);
348
349/*
350 * nsrepair2 - Return object repair for specific
351 * predefined methods/objects
352 */
353acpi_status
354acpi_ns_complex_repairs(struct acpi_evaluate_info *info,
355			struct acpi_namespace_node *node,
356			acpi_status validate_status,
357			union acpi_operand_object **return_object_ptr);
358
359/*
360 * nssearch - Namespace searching and entry
361 */
362acpi_status
363acpi_ns_search_and_enter(u32 entry_name,
364			 struct acpi_walk_state *walk_state,
365			 struct acpi_namespace_node *node,
366			 acpi_interpreter_mode interpreter_mode,
367			 acpi_object_type type,
368			 u32 flags, struct acpi_namespace_node **ret_node);
369
370acpi_status
371acpi_ns_search_one_scope(u32 entry_name,
372			 struct acpi_namespace_node *node,
373			 acpi_object_type type,
374			 struct acpi_namespace_node **ret_node);
375
376void
377acpi_ns_install_node(struct acpi_walk_state *walk_state,
378		     struct acpi_namespace_node *parent_node,
379		     struct acpi_namespace_node *node, acpi_object_type type);
380
381/*
382 * nsutils - Utility functions
383 */
384acpi_object_type acpi_ns_get_type(struct acpi_namespace_node *node);
385
386u32 acpi_ns_local(acpi_object_type type);
387
388void
389acpi_ns_print_node_pathname(struct acpi_namespace_node *node, const char *msg);
390
391acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info);
392
393void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info);
394
395acpi_status
396acpi_ns_internalize_name(const char *dotted_name, char **converted_name);
397
398acpi_status
399acpi_ns_externalize_name(u32 internal_name_length,
400			 const char *internal_name,
401			 u32 * converted_name_length, char **converted_name);
402
403struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle);
404
405void acpi_ns_terminate(void);
406
407#endif				/* __ACNAMESP_H__ */
408