topo_mod.h revision 24db46411fd54f70c35b94bb952eb7ba040e43b4
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * CDDL HEADER START
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * The contents of this file are subject to the terms of the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Common Development and Distribution License (the "License").
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * You may not use this file except in compliance with the License.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * See the License for the specific language governing permissions
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * and limitations under the License.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * When distributing Covered Code, include this CDDL HEADER in each
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * If applicable, add the following below this CDDL HEADER, with the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * fields enclosed by brackets "[]" replaced with your own identifying
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * information: Portions Copyright [yyyy] [name of copyright owner]
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * CDDL HEADER END
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * Use is subject to license terms.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#pragma ident "%Z%%M% %I% %E% SMI"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern "C" {
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Enumerator and method supplier module API
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef int topo_method_f(topo_mod_t *, tnode_t *, topo_version_t, nvlist_t *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef int topo_enum_f(topo_mod_t *, tnode_t *, const char *, topo_instance_t,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw topo_instance_t, void *, void *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef struct topo_method {
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const topo_stability_t tm_stability; /* Attributes of method */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef struct topo_modops {
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef struct topo_mod_info {
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern topo_mod_t *topo_mod_load(topo_mod_t *, const char *, topo_version_t);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_register(topo_mod_t *, const topo_modinfo_t *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_enumerate(topo_mod_t *, tnode_t *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const char *, topo_instance_t, topo_instance_t, void *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_enummap(topo_mod_t *mod, tnode_t *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern nvlist_t *topo_mod_cpufmri(topo_mod_t *, int, uint32_t, uint8_t,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern nvlist_t *topo_mod_devfmri(topo_mod_t *, int, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern nvlist_t *topo_mod_hcfmri(topo_mod_t *, tnode_t *, int, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw topo_instance_t, nvlist_t *, nvlist_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern nvlist_t *topo_mod_memfmri(topo_mod_t *, int, uint64_t, uint64_t,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw const char *, int);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern nvlist_t *topo_mod_modfmri(topo_mod_t *, int, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern nvlist_t *topo_mod_pkgfmri(topo_mod_t *, int, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_nvl2str(topo_mod_t *, nvlist_t *, char **);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_str2nvl(topo_mod_t *, const char *, nvlist_t **);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Snapshot walker support
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef int (*topo_mod_walk_cb_t)(topo_mod_t *, tnode_t *, void *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern topo_walk_t *topo_mod_walk_init(topo_mod_t *, tnode_t *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw topo_mod_walk_cb_t, void *, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Flags for topo_mod_memfmri
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_MEMFMRI_PA 0x0001 /* Valid physical address */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_method_register(topo_mod_t *, tnode_t *, const topo_method_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void topo_method_unregister(topo_mod_t *, tnode_t *, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void topo_method_unregister_all(topo_mod_t *, tnode_t *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * FMRI methods
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_METH_PRESENT_VERSION TOPO_METH_PRESENT_VERSION0
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_METH_UNUSABLE_VERSION TOPO_METH_UNUSABLE_VERSION0
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_METH_EXPAND_VERSION TOPO_METH_EXPAND_VERSION0
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_METH_ASRU_COMPUTE_DESC "Dynamic ASRU constructor"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_METH_FRU_COMPUTE_DESC "Dynamic FRU constructor"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern char *topo_mod_strdup(topo_mod_t *, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_nvalloc(topo_mod_t *, nvlist_t **, uint_t);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_mod_nvdup(topo_mod_t *, nvlist_t *, nvlist_t **);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void topo_mod_dprintf(topo_mod_t *, const char *, ...);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Topo node utilities: callable from module enumeration, topo_mod_enumerate()
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_node_range_create(topo_mod_t *, tnode_t *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void topo_node_range_destroy(tnode_t *, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern tnode_t *topo_node_bind(topo_mod_t *, tnode_t *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_node_asru_set(tnode_t *node, nvlist_t *, int, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_node_fru_set(tnode_t *node, nvlist_t *, int, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_node_label_set(tnode_t *node, char *, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_ASRU_COMPUTE 0x0001 /* Compute ASRU dynamically */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#define TOPO_FRU_COMPUTE 0x0002 /* Compute FRU dynamically */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Topo property set functions
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_int32(tnode_t *, const char *, const char *, int,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_uint32(tnode_t *, const char *, const char *, int,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_int64(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw int, int64_t, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_uint64(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw int, uint64_t, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_string(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw int, const char *, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_fmri(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw int, const nvlist_t *, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_int32_array(tnode_t *, const char *, const char *, int,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_uint32_array(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_int64_array(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_uint64_array(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_string_array(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw int, const char **, uint_t, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_set_fmri_array(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_inherit(tnode_t *, const char *, const char *, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_pgroup_create(tnode_t *, const topo_pgroup_info_t *, int *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * Topo property method registration
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern int topo_prop_method_register(tnode_t *, const char *, const char *,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwextern void topo_prop_method_unregister(tnode_t *, const char *, const char *);
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * This enum definition is used to define a set of error tags associated with
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * the module api error conditions. The shell script mkerror.sh is
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * used to parse this file and create a corresponding topo_error.c source file.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * If you do something other than add a new error tag here, you may need to
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw * update the mkerror shell script as it is based upon simple regexps.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwtypedef enum topo_mod_errno {
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw EMOD_PARTIAL_ENUM, /* module completed partial enumeration */
b3988cf65491efce7a0df7b735c586e4e12714f0Gordon Ross EMOD_NONCANON, /* non-canonical component name requested */
b3988cf65491efce7a0df7b735c586e4e12714f0Gordon Ross EMOD_UKNOWN_ENUM, /* unknown enumeration error */
b3988cf65491efce7a0df7b735c586e4e12714f0Gordon Ross EMOD_END /* end of mod errno list (to ease auto-merge) */
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw#endif /* _TOPO_MOD_H */