xref: /OK3568_Linux_fs/kernel/drivers/remoteproc/omap_remoteproc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: BSD-3-Clause */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Remote processor messaging
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2011-2020 Texas Instruments, Inc.
6*4882a593Smuzhiyun  * Copyright (C) 2011 Google, Inc.
7*4882a593Smuzhiyun  * All rights reserved.
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #ifndef _OMAP_RPMSG_H
11*4882a593Smuzhiyun #define _OMAP_RPMSG_H
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun /*
14*4882a593Smuzhiyun  * enum - Predefined Mailbox Messages
15*4882a593Smuzhiyun  *
16*4882a593Smuzhiyun  * @RP_MBOX_READY: informs the M3's that we're up and running. this is
17*4882a593Smuzhiyun  * part of the init sequence sent that the M3 expects to see immediately
18*4882a593Smuzhiyun  * after it is booted.
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * @RP_MBOX_PENDING_MSG: informs the receiver that there is an inbound
21*4882a593Smuzhiyun  * message waiting in its own receive-side vring. please note that currently
22*4882a593Smuzhiyun  * this message is optional: alternatively, one can explicitly send the index
23*4882a593Smuzhiyun  * of the triggered virtqueue itself. the preferred approach will be decided
24*4882a593Smuzhiyun  * as we progress and experiment with those two different approaches.
25*4882a593Smuzhiyun  *
26*4882a593Smuzhiyun  * @RP_MBOX_CRASH: this message is sent if BIOS crashes
27*4882a593Smuzhiyun  *
28*4882a593Smuzhiyun  * @RP_MBOX_ECHO_REQUEST: a mailbox-level "ping" message.
29*4882a593Smuzhiyun  *
30*4882a593Smuzhiyun  * @RP_MBOX_ECHO_REPLY: a mailbox-level reply to a "ping"
31*4882a593Smuzhiyun  *
32*4882a593Smuzhiyun  * @RP_MBOX_ABORT_REQUEST: a "please crash" request, used for testing the
33*4882a593Smuzhiyun  * recovery mechanism (to some extent).
34*4882a593Smuzhiyun  *
35*4882a593Smuzhiyun  * @RP_MBOX_SUSPEND_AUTO: auto suspend request for the remote processor
36*4882a593Smuzhiyun  *
37*4882a593Smuzhiyun  * @RP_MBOX_SUSPEND_SYSTEM: system suspend request for the remote processor
38*4882a593Smuzhiyun  *
39*4882a593Smuzhiyun  * @RP_MBOX_SUSPEND_ACK: successful response from remote processor for a
40*4882a593Smuzhiyun  * suspend request
41*4882a593Smuzhiyun  *
42*4882a593Smuzhiyun  * @RP_MBOX_SUSPEND_CANCEL: a cancel suspend response from a remote processor
43*4882a593Smuzhiyun  * on a suspend request
44*4882a593Smuzhiyun  *
45*4882a593Smuzhiyun  * Introduce new message definitions if any here.
46*4882a593Smuzhiyun  *
47*4882a593Smuzhiyun  * @RP_MBOX_END_MSG: Indicates end of known/defined messages from remote core
48*4882a593Smuzhiyun  * This should be the last definition.
49*4882a593Smuzhiyun  *
50*4882a593Smuzhiyun  */
51*4882a593Smuzhiyun enum omap_rp_mbox_messages {
52*4882a593Smuzhiyun 	RP_MBOX_READY		= 0xFFFFFF00,
53*4882a593Smuzhiyun 	RP_MBOX_PENDING_MSG	= 0xFFFFFF01,
54*4882a593Smuzhiyun 	RP_MBOX_CRASH		= 0xFFFFFF02,
55*4882a593Smuzhiyun 	RP_MBOX_ECHO_REQUEST	= 0xFFFFFF03,
56*4882a593Smuzhiyun 	RP_MBOX_ECHO_REPLY	= 0xFFFFFF04,
57*4882a593Smuzhiyun 	RP_MBOX_ABORT_REQUEST	= 0xFFFFFF05,
58*4882a593Smuzhiyun 	RP_MBOX_SUSPEND_AUTO	= 0xFFFFFF10,
59*4882a593Smuzhiyun 	RP_MBOX_SUSPEND_SYSTEM	= 0xFFFFFF11,
60*4882a593Smuzhiyun 	RP_MBOX_SUSPEND_ACK	= 0xFFFFFF12,
61*4882a593Smuzhiyun 	RP_MBOX_SUSPEND_CANCEL	= 0xFFFFFF13,
62*4882a593Smuzhiyun 	RP_MBOX_END_MSG		= 0xFFFFFF14,
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #endif /* _OMAP_RPMSG_H */
66