2020-03-24 14:00:35 +03:00
/* SPDX-License-Identifier: BSD-3-Clause */
2011-10-20 20:53:35 +04:00
/*
* Remote processor messaging
*
remoteproc/omap: Add support for system suspend/resume
This patch adds the support for system suspend/resume to the
OMAP remoteproc driver so that the OMAP remoteproc devices can
be suspended/resumed during a system suspend/resume. The support
is added through the driver PM .suspend/.resume callbacks, and
requires appropriate support from the OS running on the remote
processors.
The IPU & DSP remote processors typically have their own private
modules like registers, internal memories, caches etc. The context
of these modules need to be saved and restored properly for a
suspend/resume to work. These are in general not accessible from
the MPU, so the remote processors themselves have to implement
the logic for the context save & restore of these modules.
The OMAP remoteproc driver initiates a suspend by sending a mailbox
message requesting the remote processor to save its context and
enter into an idle/standby state. The remote processor should
usually stop whatever processing it is doing to switch to a context
save mode. The OMAP remoteproc driver detects the completion of
the context save by checking the module standby status for the
remoteproc device. It also stops any resources used by the remote
processors like the timers. The timers need to be running only
when the processor is active and executing, and need to be stopped
otherwise to allow the timer driver to reach low-power states. The
IOMMUs are automatically suspended by the PM core during the late
suspend stage, after the remoteproc suspend process is completed by
putting the remote processor cores into reset. Thereafter, the Linux
kernel can put the domain into further lower power states as possible.
The resume sequence undoes the operations performed in the PM suspend
callback, by starting the timers and finally releasing the processors
from reset. This requires that the remote processor side OS be able to
distinguish a power-resume boot from a power-on/cold boot, restore the
context of its private modules saved during the suspend phase, and
resume executing code from where it was suspended. The IOMMUs would
have been resumed by the PM core during early resume, so they are
already enabled by the time remoteproc resume callback gets invoked.
The remote processors should save their context into System RAM (DDR),
as any internal memories are not guaranteed to retain context as it
depends on the lowest power domain that the remote processor device
is put into. The management of the DDR contents will be managed by
the Linux kernel.
Signed-off-by: Suman Anna <s-anna@ti.com>
[t-kristo@ti.com: converted to use ti-sysc instead of hwmod]
Signed-off-by: Tero Kristo <t-kristo@ti.com>
Reviewed-by: Andrew F. Davis <afd@ti.com>
Acked-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Link: https://lore.kernel.org/r/20200324110035.29907-12-t-kristo@ti.com
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2020-03-24 14:00:31 +03:00
* Copyright ( C ) 2011 - 2020 Texas Instruments , Inc .
2011-10-20 20:53:35 +04:00
* Copyright ( C ) 2011 Google , Inc .
* All rights reserved .
*/
# ifndef _OMAP_RPMSG_H
# define _OMAP_RPMSG_H
/*
* enum - Predefined Mailbox Messages
*
* @ RP_MBOX_READY : informs the M3 ' s that we ' re up and running . this is
* part of the init sequence sent that the M3 expects to see immediately
* after it is booted .
*
* @ RP_MBOX_PENDING_MSG : informs the receiver that there is an inbound
* message waiting in its own receive - side vring . please note that currently
* this message is optional : alternatively , one can explicitly send the index
* of the triggered virtqueue itself . the preferred approach will be decided
* as we progress and experiment with those two different approaches .
*
* @ RP_MBOX_CRASH : this message is sent if BIOS crashes
*
* @ RP_MBOX_ECHO_REQUEST : a mailbox - level " ping " message .
*
* @ RP_MBOX_ECHO_REPLY : a mailbox - level reply to a " ping "
*
* @ RP_MBOX_ABORT_REQUEST : a " please crash " request , used for testing the
* recovery mechanism ( to some extent ) .
2020-03-24 14:00:29 +03:00
*
remoteproc/omap: Add support for system suspend/resume
This patch adds the support for system suspend/resume to the
OMAP remoteproc driver so that the OMAP remoteproc devices can
be suspended/resumed during a system suspend/resume. The support
is added through the driver PM .suspend/.resume callbacks, and
requires appropriate support from the OS running on the remote
processors.
The IPU & DSP remote processors typically have their own private
modules like registers, internal memories, caches etc. The context
of these modules need to be saved and restored properly for a
suspend/resume to work. These are in general not accessible from
the MPU, so the remote processors themselves have to implement
the logic for the context save & restore of these modules.
The OMAP remoteproc driver initiates a suspend by sending a mailbox
message requesting the remote processor to save its context and
enter into an idle/standby state. The remote processor should
usually stop whatever processing it is doing to switch to a context
save mode. The OMAP remoteproc driver detects the completion of
the context save by checking the module standby status for the
remoteproc device. It also stops any resources used by the remote
processors like the timers. The timers need to be running only
when the processor is active and executing, and need to be stopped
otherwise to allow the timer driver to reach low-power states. The
IOMMUs are automatically suspended by the PM core during the late
suspend stage, after the remoteproc suspend process is completed by
putting the remote processor cores into reset. Thereafter, the Linux
kernel can put the domain into further lower power states as possible.
The resume sequence undoes the operations performed in the PM suspend
callback, by starting the timers and finally releasing the processors
from reset. This requires that the remote processor side OS be able to
distinguish a power-resume boot from a power-on/cold boot, restore the
context of its private modules saved during the suspend phase, and
resume executing code from where it was suspended. The IOMMUs would
have been resumed by the PM core during early resume, so they are
already enabled by the time remoteproc resume callback gets invoked.
The remote processors should save their context into System RAM (DDR),
as any internal memories are not guaranteed to retain context as it
depends on the lowest power domain that the remote processor device
is put into. The management of the DDR contents will be managed by
the Linux kernel.
Signed-off-by: Suman Anna <s-anna@ti.com>
[t-kristo@ti.com: converted to use ti-sysc instead of hwmod]
Signed-off-by: Tero Kristo <t-kristo@ti.com>
Reviewed-by: Andrew F. Davis <afd@ti.com>
Acked-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Link: https://lore.kernel.org/r/20200324110035.29907-12-t-kristo@ti.com
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2020-03-24 14:00:31 +03:00
* @ RP_MBOX_SUSPEND_AUTO : auto suspend request for the remote processor
*
* @ RP_MBOX_SUSPEND_SYSTEM : system suspend request for the remote processor
*
* @ RP_MBOX_SUSPEND_ACK : successful response from remote processor for a
* suspend request
*
* @ RP_MBOX_SUSPEND_CANCEL : a cancel suspend response from a remote processor
* on a suspend request
*
2020-03-24 14:00:29 +03:00
* Introduce new message definitions if any here .
*
* @ RP_MBOX_END_MSG : Indicates end of known / defined messages from remote core
* This should be the last definition .
*
2011-10-20 20:53:35 +04:00
*/
enum omap_rp_mbox_messages {
RP_MBOX_READY = 0xFFFFFF00 ,
RP_MBOX_PENDING_MSG = 0xFFFFFF01 ,
RP_MBOX_CRASH = 0xFFFFFF02 ,
RP_MBOX_ECHO_REQUEST = 0xFFFFFF03 ,
RP_MBOX_ECHO_REPLY = 0xFFFFFF04 ,
RP_MBOX_ABORT_REQUEST = 0xFFFFFF05 ,
remoteproc/omap: Add support for system suspend/resume
This patch adds the support for system suspend/resume to the
OMAP remoteproc driver so that the OMAP remoteproc devices can
be suspended/resumed during a system suspend/resume. The support
is added through the driver PM .suspend/.resume callbacks, and
requires appropriate support from the OS running on the remote
processors.
The IPU & DSP remote processors typically have their own private
modules like registers, internal memories, caches etc. The context
of these modules need to be saved and restored properly for a
suspend/resume to work. These are in general not accessible from
the MPU, so the remote processors themselves have to implement
the logic for the context save & restore of these modules.
The OMAP remoteproc driver initiates a suspend by sending a mailbox
message requesting the remote processor to save its context and
enter into an idle/standby state. The remote processor should
usually stop whatever processing it is doing to switch to a context
save mode. The OMAP remoteproc driver detects the completion of
the context save by checking the module standby status for the
remoteproc device. It also stops any resources used by the remote
processors like the timers. The timers need to be running only
when the processor is active and executing, and need to be stopped
otherwise to allow the timer driver to reach low-power states. The
IOMMUs are automatically suspended by the PM core during the late
suspend stage, after the remoteproc suspend process is completed by
putting the remote processor cores into reset. Thereafter, the Linux
kernel can put the domain into further lower power states as possible.
The resume sequence undoes the operations performed in the PM suspend
callback, by starting the timers and finally releasing the processors
from reset. This requires that the remote processor side OS be able to
distinguish a power-resume boot from a power-on/cold boot, restore the
context of its private modules saved during the suspend phase, and
resume executing code from where it was suspended. The IOMMUs would
have been resumed by the PM core during early resume, so they are
already enabled by the time remoteproc resume callback gets invoked.
The remote processors should save their context into System RAM (DDR),
as any internal memories are not guaranteed to retain context as it
depends on the lowest power domain that the remote processor device
is put into. The management of the DDR contents will be managed by
the Linux kernel.
Signed-off-by: Suman Anna <s-anna@ti.com>
[t-kristo@ti.com: converted to use ti-sysc instead of hwmod]
Signed-off-by: Tero Kristo <t-kristo@ti.com>
Reviewed-by: Andrew F. Davis <afd@ti.com>
Acked-by: Mathieu Poirier <mathieu.poirier@linaro.org>
Link: https://lore.kernel.org/r/20200324110035.29907-12-t-kristo@ti.com
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
2020-03-24 14:00:31 +03:00
RP_MBOX_SUSPEND_AUTO = 0xFFFFFF10 ,
RP_MBOX_SUSPEND_SYSTEM = 0xFFFFFF11 ,
RP_MBOX_SUSPEND_ACK = 0xFFFFFF12 ,
RP_MBOX_SUSPEND_CANCEL = 0xFFFFFF13 ,
RP_MBOX_END_MSG = 0xFFFFFF14 ,
2011-10-20 20:53:35 +04:00
} ;
# endif /* _OMAP_RPMSG_H */
