fdtvar.h revision 1.34.2.2
1 /* $NetBSD: fdtvar.h,v 1.34.2.2 2020/04/08 14:08:04 martin 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 #include <sys/gpio.h> 35 #include <sys/termios.h> 36 37 #include <dev/i2c/i2cvar.h> 38 #include <dev/pwm/pwmvar.h> 39 #include <dev/clk/clk.h> 40 41 #ifdef _KERNEL_OPT 42 #include "audio.h" 43 #endif 44 #if NAUDIO > 0 45 #include <dev/audio/audio_dai.h> 46 #else 47 typedef void *audio_dai_tag_t; 48 #endif 49 50 #include <dev/clock_subr.h> 51 52 #include <dev/ofw/openfirm.h> 53 54 struct fdt_attach_args { 55 const char *faa_name; 56 bus_space_tag_t faa_bst; 57 bus_space_tag_t faa_a4x_bst; 58 bus_dma_tag_t faa_dmat; 59 int faa_phandle; 60 int faa_quiet; 61 }; 62 63 /* flags for fdtbus_intr_establish */ 64 #define FDT_INTR_MPSAFE __BIT(0) 65 66 /* Interrupt trigger types defined by the FDT "interrupts" bindings. */ 67 #define FDT_INTR_TYPE_POS_EDGE __BIT(0) 68 #define FDT_INTR_TYPE_NEG_EDGE __BIT(1) 69 #define FDT_INTR_TYPE_DOUBLE_EDGE (FDT_INTR_TYPE_POS_EDGE | \ 70 FDT_INTR_TYPE_NEG_EDGE) 71 #define FDT_INTR_TYPE_HIGH_LEVEL __BIT(2) 72 #define FDT_INTR_TYPE_LOW_LEVEL __BIT(3) 73 74 struct fdtbus_interrupt_controller_func { 75 void * (*establish)(device_t, u_int *, int, int, 76 int (*)(void *), void *); 77 void (*disestablish)(device_t, void *); 78 bool (*intrstr)(device_t, u_int *, char *, size_t); 79 void (*mask)(device_t, void *); 80 void (*unmask)(device_t, void *); 81 }; 82 83 struct fdtbus_i2c_controller_func { 84 i2c_tag_t (*get_tag)(device_t); 85 }; 86 87 struct fdtbus_gpio_controller; 88 89 struct fdtbus_gpio_pin { 90 struct fdtbus_gpio_controller *gp_gc; 91 void *gp_priv; 92 }; 93 94 struct fdtbus_gpio_controller_func { 95 void * (*acquire)(device_t, const void *, size_t, int); 96 void (*release)(device_t, void *); 97 int (*read)(device_t, void *, bool); 98 void (*write)(device_t, void *, int, bool); 99 }; 100 101 struct fdtbus_pinctrl_controller; 102 103 struct fdtbus_pinctrl_pin { 104 struct fdtbus_pinctrl_controller *pp_pc; 105 void *pp_priv; 106 }; 107 108 struct fdtbus_pinctrl_controller_func { 109 int (*set_config)(device_t, const void *, size_t); 110 }; 111 112 struct fdtbus_regulator_controller; 113 114 struct fdtbus_regulator { 115 struct fdtbus_regulator_controller *reg_rc; 116 }; 117 118 struct fdtbus_regulator_controller_func { 119 int (*acquire)(device_t); 120 void (*release)(device_t); 121 int (*enable)(device_t, bool); 122 int (*set_voltage)(device_t, u_int, u_int); 123 int (*get_voltage)(device_t, u_int *); 124 }; 125 126 struct fdtbus_clock_controller_func { 127 struct clk * (*decode)(device_t, int, const void *, size_t); 128 }; 129 130 struct fdtbus_reset_controller; 131 132 struct fdtbus_reset { 133 struct fdtbus_reset_controller *rst_rc; 134 void *rst_priv; 135 }; 136 137 struct fdtbus_reset_controller_func { 138 void * (*acquire)(device_t, const void *, size_t); 139 void (*release)(device_t, void *); 140 int (*reset_assert)(device_t, void *); 141 int (*reset_deassert)(device_t, void *); 142 }; 143 144 struct fdtbus_dai_controller_func { 145 audio_dai_tag_t (*get_tag)(device_t, const void *, size_t); 146 }; 147 148 struct fdtbus_dma_controller; 149 150 struct fdtbus_dma { 151 struct fdtbus_dma_controller *dma_dc; 152 void *dma_priv; 153 }; 154 155 enum fdtbus_dma_dir { 156 FDT_DMA_READ, /* device -> memory */ 157 FDT_DMA_WRITE /* memory -> device */ 158 }; 159 160 struct fdtbus_dma_opt { 161 int opt_bus_width; /* Bus width */ 162 int opt_burst_len; /* Burst length */ 163 int opt_swap; /* Enable data swapping */ 164 int opt_dblbuf; /* Enable double buffering */ 165 int opt_wrap_len; /* Address wrap-around window */ 166 }; 167 168 struct fdtbus_dma_req { 169 bus_dma_segment_t *dreq_segs; /* Memory */ 170 int dreq_nsegs; 171 172 bus_addr_t dreq_dev_phys; /* Device */ 173 int dreq_sel; /* Device selector */ 174 175 enum fdtbus_dma_dir dreq_dir; /* Transfer direction */ 176 177 int dreq_block_irq; /* Enable IRQ at end of block */ 178 int dreq_block_multi; /* Enable multiple block transfers */ 179 int dreq_flow; /* Enable flow control */ 180 181 struct fdtbus_dma_opt dreq_mem_opt; /* Memory options */ 182 struct fdtbus_dma_opt dreq_dev_opt; /* Device options */ 183 }; 184 185 struct fdtbus_dma_controller_func { 186 void * (*acquire)(device_t, const void *, size_t, 187 void (*)(void *), void *); 188 void (*release)(device_t, void *); 189 int (*transfer)(device_t, void *, struct fdtbus_dma_req *); 190 void (*halt)(device_t, void *); 191 }; 192 193 struct fdtbus_power_controller; 194 195 struct fdtbus_power_controller_func { 196 void (*reset)(device_t); 197 void (*poweroff)(device_t); 198 }; 199 200 struct fdtbus_phy_controller; 201 202 struct fdtbus_phy { 203 struct fdtbus_phy_controller *phy_pc; 204 void *phy_priv; 205 }; 206 207 struct fdtbus_phy_controller_func { 208 void * (*acquire)(device_t, const void *, size_t); 209 void (*release)(device_t, void *); 210 int (*enable)(device_t, void *, bool); 211 }; 212 213 struct fdtbus_pwm_controller_func { 214 pwm_tag_t (*get_tag)(device_t, const void *, size_t); 215 }; 216 217 struct fdtbus_mmc_pwrseq; 218 219 struct fdtbus_mmc_pwrseq_func { 220 void (*pre_power_on)(device_t); 221 void (*post_power_on)(device_t); 222 void (*power_off)(device_t); 223 void (*reset)(device_t); 224 }; 225 226 struct syscon; 227 228 struct fdt_console { 229 int (*match)(int); 230 void (*consinit)(struct fdt_attach_args *, u_int); 231 }; 232 233 struct fdt_console_info { 234 const struct fdt_console *ops; 235 }; 236 237 #define _FDT_CONSOLE_REGISTER(name) \ 238 __link_set_add_rodata(fdt_consoles, __CONCAT(name,_consinfo)); 239 240 #define FDT_CONSOLE(_name, _ops) \ 241 static const struct fdt_console_info __CONCAT(_name,_consinfo) = { \ 242 .ops = (_ops) \ 243 }; \ 244 _FDT_CONSOLE_REGISTER(_name) 245 246 TAILQ_HEAD(fdt_conslist, fdt_console_info); 247 248 struct fdt_dma_range { 249 paddr_t dr_sysbase; 250 bus_addr_t dr_busbase; 251 bus_size_t dr_len; 252 }; 253 254 int fdtbus_register_interrupt_controller(device_t, int, 255 const struct fdtbus_interrupt_controller_func *); 256 int fdtbus_register_i2c_controller(device_t, int, 257 const struct fdtbus_i2c_controller_func *); 258 int fdtbus_register_gpio_controller(device_t, int, 259 const struct fdtbus_gpio_controller_func *); 260 int fdtbus_register_pinctrl_config(device_t, int, 261 const struct fdtbus_pinctrl_controller_func *); 262 int fdtbus_register_regulator_controller(device_t, int, 263 const struct fdtbus_regulator_controller_func *); 264 int fdtbus_register_clock_controller(device_t, int, 265 const struct fdtbus_clock_controller_func *); 266 int fdtbus_register_reset_controller(device_t, int, 267 const struct fdtbus_reset_controller_func *); 268 int fdtbus_register_dai_controller(device_t, int, 269 const struct fdtbus_dai_controller_func *); 270 int fdtbus_register_dma_controller(device_t, int, 271 const struct fdtbus_dma_controller_func *); 272 int fdtbus_register_power_controller(device_t, int, 273 const struct fdtbus_power_controller_func *); 274 int fdtbus_register_phy_controller(device_t, int, 275 const struct fdtbus_phy_controller_func *); 276 int fdtbus_register_pwm_controller(device_t, int, 277 const struct fdtbus_pwm_controller_func *); 278 int fdtbus_register_mmc_pwrseq(device_t, int, 279 const struct fdtbus_mmc_pwrseq_func *); 280 int fdtbus_register_syscon(device_t, int, struct syscon *); 281 282 void fdtbus_set_decoderegprop(bool); 283 284 int fdtbus_get_reg(int, u_int, bus_addr_t *, bus_size_t *); 285 int fdtbus_get_reg_byname(int, const char *, bus_addr_t *, 286 bus_size_t *); 287 int fdtbus_get_reg64(int, u_int, uint64_t *, uint64_t *); 288 int fdtbus_get_addr_cells(int); 289 int fdtbus_get_size_cells(int); 290 uint64_t fdtbus_get_cells(const uint8_t *, int); 291 int fdtbus_get_phandle(int, const char *); 292 int fdtbus_get_phandle_from_native(int); 293 i2c_tag_t fdtbus_get_i2c_tag(int); 294 i2c_tag_t fdtbus_i2c_acquire(int, const char *); 295 void * fdtbus_intr_establish(int, u_int, int, int, 296 int (*func)(void *), void *arg); 297 void * fdtbus_intr_establish_byname(int, const char *, int, int, 298 int (*func)(void *), void *arg); 299 void * fdtbus_intr_establish_raw(int, const u_int *, int, int, 300 int (*func)(void *), void *arg); 301 void fdtbus_intr_mask(int, void *); 302 void fdtbus_intr_unmask(int, void *); 303 void fdtbus_intr_disestablish(int, void *); 304 bool fdtbus_intr_str(int, u_int, char *, size_t); 305 bool fdtbus_intr_str_raw(int, const u_int *, char *, size_t); 306 struct fdtbus_gpio_pin *fdtbus_gpio_acquire(int, const char *, int); 307 struct fdtbus_gpio_pin *fdtbus_gpio_acquire_index(int, const char *, int, int); 308 void fdtbus_gpio_release(struct fdtbus_gpio_pin *); 309 int fdtbus_gpio_read(struct fdtbus_gpio_pin *); 310 void fdtbus_gpio_write(struct fdtbus_gpio_pin *, int); 311 int fdtbus_gpio_read_raw(struct fdtbus_gpio_pin *); 312 void fdtbus_gpio_write_raw(struct fdtbus_gpio_pin *, int); 313 audio_dai_tag_t fdtbus_dai_acquire(int, const char *); 314 audio_dai_tag_t fdtbus_dai_acquire_index(int, const char *, int); 315 pwm_tag_t fdtbus_pwm_acquire(int, const char *); 316 pwm_tag_t fdtbus_pwm_acquire_index(int, const char *, int); 317 void fdtbus_pinctrl_configure(void); 318 int fdtbus_pinctrl_set_config_index(int, u_int); 319 int fdtbus_pinctrl_set_config(int, const char *); 320 const char * fdtbus_pinctrl_parse_function(int); 321 const void * fdtbus_pinctrl_parse_pins(int, int *); 322 const char * fdtbus_pinctrl_parse_groups(int, int *); 323 const u_int * fdtbus_pinctrl_parse_pinmux(int, int *); 324 int fdtbus_pinctrl_parse_bias(int, int *); 325 int fdtbus_pinctrl_parse_drive(int); 326 int fdtbus_pinctrl_parse_drive_strength(int); 327 int fdtbus_pinctrl_parse_input_output(int, int *); 328 struct fdtbus_regulator *fdtbus_regulator_acquire(int, const char *); 329 void fdtbus_regulator_release(struct fdtbus_regulator *); 330 int fdtbus_regulator_enable(struct fdtbus_regulator *); 331 int fdtbus_regulator_disable(struct fdtbus_regulator *); 332 int fdtbus_regulator_set_voltage(struct fdtbus_regulator *, 333 u_int, u_int); 334 int fdtbus_regulator_get_voltage(struct fdtbus_regulator *, 335 u_int *); 336 int fdtbus_regulator_supports_voltage(struct fdtbus_regulator *, 337 u_int, u_int); 338 struct syscon * fdtbus_syscon_acquire(int, const char *); 339 struct syscon * fdtbus_syscon_lookup(int); 340 341 struct fdtbus_dma *fdtbus_dma_get(int, const char *, void (*)(void *), void *); 342 struct fdtbus_dma *fdtbus_dma_get_index(int, u_int, void (*)(void *), 343 void *); 344 void fdtbus_dma_put(struct fdtbus_dma *); 345 int fdtbus_dma_transfer(struct fdtbus_dma *, 346 struct fdtbus_dma_req *); 347 void fdtbus_dma_halt(struct fdtbus_dma *); 348 349 struct clk * fdtbus_clock_get(int, const char *); 350 struct clk * fdtbus_clock_get_index(int, u_int); 351 struct clk * fdtbus_clock_byname(const char *); 352 void fdtbus_clock_assign(int); 353 354 struct fdtbus_reset *fdtbus_reset_get(int, const char *); 355 struct fdtbus_reset *fdtbus_reset_get_index(int, u_int); 356 void fdtbus_reset_put(struct fdtbus_reset *); 357 int fdtbus_reset_assert(struct fdtbus_reset *); 358 int fdtbus_reset_deassert(struct fdtbus_reset *); 359 360 struct fdtbus_phy *fdtbus_phy_get(int, const char *); 361 struct fdtbus_phy *fdtbus_phy_get_index(int, u_int); 362 void fdtbus_phy_put(struct fdtbus_phy *); 363 device_t fdtbus_phy_device(struct fdtbus_phy *); 364 int fdtbus_phy_enable(struct fdtbus_phy *, bool); 365 366 struct fdtbus_mmc_pwrseq *fdtbus_mmc_pwrseq_get(int); 367 void fdtbus_mmc_pwrseq_pre_power_on(struct fdtbus_mmc_pwrseq *); 368 void fdtbus_mmc_pwrseq_post_power_on(struct fdtbus_mmc_pwrseq *); 369 void fdtbus_mmc_pwrseq_power_off(struct fdtbus_mmc_pwrseq *); 370 void fdtbus_mmc_pwrseq_reset(struct fdtbus_mmc_pwrseq *); 371 372 int fdtbus_todr_attach(device_t, int, todr_chip_handle_t); 373 374 void fdtbus_power_reset(void); 375 void fdtbus_power_poweroff(void); 376 377 device_t fdtbus_attach_i2cbus(device_t, int, i2c_tag_t, cfprint_t); 378 379 bool fdtbus_init(const void *); 380 const void * fdtbus_get_data(void); 381 int fdtbus_phandle2offset(int); 382 int fdtbus_offset2phandle(int); 383 bool fdtbus_get_path(int, char *, size_t); 384 385 const struct fdt_console *fdtbus_get_console(void); 386 387 const char * fdtbus_get_stdout_path(void); 388 int fdtbus_get_stdout_phandle(void); 389 int fdtbus_get_stdout_speed(void); 390 tcflag_t fdtbus_get_stdout_flags(void); 391 392 bool fdtbus_status_okay(int); 393 394 const void * fdtbus_get_prop(int, const char *, int *); 395 const char * fdtbus_get_string(int, const char *); 396 const char * fdtbus_get_string_index(int, const char *, u_int); 397 int fdtbus_get_index(int, const char *, const char *, u_int *); 398 399 void fdt_add_bus(device_t, int, struct fdt_attach_args *); 400 void fdt_add_bus_match(device_t, int, struct fdt_attach_args *, 401 bool (*)(void *, int), void *); 402 void fdt_add_child(device_t, int, struct fdt_attach_args *, u_int); 403 404 void fdt_remove_byhandle(int); 405 void fdt_remove_bycompat(const char *[]); 406 int fdt_find_with_property(const char *, int *); 407 int fdtbus_print(void *, const char *); 408 409 bus_dma_tag_t fdtbus_dma_tag_create(int, const struct fdt_dma_range *, 410 u_int); 411 412 #endif /* _DEV_FDT_FDTVAR_H */ 413
Indexes created Sun Oct 12 09:09:55 GMT 2025