269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * CDDL HEADER START
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * The contents of this file are subject to the terms of the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Common Development and Distribution License (the "License").
269473047d747f7815af570197e4ef7322d3632cEvan Yan * You may not use this file except in compliance with the License.
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
269473047d747f7815af570197e4ef7322d3632cEvan Yan * or http://www.opensolaris.org/os/licensing.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * See the License for the specific language governing permissions
269473047d747f7815af570197e4ef7322d3632cEvan Yan * and limitations under the License.
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * When distributing Covered Code, include this CDDL HEADER in each
269473047d747f7815af570197e4ef7322d3632cEvan Yan * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * If applicable, add the following below this CDDL HEADER, with the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * fields enclosed by brackets "[]" replaced with your own identifying
269473047d747f7815af570197e4ef7322d3632cEvan Yan * information: Portions Copyright [yyyy] [name of copyright owner]
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * CDDL HEADER END
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Use is subject to license terms.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifndef _LIBHOTPLUG_H
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define _LIBHOTPLUG_H
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifdef __cplusplus
269473047d747f7815af570197e4ef7322d3632cEvan Yanextern "C" {
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#include <sys/types.h>
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define node types in hotplug snapshot.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_NODE_NONE 0
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_NODE_DEVICE 1
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_NODE_CONNECTOR 2
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_NODE_PORT 3
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_NODE_USAGE 4
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define flags for hp_init().
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HPINFOUSAGE 0x1
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HPINFOSEARCH 0x2 /* private flag */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define flags for hp_set_state().
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HPFORCE 0x1
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HPQUERY 0x2
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define private flags.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define return values for hp_traverse() callbacks.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_WALK_CONTINUE 0
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_WALK_PRUNECHILD 1
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_WALK_PRUNESIBLING 2
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define HP_WALK_TERMINATE 3
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Define opaque handle to hotplug nodes.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef struct hp_node *hp_node_t;
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Interface prototypes.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yanhp_node_t hp_init(const char *path, const char *connection, uint_t flags);
269473047d747f7815af570197e4ef7322d3632cEvan Yanvoid hp_fini(hp_node_t root);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_traverse(hp_node_t root, void *arg,
269473047d747f7815af570197e4ef7322d3632cEvan Yan int (*hp_callback)(hp_node_t, void *arg));
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_type(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanchar *hp_name(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanchar *hp_usage(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_state(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanchar *hp_description(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yantime_t hp_last_change(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanhp_node_t hp_parent(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanhp_node_t hp_child(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanhp_node_t hp_sibling(hp_node_t node);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_path(hp_node_t node, char *path, char *connection);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_set_state(hp_node_t node, uint_t flags, int state,
269473047d747f7815af570197e4ef7322d3632cEvan Yan hp_node_t *resultsp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_set_private(hp_node_t node, const char *options,
269473047d747f7815af570197e4ef7322d3632cEvan Yan char **resultsp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_get_private(hp_node_t node, const char *options,
269473047d747f7815af570197e4ef7322d3632cEvan Yan char **resultsp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_pack(hp_node_t root, char **bufp, size_t *lenp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint hp_unpack(char *packed_buf, size_t packed_len, hp_node_t *retp);
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifdef __cplusplus
269473047d747f7815af570197e4ef7322d3632cEvan Yan}
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif /* _LIBHOTPLUG_H */