fdtvar.h revision 1.27.2.2 1 1.27.2.2 jdolecek /* $NetBSD: fdtvar.h,v 1.27.2.2 2017/12/03 11:37:01 jdolecek Exp $ */
2 1.27.2.2 jdolecek
3 1.27.2.2 jdolecek /*-
4 1.27.2.2 jdolecek * Copyright (c) 2015 Jared D. McNeill <jmcneill (at) invisible.ca>
5 1.27.2.2 jdolecek * All rights reserved.
6 1.27.2.2 jdolecek *
7 1.27.2.2 jdolecek * Redistribution and use in source and binary forms, with or without
8 1.27.2.2 jdolecek * modification, are permitted provided that the following conditions
9 1.27.2.2 jdolecek * are met:
10 1.27.2.2 jdolecek * 1. Redistributions of source code must retain the above copyright
11 1.27.2.2 jdolecek * notice, this list of conditions and the following disclaimer.
12 1.27.2.2 jdolecek * 2. Redistributions in binary form must reproduce the above copyright
13 1.27.2.2 jdolecek * notice, this list of conditions and the following disclaimer in the
14 1.27.2.2 jdolecek * documentation and/or other materials provided with the distribution.
15 1.27.2.2 jdolecek *
16 1.27.2.2 jdolecek * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 1.27.2.2 jdolecek * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 1.27.2.2 jdolecek * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 1.27.2.2 jdolecek * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 1.27.2.2 jdolecek * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 1.27.2.2 jdolecek * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 1.27.2.2 jdolecek * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 1.27.2.2 jdolecek * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 1.27.2.2 jdolecek * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 1.27.2.2 jdolecek * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 1.27.2.2 jdolecek * SUCH DAMAGE.
27 1.27.2.2 jdolecek */
28 1.27.2.2 jdolecek
29 1.27.2.2 jdolecek #ifndef _DEV_FDT_FDTVAR_H
30 1.27.2.2 jdolecek #define _DEV_FDT_FDTVAR_H
31 1.27.2.2 jdolecek
32 1.27.2.2 jdolecek #include <sys/types.h>
33 1.27.2.2 jdolecek #include <sys/bus.h>
34 1.27.2.2 jdolecek #include <sys/termios.h>
35 1.27.2.2 jdolecek
36 1.27.2.2 jdolecek #include <dev/i2c/i2cvar.h>
37 1.27.2.2 jdolecek #include <dev/clk/clk.h>
38 1.27.2.2 jdolecek
39 1.27.2.2 jdolecek #include <dev/clock_subr.h>
40 1.27.2.2 jdolecek
41 1.27.2.2 jdolecek #include <dev/ofw/openfirm.h>
42 1.27.2.2 jdolecek
43 1.27.2.2 jdolecek struct fdt_attach_args {
44 1.27.2.2 jdolecek const char *faa_name;
45 1.27.2.2 jdolecek bus_space_tag_t faa_bst;
46 1.27.2.2 jdolecek bus_space_tag_t faa_a4x_bst;
47 1.27.2.2 jdolecek bus_dma_tag_t faa_dmat;
48 1.27.2.2 jdolecek int faa_phandle;
49 1.27.2.2 jdolecek int faa_quiet;
50 1.27.2.2 jdolecek };
51 1.27.2.2 jdolecek
52 1.27.2.2 jdolecek /* flags for fdtbus_intr_establish */
53 1.27.2.2 jdolecek #define FDT_INTR_MPSAFE __BIT(0)
54 1.27.2.2 jdolecek
55 1.27.2.2 jdolecek struct fdtbus_interrupt_controller_func {
56 1.27.2.2 jdolecek void * (*establish)(device_t, u_int *, int, int,
57 1.27.2.2 jdolecek int (*)(void *), void *);
58 1.27.2.2 jdolecek void (*disestablish)(device_t, void *);
59 1.27.2.2 jdolecek bool (*intrstr)(device_t, u_int *, char *, size_t);
60 1.27.2.2 jdolecek };
61 1.27.2.2 jdolecek
62 1.27.2.2 jdolecek struct fdtbus_i2c_controller_func {
63 1.27.2.2 jdolecek i2c_tag_t (*get_tag)(device_t);
64 1.27.2.2 jdolecek };
65 1.27.2.2 jdolecek
66 1.27.2.2 jdolecek struct fdtbus_gpio_controller;
67 1.27.2.2 jdolecek
68 1.27.2.2 jdolecek struct fdtbus_gpio_pin {
69 1.27.2.2 jdolecek struct fdtbus_gpio_controller *gp_gc;
70 1.27.2.2 jdolecek void *gp_priv;
71 1.27.2.2 jdolecek };
72 1.27.2.2 jdolecek
73 1.27.2.2 jdolecek struct fdtbus_gpio_controller_func {
74 1.27.2.2 jdolecek void * (*acquire)(device_t, const void *, size_t, int);
75 1.27.2.2 jdolecek void (*release)(device_t, void *);
76 1.27.2.2 jdolecek int (*read)(device_t, void *, bool);
77 1.27.2.2 jdolecek void (*write)(device_t, void *, int, bool);
78 1.27.2.2 jdolecek };
79 1.27.2.2 jdolecek
80 1.27.2.2 jdolecek struct fdtbus_pinctrl_controller;
81 1.27.2.2 jdolecek
82 1.27.2.2 jdolecek struct fdtbus_pinctrl_pin {
83 1.27.2.2 jdolecek struct fdtbus_pinctrl_controller *pp_pc;
84 1.27.2.2 jdolecek void *pp_priv;
85 1.27.2.2 jdolecek };
86 1.27.2.2 jdolecek
87 1.27.2.2 jdolecek struct fdtbus_pinctrl_controller_func {
88 1.27.2.2 jdolecek int (*set_config)(device_t, const void *, size_t);
89 1.27.2.2 jdolecek };
90 1.27.2.2 jdolecek
91 1.27.2.2 jdolecek struct fdtbus_regulator_controller;
92 1.27.2.2 jdolecek
93 1.27.2.2 jdolecek struct fdtbus_regulator {
94 1.27.2.2 jdolecek struct fdtbus_regulator_controller *reg_rc;
95 1.27.2.2 jdolecek };
96 1.27.2.2 jdolecek
97 1.27.2.2 jdolecek struct fdtbus_regulator_controller_func {
98 1.27.2.2 jdolecek int (*acquire)(device_t);
99 1.27.2.2 jdolecek void (*release)(device_t);
100 1.27.2.2 jdolecek int (*enable)(device_t, bool);
101 1.27.2.2 jdolecek int (*set_voltage)(device_t, u_int, u_int);
102 1.27.2.2 jdolecek int (*get_voltage)(device_t, u_int *);
103 1.27.2.2 jdolecek };
104 1.27.2.2 jdolecek
105 1.27.2.2 jdolecek struct fdtbus_clock_controller_func {
106 1.27.2.2 jdolecek struct clk * (*decode)(device_t, const void *, size_t);
107 1.27.2.2 jdolecek };
108 1.27.2.2 jdolecek
109 1.27.2.2 jdolecek struct fdtbus_reset_controller;
110 1.27.2.2 jdolecek
111 1.27.2.2 jdolecek struct fdtbus_reset {
112 1.27.2.2 jdolecek struct fdtbus_reset_controller *rst_rc;
113 1.27.2.2 jdolecek void *rst_priv;
114 1.27.2.2 jdolecek };
115 1.27.2.2 jdolecek
116 1.27.2.2 jdolecek struct fdtbus_reset_controller_func {
117 1.27.2.2 jdolecek void * (*acquire)(device_t, const void *, size_t);
118 1.27.2.2 jdolecek void (*release)(device_t, void *);
119 1.27.2.2 jdolecek int (*reset_assert)(device_t, void *);
120 1.27.2.2 jdolecek int (*reset_deassert)(device_t, void *);
121 1.27.2.2 jdolecek };
122 1.27.2.2 jdolecek
123 1.27.2.2 jdolecek struct fdtbus_dma_controller;
124 1.27.2.2 jdolecek
125 1.27.2.2 jdolecek struct fdtbus_dma {
126 1.27.2.2 jdolecek struct fdtbus_dma_controller *dma_dc;
127 1.27.2.2 jdolecek void *dma_priv;
128 1.27.2.2 jdolecek };
129 1.27.2.2 jdolecek
130 1.27.2.2 jdolecek enum fdtbus_dma_dir {
131 1.27.2.2 jdolecek FDT_DMA_READ, /* device -> memory */
132 1.27.2.2 jdolecek FDT_DMA_WRITE /* memory -> device */
133 1.27.2.2 jdolecek };
134 1.27.2.2 jdolecek
135 1.27.2.2 jdolecek struct fdtbus_dma_opt {
136 1.27.2.2 jdolecek int opt_bus_width; /* Bus width */
137 1.27.2.2 jdolecek int opt_burst_len; /* Burst length */
138 1.27.2.2 jdolecek int opt_swap; /* Enable data swapping */
139 1.27.2.2 jdolecek int opt_dblbuf; /* Enable double buffering */
140 1.27.2.2 jdolecek int opt_wrap_len; /* Address wrap-around window */
141 1.27.2.2 jdolecek };
142 1.27.2.2 jdolecek
143 1.27.2.2 jdolecek struct fdtbus_dma_req {
144 1.27.2.2 jdolecek bus_dma_segment_t *dreq_segs; /* Memory */
145 1.27.2.2 jdolecek int dreq_nsegs;
146 1.27.2.2 jdolecek
147 1.27.2.2 jdolecek bus_addr_t dreq_dev_phys; /* Device */
148 1.27.2.2 jdolecek int dreq_sel; /* Device selector */
149 1.27.2.2 jdolecek
150 1.27.2.2 jdolecek enum fdtbus_dma_dir dreq_dir; /* Transfer direction */
151 1.27.2.2 jdolecek
152 1.27.2.2 jdolecek int dreq_block_irq; /* Enable IRQ at end of block */
153 1.27.2.2 jdolecek int dreq_block_multi; /* Enable multiple block transfers */
154 1.27.2.2 jdolecek int dreq_flow; /* Enable flow control */
155 1.27.2.2 jdolecek
156 1.27.2.2 jdolecek struct fdtbus_dma_opt dreq_mem_opt; /* Memory options */
157 1.27.2.2 jdolecek struct fdtbus_dma_opt dreq_dev_opt; /* Device options */
158 1.27.2.2 jdolecek };
159 1.27.2.2 jdolecek
160 1.27.2.2 jdolecek struct fdtbus_dma_controller_func {
161 1.27.2.2 jdolecek void * (*acquire)(device_t, const void *, size_t,
162 1.27.2.2 jdolecek void (*)(void *), void *);
163 1.27.2.2 jdolecek void (*release)(device_t, void *);
164 1.27.2.2 jdolecek int (*transfer)(device_t, void *, struct fdtbus_dma_req *);
165 1.27.2.2 jdolecek void (*halt)(device_t, void *);
166 1.27.2.2 jdolecek };
167 1.27.2.2 jdolecek
168 1.27.2.2 jdolecek struct fdtbus_power_controller;
169 1.27.2.2 jdolecek
170 1.27.2.2 jdolecek struct fdtbus_power_controller_func {
171 1.27.2.2 jdolecek void (*reset)(device_t);
172 1.27.2.2 jdolecek void (*poweroff)(device_t);
173 1.27.2.2 jdolecek };
174 1.27.2.2 jdolecek
175 1.27.2.2 jdolecek struct fdtbus_phy_controller;
176 1.27.2.2 jdolecek
177 1.27.2.2 jdolecek struct fdtbus_phy {
178 1.27.2.2 jdolecek struct fdtbus_phy_controller *phy_pc;
179 1.27.2.2 jdolecek void *phy_priv;
180 1.27.2.2 jdolecek };
181 1.27.2.2 jdolecek
182 1.27.2.2 jdolecek struct fdtbus_phy_controller_func {
183 1.27.2.2 jdolecek void * (*acquire)(device_t, const void *, size_t);
184 1.27.2.2 jdolecek void (*release)(device_t, void *);
185 1.27.2.2 jdolecek int (*enable)(device_t, void *, bool);
186 1.27.2.2 jdolecek };
187 1.27.2.2 jdolecek
188 1.27.2.2 jdolecek struct fdtbus_mmc_pwrseq;
189 1.27.2.2 jdolecek
190 1.27.2.2 jdolecek struct fdtbus_mmc_pwrseq_func {
191 1.27.2.2 jdolecek void (*pre_power_on)(device_t);
192 1.27.2.2 jdolecek void (*post_power_on)(device_t);
193 1.27.2.2 jdolecek void (*power_off)(device_t);
194 1.27.2.2 jdolecek void (*reset)(device_t);
195 1.27.2.2 jdolecek };
196 1.27.2.2 jdolecek
197 1.27.2.2 jdolecek struct fdt_console {
198 1.27.2.2 jdolecek int (*match)(int);
199 1.27.2.2 jdolecek void (*consinit)(struct fdt_attach_args *, u_int);
200 1.27.2.2 jdolecek };
201 1.27.2.2 jdolecek
202 1.27.2.2 jdolecek struct fdt_console_info {
203 1.27.2.2 jdolecek const struct fdt_console *ops;
204 1.27.2.2 jdolecek };
205 1.27.2.2 jdolecek
206 1.27.2.2 jdolecek #define _FDT_CONSOLE_REGISTER(name) \
207 1.27.2.2 jdolecek __link_set_add_rodata(fdt_consoles, __CONCAT(name,_consinfo));
208 1.27.2.2 jdolecek
209 1.27.2.2 jdolecek #define FDT_CONSOLE(_name, _ops) \
210 1.27.2.2 jdolecek static const struct fdt_console_info __CONCAT(_name,_consinfo) = { \
211 1.27.2.2 jdolecek .ops = (_ops) \
212 1.27.2.2 jdolecek }; \
213 1.27.2.2 jdolecek _FDT_CONSOLE_REGISTER(_name)
214 1.27.2.2 jdolecek
215 1.27.2.2 jdolecek TAILQ_HEAD(fdt_conslist, fdt_console_info);
216 1.27.2.2 jdolecek
217 1.27.2.2 jdolecek int fdtbus_register_interrupt_controller(device_t, int,
218 1.27.2.2 jdolecek const struct fdtbus_interrupt_controller_func *);
219 1.27.2.2 jdolecek int fdtbus_register_i2c_controller(device_t, int,
220 1.27.2.2 jdolecek const struct fdtbus_i2c_controller_func *);
221 1.27.2.2 jdolecek int fdtbus_register_gpio_controller(device_t, int,
222 1.27.2.2 jdolecek const struct fdtbus_gpio_controller_func *);
223 1.27.2.2 jdolecek int fdtbus_register_pinctrl_config(device_t, int,
224 1.27.2.2 jdolecek const struct fdtbus_pinctrl_controller_func *);
225 1.27.2.2 jdolecek int fdtbus_register_regulator_controller(device_t, int,
226 1.27.2.2 jdolecek const struct fdtbus_regulator_controller_func *);
227 1.27.2.2 jdolecek int fdtbus_register_clock_controller(device_t, int,
228 1.27.2.2 jdolecek const struct fdtbus_clock_controller_func *);
229 1.27.2.2 jdolecek int fdtbus_register_reset_controller(device_t, int,
230 1.27.2.2 jdolecek const struct fdtbus_reset_controller_func *);
231 1.27.2.2 jdolecek int fdtbus_register_dma_controller(device_t, int,
232 1.27.2.2 jdolecek const struct fdtbus_dma_controller_func *);
233 1.27.2.2 jdolecek int fdtbus_register_power_controller(device_t, int,
234 1.27.2.2 jdolecek const struct fdtbus_power_controller_func *);
235 1.27.2.2 jdolecek int fdtbus_register_phy_controller(device_t, int,
236 1.27.2.2 jdolecek const struct fdtbus_phy_controller_func *);
237 1.27.2.2 jdolecek int fdtbus_register_mmc_pwrseq(device_t, int,
238 1.27.2.2 jdolecek const struct fdtbus_mmc_pwrseq_func *);
239 1.27.2.2 jdolecek
240 1.27.2.2 jdolecek int fdtbus_get_reg(int, u_int, bus_addr_t *, bus_size_t *);
241 1.27.2.2 jdolecek int fdtbus_get_reg_byname(int, const char *, bus_addr_t *,
242 1.27.2.2 jdolecek bus_size_t *);
243 1.27.2.2 jdolecek int fdtbus_get_reg64(int, u_int, uint64_t *, uint64_t *);
244 1.27.2.2 jdolecek int fdtbus_get_phandle(int, const char *);
245 1.27.2.2 jdolecek int fdtbus_get_phandle_from_native(int);
246 1.27.2.2 jdolecek i2c_tag_t fdtbus_get_i2c_tag(int);
247 1.27.2.2 jdolecek void * fdtbus_intr_establish(int, u_int, int, int,
248 1.27.2.2 jdolecek int (*func)(void *), void *arg);
249 1.27.2.2 jdolecek void fdtbus_intr_disestablish(int, void *);
250 1.27.2.2 jdolecek bool fdtbus_intr_str(int, u_int, char *, size_t);
251 1.27.2.2 jdolecek struct fdtbus_gpio_pin *fdtbus_gpio_acquire(int, const char *, int);
252 1.27.2.2 jdolecek struct fdtbus_gpio_pin *fdtbus_gpio_acquire_index(int, const char *, int, int);
253 1.27.2.2 jdolecek void fdtbus_gpio_release(struct fdtbus_gpio_pin *);
254 1.27.2.2 jdolecek int fdtbus_gpio_read(struct fdtbus_gpio_pin *);
255 1.27.2.2 jdolecek void fdtbus_gpio_write(struct fdtbus_gpio_pin *, int);
256 1.27.2.2 jdolecek int fdtbus_gpio_read_raw(struct fdtbus_gpio_pin *);
257 1.27.2.2 jdolecek void fdtbus_gpio_write_raw(struct fdtbus_gpio_pin *, int);
258 1.27.2.2 jdolecek void fdtbus_pinctrl_configure(void);
259 1.27.2.2 jdolecek int fdtbus_pinctrl_set_config_index(int, u_int);
260 1.27.2.2 jdolecek int fdtbus_pinctrl_set_config(int, const char *);
261 1.27.2.2 jdolecek struct fdtbus_regulator *fdtbus_regulator_acquire(int, const char *);
262 1.27.2.2 jdolecek void fdtbus_regulator_release(struct fdtbus_regulator *);
263 1.27.2.2 jdolecek int fdtbus_regulator_enable(struct fdtbus_regulator *);
264 1.27.2.2 jdolecek int fdtbus_regulator_disable(struct fdtbus_regulator *);
265 1.27.2.2 jdolecek int fdtbus_regulator_set_voltage(struct fdtbus_regulator *,
266 1.27.2.2 jdolecek u_int, u_int);
267 1.27.2.2 jdolecek int fdtbus_regulator_get_voltage(struct fdtbus_regulator *,
268 1.27.2.2 jdolecek u_int *);
269 1.27.2.2 jdolecek
270 1.27.2.2 jdolecek struct fdtbus_dma *fdtbus_dma_get(int, const char *, void (*)(void *), void *);
271 1.27.2.2 jdolecek struct fdtbus_dma *fdtbus_dma_get_index(int, u_int, void (*)(void *),
272 1.27.2.2 jdolecek void *);
273 1.27.2.2 jdolecek void fdtbus_dma_put(struct fdtbus_dma *);
274 1.27.2.2 jdolecek int fdtbus_dma_transfer(struct fdtbus_dma *,
275 1.27.2.2 jdolecek struct fdtbus_dma_req *);
276 1.27.2.2 jdolecek void fdtbus_dma_halt(struct fdtbus_dma *);
277 1.27.2.2 jdolecek
278 1.27.2.2 jdolecek struct clk * fdtbus_clock_get(int, const char *);
279 1.27.2.2 jdolecek struct clk * fdtbus_clock_get_index(int, u_int);
280 1.27.2.2 jdolecek
281 1.27.2.2 jdolecek struct fdtbus_reset *fdtbus_reset_get(int, const char *);
282 1.27.2.2 jdolecek struct fdtbus_reset *fdtbus_reset_get_index(int, u_int);
283 1.27.2.2 jdolecek void fdtbus_reset_put(struct fdtbus_reset *);
284 1.27.2.2 jdolecek int fdtbus_reset_assert(struct fdtbus_reset *);
285 1.27.2.2 jdolecek int fdtbus_reset_deassert(struct fdtbus_reset *);
286 1.27.2.2 jdolecek
287 1.27.2.2 jdolecek struct fdtbus_phy *fdtbus_phy_get(int, const char *);
288 1.27.2.2 jdolecek struct fdtbus_phy *fdtbus_phy_get_index(int, u_int);
289 1.27.2.2 jdolecek void fdtbus_phy_put(struct fdtbus_phy *);
290 1.27.2.2 jdolecek int fdtbus_phy_enable(struct fdtbus_phy *, bool);
291 1.27.2.2 jdolecek
292 1.27.2.2 jdolecek struct fdtbus_mmc_pwrseq *fdtbus_mmc_pwrseq_get(int);
293 1.27.2.2 jdolecek void fdtbus_mmc_pwrseq_pre_power_on(struct fdtbus_mmc_pwrseq *);
294 1.27.2.2 jdolecek void fdtbus_mmc_pwrseq_post_power_on(struct fdtbus_mmc_pwrseq *);
295 1.27.2.2 jdolecek void fdtbus_mmc_pwrseq_power_off(struct fdtbus_mmc_pwrseq *);
296 1.27.2.2 jdolecek void fdtbus_mmc_pwrseq_reset(struct fdtbus_mmc_pwrseq *);
297 1.27.2.2 jdolecek
298 1.27.2.2 jdolecek int fdtbus_todr_attach(device_t, int, todr_chip_handle_t);
299 1.27.2.2 jdolecek
300 1.27.2.2 jdolecek void fdtbus_power_reset(void);
301 1.27.2.2 jdolecek void fdtbus_power_poweroff(void);
302 1.27.2.2 jdolecek
303 1.27.2.2 jdolecek bool fdtbus_set_data(const void *);
304 1.27.2.2 jdolecek const void * fdtbus_get_data(void);
305 1.27.2.2 jdolecek int fdtbus_phandle2offset(int);
306 1.27.2.2 jdolecek int fdtbus_offset2phandle(int);
307 1.27.2.2 jdolecek bool fdtbus_get_path(int, char *, size_t);
308 1.27.2.2 jdolecek
309 1.27.2.2 jdolecek const struct fdt_console *fdtbus_get_console(void);
310 1.27.2.2 jdolecek
311 1.27.2.2 jdolecek const char * fdtbus_get_stdout_path(void);
312 1.27.2.2 jdolecek int fdtbus_get_stdout_phandle(void);
313 1.27.2.2 jdolecek int fdtbus_get_stdout_speed(void);
314 1.27.2.2 jdolecek tcflag_t fdtbus_get_stdout_flags(void);
315 1.27.2.2 jdolecek
316 1.27.2.2 jdolecek bool fdtbus_status_okay(int);
317 1.27.2.2 jdolecek
318 1.27.2.2 jdolecek const void * fdtbus_get_prop(int, const char *, int *);
319 1.27.2.2 jdolecek const char * fdtbus_get_string(int, const char *);
320 1.27.2.2 jdolecek const char * fdtbus_get_string_index(int, const char *, u_int);
321 1.27.2.2 jdolecek
322 1.27.2.2 jdolecek int fdtbus_print(void *, const char *);
323 1.27.2.2 jdolecek
324 1.27.2.2 jdolecek #endif /* _DEV_FDT_FDTVAR_H */
325