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$
28 */
29
30#ifndef _DEVINFO_H_INCLUDED
31#define _DEVINFO_H_INCLUDED
32
33#include <sys/cdefs.h>
34#include <sys/types.h>
35#include <sys/bus.h>
36
37typedef __uintptr_t	devinfo_handle_t;
38#define DEVINFO_ROOT_DEVICE	((devinfo_handle_t)0)
39
40typedef enum device_state devinfo_state_t;
41
42struct devinfo_dev {
43	devinfo_handle_t	dd_handle;	/* device handle */
44	devinfo_handle_t	dd_parent;	/* parent handle */
45
46	char			*dd_name;	/* name of device */
47	char			*dd_desc;	/* device description */
48	char			*dd_drivername;	/* name of attached driver*/
49	char			*dd_pnpinfo;	/* pnp info from parent bus */
50	char			*dd_location;	/* Where bus thinks dev at */
51	uint32_t		dd_devflags;	/* API flags */
52	uint16_t		dd_flags;	/* internal dev flags */
53	devinfo_state_t		dd_state;	/* attachment state of dev */
54};
55
56struct devinfo_rman {
57	devinfo_handle_t	dm_handle;	/* resource manager handle */
58
59	rman_res_t		dm_start;	/* resource start */
60	rman_res_t		dm_size;	/* resource size */
61
62	char			*dm_desc;	/* resource description */
63};
64
65struct devinfo_res {
66	devinfo_handle_t	dr_handle;	/* resource handle */
67	devinfo_handle_t	dr_rman;	/* resource manager handle */
68	devinfo_handle_t	dr_device;	/* owning device */
69
70	rman_res_t		dr_start;	/* region start */
71	rman_res_t		dr_size;	/* region size */
72	/* XXX add flags */
73};
74
75__BEGIN_DECLS
76
77/*
78 * Acquire a coherent copy of the kernel's device and resource tables.
79 * This must return success (zero) before any other interfaces will
80 * function.  Sets errno on failure.
81 */
82extern int	devinfo_init(void);
83
84/*
85 * Release the storage associated with the internal copy of the device
86 * and resource tables. devinfo_init must be called before any attempt
87 * is made to use any other interfaces.
88 */
89extern void	devinfo_free(void);
90
91/*
92 * Find a device/resource/resource manager by its handle.
93 */
94extern struct devinfo_dev
95	*devinfo_handle_to_device(devinfo_handle_t handle);
96extern struct devinfo_res
97	*devinfo_handle_to_resource(devinfo_handle_t handle);
98extern struct devinfo_rman
99	*devinfo_handle_to_rman(devinfo_handle_t handle);
100
101/*
102 * Iterate over the children of a device, calling (fn) on each.  If
103 * (fn) returns nonzero, abort the scan and return.
104 */
105extern int
106	devinfo_foreach_device_child(struct devinfo_dev *parent,
107	    int (* fn)(struct devinfo_dev *child, void *arg),
108	    void *arg);
109
110/*
111 * Iterate over all the resources owned by a device, calling (fn) on each.
112 * If (fn) returns nonzero, abort the scan and return.
113 */
114extern int
115	devinfo_foreach_device_resource(struct devinfo_dev *dev,
116	    int (* fn)(struct devinfo_dev *dev,
117	    struct devinfo_res *res, void *arg),
118	    void *arg);
119
120/*
121 * Iterate over all the resources owned by a resource manager, calling (fn)
122 * on each.  If (fn) returns nonzero, abort the scan and return.
123 */
124extern int
125	devinfo_foreach_rman_resource(struct devinfo_rman *rman,
126	    int (* fn)(struct devinfo_res *res, void *arg),
127	    void *arg);
128
129/*
130 * Iterate over all the resource managers, calling (fn) on each.  If (fn)
131 * returns nonzero, abort the scan and return.
132 */
133extern int
134	devinfo_foreach_rman(int (* fn)(struct devinfo_rman *rman, void *arg),
135	    void *arg);
136
137__END_DECLS
138
139#endif /* ! _DEVINFO_H_INCLUDED */
140