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