From: Mathieu Poirier <mathieu.poirier@linaro.org>
To: bjorn.andersson@linaro.org, ohad@wizery.com
Cc: loic.pallardy@st.com, arnaud.pouliquen@st.com, s-anna@ti.com,
linux-remoteproc@vger.kernel.org, corbet@lwn.net,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v3 13/14] remoteproc: Document function rproc_set_state_machine()
Date: Fri, 24 Apr 2020 14:01:34 -0600 [thread overview]
Message-ID: <20200424200135.28825-14-mathieu.poirier@linaro.org> (raw)
In-Reply-To: <20200424200135.28825-1-mathieu.poirier@linaro.org>
Add a few words on the newly added rproc_set_state_machine()
in order to adversite the new API and help put people into
context.
Signed-off-by: Mathieu Poirier <mathieu.poirier@linaro.org>
---
Documentation/remoteproc.txt | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Documentation/remoteproc.txt b/Documentation/remoteproc.txt
index 2be1147256e0..550ed9a06a27 100644
--- a/Documentation/remoteproc.txt
+++ b/Documentation/remoteproc.txt
@@ -132,6 +132,23 @@ On success, the new rproc is returned, and on failure, NULL.
**never** directly deallocate @rproc, even if it was not registered
yet. Instead, when you need to unroll rproc_alloc(), use rproc_free().
+::
+
+ int rproc_set_state_machine(struct rproc *rproc,
+ const struct rproc_ops *sync_ops,
+ struct rproc_sync_flags sync_flags)
+
+This function should be called for cases where the remote processor has
+been started by another entity, be it a boot loader or trusted environment,
+and the remoteproc core is to synchronise with the remote processor rather
+then boot it. The synchronisation flags @sync_flags tell the core whether
+it should synchronise with a remote processor when the core initialises, after
+a remote processor has crashed and after it was voluntarily stopped. Operations
+provided in the @sync_ops should reflect the reality of the use case. For
+example if the remoteproc core is to synchronise with a remote processor at
+initialisation time, sync_ops::find_loaded_rsc_table should provide a pointer to
+the resource table in memory rather than fetch it from the firmware image.
+
::
void rproc_free(struct rproc *rproc)
--
2.20.1
next prev parent reply other threads:[~2020-04-24 20:02 UTC|newest]
Thread overview: 64+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-24 20:01 [PATCH v3 00/14] remoteproc: Add support for synchronisaton with rproc Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 01/14] remoteproc: Make core operations optional Mathieu Poirier
2020-04-28 16:18 ` Arnaud POULIQUEN
2020-04-30 19:39 ` Mathieu Poirier
2020-05-05 22:16 ` Bjorn Andersson
2020-05-08 19:09 ` Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 02/14] remoteproc: Introduce function rproc_alloc_internals() Mathieu Poirier
2020-05-05 22:31 ` Bjorn Andersson
2020-05-08 19:37 ` Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 03/14] remoteproc: Add new operation and flags for synchronistation Mathieu Poirier
2020-04-28 16:38 ` Arnaud POULIQUEN
2020-04-30 19:49 ` Mathieu Poirier
2020-05-06 0:22 ` Bjorn Andersson
2020-05-08 21:01 ` Mathieu Poirier
2020-05-14 1:32 ` Bjorn Andersson
2020-05-15 19:24 ` Mathieu Poirier
2020-05-19 0:55 ` Bjorn Andersson
2020-05-20 22:06 ` Mathieu Poirier
2020-05-21 5:21 ` Bjorn Andersson
2020-05-21 21:55 ` Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 04/14] remoteproc: Refactor function rproc_boot() Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 05/14] remoteproc: Refactor function rproc_fw_boot() Mathieu Poirier
2020-05-06 0:33 ` Bjorn Andersson
2020-05-08 21:27 ` Mathieu Poirier
2020-05-14 2:10 ` Bjorn Andersson
2020-05-15 19:46 ` Mathieu Poirier
2020-05-19 0:22 ` Bjorn Andersson
2020-04-24 20:01 ` [PATCH v3 06/14] remoteproc: Refactor function rproc_trigger_auto_boot() Mathieu Poirier
2020-04-28 17:00 ` Arnaud POULIQUEN
2020-04-24 20:01 ` [PATCH v3 07/14] remoteproc: Introducting new start and stop functions Mathieu Poirier
2020-05-06 0:42 ` Bjorn Andersson
2020-04-24 20:01 ` [PATCH v3 08/14] remoteproc: Call core functions based on synchronisation flag Mathieu Poirier
2020-04-28 17:27 ` Arnaud POULIQUEN
2020-04-30 19:57 ` Mathieu Poirier
2020-05-04 11:14 ` Arnaud POULIQUEN
2020-05-05 22:10 ` Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 09/14] remoteproc: Deal with synchronisation when crashing Mathieu Poirier
2020-04-29 7:44 ` Arnaud POULIQUEN
2020-04-30 20:11 ` Mathieu Poirier
2020-05-06 1:01 ` Bjorn Andersson
2020-05-08 21:47 ` Mathieu Poirier
2020-04-24 20:01 ` [PATCH v3 10/14] remoteproc: Deal with synchronisation when shutting down Mathieu Poirier
2020-04-29 8:19 ` Arnaud POULIQUEN
2020-04-30 20:23 ` Mathieu Poirier
2020-05-04 11:34 ` Arnaud POULIQUEN
2020-05-05 22:03 ` Mathieu Poirier
2020-05-06 7:51 ` Arnaud POULIQUEN
2020-05-06 1:10 ` Bjorn Andersson
2020-04-24 20:01 ` [PATCH v3 11/14] remoteproc: Deal with synchronisation when changing FW image Mathieu Poirier
2020-04-29 8:52 ` Arnaud POULIQUEN
2020-04-30 20:32 ` Mathieu Poirier
2020-05-06 1:27 ` Bjorn Andersson
2020-04-24 20:01 ` [PATCH v3 12/14] remoteproc: Introducing function rproc_set_state_machine() Mathieu Poirier
2020-04-29 9:22 ` Arnaud POULIQUEN
2020-04-29 14:38 ` Arnaud POULIQUEN
2020-04-30 20:51 ` Mathieu Poirier
2020-05-04 12:00 ` Arnaud POULIQUEN
2020-04-30 20:42 ` Mathieu Poirier
2020-05-04 11:57 ` Arnaud POULIQUEN
2020-05-05 21:43 ` Mathieu Poirier
2020-04-24 20:01 ` Mathieu Poirier [this message]
2020-04-24 20:01 ` [PATCH v3 14/14] remoteproc: Expose synchronisation flags via debugfs Mathieu Poirier
2020-05-18 13:28 ` [PATCH v3 00/14] remoteproc: Add support for synchronisaton with rproc Peng Fan
2020-05-18 16:29 ` Mathieu Poirier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200424200135.28825-14-mathieu.poirier@linaro.org \
--to=mathieu.poirier@linaro.org \
--cc=arnaud.pouliquen@st.com \
--cc=bjorn.andersson@linaro.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-remoteproc@vger.kernel.org \
--cc=loic.pallardy@st.com \
--cc=ohad@wizery.com \
--cc=s-anna@ti.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).