/*	$NetBSD: fdt_mbox.h,v 1.1 2025/09/06 20:11:30 thorpej Exp $	*/

/*-
 * Copyright (c) 2022 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Nick Hudson
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _DEV_FDT_FDT_MBOX_H_
#define	_DEV_FDT_FDT_MBOX_H_

#include <sys/device.h>

struct fdtbus_mbox_channel {
	struct fdtbus_mbox_controller *mb_ctlr;
	void *mb_priv;
};

struct fdtbus_mbox_controller_func {
	void *	(*mc_acquire)(device_t, const void *, size_t, void (*)(void *),
			      void *);
	void	(*mc_release)(device_t, void *);
	int	(*mc_recv)(device_t, void *, void *, size_t);
	int	(*mc_send)(device_t, void *, const void *, size_t);
};

int		fdtbus_register_mbox_controller(device_t, int,
		    const struct fdtbus_mbox_controller_func *);

struct fdtbus_mbox_channel *
		fdtbus_mbox_get(int, const char *, void (*)(void *), void *);
struct fdtbus_mbox_channel *
		fdtbus_mbox_get_index(int, u_int, void (*)(void *),
		    void *);
int		fdtbus_mbox_send(struct fdtbus_mbox_channel *, const void *,
		    size_t);
int		fdtbus_mbox_recv(struct fdtbus_mbox_channel *, void *, size_t);
void		fdtbus_mbox_put(struct fdtbus_mbox_channel *);

#endif /* _DEV_FDT_FDT_MBOX_H_ */