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 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _LIBDEVINFO_H 27 #define _LIBDEVINFO_H 28 29 #pragma ident "%Z%%M% %I% %E% SMI" 30 31 #include <errno.h> 32 #include <sys/param.h> 33 #include <sys/sunddi.h> 34 #include <sys/sunmdi.h> 35 #include <sys/openpromio.h> 36 #include <sys/ddi_impldefs.h> 37 #include <sys/devinfo_impl.h> 38 #include <limits.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* 45 * flags for di_walk_node 46 */ 47 #define DI_WALK_CLDFIRST 0 48 #define DI_WALK_SIBFIRST 1 49 #define DI_WALK_LINKGEN 2 50 51 #define DI_WALK_MASK 0xf 52 53 /* 54 * flags for di_walk_link 55 */ 56 #define DI_LINK_SRC 1 57 #define DI_LINK_TGT 2 58 59 /* 60 * return code for node_callback 61 */ 62 #define DI_WALK_CONTINUE 0 63 #define DI_WALK_PRUNESIB -1 64 #define DI_WALK_PRUNECHILD -2 65 #define DI_WALK_TERMINATE -3 66 67 /* 68 * flags for di_walk_minor 69 */ 70 #define DI_CHECK_ALIAS 0x10 71 #define DI_CHECK_INTERNAL_PATH 0x20 72 73 #define DI_CHECK_MASK 0xf0 74 75 /* nodeid types */ 76 #define DI_PSEUDO_NODEID -1 77 #define DI_SID_NODEID -2 78 #define DI_PROM_NODEID -3 79 80 /* node & device states */ 81 #define DI_DRIVER_DETACHED 0x8000 82 #define DI_DEVICE_OFFLINE 0x1 83 #define DI_DEVICE_DOWN 0x2 84 #define DI_BUS_QUIESCED 0x100 85 #define DI_BUS_DOWN 0x200 86 87 /* property types */ 88 #define DI_PROP_TYPE_BOOLEAN 0 89 #define DI_PROP_TYPE_INT 1 90 #define DI_PROP_TYPE_STRING 2 91 #define DI_PROP_TYPE_BYTE 3 92 #define DI_PROP_TYPE_UNKNOWN 4 93 #define DI_PROP_TYPE_UNDEF_IT 5 94 #define DI_PROP_TYPE_INT64 6 95 96 /* private macro for checking if a prop type is valid */ 97 #define DI_PROP_TYPE_VALID(type) \ 98 ((((type) >= DI_PROP_TYPE_INT) && ((type) <= DI_PROP_TYPE_BYTE)) || \ 99 ((type) == DI_PROP_TYPE_INT64)) 100 101 /* opaque handles */ 102 103 typedef struct di_node *di_node_t; /* opaque handle to node */ 104 typedef struct di_minor *di_minor_t; /* opaque handle to minor node */ 105 typedef struct di_prop *di_prop_t; /* opaque handle to property */ 106 typedef struct di_prom_prop *di_prom_prop_t; /* opaque handle to prom prop */ 107 typedef struct di_prom_handle *di_prom_handle_t; /* opaque handle */ 108 typedef struct di_path *di_path_t; /* opaque handle */ 109 typedef struct di_path_prop *di_path_prop_t; /* opaque handle */ 110 111 typedef struct di_devlink_handle *di_devlink_handle_t; /* devlink snapshot */ 112 typedef struct di_devlink *di_devlink_t; /* opaque handle to devlink */ 113 typedef struct di_link *di_link_t; /* opaque handle to link */ 114 typedef struct di_lnode *di_lnode_t; /* opaque handle to endpoint */ 115 116 /* 117 * Null handles to make handles really opaque 118 */ 119 #define DI_NODE_NIL NULL 120 #define DI_LINK_NIL NULL 121 #define DI_LNODE_NIL NULL 122 #define DI_MINOR_NIL NULL 123 #define DI_PROP_NIL NULL 124 #define DI_PROM_PROP_NIL NULL 125 #define DI_PROM_HANDLE_NIL NULL 126 #define DI_PATH_NIL NULL 127 128 /* Interface Prototypes */ 129 130 /* 131 * Snapshot initialization and cleanup 132 */ 133 extern di_node_t di_init(const char *phys_path, uint_t flag); 134 extern void di_fini(di_node_t root); 135 136 /* 137 * tree traversal 138 */ 139 extern di_node_t di_parent_node(di_node_t node); 140 extern di_node_t di_sibling_node(di_node_t node); 141 extern di_node_t di_child_node(di_node_t node); 142 extern di_node_t di_drv_first_node(const char *drv_name, di_node_t root); 143 extern di_node_t di_drv_next_node(di_node_t node); 144 extern di_node_t di_vhci_first_node(di_node_t root); 145 extern di_node_t di_vhci_next_node(di_node_t node); 146 extern di_node_t di_phci_first_node(di_node_t vhci_node); 147 extern di_node_t di_phci_next_node(di_node_t node); 148 149 /* 150 * tree walking assistants 151 */ 152 extern int di_walk_node(di_node_t root, uint_t flag, void *arg, 153 int (*node_callback)(di_node_t node, void *arg)); 154 extern int di_walk_minor(di_node_t root, const char *minortype, uint_t flag, 155 void *arg, int (*minor_callback)(di_node_t node, di_minor_t minor, 156 void *arg)); 157 extern int di_walk_link(di_node_t root, uint_t flag, uint_t endpoint, 158 void *arg, int (*link_callback)(di_link_t link, void *arg)); 159 extern int di_walk_lnode(di_node_t root, uint_t flag, 160 void *arg, int (*lnode_callback)(di_lnode_t lnode, void *arg)); 161 162 extern void di_node_private_set(di_node_t node, void *data); 163 extern void *di_node_private_get(di_node_t node); 164 extern void di_minor_private_set(di_minor_t minor, void *data); 165 extern void *di_minor_private_get(di_minor_t minor); 166 extern void di_lnode_private_set(di_lnode_t lnode, void *data); 167 extern void *di_lnode_private_get(di_lnode_t lnode); 168 extern void di_link_private_set(di_link_t link, void *data); 169 extern void *di_link_private_get(di_link_t link); 170 171 /* 172 * generic node parameters 173 */ 174 extern char *di_node_name(di_node_t node); 175 extern char *di_bus_addr(di_node_t node); 176 extern char *di_binding_name(di_node_t node); 177 extern int di_compatible_names(di_node_t, char **names); 178 extern int di_instance(di_node_t node); 179 extern int di_nodeid(di_node_t node); 180 extern int di_driver_major(di_node_t node); 181 extern uint_t di_state(di_node_t node); 182 extern ddi_node_state_t di_node_state(di_node_t node); 183 extern ddi_devid_t di_devid(di_node_t node); 184 185 extern char *di_driver_name(di_node_t node); 186 extern uint_t di_driver_ops(di_node_t node); 187 188 extern char *di_devfs_path(di_node_t node); 189 extern char *di_devfs_minor_path(di_minor_t minor); 190 191 extern void di_devfs_path_free(char *path_buf); 192 193 /* 194 * layering data access 195 */ 196 extern di_link_t di_link_next_by_node(di_node_t node, 197 di_link_t link, uint_t endpoint); 198 extern di_link_t di_link_next_by_lnode(di_lnode_t lnode, 199 di_link_t link, uint_t endpoint); 200 extern di_lnode_t di_link_to_lnode(di_link_t link, uint_t endpoint); 201 202 extern di_lnode_t di_lnode_next(di_node_t node, di_lnode_t lnode); 203 extern char *di_lnode_name(di_lnode_t lnode); 204 extern di_node_t di_lnode_devinfo(di_lnode_t lnode); 205 extern int di_lnode_devt(di_lnode_t lnode, dev_t *devt); 206 207 extern int di_link_spectype(di_link_t link); 208 209 /* 210 * minor data access 211 */ 212 extern di_minor_t di_minor_next(di_node_t node, di_minor_t minor); 213 extern di_node_t di_minor_devinfo(di_minor_t minor); 214 extern ddi_minor_type di_minor_type(di_minor_t minor); 215 extern char *di_minor_name(di_minor_t minor); 216 extern dev_t di_minor_devt(di_minor_t minor); 217 extern int di_minor_spectype(di_minor_t minor); 218 extern char *di_minor_nodetype(di_minor_t node); 219 220 /* 221 * Software property access 222 */ 223 extern di_prop_t di_prop_next(di_node_t node, di_prop_t prop); 224 extern dev_t di_prop_devt(di_prop_t prop); 225 extern char *di_prop_name(di_prop_t prop); 226 extern int di_prop_type(di_prop_t prop); 227 extern int di_prop_ints(di_prop_t prop, int **prop_data); 228 extern int di_prop_int64(di_prop_t prop, int64_t **prop_data); 229 extern int di_prop_strings(di_prop_t prop, char **prop_data); 230 extern int di_prop_bytes(di_prop_t prop, uchar_t **prop_data); 231 extern int di_prop_lookup_ints(dev_t dev, di_node_t node, 232 const char *prop_name, int **prop_data); 233 extern int di_prop_lookup_int64(dev_t dev, di_node_t node, 234 const char *prop_name, int64_t **prop_data); 235 extern int di_prop_lookup_strings(dev_t dev, di_node_t node, 236 const char *prop_name, char **prop_data); 237 extern int di_prop_lookup_bytes(dev_t dev, di_node_t node, 238 const char *prop_name, uchar_t **prop_data); 239 240 /* 241 * PROM property access 242 */ 243 extern di_prom_handle_t di_prom_init(void); 244 extern void di_prom_fini(di_prom_handle_t ph); 245 246 extern di_prom_prop_t di_prom_prop_next(di_prom_handle_t ph, di_node_t node, 247 di_prom_prop_t prom_prop); 248 249 extern char *di_prom_prop_name(di_prom_prop_t prom_prop); 250 extern int di_prom_prop_data(di_prom_prop_t prop, uchar_t **prom_prop_data); 251 252 extern int di_prom_prop_lookup_ints(di_prom_handle_t prom, di_node_t node, 253 const char *prom_prop_name, int **prom_prop_data); 254 extern int di_prom_prop_lookup_strings(di_prom_handle_t prom, di_node_t node, 255 const char *prom_prop_name, char **prom_prop_data); 256 extern int di_prom_prop_lookup_bytes(di_prom_handle_t prom, di_node_t node, 257 const char *prom_prop_name, uchar_t **prom_prop_data); 258 259 /* 260 * Private interfaces 261 * 262 * The interfaces and structures below are private to this implementation 263 * of Solaris and are subject to change at any time without notice. 264 * 265 * Applications and drivers using these interfaces will fail 266 * to run on future releases. 267 */ 268 269 /* 270 * Interfaces for accessing I/O multipathing data 271 */ 272 /* XXX remove di_path_next() after updating NWS consolidation */ 273 extern di_path_t di_path_next(di_node_t node, di_path_t path); 274 extern di_path_t di_path_next_phci(di_node_t node, di_path_t path); 275 extern di_path_t di_path_next_client(di_node_t node, di_path_t path); 276 extern di_path_state_t di_path_state(di_path_t path); 277 extern char *di_path_addr(di_path_t path, char *buf); 278 extern di_node_t di_path_client_node(di_path_t path); 279 extern void di_path_client_path(di_path_t path, char *buf); 280 extern di_node_t di_path_phci_node(di_path_t path); 281 extern void di_path_phci_path(di_path_t path, char *buf); 282 extern di_path_prop_t di_path_prop_next(di_path_t path, di_path_prop_t prop); 283 extern char *di_path_prop_name(di_path_prop_t prop); 284 extern int di_path_prop_type(di_path_prop_t prop); 285 extern int di_path_prop_len(di_path_prop_t prop); 286 extern int di_path_prop_bytes(di_path_prop_t prop, uchar_t **prop_data); 287 extern int di_path_prop_ints(di_path_prop_t prop, int **prop_data); 288 extern int di_path_prop_int64s(di_path_prop_t prop, int64_t **prop_data); 289 extern int di_path_prop_strings(di_path_prop_t prop, char **prop_data); 290 extern int di_path_prop_lookup_bytes(di_path_t path, const char *prop_name, 291 uchar_t **prop_data); 292 extern int di_path_prop_lookup_ints(di_path_t path, const char *prop_name, 293 int **prop_data); 294 extern int di_path_prop_lookup_int64s(di_path_t path, const char *prop_name, 295 int64_t **prop_data); 296 extern int di_path_prop_lookup_strings(di_path_t path, const char *prop_name, 297 char **prop_data); 298 299 300 /* 301 * Interfaces for private data 302 */ 303 extern di_node_t di_init_driver(const char *drv_name, uint_t flag); 304 extern di_node_t di_init_impl(const char *phys_path, uint_t flag, 305 struct di_priv_data *priv_data); 306 307 /* 308 * Prtconf needs to know property lists, raw prop_data, and private data 309 */ 310 extern di_prop_t di_prop_drv_next(di_node_t node, di_prop_t prop); 311 extern di_prop_t di_prop_sys_next(di_node_t node, di_prop_t prop); 312 extern di_prop_t di_prop_global_next(di_node_t node, di_prop_t prop); 313 extern di_prop_t di_prop_hw_next(di_node_t node, di_prop_t prop); 314 315 extern int di_prop_rawdata(di_prop_t prop, uchar_t **prop_data); 316 extern void *di_parent_private_data(di_node_t node); 317 extern void *di_driver_private_data(di_node_t node); 318 319 /* 320 * Types of links for devlink lookup 321 */ 322 #define DI_PRIMARY_LINK 0x01 323 #define DI_SECONDARY_LINK 0x02 324 #define DI_LINK_TYPES 0x03 325 326 /* 327 * Flag for di_devlink_init() 328 */ 329 #define DI_MAKE_LINK 0x01 330 331 /* 332 * Flag for di_devlink_close() 333 */ 334 #define DI_LINK_ERROR 0x01 335 336 /* 337 * For devfsadm synchronous link creation interfaces 338 */ 339 #define DEVFSADM_SYNCH_DOOR ".devfsadm_synch_door" 340 341 /* 342 * devlink create argument 343 */ 344 struct dca_off { 345 uint32_t dca_root; 346 uint32_t dca_minor; 347 uint32_t dca_driver; 348 int dca_error; 349 int dca_flags; 350 char dca_name[PATH_MAX+MAXNAMELEN]; 351 }; 352 353 extern di_devlink_handle_t di_devlink_init(const char *name, uint_t flags); 354 extern int di_devlink_walk(di_devlink_handle_t hdl, const char *re, 355 const char *minor_path, uint_t flags, void *arg, 356 int (*devlink_callback)(di_devlink_t, void *)); 357 extern const char *di_devlink_path(di_devlink_t devlink); 358 extern const char *di_devlink_content(di_devlink_t devlink); 359 extern int di_devlink_type(di_devlink_t devlink); 360 extern di_devlink_t di_devlink_dup(di_devlink_t devlink); 361 extern int di_devlink_free(di_devlink_t devlink); 362 extern int di_devlink_fini(di_devlink_handle_t *hdlp); 363 364 extern di_devlink_handle_t di_devlink_open(const char *root_dir, uint_t flags); 365 extern int di_devlink_close(di_devlink_handle_t *pp, int flag); 366 extern int di_devlink_rm_link(di_devlink_handle_t hdp, const char *link); 367 extern int di_devlink_add_link(di_devlink_handle_t hdp, const char *link, 368 const char *content, int flags); 369 extern int di_devlink_update(di_devlink_handle_t hdp); 370 extern di_devlink_handle_t di_devlink_init_root(const char *root, 371 const char *name, uint_t flags); 372 extern int di_devlink_cache_walk(di_devlink_handle_t hdp, const char *re, 373 const char *path, uint_t flags, void *arg, 374 int (*devlink_callback)(di_devlink_t, void *)); 375 376 /* 377 * Private interfaces for /etc/logindevperm 378 */ 379 extern int di_devperm_login(const char *, uid_t, gid_t, void (*)(char *)); 380 extern int di_devperm_logout(const char *); 381 382 /* 383 * Private interface for looking up a node in a snapshot 384 */ 385 extern di_node_t di_lookup_node(di_node_t root, char *path); 386 387 388 /* 389 * Private hotplug interfaces to be used between cfgadm pci plugin and 390 * devfsadm link generator. 391 */ 392 extern char *di_dli_name(char *); 393 extern int di_dli_openr(char *); 394 extern int di_dli_openw(char *); 395 extern void di_dli_close(int); 396 397 #ifdef __cplusplus 398 } 399 #endif 400 401 #endif /* _LIBDEVINFO_H */ 402