subr_device.c revision 1.4 1 1.4 thorpej /* $NetBSD: subr_device.c,v 1.4 2021/01/28 15:53:46 thorpej Exp $ */
2 1.2 pooka
3 1.2 pooka /*
4 1.2 pooka * Copyright (c) 2006 The NetBSD Foundation, Inc.
5 1.2 pooka * All rights reserved.
6 1.2 pooka *
7 1.2 pooka * Redistribution and use in source and binary forms, with or without
8 1.2 pooka * modification, are permitted provided that the following conditions
9 1.2 pooka * are met:
10 1.2 pooka * 1. Redistributions of source code must retain the above copyright
11 1.2 pooka * notice, this list of conditions and the following disclaimer.
12 1.2 pooka * 2. Redistributions in binary form must reproduce the above copyright
13 1.2 pooka * notice, this list of conditions and the following disclaimer in the
14 1.2 pooka * documentation and/or other materials provided with the distribution.
15 1.2 pooka *
16 1.2 pooka * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 1.2 pooka * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 1.2 pooka * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 1.2 pooka * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 1.2 pooka * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 1.2 pooka * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 1.2 pooka * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 1.2 pooka * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 1.2 pooka * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 1.2 pooka * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 1.2 pooka * POSSIBILITY OF SUCH DAMAGE.
27 1.2 pooka */
28 1.2 pooka
29 1.2 pooka #include <sys/cdefs.h>
30 1.4 thorpej __KERNEL_RCSID(0, "$NetBSD: subr_device.c,v 1.4 2021/01/28 15:53:46 thorpej Exp $");
31 1.2 pooka
32 1.2 pooka #include <sys/param.h>
33 1.2 pooka #include <sys/device.h>
34 1.2 pooka #include <sys/systm.h>
35 1.2 pooka
36 1.3 pooka /* Root device. */
37 1.3 pooka device_t root_device;
38 1.3 pooka
39 1.2 pooka /*
40 1.2 pooka * Accessor functions for the device_t type.
41 1.2 pooka */
42 1.2 pooka devclass_t
43 1.2 pooka device_class(device_t dev)
44 1.2 pooka {
45 1.2 pooka
46 1.2 pooka return dev->dv_class;
47 1.2 pooka }
48 1.2 pooka
49 1.2 pooka cfdata_t
50 1.2 pooka device_cfdata(device_t dev)
51 1.2 pooka {
52 1.2 pooka
53 1.2 pooka return dev->dv_cfdata;
54 1.2 pooka }
55 1.2 pooka
56 1.2 pooka cfdriver_t
57 1.2 pooka device_cfdriver(device_t dev)
58 1.2 pooka {
59 1.2 pooka
60 1.2 pooka return dev->dv_cfdriver;
61 1.2 pooka }
62 1.2 pooka
63 1.2 pooka cfattach_t
64 1.2 pooka device_cfattach(device_t dev)
65 1.2 pooka {
66 1.2 pooka
67 1.2 pooka return dev->dv_cfattach;
68 1.2 pooka }
69 1.2 pooka
70 1.2 pooka int
71 1.2 pooka device_unit(device_t dev)
72 1.2 pooka {
73 1.2 pooka
74 1.2 pooka return dev->dv_unit;
75 1.2 pooka }
76 1.2 pooka
77 1.2 pooka const char *
78 1.2 pooka device_xname(device_t dev)
79 1.2 pooka {
80 1.2 pooka
81 1.2 pooka return dev->dv_xname;
82 1.2 pooka }
83 1.2 pooka
84 1.2 pooka device_t
85 1.2 pooka device_parent(device_t dev)
86 1.2 pooka {
87 1.2 pooka
88 1.2 pooka return dev->dv_parent;
89 1.2 pooka }
90 1.2 pooka
91 1.2 pooka bool
92 1.2 pooka device_activation(device_t dev, devact_level_t level)
93 1.2 pooka {
94 1.2 pooka int active_flags;
95 1.2 pooka
96 1.2 pooka active_flags = DVF_ACTIVE;
97 1.2 pooka switch (level) {
98 1.2 pooka case DEVACT_LEVEL_FULL:
99 1.2 pooka active_flags |= DVF_CLASS_SUSPENDED;
100 1.2 pooka /*FALLTHROUGH*/
101 1.2 pooka case DEVACT_LEVEL_DRIVER:
102 1.2 pooka active_flags |= DVF_DRIVER_SUSPENDED;
103 1.2 pooka /*FALLTHROUGH*/
104 1.2 pooka case DEVACT_LEVEL_BUS:
105 1.2 pooka active_flags |= DVF_BUS_SUSPENDED;
106 1.2 pooka break;
107 1.2 pooka }
108 1.2 pooka
109 1.2 pooka return (dev->dv_flags & active_flags) == DVF_ACTIVE;
110 1.2 pooka }
111 1.2 pooka
112 1.2 pooka bool
113 1.2 pooka device_is_active(device_t dev)
114 1.2 pooka {
115 1.2 pooka int active_flags;
116 1.2 pooka
117 1.2 pooka active_flags = DVF_ACTIVE;
118 1.2 pooka active_flags |= DVF_CLASS_SUSPENDED;
119 1.2 pooka active_flags |= DVF_DRIVER_SUSPENDED;
120 1.2 pooka active_flags |= DVF_BUS_SUSPENDED;
121 1.2 pooka
122 1.2 pooka return (dev->dv_flags & active_flags) == DVF_ACTIVE;
123 1.2 pooka }
124 1.2 pooka
125 1.2 pooka bool
126 1.2 pooka device_is_enabled(device_t dev)
127 1.2 pooka {
128 1.2 pooka return (dev->dv_flags & DVF_ACTIVE) == DVF_ACTIVE;
129 1.2 pooka }
130 1.2 pooka
131 1.2 pooka bool
132 1.2 pooka device_has_power(device_t dev)
133 1.2 pooka {
134 1.2 pooka int active_flags;
135 1.2 pooka
136 1.2 pooka active_flags = DVF_ACTIVE | DVF_BUS_SUSPENDED;
137 1.2 pooka
138 1.2 pooka return (dev->dv_flags & active_flags) == DVF_ACTIVE;
139 1.2 pooka }
140 1.2 pooka
141 1.2 pooka int
142 1.2 pooka device_locator(device_t dev, u_int locnum)
143 1.2 pooka {
144 1.2 pooka
145 1.2 pooka KASSERT(dev->dv_locators != NULL);
146 1.2 pooka return dev->dv_locators[locnum];
147 1.2 pooka }
148 1.2 pooka
149 1.2 pooka void *
150 1.2 pooka device_private(device_t dev)
151 1.2 pooka {
152 1.2 pooka
153 1.2 pooka /*
154 1.2 pooka * The reason why device_private(NULL) is allowed is to simplify the
155 1.2 pooka * work of a lot of userspace request handlers (i.e., c/bdev
156 1.2 pooka * handlers) which grab cfdriver_t->cd_units[n].
157 1.2 pooka * It avoids having them test for it to be NULL and only then calling
158 1.2 pooka * device_private.
159 1.2 pooka */
160 1.2 pooka return dev == NULL ? NULL : dev->dv_private;
161 1.2 pooka }
162 1.2 pooka
163 1.2 pooka prop_dictionary_t
164 1.2 pooka device_properties(device_t dev)
165 1.2 pooka {
166 1.2 pooka
167 1.2 pooka return dev->dv_properties;
168 1.2 pooka }
169 1.2 pooka
170 1.2 pooka /*
171 1.2 pooka * device_is_a:
172 1.2 pooka *
173 1.2 pooka * Returns true if the device is an instance of the specified
174 1.2 pooka * driver.
175 1.2 pooka */
176 1.2 pooka bool
177 1.2 pooka device_is_a(device_t dev, const char *dname)
178 1.2 pooka {
179 1.4 thorpej if (dev == NULL || dev->dv_cfdriver == NULL) {
180 1.4 thorpej return false;
181 1.4 thorpej }
182 1.2 pooka
183 1.2 pooka return strcmp(dev->dv_cfdriver->cd_name, dname) == 0;
184 1.2 pooka }
185