| Message ID | 20241106051016.89113-2-yesanishhere@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | remoteproc documentation update | expand |
On Tue, Nov 05, 2024 at 09:10:14PM -0800, anish kumar wrote: > Update the intrduction section to add key components > provided by remote processor framework. > > Signed-off-by: anish kumar <yesanishhere@gmail.com> > --- > Documentation/staging/remoteproc.rst | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > > diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst > index 348ee7e508ac..eeebbeca71de 100644 > --- a/Documentation/staging/remoteproc.rst > +++ b/Documentation/staging/remoteproc.rst > @@ -29,6 +29,23 @@ remoteproc will add those devices. This makes it possible to reuse the > existing virtio drivers with remote processor backends at a minimal development > cost. > > +The primary purpose of the remoteproc framework is to download firmware > +for remote processors and manage their lifecycle. The framework consists > +of several key components: > + > +- **Character Driver**: Provides userspace access to control the remote > + processor. > +- **ELF Utility**: Offers functions for handling ELF files and managing > + resources requested by the remote processor. > +- **Remoteproc Core**: Manages firmware downloads and recovery actions > + in case of a remote processor crash. > +- **Coredump**: Provides facilities for coredumping and tracing from > + the remote processor in the event of a crash. > +- **Userspace Interaction**: Uses sysfs and debugfs to manage the > + lifecycle and status of the remote processor. > +- **Virtio Support**: Facilitates interaction with the virtio and > + rpmsg bus. Some of the above is either inaccurate or incomplete. It would be fairly time consuming for me to point out where the problems are, especially since I don't see a lot of value in adding this section. > + > User API > ======== > > -- > 2.39.3 (Apple Git-146) >
diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst index 348ee7e508ac..eeebbeca71de 100644 --- a/Documentation/staging/remoteproc.rst +++ b/Documentation/staging/remoteproc.rst @@ -29,6 +29,23 @@ remoteproc will add those devices. This makes it possible to reuse the existing virtio drivers with remote processor backends at a minimal development cost. +The primary purpose of the remoteproc framework is to download firmware +for remote processors and manage their lifecycle. The framework consists +of several key components: + +- **Character Driver**: Provides userspace access to control the remote + processor. +- **ELF Utility**: Offers functions for handling ELF files and managing + resources requested by the remote processor. +- **Remoteproc Core**: Manages firmware downloads and recovery actions + in case of a remote processor crash. +- **Coredump**: Provides facilities for coredumping and tracing from + the remote processor in the event of a crash. +- **Userspace Interaction**: Uses sysfs and debugfs to manage the + lifecycle and status of the remote processor. +- **Virtio Support**: Facilitates interaction with the virtio and + rpmsg bus. + User API ========
Update the intrduction section to add key components provided by remote processor framework. Signed-off-by: anish kumar <yesanishhere@gmail.com> --- Documentation/staging/remoteproc.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+)