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 2007 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 <libnvpair.h> 35 #include <libdevinfo.h> 36 37 #ifdef __cplusplus 38 extern "C" { 39 #endif 40 41 /* 42 * Enumerator and method supplier module API 43 */ 44 typedef struct topo_mod topo_mod_t; 45 46 typedef int topo_method_f(topo_mod_t *, tnode_t *, topo_version_t, nvlist_t *, 47 nvlist_t **); 48 typedef int topo_enum_f(topo_mod_t *, tnode_t *, const char *, topo_instance_t, 49 topo_instance_t, void *, void *); 50 typedef void topo_release_f(topo_mod_t *, tnode_t *); 51 52 typedef struct topo_method { 53 const char *tm_name; /* Method name */ 54 const char *tm_desc; /* Method description */ 55 const topo_version_t tm_version; /* Method version */ 56 const topo_stability_t tm_stability; /* Attributes of method */ 57 topo_method_f *tm_func; /* Method function */ 58 } topo_method_t; 59 60 typedef struct topo_modops { 61 topo_enum_f *tmo_enum; /* enumeration op */ 62 topo_release_f *tmo_release; /* resource release op */ 63 } topo_modops_t; 64 65 typedef struct topo_mod_info { 66 const char *tmi_desc; /* module description */ 67 const char *tmi_scheme; /* enumeration scheme type */ 68 topo_version_t tmi_version; /* module version */ 69 const topo_modops_t *tmi_ops; /* module ops vector */ 70 } topo_modinfo_t; 71 72 extern topo_mod_t *topo_mod_load(topo_mod_t *, const char *, topo_version_t); 73 extern void topo_mod_unload(topo_mod_t *); 74 extern int topo_mod_register(topo_mod_t *, const topo_modinfo_t *, 75 topo_version_t); 76 extern void topo_mod_unregister(topo_mod_t *); 77 extern int topo_mod_enumerate(topo_mod_t *, tnode_t *, const char *, 78 const char *, topo_instance_t, topo_instance_t, void *); 79 extern int topo_mod_enummap(topo_mod_t *mod, tnode_t *, const char *, 80 const char *); 81 extern void topo_mod_release(topo_mod_t *, tnode_t *); 82 extern void topo_mod_setspecific(topo_mod_t *, void *); 83 extern void *topo_mod_getspecific(topo_mod_t *); 84 85 extern nvlist_t *topo_mod_cpufmri(topo_mod_t *, int, uint32_t, uint8_t, 86 const char *); 87 extern nvlist_t *topo_mod_devfmri(topo_mod_t *, int, const char *, 88 const char *); 89 extern nvlist_t *topo_mod_hcfmri(topo_mod_t *, tnode_t *, int, const char *, 90 topo_instance_t, nvlist_t *, nvlist_t *, const char *, const char *, 91 const char *); 92 extern nvlist_t *topo_mod_memfmri(topo_mod_t *, int, uint64_t, uint64_t, 93 const char *, int); 94 extern nvlist_t *topo_mod_modfmri(topo_mod_t *, int, const char *); 95 extern nvlist_t *topo_mod_pkgfmri(topo_mod_t *, int, const char *); 96 extern int topo_mod_nvl2str(topo_mod_t *, nvlist_t *, char **); 97 extern int topo_mod_str2nvl(topo_mod_t *, const char *, nvlist_t **); 98 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 di_prom_handle_t topo_mod_prominfo(topo_mod_t *); 119 extern nvlist_t *topo_mod_auth(topo_mod_t *, tnode_t *); 120 121 /* 122 * FMRI methods 123 */ 124 #define TOPO_METH_LABEL "topo_label" 125 #define TOPO_METH_LABEL_DESC "label constructor" 126 #define TOPO_METH_LABEL_VERSION0 0 127 #define TOPO_METH_LABEL_VERSION TOPO_METH_LABEL_VERSION0 128 #define TOPO_METH_LABEL_ARG_NVL "label-specific" 129 #define TOPO_METH_LABEL_RET_STR "label-string" 130 131 #define TOPO_METH_PRESENT "topo_present" 132 #define TOPO_METH_PRESENT_DESC "presence indicator" 133 #define TOPO_METH_PRESENT_VERSION0 0 134 #define TOPO_METH_PRESENT_VERSION TOPO_METH_PRESENT_VERSION0 135 #define TOPO_METH_PRESENT_RET "present-ret" 136 137 #define TOPO_METH_UNUSABLE "topo_unusable" 138 #define TOPO_METH_UNUSABLE_DESC "unusable indicator" 139 #define TOPO_METH_UNUSABLE_VERSION0 0 140 #define TOPO_METH_UNUSABLE_VERSION TOPO_METH_UNUSABLE_VERSION0 141 #define TOPO_METH_UNUSABLE_RET "unusable-ret" 142 143 #define TOPO_METH_EXPAND "topo_expand" 144 #define TOPO_METH_EXPAND_DESC "expand FMRI" 145 #define TOPO_METH_EXPAND_VERSION0 0 146 #define TOPO_METH_EXPAND_VERSION TOPO_METH_EXPAND_VERSION0 147 148 #define TOPO_METH_ASRU_COMPUTE "topo_asru_compute" 149 #define TOPO_METH_ASRU_COMPUTE_VERSION 0 150 #define TOPO_METH_ASRU_COMPUTE_DESC "Dynamic ASRU constructor" 151 152 #define TOPO_METH_FRU_COMPUTE "topo_fru_compute" 153 #define TOPO_METH_FRU_COMPUTE_VERSION 0 154 #define TOPO_METH_FRU_COMPUTE_DESC "Dynamic FRU constructor" 155 156 extern void *topo_mod_alloc(topo_mod_t *, size_t); 157 extern void *topo_mod_zalloc(topo_mod_t *, size_t); 158 extern void topo_mod_free(topo_mod_t *, void *, size_t); 159 extern char *topo_mod_strdup(topo_mod_t *, const char *); 160 extern void topo_mod_strfree(topo_mod_t *, char *); 161 extern int topo_mod_nvalloc(topo_mod_t *, nvlist_t **, uint_t); 162 extern int topo_mod_nvdup(topo_mod_t *, nvlist_t *, nvlist_t **); 163 164 extern void topo_mod_clrdebug(topo_mod_t *); 165 extern void topo_mod_setdebug(topo_mod_t *); 166 extern void topo_mod_dprintf(topo_mod_t *, const char *, ...); 167 extern const char *topo_mod_errmsg(topo_mod_t *); 168 extern int topo_mod_errno(topo_mod_t *); 169 170 /* 171 * Topo node utilities: callable from module enumeration, topo_mod_enumerate() 172 */ 173 extern int topo_node_range_create(topo_mod_t *, tnode_t *, const char *, 174 topo_instance_t, topo_instance_t); 175 extern void topo_node_range_destroy(tnode_t *, const char *); 176 extern tnode_t *topo_node_bind(topo_mod_t *, tnode_t *, const char *, 177 topo_instance_t, nvlist_t *); 178 extern void topo_node_unbind(tnode_t *); 179 extern void topo_node_setspecific(tnode_t *, void *); 180 extern void *topo_node_getspecific(tnode_t *); 181 extern int topo_node_asru_set(tnode_t *node, nvlist_t *, int, int *); 182 extern int topo_node_fru_set(tnode_t *node, nvlist_t *, int, int *); 183 extern int topo_node_label_set(tnode_t *node, char *, int *); 184 185 #define TOPO_ASRU_COMPUTE 0x0001 /* Compute ASRU dynamically */ 186 #define TOPO_FRU_COMPUTE 0x0002 /* Compute FRU dynamically */ 187 188 /* 189 * Topo property set functions 190 */ 191 extern int topo_prop_set_int32(tnode_t *, const char *, const char *, int, 192 int32_t, int *); 193 extern int topo_prop_set_uint32(tnode_t *, const char *, const char *, int, 194 uint32_t, int *); 195 extern int topo_prop_set_int64(tnode_t *, const char *, const char *, 196 int, int64_t, int *); 197 extern int topo_prop_set_uint64(tnode_t *, const char *, const char *, 198 int, uint64_t, int *); 199 extern int topo_prop_set_string(tnode_t *, const char *, const char *, 200 int, const char *, int *); 201 extern int topo_prop_set_fmri(tnode_t *, const char *, const char *, 202 int, const nvlist_t *, int *); 203 extern int topo_prop_set_int32_array(tnode_t *, const char *, const char *, int, 204 int32_t *, uint_t, int *); 205 extern int topo_prop_set_uint32_array(tnode_t *, const char *, const char *, 206 int, uint32_t *, uint_t, int *); 207 extern int topo_prop_set_int64_array(tnode_t *, const char *, const char *, 208 int, int64_t *, uint_t, int *); 209 extern int topo_prop_set_uint64_array(tnode_t *, const char *, const char *, 210 int, uint64_t *, uint_t, int *); 211 extern int topo_prop_set_string_array(tnode_t *, const char *, const char *, 212 int, const char **, uint_t, int *); 213 extern int topo_prop_set_fmri_array(tnode_t *, const char *, const char *, 214 int, const nvlist_t **, uint_t, int *); 215 extern int topo_prop_inherit(tnode_t *, const char *, const char *, int *); 216 extern int topo_pgroup_create(tnode_t *, const topo_pgroup_info_t *, int *); 217 218 /* 219 * Topo property method registration 220 */ 221 extern int topo_prop_method_register(tnode_t *, const char *, const char *, 222 topo_type_t, const char *, const nvlist_t *, int *); 223 extern void topo_prop_method_unregister(tnode_t *, const char *, const char *); 224 225 /* 226 * This enum definition is used to define a set of error tags associated with 227 * the module api error conditions. The shell script mkerror.sh is 228 * used to parse this file and create a corresponding topo_error.c source file. 229 * If you do something other than add a new error tag here, you may need to 230 * update the mkerror shell script as it is based upon simple regexps. 231 */ 232 typedef enum topo_mod_errno { 233 EMOD_UNKNOWN = 2000, /* unknown libtopo error */ 234 EMOD_NOMEM, /* module memory limit exceeded */ 235 EMOD_PARTIAL_ENUM, /* module completed partial enumeration */ 236 EMOD_METHOD_INVAL, /* method arguments invalid */ 237 EMOD_METHOD_NOTSUP, /* method not supported */ 238 EMOD_FMRI_NVL, /* nvlist allocation failure for FMRI */ 239 EMOD_FMRI_VERSION, /* invalid FMRI scheme version */ 240 EMOD_FMRI_MALFORM, /* malformed FMRI */ 241 EMOD_VER_ABI, /* registered with invalid ABI version */ 242 EMOD_VER_OLD, /* attempt to load obsolete module */ 243 EMOD_VER_NEW, /* attempt to load a newer module */ 244 EMOD_NVL_INVAL, /* invalid nvlist */ 245 EMOD_NONCANON, /* non-canonical component name requested */ 246 EMOD_MOD_NOENT, /* module lookup failed */ 247 EMOD_UKNOWN_ENUM, /* unknown enumeration error */ 248 EMOD_END /* end of mod errno list (to ease auto-merge) */ 249 } topo_mod_errno_t; 250 251 extern int topo_mod_seterrno(topo_mod_t *, int); 252 253 #ifdef __cplusplus 254 } 255 #endif 256 257 #endif /* _TOPO_MOD_H */ 258