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 2008 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 #ifdef __cplusplus 32 extern "C" { 33 #endif 34 35 #include <errno.h> 36 #include <libnvpair.h> 37 #include <sys/param.h> 38 #include <sys/sunddi.h> 39 #include <sys/sunmdi.h> 40 #include <sys/openpromio.h> 41 #include <sys/ddi_impldefs.h> 42 #include <sys/devinfo_impl.h> 43 #include <limits.h> 44 45 /* 46 * flags for di_walk_node 47 */ 48 #define DI_WALK_CLDFIRST 0 49 #define DI_WALK_SIBFIRST 1 50 #define DI_WALK_LINKGEN 2 51 52 #define DI_WALK_MASK 0xf 53 54 /* 55 * flags for di_walk_link 56 */ 57 #define DI_LINK_SRC 1 58 #define DI_LINK_TGT 2 59 60 /* 61 * return code for node_callback 62 */ 63 #define DI_WALK_CONTINUE 0 64 #define DI_WALK_PRUNESIB -1 65 #define DI_WALK_PRUNECHILD -2 66 #define DI_WALK_TERMINATE -3 67 68 /* 69 * flags for di_walk_minor 70 */ 71 #define DI_CHECK_ALIAS 0x10 72 #define DI_CHECK_INTERNAL_PATH 0x20 73 74 #define DI_CHECK_MASK 0xf0 75 76 /* nodeid types */ 77 #define DI_PSEUDO_NODEID -1 78 #define DI_SID_NODEID -2 79 #define DI_PROM_NODEID -3 80 81 /* node & device states */ 82 #define DI_DRIVER_DETACHED 0x8000 83 #define DI_DEVICE_OFFLINE 0x1 84 #define DI_DEVICE_DOWN 0x2 85 #define DI_BUS_QUIESCED 0x100 86 #define DI_BUS_DOWN 0x200 87 88 /* property types */ 89 #define DI_PROP_TYPE_BOOLEAN 0 90 #define DI_PROP_TYPE_INT 1 91 #define DI_PROP_TYPE_STRING 2 92 #define DI_PROP_TYPE_BYTE 3 93 #define DI_PROP_TYPE_UNKNOWN 4 94 #define DI_PROP_TYPE_UNDEF_IT 5 95 #define DI_PROP_TYPE_INT64 6 96 97 /* private macro for checking if a prop type is valid */ 98 #define DI_PROP_TYPE_VALID(type) \ 99 ((((type) >= DI_PROP_TYPE_INT) && ((type) <= DI_PROP_TYPE_BYTE)) || \ 100 ((type) == DI_PROP_TYPE_INT64)) 101 102 /* opaque handles */ 103 104 typedef struct di_node *di_node_t; /* opaque handle to node */ 105 typedef struct di_minor *di_minor_t; /* opaque handle to minor node */ 106 typedef struct di_prop *di_prop_t; /* opaque handle to property */ 107 typedef struct di_prom_prop *di_prom_prop_t; /* opaque handle to prom prop */ 108 typedef struct di_prom_handle *di_prom_handle_t; /* opaque handle */ 109 typedef struct di_path *di_path_t; /* opaque handle */ 110 typedef struct di_path_prop *di_path_prop_t; /* opaque handle */ 111 112 typedef struct di_devlink_handle *di_devlink_handle_t; /* devlink snapshot */ 113 typedef struct di_devlink *di_devlink_t; /* opaque handle to devlink */ 114 typedef struct di_link *di_link_t; /* opaque handle to link */ 115 typedef struct di_lnode *di_lnode_t; /* opaque handle to endpoint */ 116 117 /* 118 * Null handles to make handles really opaque 119 */ 120 #define DI_NODE_NIL NULL 121 #define DI_LINK_NIL NULL 122 #define DI_LNODE_NIL NULL 123 #define DI_MINOR_NIL NULL 124 #define DI_PROP_NIL NULL 125 #define DI_PROM_PROP_NIL NULL 126 #define DI_PROM_HANDLE_NIL NULL 127 #define DI_PATH_NIL NULL 128 129 /* 130 * IEEE 1275 properties and other standardized property names 131 */ 132 #define DI_PROP_FIRST_CHAS "first-in-chassis" 133 #define DI_PROP_SLOT_NAMES "slot-names" 134 #define DI_PROP_PHYS_SLOT "physical-slot#" 135 #define DI_PROP_DEV_TYPE "device_type" 136 #define DI_PROP_BUS_RANGE "bus-range" 137 #define DI_PROP_SERID "serialid#" 138 #define DI_PROP_REG "reg" 139 #define DI_PROP_AP_NAMES "ap-names" 140 141 142 /* Interface Prototypes */ 143 144 /* 145 * Snapshot initialization and cleanup 146 */ 147 extern di_node_t di_init(const char *phys_path, uint_t flag); 148 extern void di_fini(di_node_t root); 149 150 /* 151 * tree traversal 152 */ 153 extern di_node_t di_parent_node(di_node_t node); 154 extern di_node_t di_sibling_node(di_node_t node); 155 extern di_node_t di_child_node(di_node_t node); 156 extern di_node_t di_drv_first_node(const char *drv_name, di_node_t root); 157 extern di_node_t di_drv_next_node(di_node_t node); 158 extern di_node_t di_vhci_first_node(di_node_t root); 159 extern di_node_t di_vhci_next_node(di_node_t node); 160 extern di_node_t di_phci_first_node(di_node_t vhci_node); 161 extern di_node_t di_phci_next_node(di_node_t node); 162 163 /* 164 * tree walking assistants 165 */ 166 extern int di_walk_node(di_node_t root, uint_t flag, void *arg, 167 int (*node_callback)(di_node_t node, void *arg)); 168 extern int di_walk_minor(di_node_t root, const char *minortype, uint_t flag, 169 void *arg, int (*minor_callback)(di_node_t node, di_minor_t minor, 170 void *arg)); 171 extern int di_walk_link(di_node_t root, uint_t flag, uint_t endpoint, 172 void *arg, int (*link_callback)(di_link_t link, void *arg)); 173 extern int di_walk_lnode(di_node_t root, uint_t flag, 174 void *arg, int (*lnode_callback)(di_lnode_t lnode, void *arg)); 175 176 extern void di_node_private_set(di_node_t node, void *data); 177 extern void *di_node_private_get(di_node_t node); 178 extern void di_minor_private_set(di_minor_t minor, void *data); 179 extern void *di_minor_private_get(di_minor_t minor); 180 extern void di_lnode_private_set(di_lnode_t lnode, void *data); 181 extern void *di_lnode_private_get(di_lnode_t lnode); 182 extern void di_link_private_set(di_link_t link, void *data); 183 extern void *di_link_private_get(di_link_t link); 184 185 /* 186 * generic node parameters 187 */ 188 extern char *di_node_name(di_node_t node); 189 extern char *di_bus_addr(di_node_t node); 190 extern char *di_binding_name(di_node_t node); 191 extern int di_compatible_names(di_node_t, char **names); 192 extern int di_instance(di_node_t node); 193 extern int di_nodeid(di_node_t node); 194 extern int di_driver_major(di_node_t node); 195 extern uint_t di_state(di_node_t node); 196 extern ddi_node_state_t di_node_state(di_node_t node); 197 extern ddi_devid_t di_devid(di_node_t node); 198 199 extern char *di_driver_name(di_node_t node); 200 extern uint_t di_driver_ops(di_node_t node); 201 202 extern char *di_devfs_path(di_node_t node); 203 extern char *di_devfs_minor_path(di_minor_t minor); 204 205 extern void di_devfs_path_free(char *path_buf); 206 207 /* 208 * layering data access 209 */ 210 extern di_link_t di_link_next_by_node(di_node_t node, 211 di_link_t link, uint_t endpoint); 212 extern di_link_t di_link_next_by_lnode(di_lnode_t lnode, 213 di_link_t link, uint_t endpoint); 214 extern di_lnode_t di_link_to_lnode(di_link_t link, uint_t endpoint); 215 216 extern di_lnode_t di_lnode_next(di_node_t node, di_lnode_t lnode); 217 extern char *di_lnode_name(di_lnode_t lnode); 218 extern di_node_t di_lnode_devinfo(di_lnode_t lnode); 219 extern int di_lnode_devt(di_lnode_t lnode, dev_t *devt); 220 221 extern int di_link_spectype(di_link_t link); 222 223 /* 224 * minor data access 225 */ 226 extern di_minor_t di_minor_next(di_node_t node, di_minor_t minor); 227 extern di_node_t di_minor_devinfo(di_minor_t minor); 228 extern ddi_minor_type di_minor_type(di_minor_t minor); 229 extern char *di_minor_name(di_minor_t minor); 230 extern dev_t di_minor_devt(di_minor_t minor); 231 extern int di_minor_spectype(di_minor_t minor); 232 extern char *di_minor_nodetype(di_minor_t node); 233 234 /* 235 * Software property access 236 */ 237 extern di_prop_t di_prop_next(di_node_t node, di_prop_t prop); 238 extern dev_t di_prop_devt(di_prop_t prop); 239 extern char *di_prop_name(di_prop_t prop); 240 extern int di_prop_type(di_prop_t prop); 241 extern int di_prop_ints(di_prop_t prop, int **prop_data); 242 extern int di_prop_int64(di_prop_t prop, int64_t **prop_data); 243 extern int di_prop_strings(di_prop_t prop, char **prop_data); 244 extern int di_prop_bytes(di_prop_t prop, uchar_t **prop_data); 245 extern int di_prop_lookup_ints(dev_t dev, di_node_t node, 246 const char *prop_name, int **prop_data); 247 extern int di_prop_lookup_int64(dev_t dev, di_node_t node, 248 const char *prop_name, int64_t **prop_data); 249 extern int di_prop_lookup_strings(dev_t dev, di_node_t node, 250 const char *prop_name, char **prop_data); 251 extern int di_prop_lookup_bytes(dev_t dev, di_node_t node, 252 const char *prop_name, uchar_t **prop_data); 253 254 /* 255 * PROM property access 256 */ 257 extern di_prom_handle_t di_prom_init(void); 258 extern void di_prom_fini(di_prom_handle_t ph); 259 260 extern di_prom_prop_t di_prom_prop_next(di_prom_handle_t ph, di_node_t node, 261 di_prom_prop_t prom_prop); 262 263 extern char *di_prom_prop_name(di_prom_prop_t prom_prop); 264 extern int di_prom_prop_data(di_prom_prop_t prop, uchar_t **prom_prop_data); 265 266 extern int di_prom_prop_lookup_ints(di_prom_handle_t prom, di_node_t node, 267 const char *prom_prop_name, int **prom_prop_data); 268 extern int di_prom_prop_lookup_strings(di_prom_handle_t prom, di_node_t node, 269 const char *prom_prop_name, char **prom_prop_data); 270 extern int di_prom_prop_lookup_bytes(di_prom_handle_t prom, di_node_t node, 271 const char *prom_prop_name, uchar_t **prom_prop_data); 272 273 /* 274 * Private interfaces 275 * 276 * The interfaces and structures below are private to this implementation 277 * of Solaris and are subject to change at any time without notice. 278 * 279 * Applications and drivers using these interfaces will fail 280 * to run on future releases. 281 */ 282 283 extern di_prop_t di_prop_find(dev_t match_dev, di_node_t node, 284 const char *name); 285 286 /* 287 * Interfaces for handling IEEE 1275 and other standardized properties 288 */ 289 290 /* structure for a single slot */ 291 typedef struct di_slot_name { 292 int num; /* corresponding pci device number */ 293 char *name; 294 } di_slot_name_t; 295 296 extern void di_slot_names_free(int count, di_slot_name_t *slot_names); 297 extern int di_slot_names_decode(uchar_t *rawdata, int rawlen, 298 di_slot_name_t **prop_data); 299 extern int di_prop_slot_names(di_prop_t prop, di_slot_name_t **prop_data); 300 extern int di_prom_prop_slot_names(di_prom_prop_t prom_prop, 301 di_slot_name_t **prop_data); 302 extern int di_prop_lookup_slot_names(dev_t dev, di_node_t node, 303 di_slot_name_t **prop_data); 304 extern int di_prom_prop_lookup_slot_names(di_prom_handle_t ph, di_node_t node, 305 di_slot_name_t **prop_data); 306 307 /* 308 * Interfaces for accessing I/O multipathing data 309 */ 310 /* XXX remove di_path_next() after updating NWS consolidation */ 311 extern di_path_t di_path_next(di_node_t node, di_path_t path); 312 extern di_path_t di_path_next_phci(di_node_t node, di_path_t path); 313 extern di_path_t di_path_next_client(di_node_t node, di_path_t path); 314 extern di_path_state_t di_path_state(di_path_t path); 315 extern char *di_path_addr(di_path_t path, char *buf); 316 extern di_node_t di_path_client_node(di_path_t path); 317 extern void di_path_client_path(di_path_t path, char *buf); 318 extern di_node_t di_path_phci_node(di_path_t path); 319 extern void di_path_phci_path(di_path_t path, char *buf); 320 extern di_path_prop_t di_path_prop_next(di_path_t path, di_path_prop_t prop); 321 extern char *di_path_prop_name(di_path_prop_t prop); 322 extern int di_path_prop_type(di_path_prop_t prop); 323 extern int di_path_prop_len(di_path_prop_t prop); 324 extern int di_path_prop_bytes(di_path_prop_t prop, uchar_t **prop_data); 325 extern int di_path_prop_ints(di_path_prop_t prop, int **prop_data); 326 extern int di_path_prop_int64s(di_path_prop_t prop, int64_t **prop_data); 327 extern int di_path_prop_strings(di_path_prop_t prop, char **prop_data); 328 extern int di_path_prop_lookup_bytes(di_path_t path, const char *prop_name, 329 uchar_t **prop_data); 330 extern int di_path_prop_lookup_ints(di_path_t path, const char *prop_name, 331 int **prop_data); 332 extern int di_path_prop_lookup_int64s(di_path_t path, const char *prop_name, 333 int64_t **prop_data); 334 extern int di_path_prop_lookup_strings(di_path_t path, const char *prop_name, 335 char **prop_data); 336 337 338 /* 339 * Interfaces for private data 340 */ 341 extern di_node_t di_init_driver(const char *drv_name, uint_t flag); 342 extern di_node_t di_init_impl(const char *phys_path, uint_t flag, 343 struct di_priv_data *priv_data); 344 345 /* 346 * Prtconf needs to know property lists, raw prop_data, and private data 347 */ 348 extern di_prop_t di_prop_drv_next(di_node_t node, di_prop_t prop); 349 extern di_prop_t di_prop_sys_next(di_node_t node, di_prop_t prop); 350 extern di_prop_t di_prop_global_next(di_node_t node, di_prop_t prop); 351 extern di_prop_t di_prop_hw_next(di_node_t node, di_prop_t prop); 352 353 extern int di_prop_rawdata(di_prop_t prop, uchar_t **prop_data); 354 extern void *di_parent_private_data(di_node_t node); 355 extern void *di_driver_private_data(di_node_t node); 356 357 /* 358 * The value of the dip's devi_flags field 359 */ 360 uint_t di_flags(di_node_t node); 361 362 /* 363 * Types of links for devlink lookup 364 */ 365 #define DI_PRIMARY_LINK 0x01 366 #define DI_SECONDARY_LINK 0x02 367 #define DI_LINK_TYPES 0x03 368 369 /* 370 * Flag for di_devlink_init() 371 */ 372 #define DI_MAKE_LINK 0x01 373 374 /* 375 * Flag for di_devlink_close() 376 */ 377 #define DI_LINK_ERROR 0x01 378 379 /* 380 * For devfsadm synchronous link creation interfaces 381 */ 382 #define DEVFSADM_SYNCH_DOOR ".devfsadm_synch_door" 383 384 /* 385 * devlink create argument 386 */ 387 struct dca_off { 388 uint32_t dca_root; 389 uint32_t dca_minor; 390 uint32_t dca_driver; 391 int dca_error; 392 int dca_flags; 393 char dca_name[PATH_MAX+MAXNAMELEN]; 394 }; 395 396 extern di_devlink_handle_t di_devlink_init(const char *name, uint_t flags); 397 extern int di_devlink_walk(di_devlink_handle_t hdl, const char *re, 398 const char *minor_path, uint_t flags, void *arg, 399 int (*devlink_callback)(di_devlink_t, void *)); 400 extern const char *di_devlink_path(di_devlink_t devlink); 401 extern const char *di_devlink_content(di_devlink_t devlink); 402 extern int di_devlink_type(di_devlink_t devlink); 403 extern di_devlink_t di_devlink_dup(di_devlink_t devlink); 404 extern int di_devlink_free(di_devlink_t devlink); 405 extern int di_devlink_fini(di_devlink_handle_t *hdlp); 406 407 extern di_devlink_handle_t di_devlink_open(const char *root_dir, uint_t flags); 408 extern int di_devlink_close(di_devlink_handle_t *pp, int flag); 409 extern int di_devlink_rm_link(di_devlink_handle_t hdp, const char *link); 410 extern int di_devlink_add_link(di_devlink_handle_t hdp, const char *link, 411 const char *content, int flags); 412 extern int di_devlink_update(di_devlink_handle_t hdp); 413 extern di_devlink_handle_t di_devlink_init_root(const char *root, 414 const char *name, uint_t flags); 415 extern int di_devlink_cache_walk(di_devlink_handle_t hdp, const char *re, 416 const char *path, uint_t flags, void *arg, 417 int (*devlink_callback)(di_devlink_t, void *)); 418 419 /* 420 * Private interfaces for I/O retire 421 */ 422 typedef struct di_retire { 423 void *rt_hdl; 424 void (*rt_abort)(void *hdl, const char *format, ...); 425 void (*rt_debug)(void *hdl, const char *format, ...); 426 } di_retire_t; 427 428 extern int di_retire_device(char *path, di_retire_t *dp, int flags); 429 extern int di_unretire_device(char *path, di_retire_t *dp); 430 extern uint_t di_retired(di_node_t node); 431 432 /* 433 * Private interfaces for /etc/logindevperm 434 */ 435 extern int di_devperm_login(const char *, uid_t, gid_t, void (*)(char *)); 436 extern int di_devperm_logout(const char *); 437 438 /* 439 * Private interface for looking up a node in a snapshot 440 */ 441 extern di_node_t di_lookup_node(di_node_t root, char *path); 442 443 444 /* 445 * Private hotplug interfaces to be used between cfgadm pci plugin and 446 * devfsadm link generator. 447 */ 448 extern char *di_dli_name(char *); 449 extern int di_dli_openr(char *); 450 extern int di_dli_openw(char *); 451 extern void di_dli_close(int); 452 453 /* 454 * Private interface for parsing devname binding info 455 */ 456 extern void di_devname_print_mapinfo(nvlist_t *); 457 extern int di_devname_get_mapinfo(char *, nvlist_t **); 458 extern int di_devname_get_mapent(char *, char *, nvlist_t **); 459 extern int di_devname_action_on_key(nvlist_t *, uint8_t, char *, void *); 460 461 /* 462 * Private interface for parsing path_to_inst binding file 463 */ 464 extern int devfs_parse_binding_file(const char *, 465 int (*)(void *, const char *, int, const char *), void *); 466 extern int devfs_walk_minor_nodes(const char *, 467 int (*)(void *, const char *), void *); 468 469 /* 470 * finddev - alternate readdir to discover only /dev persisted device names 471 */ 472 typedef struct __finddevhdl *finddevhdl_t; 473 474 extern int device_exists(const char *); 475 extern int finddev_readdir(const char *, finddevhdl_t *); 476 extern int finddev_emptydir(const char *); 477 extern void finddev_close(finddevhdl_t); 478 extern const char *finddev_next(finddevhdl_t); 479 480 481 /* 482 * Private interfaces for non-global /dev profile 483 */ 484 typedef struct __di_prof *di_prof_t; 485 486 extern int di_prof_init(const char *mountpt, di_prof_t *); 487 extern void di_prof_fini(di_prof_t); 488 extern int di_prof_commit(di_prof_t); 489 extern int di_prof_add_dev(di_prof_t, const char *); 490 extern int di_prof_add_exclude(di_prof_t, const char *); 491 extern int di_prof_add_symlink(di_prof_t, const char *, const char *); 492 extern int di_prof_add_map(di_prof_t, const char *, const char *); 493 494 /* 495 * Private interfaces for <driver><instance><minor> to path conversion. 496 * NOTE: These interfaces do not require or cause attach. The implementation 497 * uses the kernel instance-tree (/etc/path_to_inst) and the di_devlinks 498 * database information. 499 */ 500 typedef struct __di_dim *di_dim_t; 501 502 extern di_dim_t di_dim_init(); 503 extern void di_dim_fini(di_dim_t); 504 extern char *di_dim_path_devices(di_dim_t, 505 char *drv_name, int instance, char *minor_name); 506 extern char *di_dim_path_dev(di_dim_t, 507 char *drv_name, int instance, char *minor_name); 508 509 510 #ifdef __cplusplus 511 } 512 #endif 513 514 #endif /* _LIBDEVINFO_H */ 515