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 * Flags for topo_mod_memfmri 101 */ 102 #define TOPO_MEMFMRI_PA 0x0001 /* Valid physical address */ 103 #define TOPO_MEMFMRI_OFFSET 0x0002 /* Valid offset */ 104 105 extern int topo_method_register(topo_mod_t *, tnode_t *, const topo_method_t *); 106 extern void topo_method_unregister(topo_mod_t *, tnode_t *, const char *); 107 extern void topo_method_unregister_all(topo_mod_t *, tnode_t *); 108 109 extern di_node_t topo_mod_devinfo(topo_mod_t *); 110 extern di_prom_handle_t topo_mod_prominfo(topo_mod_t *); 111 extern nvlist_t *topo_mod_auth(topo_mod_t *, tnode_t *); 112 113 /* 114 * FMRI methods 115 */ 116 #define TOPO_METH_LABEL "topo_label" 117 #define TOPO_METH_LABEL_DESC "Dynamic label discovery" 118 #define TOPO_METH_LABEL_VERSION0 0 119 #define TOPO_METH_LABEL_VERSION TOPO_METH_LABEL_VERSION0 120 #define TOPO_METH_LABEL_ARG_NVL "label-specific" 121 #define TOPO_METH_LABEL_RET_STR "label-string" 122 123 #define TOPO_METH_PRESENT "topo_present" 124 #define TOPO_METH_PRESENT_DESC "Dynamic label discovery" 125 #define TOPO_METH_PRESENT_VERSION0 0 126 #define TOPO_METH_PRESENT_VERSION TOPO_METH_PRESENT_VERSION0 127 #define TOPO_METH_PRESENT_RET "present-ret" 128 129 #define TOPO_METH_UNUSABLE "topo_unusable" 130 #define TOPO_METH_UNUSABLE_DESC "FMRI is unusable" 131 #define TOPO_METH_UNUSABLE_VERSION0 0 132 #define TOPO_METH_UNUSABLE_VERSION TOPO_METH_UNUSABLE_VERSION0 133 #define TOPO_METH_UNUSABLE_RET "unusable-ret" 134 135 #define TOPO_METH_EXPAND "topo_expand" 136 #define TOPO_METH_EXPAND_DESC "expand FMRI" 137 #define TOPO_METH_EXPAND_VERSION0 0 138 #define TOPO_METH_EXPAND_VERSION TOPO_METH_EXPAND_VERSION0 139 140 #define TOPO_METH_ASRU_COMPUTE "topo_asru_compute" 141 #define TOPO_METH_ASRU_COMPUTE_VERSION 0 142 #define TOPO_METH_ASRU_COMPUTE_DESC "Dynamic ASRU constructor" 143 144 #define TOPO_METH_FRU_COMPUTE "topo_fru_compute" 145 #define TOPO_METH_FRU_COMPUTE_VERSION 0 146 #define TOPO_METH_FRU_COMPUTE_DESC "Dynamic FRU constructor" 147 148 extern void *topo_mod_alloc(topo_mod_t *, size_t); 149 extern void *topo_mod_zalloc(topo_mod_t *, size_t); 150 extern void topo_mod_free(topo_mod_t *, void *, size_t); 151 extern char *topo_mod_strdup(topo_mod_t *, const char *); 152 extern void topo_mod_strfree(topo_mod_t *, char *); 153 extern int topo_mod_nvalloc(topo_mod_t *, nvlist_t **, uint_t); 154 extern int topo_mod_nvdup(topo_mod_t *, nvlist_t *, nvlist_t **); 155 156 extern void topo_mod_clrdebug(topo_mod_t *); 157 extern void topo_mod_setdebug(topo_mod_t *); 158 extern void topo_mod_dprintf(topo_mod_t *, const char *, ...); 159 extern const char *topo_mod_errmsg(topo_mod_t *); 160 extern int topo_mod_errno(topo_mod_t *); 161 162 /* 163 * Topo node utilities: callable from module enumeration, topo_mod_enumerate() 164 */ 165 extern int topo_node_range_create(topo_mod_t *, tnode_t *, const char *, 166 topo_instance_t, topo_instance_t); 167 extern void topo_node_range_destroy(tnode_t *, const char *); 168 extern tnode_t *topo_node_bind(topo_mod_t *, tnode_t *, const char *, 169 topo_instance_t, nvlist_t *); 170 extern void topo_node_unbind(tnode_t *); 171 extern void topo_node_setspecific(tnode_t *, void *); 172 extern void *topo_node_getspecific(tnode_t *); 173 extern int topo_node_asru_set(tnode_t *node, nvlist_t *, int, int *); 174 extern int topo_node_fru_set(tnode_t *node, nvlist_t *, int, int *); 175 extern int topo_node_label_set(tnode_t *node, char *, int *); 176 177 #define TOPO_ASRU_COMPUTE 0x0001 /* Compute ASRU dynamically */ 178 #define TOPO_FRU_COMPUTE 0x0002 /* Compute FRU dynamically */ 179 180 /* 181 * This enum definition is used to define a set of error tags associated with 182 * the module api error conditions. The shell script mkerror.sh is 183 * used to parse this file and create a corresponding topo_error.c source file. 184 * If you do something other than add a new error tag here, you may need to 185 * update the mkerror shell script as it is based upon simple regexps. 186 */ 187 typedef enum topo_mod_errno { 188 EMOD_UNKNOWN = 2000, /* unknown libtopo error */ 189 EMOD_NOMEM, /* module memory limit exceeded */ 190 EMOD_PARTIAL_ENUM, /* module completed partial enumeration */ 191 EMOD_METHOD_INVAL, /* method arguments invalid */ 192 EMOD_METHOD_NOTSUP, /* method not supported */ 193 EMOD_FMRI_NVL, /* nvlist allocation failure for FMRI */ 194 EMOD_FMRI_VERSION, /* invalid FMRI scheme version */ 195 EMOD_FMRI_MALFORM, /* malformed FMRI */ 196 EMOD_VER_ABI, /* registered with invalid ABI version */ 197 EMOD_VER_OLD, /* attempt to load obsolete module */ 198 EMOD_VER_NEW, /* attempt to load a newer module */ 199 EMOD_NVL_INVAL, /* invalid nvlist */ 200 EMOD_NONCANON, /* non-canonical component name requested */ 201 EMOD_MOD_NOENT, /* module lookup failed */ 202 EMOD_UKNOWN_ENUM, /* unknown enumeration error */ 203 EMOD_END /* end of mod errno list (to ease auto-merge) */ 204 } topo_mod_errno_t; 205 206 extern int topo_mod_seterrno(topo_mod_t *, int); 207 208 #ifdef __cplusplus 209 } 210 #endif 211 212 #endif /* _TOPO_MOD_H */ 213