Home | History | Annotate | Line # | Download | only in fdt 
      1 /*	$NetBSD: fdt_mbox.h,v 1.1 2025/09/06 20:11:30 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2022 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Nick Hudson
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _DEV_FDT_FDT_MBOX_H_
     33 #define	_DEV_FDT_FDT_MBOX_H_
     34 
     35 #include <sys/device.h>
     36 
     37 struct fdtbus_mbox_channel {
     38 	struct fdtbus_mbox_controller *mb_ctlr;
     39 	void *mb_priv;
     40 };
     41 
     42 struct fdtbus_mbox_controller_func {
     43 	void *	(*mc_acquire)(device_t, const void *, size_t, void (*)(void *),
     44 			      void *);
     45 	void	(*mc_release)(device_t, void *);
     46 	int	(*mc_recv)(device_t, void *, void *, size_t);
     47 	int	(*mc_send)(device_t, void *, const void *, size_t);
     48 };
     49 
     50 int		fdtbus_register_mbox_controller(device_t, int,
     51 		    const struct fdtbus_mbox_controller_func *);
     52 
     53 struct fdtbus_mbox_channel *
     54 		fdtbus_mbox_get(int, const char *, void (*)(void *), void *);
     55 struct fdtbus_mbox_channel *
     56 		fdtbus_mbox_get_index(int, u_int, void (*)(void *),
     57 		    void *);
     58 int		fdtbus_mbox_send(struct fdtbus_mbox_channel *, const void *,
     59 		    size_t);
     60 int		fdtbus_mbox_recv(struct fdtbus_mbox_channel *, void *, size_t);
     61 void		fdtbus_mbox_put(struct fdtbus_mbox_channel *);
     62 
     63 #endif /* _DEV_FDT_FDT_MBOX_H_ */
     64