devinfo.h revision 75726 
1/*-
2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2000 BSDi
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 *	$FreeBSD: head/lib/libdevinfo/devinfo.h 75726 2001-04-20 05:53:30Z msmith $
28 */
29
30typedef uintptr_t	devinfo_handle_t;
31#define DEVINFO_ROOT_DEVICE	(devinfo_handle_t)0
32
33struct devinfo_dev {
34	devinfo_handle_t	dd_handle;	/* device handle */
35	devinfo_handle_t	dd_parent;	/* parent handle */
36
37	char			*dd_name;	/* name of device */
38	char			*dd_desc;	/* device description */
39	char			*dd_drivername;	/* name of attached driver*/
40};
41
42struct devinfo_rman {
43	devinfo_handle_t	dm_handle;	/* resource manager handle */
44
45	u_long			dm_start;	/* resource start */
46	u_long			dm_size;	/* resource size */
47
48	char			*dm_desc;	/* resource description */
49};
50
51struct devinfo_res {
52	devinfo_handle_t	dr_handle;	/* resource handle */
53	devinfo_handle_t	dr_rman;	/* resource manager handle */
54	devinfo_handle_t	dr_device;	/* owning device */
55
56	u_long			dr_start;	/* region start */
57	u_long			dr_size;	/* region size */
58	/* XXX add flags */
59};
60
61/*
62 * Acquire a coherent copy of the kernel's device and resource tables.
63 * This must return success (zero) before any other interfaces will
64 * function.  Sets errno on failure.
65 */
66extern int	devinfo_init(void);
67
68/*
69 * Release the storage associated with the internal copy of the device
70 * and resource tables. devinfo_init must be called before any attempt
71 * is made to use any other interfaces.
72 */
73extern void	devinfo_free(void);
74
75/*
76 * Find a device/resource/resource manager by its handle.
77 */
78extern struct devinfo_dev
79	*devinfo_handle_to_device(devinfo_handle_t handle);
80extern struct devinfo_res
81	*devinfo_handle_to_resource(devinfo_handle_t handle);
82extern struct devinfo_rman
83	*devinfo_handle_to_rman(devinfo_handle_t handle);
84
85/*
86 * Iterate over the children of a device, calling (fn) on each.  If
87 * (fn) returns nonzero, abort the scan and return.
88 */
89extern int
90	devinfo_foreach_device_child(struct devinfo_dev *parent,
91	    int (* fn)(struct devinfo_dev *child, void *arg),
92	    void *arg);
93
94/*
95 * Iterate over all the resources owned by a device, calling (fn) on each.
96 * If (fn) returns nonzero, abort the scan and return.
97 */
98extern int
99	devinfo_foreach_device_resource(struct devinfo_dev *dev,
100	    int (* fn)(struct devinfo_dev *dev,
101	    struct devinfo_res *res, void *arg),
102	    void *arg);
103
104/*
105 * Iterate over all the resources owned by a resource manager, calling (fn)
106 * on each.  If (fn) returns nonzero, abort the scan and return.
107 */
108extern int
109	devinfo_foreach_rman_resource(struct devinfo_rman *rman,
110	    int (* fn)(struct devinfo_res *res, void *arg),
111	    void *arg);
112
113/*
114 * Iterate over all the resource managers, calling (fn) on each.  If (fn)
115 * returns nonzero, abort the scan and return.
116 */
117extern int
118	devinfo_foreach_rman(int (* fn)(struct devinfo_rman *rman, void *arg),
119	    void *arg);
120