drivers/remoteproc/omap_remoteproc.h

0001 /* SPDX-License-Identifier: BSD-3-Clause */
0002 /*
0003  * Remote processor messaging
0004  *
0005  * Copyright (C) 2011-2020 Texas Instruments, Inc.
0006  * Copyright (C) 2011 Google, Inc.
0007  * All rights reserved.
0008  */
0009
0010 #ifndef _OMAP_RPMSG_H
0011 #define _OMAP_RPMSG_H
0012
0013 /*
0014  * enum - Predefined Mailbox Messages
0015  *
0016  * @RP_MBOX_READY: informs the M3's that we're up and running. this is
0017  * part of the init sequence sent that the M3 expects to see immediately
0018  * after it is booted.
0019  *
0020  * @RP_MBOX_PENDING_MSG: informs the receiver that there is an inbound
0021  * message waiting in its own receive-side vring. please note that currently
0022  * this message is optional: alternatively, one can explicitly send the index
0023  * of the triggered virtqueue itself. the preferred approach will be decided
0024  * as we progress and experiment with those two different approaches.
0025  *
0026  * @RP_MBOX_CRASH: this message is sent if BIOS crashes
0027  *
0028  * @RP_MBOX_ECHO_REQUEST: a mailbox-level "ping" message.
0029  *
0030  * @RP_MBOX_ECHO_REPLY: a mailbox-level reply to a "ping"
0031  *
0032  * @RP_MBOX_ABORT_REQUEST: a "please crash" request, used for testing the
0033  * recovery mechanism (to some extent).
0034  *
0035  * @RP_MBOX_SUSPEND_AUTO: auto suspend request for the remote processor
0036  *
0037  * @RP_MBOX_SUSPEND_SYSTEM: system suspend request for the remote processor
0038  *
0039  * @RP_MBOX_SUSPEND_ACK: successful response from remote processor for a
0040  * suspend request
0041  *
0042  * @RP_MBOX_SUSPEND_CANCEL: a cancel suspend response from a remote processor
0043  * on a suspend request
0044  *
0045  * Introduce new message definitions if any here.
0046  *
0047  * @RP_MBOX_END_MSG: Indicates end of known/defined messages from remote core
0048  * This should be the last definition.
0049  *
0050  */
0051 enum omap_rp_mbox_messages {
0052     RP_MBOX_READY       = 0xFFFFFF00,
0053     RP_MBOX_PENDING_MSG = 0xFFFFFF01,
0054     RP_MBOX_CRASH       = 0xFFFFFF02,
0055     RP_MBOX_ECHO_REQUEST    = 0xFFFFFF03,
0056     RP_MBOX_ECHO_REPLY  = 0xFFFFFF04,
0057     RP_MBOX_ABORT_REQUEST   = 0xFFFFFF05,
0058     RP_MBOX_SUSPEND_AUTO    = 0xFFFFFF10,
0059     RP_MBOX_SUSPEND_SYSTEM  = 0xFFFFFF11,
0060     RP_MBOX_SUSPEND_ACK = 0xFFFFFF12,
0061     RP_MBOX_SUSPEND_CANCEL  = 0xFFFFFF13,
0062     RP_MBOX_END_MSG     = 0xFFFFFF14,
0063 };
0064
0065 #endif /* _OMAP_RPMSG_H */