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