xref: /freebsd/sys/dev/mailbox/arm/arm_doorbell.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1*54b96380SRuslan Bukin /*-
2*54b96380SRuslan Bukin  * SPDX-License-Identifier: BSD-2-Clause
3*54b96380SRuslan Bukin  *
4*54b96380SRuslan Bukin  * Copyright (c) 2022 Ruslan Bukin <br@bsdpad.com>
5*54b96380SRuslan Bukin  *
6*54b96380SRuslan Bukin  * This work was supported by Innovate UK project 105694, "Digital Security
7*54b96380SRuslan Bukin  * by Design (DSbD) Technology Platform Prototype".
8*54b96380SRuslan Bukin  *
9*54b96380SRuslan Bukin  * Redistribution and use in source and binary forms, with or without
10*54b96380SRuslan Bukin  * modification, are permitted provided that the following conditions
11*54b96380SRuslan Bukin  * are met:
12*54b96380SRuslan Bukin  * 1. Redistributions of source code must retain the above copyright
13*54b96380SRuslan Bukin  *    notice, this list of conditions and the following disclaimer.
14*54b96380SRuslan Bukin  * 2. Redistributions in binary form must reproduce the above copyright
15*54b96380SRuslan Bukin  *    notice, this list of conditions and the following disclaimer in the
16*54b96380SRuslan Bukin  *    documentation and/or other materials provided with the distribution.
17*54b96380SRuslan Bukin  *
18*54b96380SRuslan Bukin  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19*54b96380SRuslan Bukin  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20*54b96380SRuslan Bukin  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21*54b96380SRuslan Bukin  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22*54b96380SRuslan Bukin  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23*54b96380SRuslan Bukin  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24*54b96380SRuslan Bukin  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25*54b96380SRuslan Bukin  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26*54b96380SRuslan Bukin  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27*54b96380SRuslan Bukin  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28*54b96380SRuslan Bukin  * SUCH DAMAGE.
29*54b96380SRuslan Bukin  */
30*54b96380SRuslan Bukin 
31*54b96380SRuslan Bukin #ifndef	_ARM64_SCMI_ARM_DOORBELL_H_
32*54b96380SRuslan Bukin #define	_ARM64_SCMI_ARM_DOORBELL_H_
33*54b96380SRuslan Bukin 
34*54b96380SRuslan Bukin struct arm_doorbell {
35*54b96380SRuslan Bukin 	device_t dev;
36*54b96380SRuslan Bukin 	device_t db_dev;
37*54b96380SRuslan Bukin 	int chan;
38*54b96380SRuslan Bukin 	int db;
39*54b96380SRuslan Bukin 	void (*func)(void *);
40*54b96380SRuslan Bukin 	void *arg;
41*54b96380SRuslan Bukin };
42*54b96380SRuslan Bukin 
43*54b96380SRuslan Bukin void arm_doorbell_set(struct arm_doorbell *db);
44*54b96380SRuslan Bukin int arm_doorbell_get(struct arm_doorbell *db);
45*54b96380SRuslan Bukin struct arm_doorbell * arm_doorbell_ofw_get(device_t dev, const char *name);
46*54b96380SRuslan Bukin void arm_doorbell_set_handler(struct arm_doorbell *db, void (*func)(void *),
47*54b96380SRuslan Bukin     void *arg);
48*54b96380SRuslan Bukin 
49*54b96380SRuslan Bukin #endif /* !_ARM64_SCMI_ARM_DOORBELL_H_ */
50