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 #include <fm/libtopo.h> 31 #include <fm/topo_hc.h> 32 #include <libipmi.h> 33 #include <libnvpair.h> 34 #include <libdevinfo.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 int topo_mod_nvl2str(topo_mod_t *, nvlist_t *, char **); 96 extern int topo_mod_str2nvl(topo_mod_t *, const char *, nvlist_t **); 97 extern int topo_prop_setmutable(tnode_t *node, const char *pgname, 98 const char *pname, int *err); 99 /* 100 * Snapshot walker support 101 */ 102 typedef int (*topo_mod_walk_cb_t)(topo_mod_t *, tnode_t *, void *); 103 104 extern topo_walk_t *topo_mod_walk_init(topo_mod_t *, tnode_t *, 105 topo_mod_walk_cb_t, void *, int *); 106 107 /* 108 * Flags for topo_mod_memfmri 109 */ 110 #define TOPO_MEMFMRI_PA 0x0001 /* Valid physical address */ 111 #define TOPO_MEMFMRI_OFFSET 0x0002 /* Valid offset */ 112 113 extern int topo_method_register(topo_mod_t *, tnode_t *, const topo_method_t *); 114 extern void topo_method_unregister(topo_mod_t *, tnode_t *, const char *); 115 extern void topo_method_unregister_all(topo_mod_t *, tnode_t *); 116 117 extern di_node_t topo_mod_devinfo(topo_mod_t *); 118 extern ipmi_handle_t *topo_mod_ipmi_hold(topo_mod_t *); 119 extern void topo_mod_ipmi_rele(topo_mod_t *); 120 extern di_prom_handle_t topo_mod_prominfo(topo_mod_t *); 121 extern nvlist_t *topo_mod_auth(topo_mod_t *, tnode_t *); 122 123 /* 124 * FMRI methods 125 */ 126 #define TOPO_METH_LABEL "topo_label" 127 #define TOPO_METH_LABEL_DESC "label constructor" 128 #define TOPO_METH_LABEL_VERSION0 0 129 #define TOPO_METH_LABEL_VERSION TOPO_METH_LABEL_VERSION0 130 #define TOPO_METH_LABEL_ARG_NVL "label-specific" 131 #define TOPO_METH_LABEL_RET_STR "label-string" 132 133 #define TOPO_METH_PRESENT "topo_present" 134 #define TOPO_METH_PRESENT_DESC "presence indicator" 135 #define TOPO_METH_PRESENT_VERSION0 0 136 #define TOPO_METH_PRESENT_VERSION TOPO_METH_PRESENT_VERSION0 137 #define TOPO_METH_PRESENT_RET "present-ret" 138 139 #define TOPO_METH_REPLACED "topo_replaced" 140 #define TOPO_METH_REPLACED_DESC "replaced indicator" 141 #define TOPO_METH_REPLACED_VERSION0 0 142 #define TOPO_METH_REPLACED_VERSION TOPO_METH_REPLACED_VERSION0 143 #define TOPO_METH_REPLACED_RET "replaced-ret" 144 145 #define TOPO_METH_UNUSABLE "topo_unusable" 146 #define TOPO_METH_UNUSABLE_DESC "unusable indicator" 147 #define TOPO_METH_UNUSABLE_VERSION0 0 148 #define TOPO_METH_UNUSABLE_VERSION TOPO_METH_UNUSABLE_VERSION0 149 #define TOPO_METH_UNUSABLE_RET "unusable-ret" 150 151 #define TOPO_METH_SERVICE_STATE "topo_service_state" 152 #define TOPO_METH_SERVICE_STATE_DESC "service_state indicator" 153 #define TOPO_METH_SERVICE_STATE_VERSION0 0 154 #define TOPO_METH_SERVICE_STATE_VERSION TOPO_METH_SERVICE_STATE_VERSION0 155 #define TOPO_METH_SERVICE_STATE_RET "service_state-ret" 156 157 #define TOPO_METH_EXPAND "topo_expand" 158 #define TOPO_METH_EXPAND_DESC "expand FMRI" 159 #define TOPO_METH_EXPAND_VERSION0 0 160 #define TOPO_METH_EXPAND_VERSION TOPO_METH_EXPAND_VERSION0 161 162 #define TOPO_METH_CONTAINS "topo_contains" 163 #define TOPO_METH_CONTAINS_DESC "FMRI contains sub-FMRI" 164 #define TOPO_METH_CONTAINS_VERSION0 0 165 #define TOPO_METH_CONTAINS_VERSION TOPO_METH_CONTAINS_VERSION0 166 #define TOPO_METH_CONTAINS_RET "contains-return" 167 #define TOPO_METH_FMRI_ARG_FMRI "fmri" 168 #define TOPO_METH_FMRI_ARG_SUBFMRI "sub-fmri" 169 170 #define TOPO_METH_ASRU_COMPUTE "topo_asru_compute" 171 #define TOPO_METH_ASRU_COMPUTE_VERSION 0 172 #define TOPO_METH_ASRU_COMPUTE_DESC "Dynamic ASRU constructor" 173 174 #define TOPO_METH_FRU_COMPUTE "topo_fru_compute" 175 #define TOPO_METH_FRU_COMPUTE_VERSION 0 176 #define TOPO_METH_FRU_COMPUTE_DESC "Dynamic FRU constructor" 177 178 #define TOPO_METH_DISK_STATUS "topo_disk_status" 179 #define TOPO_METH_DISK_STATUS_VERSION 0 180 #define TOPO_METH_DISK_STATUS_DESC "Disk status" 181 182 #define TOPO_PROP_METH_DESC "Dynamic Property method" 183 184 #define TOPO_METH_IPMI_ENTITY "ipmi_entity" 185 #define TOPO_METH_FAC_ENUM_DESC "Facility Enumerator" 186 187 extern void *topo_mod_alloc(topo_mod_t *, size_t); 188 extern void *topo_mod_zalloc(topo_mod_t *, size_t); 189 extern void topo_mod_free(topo_mod_t *, void *, size_t); 190 extern char *topo_mod_strdup(topo_mod_t *, const char *); 191 extern void topo_mod_strfree(topo_mod_t *, char *); 192 extern int topo_mod_nvalloc(topo_mod_t *, nvlist_t **, uint_t); 193 extern int topo_mod_nvdup(topo_mod_t *, nvlist_t *, nvlist_t **); 194 195 extern void topo_mod_clrdebug(topo_mod_t *); 196 extern void topo_mod_setdebug(topo_mod_t *); 197 extern void topo_mod_dprintf(topo_mod_t *, const char *, ...); 198 extern const char *topo_mod_errmsg(topo_mod_t *); 199 extern int topo_mod_errno(topo_mod_t *); 200 201 /* 202 * Topo node utilities: callable from module enumeration, topo_mod_enumerate() 203 */ 204 extern int topo_node_range_create(topo_mod_t *, tnode_t *, const char *, 205 topo_instance_t, topo_instance_t); 206 extern void topo_node_range_destroy(tnode_t *, const char *); 207 extern tnode_t *topo_node_bind(topo_mod_t *, tnode_t *, const char *, 208 topo_instance_t, nvlist_t *); 209 extern tnode_t *topo_node_facbind(topo_mod_t *, tnode_t *, const char *, 210 const char *); 211 extern void topo_node_unbind(tnode_t *); 212 extern void topo_node_setspecific(tnode_t *, void *); 213 extern void *topo_node_getspecific(tnode_t *); 214 extern int topo_node_asru_set(tnode_t *node, nvlist_t *, int, int *); 215 extern int topo_node_fru_set(tnode_t *node, nvlist_t *, int, int *); 216 extern int topo_node_label_set(tnode_t *node, char *, int *); 217 218 #define TOPO_ASRU_COMPUTE 0x0001 /* Compute ASRU dynamically */ 219 #define TOPO_FRU_COMPUTE 0x0002 /* Compute FRU dynamically */ 220 221 extern int topo_prop_inherit(tnode_t *, const char *, const char *, int *); 222 extern int topo_pgroup_create(tnode_t *, const topo_pgroup_info_t *, int *); 223 224 /* 225 * Topo property method registration 226 */ 227 extern int topo_prop_method_register(tnode_t *, const char *, const char *, 228 topo_type_t, const char *, const nvlist_t *, int *); 229 extern void topo_prop_method_unregister(tnode_t *, const char *, const char *); 230 231 /* 232 * This enum definition is used to define a set of error tags associated with 233 * the module api error conditions. The shell script mkerror.sh is 234 * used to parse this file and create a corresponding topo_error.c source file. 235 * If you do something other than add a new error tag here, you may need to 236 * update the mkerror shell script as it is based upon simple regexps. 237 */ 238 typedef enum topo_mod_errno { 239 EMOD_UNKNOWN = 2000, /* unknown libtopo error */ 240 EMOD_NOMEM, /* module memory limit exceeded */ 241 EMOD_PARTIAL_ENUM, /* module completed partial enumeration */ 242 EMOD_METHOD_INVAL, /* method arguments invalid */ 243 EMOD_METHOD_NOTSUP, /* method not supported */ 244 EMOD_FMRI_NVL, /* nvlist allocation failure for FMRI */ 245 EMOD_FMRI_VERSION, /* invalid FMRI scheme version */ 246 EMOD_FMRI_MALFORM, /* malformed FMRI */ 247 EMOD_NODE_BOUND, /* node already bound */ 248 EMOD_NODE_DUP, /* duplicate node */ 249 EMOD_NODE_NOENT, /* node not found */ 250 EMOD_NODE_RANGE, /* invalid node range */ 251 EMOD_VER_ABI, /* registered with invalid ABI version */ 252 EMOD_VER_OLD, /* attempt to load obsolete module */ 253 EMOD_VER_NEW, /* attempt to load a newer module */ 254 EMOD_NVL_INVAL, /* invalid nvlist */ 255 EMOD_NONCANON, /* non-canonical component name requested */ 256 EMOD_MOD_NOENT, /* module lookup failed */ 257 EMOD_UKNOWN_ENUM, /* unknown enumeration error */ 258 EMOD_END /* end of mod errno list (to ease auto-merge) */ 259 } topo_mod_errno_t; 260 261 extern int topo_mod_seterrno(topo_mod_t *, int); 262 263 #ifdef __cplusplus 264 } 265 #endif 266 267 #endif /* _TOPO_MOD_H */ 268