1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2006, 2010, Oracle and/or its affiliates. All rights reserved.
24 */
25
26 #ifndef _TOPO_MOD_H
27 #define _TOPO_MOD_H
28
29 #include <fm/libtopo.h>
30 #include <fm/topo_hc.h>
31 #include <libipmi.h>
32 #include <libnvpair.h>
33 #include <libdevinfo.h>
34 #include <smbios.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 /*
41 * Enumerator and method supplier module API
42 */
43 typedef struct topo_mod topo_mod_t;
44
45 typedef int topo_method_f(topo_mod_t *, tnode_t *, topo_version_t, nvlist_t *,
46 nvlist_t **);
47 typedef int topo_enum_f(topo_mod_t *, tnode_t *, const char *, topo_instance_t,
48 topo_instance_t, void *, void *);
49 typedef void topo_release_f(topo_mod_t *, tnode_t *);
50
51 typedef struct topo_method {
52 const char *tm_name; /* Method name */
53 const char *tm_desc; /* Method description */
54 const topo_version_t tm_version; /* Method version */
55 const topo_stability_t tm_stability; /* Attributes of method */
56 topo_method_f *tm_func; /* Method function */
57 } topo_method_t;
58
59 typedef struct topo_modops {
60 topo_enum_f *tmo_enum; /* enumeration op */
61 topo_release_f *tmo_release; /* resource release op */
62 } topo_modops_t;
63
64 typedef struct topo_mod_info {
65 const char *tmi_desc; /* module description */
66 const char *tmi_scheme; /* enumeration scheme type */
67 topo_version_t tmi_version; /* module version */
68 const topo_modops_t *tmi_ops; /* module ops vector */
69 } topo_modinfo_t;
70
71 extern topo_mod_t *topo_mod_load(topo_mod_t *, const char *, topo_version_t);
72 extern void topo_mod_unload(topo_mod_t *);
73 extern int topo_mod_register(topo_mod_t *, const topo_modinfo_t *,
74 topo_version_t);
75 extern void topo_mod_unregister(topo_mod_t *);
76 extern int topo_mod_enumerate(topo_mod_t *, tnode_t *, const char *,
77 const char *, topo_instance_t, topo_instance_t, void *);
78 extern int topo_mod_enummap(topo_mod_t *mod, tnode_t *, const char *,
79 const char *);
80 extern void topo_mod_release(topo_mod_t *, tnode_t *);
81 extern void topo_mod_setspecific(topo_mod_t *, void *);
82 extern void *topo_mod_getspecific(topo_mod_t *);
83
84 extern nvlist_t *topo_mod_cpufmri(topo_mod_t *, int, uint32_t, uint8_t,
85 const char *);
86 extern nvlist_t *topo_mod_devfmri(topo_mod_t *, int, const char *,
87 const char *);
88 extern nvlist_t *topo_mod_hcfmri(topo_mod_t *, tnode_t *, int, const char *,
89 topo_instance_t, nvlist_t *, nvlist_t *, const char *, const char *,
90 const char *);
91 extern nvlist_t *topo_mod_memfmri(topo_mod_t *, int, uint64_t, uint64_t,
92 const char *, int);
93 extern nvlist_t *topo_mod_modfmri(topo_mod_t *, int, const char *);
94 extern nvlist_t *topo_mod_pkgfmri(topo_mod_t *, int, const char *);
95 extern nvlist_t *topo_mod_swfmri(topo_mod_t *, int,
96 char *, char *, nvlist_t *,
97 char *, char *, char *, char *, int64_t,
98 char *, char *, int64_t, char *, int64_t, char **, uint_t);
99 extern int topo_mod_nvl2str(topo_mod_t *, nvlist_t *, char **);
100 extern int topo_mod_str2nvl(topo_mod_t *, const char *, nvlist_t **);
101 extern int topo_prop_setmutable(tnode_t *node, const char *pgname,
102 const char *pname, int *err);
103 extern int topo_prop_setnonvolatile(tnode_t *node, const char *pgname,
104 const char *pname, int *err);
105 /*
106 * Snapshot walker support
107 */
108 typedef int (*topo_mod_walk_cb_t)(topo_mod_t *, tnode_t *, void *);
109
110 extern topo_walk_t *topo_mod_walk_init(topo_mod_t *, tnode_t *,
111 topo_mod_walk_cb_t, void *, int *);
112
113 /*
114 * Flags for topo_mod_memfmri
115 */
116 #define TOPO_MEMFMRI_PA 0x0001 /* Valid physical address */
117 #define TOPO_MEMFMRI_OFFSET 0x0002 /* Valid offset */
118
119 extern int topo_method_register(topo_mod_t *, tnode_t *, const topo_method_t *);
120 extern void topo_method_unregister(topo_mod_t *, tnode_t *, const char *);
121 extern void topo_method_unregister_all(topo_mod_t *, tnode_t *);
122
123 extern di_node_t topo_mod_devinfo(topo_mod_t *);
124 extern ipmi_handle_t *topo_mod_ipmi_hold(topo_mod_t *);
125 extern void topo_mod_ipmi_rele(topo_mod_t *);
126 extern smbios_hdl_t *topo_mod_smbios(topo_mod_t *);
127 extern di_prom_handle_t topo_mod_prominfo(topo_mod_t *);
128 extern nvlist_t *topo_mod_auth(topo_mod_t *, tnode_t *);
129
130 extern int topo_method_sensor_failure(topo_mod_t *, tnode_t *, topo_version_t,
131 nvlist_t *, nvlist_t **);
132
133 /*
134 * FMRI methods
135 */
136 #define TOPO_METH_LABEL "topo_label"
137 #define TOPO_METH_LABEL_DESC "label constructor"
138 #define TOPO_METH_LABEL_VERSION0 0
139 #define TOPO_METH_LABEL_VERSION TOPO_METH_LABEL_VERSION0
140 #define TOPO_METH_LABEL_ARG_NVL "label-specific"
141 #define TOPO_METH_LABEL_RET_STR "label-string"
142
143 #define TOPO_METH_PRESENT "topo_present"
144 #define TOPO_METH_PRESENT_DESC "presence indicator"
145 #define TOPO_METH_PRESENT_VERSION0 0
146 #define TOPO_METH_PRESENT_VERSION TOPO_METH_PRESENT_VERSION0
147 #define TOPO_METH_PRESENT_RET "present-ret"
148
149 #define TOPO_METH_REPLACED "topo_replaced"
150 #define TOPO_METH_REPLACED_DESC "replaced indicator"
151 #define TOPO_METH_REPLACED_VERSION0 0
152 #define TOPO_METH_REPLACED_VERSION TOPO_METH_REPLACED_VERSION0
153 #define TOPO_METH_REPLACED_RET "replaced-ret"
154
155 #define TOPO_METH_UNUSABLE "topo_unusable"
156 #define TOPO_METH_UNUSABLE_DESC "unusable indicator"
157 #define TOPO_METH_UNUSABLE_VERSION0 0
158 #define TOPO_METH_UNUSABLE_VERSION TOPO_METH_UNUSABLE_VERSION0
159 #define TOPO_METH_UNUSABLE_RET "unusable-ret"
160
161 #define TOPO_METH_SERVICE_STATE "topo_service_state"
162 #define TOPO_METH_SERVICE_STATE_DESC "service_state indicator"
163 #define TOPO_METH_SERVICE_STATE_VERSION0 0
164 #define TOPO_METH_SERVICE_STATE_VERSION TOPO_METH_SERVICE_STATE_VERSION0
165 #define TOPO_METH_SERVICE_STATE_RET "service_state-ret"
166
167 #define TOPO_METH_RETIRE "topo_retire"
168 #define TOPO_METH_RETIRE_DESC "retire action"
169 #define TOPO_METH_RETIRE_VERSION0 0
170 #define TOPO_METH_RETIRE_VERSION TOPO_METH_RETIRE_VERSION0
171 #define TOPO_METH_RETIRE_RET "retire-ret"
172
173 #define TOPO_METH_UNRETIRE "topo_unretire"
174 #define TOPO_METH_UNRETIRE_DESC "unretire action"
175 #define TOPO_METH_UNRETIRE_VERSION0 0
176 #define TOPO_METH_UNRETIRE_VERSION TOPO_METH_UNRETIRE_VERSION0
177 #define TOPO_METH_UNRETIRE_RET "unretire-ret"
178
179 #define TOPO_METH_EXPAND "topo_expand"
180 #define TOPO_METH_EXPAND_DESC "expand FMRI"
181 #define TOPO_METH_EXPAND_VERSION0 0
182 #define TOPO_METH_EXPAND_VERSION TOPO_METH_EXPAND_VERSION0
183
184 #define TOPO_METH_CONTAINS "topo_contains"
185 #define TOPO_METH_CONTAINS_DESC "FMRI contains sub-FMRI"
186 #define TOPO_METH_CONTAINS_VERSION0 0
187 #define TOPO_METH_CONTAINS_VERSION TOPO_METH_CONTAINS_VERSION0
188 #define TOPO_METH_CONTAINS_RET "contains-return"
189 #define TOPO_METH_FMRI_ARG_FMRI "fmri"
190 #define TOPO_METH_FMRI_ARG_SUBFMRI "sub-fmri"
191
192 #define TOPO_METH_ASRU_COMPUTE "topo_asru_compute"
193 #define TOPO_METH_ASRU_COMPUTE_VERSION 0
194 #define TOPO_METH_ASRU_COMPUTE_DESC "Dynamic ASRU constructor"
195
196 #define TOPO_METH_FRU_COMPUTE "topo_fru_compute"
197 #define TOPO_METH_FRU_COMPUTE_VERSION 0
198 #define TOPO_METH_FRU_COMPUTE_DESC "Dynamic FRU constructor"
199
200 #define TOPO_METH_DISK_STATUS "topo_disk_status"
201 #define TOPO_METH_DISK_STATUS_VERSION 0
202 #define TOPO_METH_DISK_STATUS_DESC "Disk status"
203
204 #define TOPO_METH_SENSOR_FAILURE "topo_sensor_failure"
205 #define TOPO_METH_SENSOR_FAILURE_VERSION 0
206 #define TOPO_METH_SENSOR_FAILURE_DESC "Sensor failure state"
207
208 #define TOPO_PROP_METH_DESC "Dynamic Property method"
209
210 #define TOPO_METH_IPMI_ENTITY "ipmi_entity"
211 #define TOPO_METH_FAC_ENUM_DESC "Facility Enumerator"
212
213 extern void *topo_mod_alloc(topo_mod_t *, size_t);
214 extern void *topo_mod_zalloc(topo_mod_t *, size_t);
215 extern void topo_mod_free(topo_mod_t *, void *, size_t);
216 extern char *topo_mod_strdup(topo_mod_t *, const char *);
217 extern void topo_mod_strfree(topo_mod_t *, char *);
218 extern int topo_mod_nvalloc(topo_mod_t *, nvlist_t **, uint_t);
219 extern int topo_mod_nvdup(topo_mod_t *, nvlist_t *, nvlist_t **);
220
221 extern void topo_mod_clrdebug(topo_mod_t *);
222 extern void topo_mod_setdebug(topo_mod_t *);
223 extern void topo_mod_dprintf(topo_mod_t *, const char *, ...);
224 extern const char *topo_mod_errmsg(topo_mod_t *);
225 extern int topo_mod_errno(topo_mod_t *);
226
227 /*
228 * Topo node utilities: callable from module enumeration, topo_mod_enumerate()
229 */
230 extern int topo_node_range_create(topo_mod_t *, tnode_t *, const char *,
231 topo_instance_t, topo_instance_t);
232 extern void topo_node_range_destroy(tnode_t *, const char *);
233 extern tnode_t *topo_node_bind(topo_mod_t *, tnode_t *, const char *,
234 topo_instance_t, nvlist_t *);
235 extern tnode_t *topo_node_facbind(topo_mod_t *, tnode_t *, const char *,
236 const char *);
237 extern void topo_node_unbind(tnode_t *);
238 extern void topo_node_setspecific(tnode_t *, void *);
239 extern void *topo_node_getspecific(tnode_t *);
240 extern int topo_node_asru_set(tnode_t *node, nvlist_t *, int, int *);
241 extern int topo_node_fru_set(tnode_t *node, nvlist_t *, int, int *);
242 extern int topo_node_label_set(tnode_t *node, char *, int *);
243
244 #define TOPO_ASRU_COMPUTE 0x0001 /* Compute ASRU dynamically */
245 #define TOPO_FRU_COMPUTE 0x0002 /* Compute FRU dynamically */
246
247 extern int topo_prop_inherit(tnode_t *, const char *, const char *, int *);
248 extern int topo_pgroup_create(tnode_t *, const topo_pgroup_info_t *, int *);
249
250 /*
251 * Topo property method registration
252 */
253 extern int topo_prop_method_register(tnode_t *, const char *, const char *,
254 topo_type_t, const char *, const nvlist_t *, int *);
255 extern void topo_prop_method_unregister(tnode_t *, const char *, const char *);
256
257 /*
258 * This enum definition is used to define a set of error tags associated with
259 * the module api error conditions. The shell script mkerror.sh is
260 * used to parse this file and create a corresponding topo_error.c source file.
261 * If you do something other than add a new error tag here, you may need to
262 * update the mkerror shell script as it is based upon simple regexps.
263 */
264 typedef enum topo_mod_errno {
265 EMOD_UNKNOWN = 2000, /* unknown libtopo error */
266 EMOD_NOMEM, /* module memory limit exceeded */
267 EMOD_PARTIAL_ENUM, /* module completed partial enumeration */
268 EMOD_METHOD_INVAL, /* method arguments invalid */
269 EMOD_METHOD_NOTSUP, /* method not supported */
270 EMOD_FMRI_NVL, /* nvlist allocation failure for FMRI */
271 EMOD_FMRI_VERSION, /* invalid FMRI scheme version */
272 EMOD_FMRI_MALFORM, /* malformed FMRI */
273 EMOD_NODE_BOUND, /* node already bound */
274 EMOD_NODE_DUP, /* duplicate node */
275 EMOD_NODE_NOENT, /* node not found */
276 EMOD_NODE_RANGE, /* invalid node range */
277 EMOD_VER_ABI, /* registered with invalid ABI version */
278 EMOD_VER_OLD, /* attempt to load obsolete module */
279 EMOD_VER_NEW, /* attempt to load a newer module */
280 EMOD_NVL_INVAL, /* invalid nvlist */
281 EMOD_NONCANON, /* non-canonical component name requested */
282 EMOD_MOD_NOENT, /* module lookup failed */
283 EMOD_UKNOWN_ENUM, /* unknown enumeration error */
284 EMOD_END /* end of mod errno list (to ease auto-merge) */
285 } topo_mod_errno_t;
286
287 extern int topo_mod_seterrno(topo_mod_t *, int);
288
289 #ifdef __cplusplus
290 }
291 #endif
292
293 #endif /* _TOPO_MOD_H */