Skip to content

docs: Include instructions on enable Remoteproc Runtime in userspace#15

Merged
yejseo01 merged 32 commits into
arm:mainfrom
yejseo01:userspace_enable
Nov 12, 2025
Merged

docs: Include instructions on enable Remoteproc Runtime in userspace#15
yejseo01 merged 32 commits into
arm:mainfrom
yejseo01:userspace_enable

Conversation

@yejseo01

@yejseo01 yejseo01 commented Oct 15, 2025

Copy link
Copy Markdown
Contributor

Changes

Update document to include information on enabling Remoteproc Runtime run in userspace

Checklist

  • 🤖 This change is covered by tests as required.
  • 🤹 All required manual testing has been performed.
  • 📖 All documentation updates are complete.

@yejseo01
yejseo01 requested a review from a team as a code owner October 15, 2025 13:48
Comment thread internal/oci/state.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/runtime/create.go Outdated
Comment thread docs/USAGE.md Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
@yejseo01 yejseo01 changed the title Enable Remoteproc Runtime to be usable in user space feat: Enable Remoteproc Runtime to be usable in user space Oct 15, 2025
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread internal/oci/state.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread internal/userdirs/userdirs.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/oci/state.go Outdated
Comment thread internal/oci/state.go Outdated
Comment thread internal/oci/state.go Outdated
Comment thread internal/oci/state.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
@yejseo01

Copy link
Copy Markdown
Contributor Author

The CI test of this PR is dependent on this change - arm/remoteproc-simulator#2

Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
@arm arm deleted a comment from yejseo01 Oct 30, 2025
Comment thread docs/PERMISSION_SETTING.md Outdated

@muchzill4 muchzill4 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everywhere we use fmt.Println we should aim to use logger instead.

In order to make some incremental progress here - it's been a bit of a drag - I suggest we split this PR. I worry that tackling the logging properly will balloon this further. We should also consider how we test the features added here.

Something we could land as a separate change is respecting the /sys/.../parameters/path. This does not rely on root or non-root.

Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread internal/userdirs/userdirs_test.go Outdated
Comment thread internal/userdirs/userdirs_test.go
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/userdirs/userdirs.go
Comment thread internal/remoteproc/remoteproc.go Outdated
Comment thread internal/remoteproc/remoteproc.go Outdated
@yejseo01
yejseo01 marked this pull request as draft November 3, 2025 12:15
Remoteproc Runtime uses Remoteproc, which usually requires root
permissions to write to its filesystem.

To ensure that Remoteproc Runtime has root access, the container
engines that spawn containers with Remoteproc Runtime should be run
with root access.

Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
@yejseo01
yejseo01 requested a review from Copilot November 11, 2025 11:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enables Remoteproc Runtime to be usable by non-root users by removing hard-coded root-only paths and providing configuration guidance. The changes focus on documentation to help users set up proper permissions for running the runtime in user space.

  • Added permission setting documentation for non-root user access
  • Updated usage documentation to reference new permission requirements
  • Provided instructions for configuring remoteproc driver access and firmware paths

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/USAGE.md Added note about elevated permissions requirement with link to permission setup guide
docs/PERMISSION_SETTING.md New comprehensive guide for configuring non-root user access to remoteproc driver and firmware paths

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
@yejseo01 yejseo01 changed the title feat: Enable Remoteproc Runtime to be usable in user space docs: Include instructions on enable Remoteproc Runtime in userspace Nov 11, 2025
yejseo01 and others added 3 commits November 11, 2025 13:31
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: yejseo01 <yejseo01@arm.com>
@yejseo01
yejseo01 marked this pull request as ready for review November 11, 2025 13:33
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/USAGE.md Outdated
yejseo01 and others added 8 commits November 11, 2025 15:11
Co-authored-by: Luke Parkin <65398091+Luke-Parkin@users.noreply.github.com>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Co-authored-by: Luke Parkin <65398091+Luke-Parkin@users.noreply.github.com>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Co-authored-by: Luke Parkin <65398091+Luke-Parkin@users.noreply.github.com>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
Comment thread docs/PERMISSION_SETTING.md Outdated
yejseo01 and others added 6 commits November 12, 2025 10:12
Co-authored-by: James Cox-Morton <Th3james@fastmail.fm>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Co-authored-by: James Cox-Morton <Th3james@fastmail.fm>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Co-authored-by: James Cox-Morton <Th3james@fastmail.fm>
Signed-off-by: yejseo01 <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
Signed-off-by: Yejin Seo <yejseo01@arm.com>
@yejseo01
yejseo01 requested a review from th3james November 12, 2025 10:23
@yejseo01
yejseo01 dismissed stale reviews from th3james and muchzill4 November 12, 2025 15:31

All requested changes applied

@yejseo01
yejseo01 merged commit 1a079a6 into arm:main Nov 12, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants