Home | History | Annotate | Line # | Download | only in fdt
      1 /*	$NetBSD: fdt_intr.h,v 1.1 2025/09/06 20:11:30 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2015-2018 Jared 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_FDT_INTR_H_
     30 #define	_DEV_FDT_FDT_INTR_H_
     31 
     32 #include <sys/device.h>
     33 
     34 /* flags for fdtbus_intr_establish */
     35 #define	FDT_INTR_MPSAFE			__BIT(0)
     36 
     37 /* Interrupt trigger types defined by the FDT "interrupts" bindings. */
     38 #define	FDT_INTR_TYPE_POS_EDGE		__BIT(0)
     39 #define	FDT_INTR_TYPE_NEG_EDGE		__BIT(1)
     40 #define	FDT_INTR_TYPE_DOUBLE_EDGE	(FDT_INTR_TYPE_POS_EDGE | \
     41 					 FDT_INTR_TYPE_NEG_EDGE)
     42 #define	FDT_INTR_TYPE_HIGH_LEVEL	__BIT(2)
     43 #define	FDT_INTR_TYPE_LOW_LEVEL		__BIT(3)
     44 
     45 struct fdtbus_interrupt_controller_func {
     46 	void *	(*establish)(device_t, u_int *, int, int,
     47 			     int (*)(void *), void *, const char *);
     48 	void	(*disestablish)(device_t, void *);
     49 	bool	(*intrstr)(device_t, u_int *, char *, size_t);
     50 	void	(*mask)(device_t, void *);
     51 	void	(*unmask)(device_t, void *);
     52 };
     53 
     54 int		fdtbus_register_interrupt_controller(device_t, int,
     55 		    const struct fdtbus_interrupt_controller_func *);
     56 
     57 void *		fdtbus_intr_establish(int, u_int, int, int,
     58 		    int (*func)(void *), void *arg);
     59 void *		fdtbus_intr_establish_xname(int, u_int, int, int,
     60 		    int (*func)(void *), void *arg, const char *);
     61 void *		fdtbus_intr_establish_byname(int, const char *, int, int,
     62 		    int (*func)(void *), void *arg, const char *);
     63 void *		fdtbus_intr_establish_raw(int, const u_int *, int, int,
     64 		    int (*func)(void *), void *arg, const char *);
     65 void		fdtbus_intr_mask(int, void *);
     66 void		fdtbus_intr_unmask(int, void *);
     67 void		fdtbus_intr_disestablish(int, void *);
     68 bool		fdtbus_intr_str(int, u_int, char *, size_t);
     69 bool		fdtbus_intr_str_raw(int, const u_int *, char *, size_t);
     70 int		fdtbus_intr_parent(int);
     71 
     72 #endif /* _DEV_FDT_FDT_INTR_H_ */
     73