Skip to content

doc(firmware-update): add automatic net boot and flash with --devkit and --autoflash - #110

Closed
dotimothy wants to merge 1 commit into
developfrom
doc/netboot-autoflash
Closed

dotimothy wants to merge 1 commit into
developfrom
doc/netboot-autoflash

Conversation

@dotimothy

Copy link
Copy Markdown
Collaborator

Refs #92

Summary

Net Boot Recovery now starts with the automatic path that sima-cli supports: one command sets the DevKit to boot from the network, reboots it, flashes the eMMC, and restores the saved U-Boot environment when the session ends. The serial-console steps stay as the manual path for a DevKit that does not boot Linux.

sudo ~/.sima-cli/.venv/bin/sima-cli bootimg -v <version> --netboot --devkit <devkit-ip> --autoflash

This follows feedback from the factory process owner, who asked for the net boot procedure to use the more automated commands with --autoflash.

Change Detail
New section: Automatic Net Boot and Flash Requirements (sima-cli 2.1.17 or later; a DevKit that runs Linux and is reachable over SSH), the macOS and Linux commands, what sima-cli does after you confirm, q to restore the U-Boot environment, and what happens when automatic setup is not possible
Manual Net Boot and Flash The existing Steps 1 to 4, unchanged, under their own heading
Netboot shell commands d (discover DevKits) and q (end the session) added to c and f
Korean The Step 4 title is fixed so that its text is inside the bold tags

Source

The behavior is read from the sima-cli source at the v2.1.18 release (sima_cli/cli.py, sima_cli/update/netboot.py, sima_cli/update/netboot_device.py). --devkit first appears in v2.1.17, --autoflash in v2.1.5.

For review

  • Internal flags are left out. The command in the feedback also used -i (internal Artifactory, SiMa.ai employees only) and -f (daily-mirror fallback for internal eLxr builds), and -v 3.0, which is not released. The page uses -v <version> with %platform_version% as the example.
  • Not run on a board. The automatic path has not been run from this page on a 2.1.3 DevKit. Please confirm it on one before this reaches main.
  • Not in this PR: the SPI flasher recovery for a board whose serial console shows nothing ([DOC] Request to Add SPI Flasher Connection Diagram #109). It needs the DevKit's SPI flash connector and a connection diagram from the hardware owner.

Change Type

  • Bug fix
  • Refactor
  • Feature
  • Docs
  • Test-only
  • Build/CI
  • Breaking change

Risk

  • Low
  • Medium
  • High

Risk notes:

  • One page in five locales. No URL, anchor, or navigation change. The existing step anchors and links still work.

Test Evidence

sima-i18n check --require-complete      44/44 translated in ja, ko, zh-Hant, uk; structure preserved
npm run check:language                   passes
SYSDOC_STRICT_LINKS=1 npx docusaurus build   exit 0, all 5 locales, no broken links
served build                              the page returns 200 in all 5 locales; checked the rendering in English

Docs Impact

  • No docs update needed
  • Docs updated in this PR
  • Docs follow-up required (linked issue)

Docs notes: SPI flasher recovery and connection diagram in #109.

Migration Impact

  • No migration impact
  • Migration required and documented

Breaking API Change

  • Not applicable
  • This PR changes public API signatures under include/*

API / Deprecation Checklist

  • Public API unchanged
  • Public API changed with deprecation path documented under docs/develop-apps/
  • Naming contract respected (docs/develop-apps/contribute/start-here/naming.md)

Release Hygiene Checklist

  • scripts/ci/check_naming_and_conflicts.sh passed (core-repo script; not applicable here)
  • scripts/ci/check_artifacts.sh passed (core-repo script; not applicable here)
  • scripts/ci/check_release_policy.sh passed (core-repo script; not applicable here)

🤖 Generated with Claude Code

…and --autoflash

Net Boot Recovery now starts with the one-command path: sima-cli connects to a
running DevKit over SSH, sets U-Boot to boot from the host, reboots it, flashes
the eMMC, and restores the saved U-Boot environment when the session ends. The
serial-console steps stay as the manual path for a DevKit that does not boot
Linux. Requires sima-cli 2.1.17 or later; behavior read from the v2.1.18 source.

The netboot shell's d and q commands are listed. The Korean Step 4 title is
fixed so that its text is inside the bold tags.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-15T21:21:10.205325Z 6a1f9dc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6a1f9dc239

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

sima-user@sima-user-machine:~$ sudo ~/.sima-cli/.venv/bin/sima-cli bootimg -v <version> --netboot --devkit <devkit-ip> --autoflash
```

The command installs eLxr on a Modalix DevKit by default. For Yocto, add `--fwtype yocto`. If you leave out `--devkit`, `sima-cli` looks for DevKits on the network and asks you to choose one.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Pass the Modalix and eLxr target flags explicitly

When users copy either automatic command, the omitted target flags do not select the target claimed here: the generated sima-cli bootimg --help lists mlsoc and yocto as the defaults. The examples can therefore prepare incompatible MLSoC/Yocto firmware instead of the intended Modalix/eLxr image; add --boardtype modalix --fwtype elxr to both commands and their translations.

Useful? React with 👍 / 👎.

Base automatically changed from develop to main November 4, 2026 17:28
@dotimothy
dotimothy changed the base branch from main to develop November 5, 2026 00:16
@dotimothy

Copy link
Copy Markdown
Collaborator Author

Closing: #122 already added the --devkit/--autoflash path to Net Boot Recovery. The parts of this PR that #122 didn't cover (reboot behaviour, SSH fallback, d/q commands) are in #155.

@dotimothy dotimothy closed this Nov 5, 2026
shanguangzai added a commit that referenced this pull request Nov 15, 2026
With --autoflash, sima-cli reboots the device into eMMC; after a manual f
it asks whether to reboot. If it cannot reach the device over SSH, it
leaves it unchanged. Add the d and q netboot commands. From #110.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Jim Fan <ji.fan@sima.ai>
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.

1 participant