1 /*
2  * Arm SCP/MCP Software
3  * Copyright (c) 2015-2021, Arm Limited and Contributors. All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  *
7  * Description:
8  *      Message Handling Unit (MHU) Device Driver.
9  */
10 
11 #ifndef MOD_MHU_H
12 #define MOD_MHU_H
13 
14 #include <fwk_macros.h>
15 
16 #include <stdint.h>
17 
18 /*!
19  * \addtogroup GroupModules Modules
20  * \{
21  */
22 
23 /*!
24  * \defgroup GroupMHU Message Handling Unit (MHU) Driver
25  * \{
26  */
27 
28 /*!
29  * \brief MHU device
30  *
31  * \details Abstract representation of a bidirectional MHU device that consists
32  *      of a single receive interrupt line and a pair of register sets, one for
33  *      each direction of communication.
34  */
35 struct mod_mhu_device_config {
36     /*! IRQ number of the receive interrupt line */
37     unsigned int irq;
38 
39     /*! Base address of the registers of the incoming MHU */
40     uintptr_t in;
41 
42     /*! Base address of the registers of the outgoing MHU */
43     uintptr_t out;
44 };
45 
46 /*!
47  * \}
48  */
49 
50 /*!
51  * \}
52  */
53 
54 #endif /* MOD_MHU_H */
55