xref: /arm-trusted-firmware/include/drivers/arm/css/css_mhu_doorbell.h (revision 91f16700b400a8c0651d24a598fc48ee2997a0d7)
1*91f16700Schasinglulu /*
2*91f16700Schasinglulu  * Copyright (c) 2014-2020, ARM Limited and Contributors. All rights reserved.
3*91f16700Schasinglulu  *
4*91f16700Schasinglulu  * SPDX-License-Identifier: BSD-3-Clause
5*91f16700Schasinglulu  */
6*91f16700Schasinglulu 
7*91f16700Schasinglulu #ifndef CSS_MHU_DOORBELL_H
8*91f16700Schasinglulu #define CSS_MHU_DOORBELL_H
9*91f16700Schasinglulu 
10*91f16700Schasinglulu #include <stdint.h>
11*91f16700Schasinglulu 
12*91f16700Schasinglulu #include <lib/mmio.h>
13*91f16700Schasinglulu 
14*91f16700Schasinglulu /* MHUv2 Frame Base Mask */
15*91f16700Schasinglulu #define MHU_V2_FRAME_BASE_MASK			UL(~0xFFF)
16*91f16700Schasinglulu 
17*91f16700Schasinglulu /* MHUv2 Control Registers Offsets */
18*91f16700Schasinglulu #define MHU_V2_MSG_NO_CAP_OFFSET		UL(0xF80)
19*91f16700Schasinglulu #define MHU_V2_ACCESS_REQ_OFFSET		UL(0xF88)
20*91f16700Schasinglulu #define MHU_V2_ACCESS_READY_OFFSET		UL(0xF8C)
21*91f16700Schasinglulu 
22*91f16700Schasinglulu #define SENDER_REG_STAT(_channel)	(0x20 * (_channel))
23*91f16700Schasinglulu #define SENDER_REG_SET(_channel)	((0x20 * (_channel)) + 0xC)
24*91f16700Schasinglulu 
25*91f16700Schasinglulu /* Helper macro to ring doorbell */
26*91f16700Schasinglulu #define MHU_RING_DOORBELL(addr, modify_mask, preserve_mask)	do {	\
27*91f16700Schasinglulu 		uint32_t db = mmio_read_32(addr) & (preserve_mask);	\
28*91f16700Schasinglulu 		mmio_write_32(addr, db | (modify_mask));		\
29*91f16700Schasinglulu 	} while (0)
30*91f16700Schasinglulu 
31*91f16700Schasinglulu #define MHU_V2_ACCESS_REQUEST(addr)	\
32*91f16700Schasinglulu 	mmio_write_32((addr) + MHU_V2_ACCESS_REQ_OFFSET, 0x1)
33*91f16700Schasinglulu 
34*91f16700Schasinglulu #define MHU_V2_CLEAR_REQUEST(addr)	\
35*91f16700Schasinglulu 	mmio_write_32((addr) + MHU_V2_ACCESS_REQ_OFFSET, 0x0)
36*91f16700Schasinglulu 
37*91f16700Schasinglulu #define MHU_V2_IS_ACCESS_READY(addr)	\
38*91f16700Schasinglulu 	(mmio_read_32((addr) + MHU_V2_ACCESS_READY_OFFSET) & 0x1)
39*91f16700Schasinglulu 
40*91f16700Schasinglulu struct scmi_channel_plat_info;
41*91f16700Schasinglulu void mhu_ring_doorbell(struct scmi_channel_plat_info *plat_info);
42*91f16700Schasinglulu void mhuv2_ring_doorbell(struct scmi_channel_plat_info *plat_info);
43*91f16700Schasinglulu 
44*91f16700Schasinglulu #endif	/* CSS_MHU_DOORBELL_H */
45