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