fdtvar.h revision 1.7.4.1 1 /* $NetBSD: fdtvar.h,v 1.7.4.1 2017/04/21 16:53:45 bouyer Exp $ */
2
3 /*-
4 * Copyright (c) 2015 Jared D. McNeill <jmcneill (at) invisible.ca>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #ifndef _DEV_FDT_FDTVAR_H
30 #define _DEV_FDT_FDTVAR_H
31
32 #include <sys/types.h>
33 #include <sys/bus.h>
34
35 #include <dev/i2c/i2cvar.h>
36 #include <dev/clk/clk.h>
37
38 #include <dev/ofw/openfirm.h>
39
40 struct fdt_attach_args {
41 const char *faa_name;
42 bus_space_tag_t faa_bst;
43 bus_space_tag_t faa_a4x_bst;
44 bus_dma_tag_t faa_dmat;
45 int faa_phandle;
46 };
47
48 /* flags for fdtbus_intr_establish */
49 #define FDT_INTR_MPSAFE __BIT(0)
50
51 struct fdtbus_interrupt_controller_func {
52 void * (*establish)(device_t, u_int *, int, int,
53 int (*)(void *), void *);
54 void (*disestablish)(device_t, void *);
55 bool (*intrstr)(device_t, u_int *, char *, size_t);
56 };
57
58 struct fdtbus_i2c_controller_func {
59 i2c_tag_t (*get_tag)(device_t);
60 };
61
62 struct fdtbus_gpio_controller;
63
64 struct fdtbus_gpio_pin {
65 struct fdtbus_gpio_controller *gp_gc;
66 void *gp_priv;
67 };
68
69 struct fdtbus_gpio_controller_func {
70 void * (*acquire)(device_t, const void *, size_t, int);
71 void (*release)(device_t, void *);
72 int (*read)(device_t, void *, bool);
73 void (*write)(device_t, void *, int, bool);
74 };
75
76 struct fdtbus_pinctrl_controller;
77
78 struct fdtbus_pinctrl_pin {
79 struct fdtbus_pinctrl_controller *pp_pc;
80 void *pp_priv;
81 };
82
83 struct fdtbus_pinctrl_controller_func {
84 int (*set_config)(void *);
85 };
86
87 struct fdtbus_regulator_controller;
88
89 struct fdtbus_regulator {
90 struct fdtbus_regulator_controller *reg_rc;
91 };
92
93 struct fdtbus_regulator_controller_func {
94 int (*acquire)(device_t);
95 void (*release)(device_t);
96 int (*enable)(device_t, bool);
97 };
98
99 struct fdtbus_clock_controller_func {
100 struct clk * (*decode)(device_t, const void *, size_t);
101 };
102
103 struct fdtbus_reset_controller;
104
105 struct fdtbus_reset {
106 struct fdtbus_reset_controller *rst_rc;
107 void *rst_priv;
108 };
109
110 struct fdtbus_reset_controller_func {
111 void * (*acquire)(device_t, const void *, size_t);
112 void (*release)(device_t, void *);
113 int (*reset_assert)(device_t, void *);
114 int (*reset_deassert)(device_t, void *);
115 };
116
117 int fdtbus_register_interrupt_controller(device_t, int,
118 const struct fdtbus_interrupt_controller_func *);
119 int fdtbus_register_i2c_controller(device_t, int,
120 const struct fdtbus_i2c_controller_func *);
121 int fdtbus_register_gpio_controller(device_t, int,
122 const struct fdtbus_gpio_controller_func *);
123 int fdtbus_register_pinctrl_config(void *, int,
124 const struct fdtbus_pinctrl_controller_func *);
125 int fdtbus_register_regulator_controller(device_t, int,
126 const struct fdtbus_regulator_controller_func *);
127 int fdtbus_register_clock_controller(device_t, int,
128 const struct fdtbus_clock_controller_func *);
129 int fdtbus_register_reset_controller(device_t, int,
130 const struct fdtbus_reset_controller_func *);
131
132 int fdtbus_get_reg(int, u_int, bus_addr_t *, bus_size_t *);
133 int fdtbus_get_phandle(int, const char *);
134 int fdtbus_get_phandle_from_native(int);
135 i2c_tag_t fdtbus_get_i2c_tag(int);
136 void * fdtbus_intr_establish(int, u_int, int, int,
137 int (*func)(void *), void *arg);
138 void fdtbus_intr_disestablish(int, void *);
139 bool fdtbus_intr_str(int, u_int, char *, size_t);
140 struct fdtbus_gpio_pin *fdtbus_gpio_acquire(int, const char *, int);
141 void fdtbus_gpio_release(struct fdtbus_gpio_pin *);
142 int fdtbus_gpio_read(struct fdtbus_gpio_pin *);
143 void fdtbus_gpio_write(struct fdtbus_gpio_pin *, int);
144 int fdtbus_gpio_read_raw(struct fdtbus_gpio_pin *);
145 void fdtbus_gpio_write_raw(struct fdtbus_gpio_pin *, int);
146 int fdtbus_pinctrl_set_config_index(int, u_int);
147 int fdtbus_pinctrl_set_config(int, const char *);
148 struct fdtbus_regulator *fdtbus_regulator_acquire(int, const char *);
149 void fdtbus_regulator_release(struct fdtbus_regulator *);
150 int fdtbus_regulator_enable(struct fdtbus_regulator *);
151 int fdtbus_regulator_disable(struct fdtbus_regulator *);
152
153 struct clk * fdtbus_clock_get(int, const char *);
154 struct clk * fdtbus_clock_get_index(int, u_int);
155
156 struct fdtbus_reset *fdtbus_reset_get(int, const char *);
157 struct fdtbus_reset *fdtbus_reset_get_index(int, u_int);
158 void fdtbus_reset_put(struct fdtbus_reset *);
159 int fdtbus_reset_assert(struct fdtbus_reset *);
160 int fdtbus_reset_deassert(struct fdtbus_reset *);
161
162 bool fdtbus_set_data(const void *);
163 const void * fdtbus_get_data(void);
164 int fdtbus_phandle2offset(int);
165 int fdtbus_offset2phandle(int);
166 bool fdtbus_get_path(int, char *, size_t);
167
168 #endif /* _DEV_FDT_FDTVAR_H */
169