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