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