Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow boot from USB and NVMe on Khadas VIM3 #3784

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Conversation

viraniac
Copy link
Contributor

@viraniac viraniac commented Jan 10, 2025

Currently its hardcoded in the script to use mmc command. This means the image can not be flashed to usb or nvme drive and booted from the same. Making it flexible to allow booting in such scenarios.

Summary by CodeRabbit

  • Refactor
    • Enhanced boot script flexibility by replacing hardcoded device commands with a dynamic variable
    • Improved script adaptability for different device types without changing core boot management logic

Signed-off-by: Gunjan Gupta <gunjan@wesion.com>
Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @viraniac

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft January 10, 2025 05:46
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@viraniac viraniac marked this pull request as ready for review January 10, 2025 05:48
Copy link

coderabbitai bot commented Jan 10, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the uboot-boot.ush script for the Khadas VIM3 board, replacing hardcoded mmc commands with a more flexible ${devtype} variable. This change allows for dynamic device type handling during the boot process, making the script more adaptable to different storage devices while maintaining the original boot management logic and control flow.

Changes

File Change Summary
buildroot-external/board/khadas/vim3/uboot-boot.ush Replaced direct mmc command references with ${devtype} variable for more generic device handling

Sequence Diagram

sequenceDiagram
    participant Script as Boot Script
    participant DevType as ${devtype}
    participant Storage as Storage Device
    
    Script->>DevType: Determine device type
    DevType->>Storage: Select storage device
    Storage-->>Script: Prepare for boot operations
    Script->>Storage: Perform boot actions (load kernel, etc.)
Loading

The sequence diagram illustrates how the script now uses a dynamic ${devtype} to select and interact with the storage device, providing more flexibility in the boot process.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
buildroot-external/board/khadas/vim3/uboot-boot.ush (1)

Line range hint 1-108: Consider documenting supported device types and testing requirements.

The changes successfully implement dynamic device type support, making the boot process more flexible. To ensure long-term maintainability:

  1. Document the supported device types (MMC, USB, NVMe) in the board's documentation
  2. Add test cases to verify boot functionality across different storage devices
  3. Consider adding a comment in the script header explaining the device type handling
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c7e21c0 and 8d1dfd2.

📒 Files selected for processing (1)
  • buildroot-external/board/khadas/vim3/uboot-boot.ush (3 hunks)
🔇 Additional comments (5)
buildroot-external/board/khadas/vim3/uboot-boot.ush (5)

4-14: LGTM! Verify environment storage compatibility.

The replacement of hardcoded mmc commands with ${devtype} maintains the same functionality while adding support for different storage devices. The environment storage mechanism remains consistent.

Please ensure that the environment storage works correctly with different device types by testing:

  1. Reading/writing environment from MMC
  2. Reading/writing environment from USB
  3. Reading/writing environment from NVMe

32-33: LGTM! Configuration loading properly adapted.

The configuration loading mechanism has been correctly updated to use the dynamic device type while maintaining the same functionality.


38-38: LGTM! Command line loading properly adapted.

The command line loading mechanism has been correctly updated to use the dynamic device type.


43-56: LGTM! Verify DTB loading across device types.

The device tree and overlay loading mechanisms have been correctly updated to use the dynamic device type.

Please verify that the device tree and overlays load correctly from different storage devices, particularly testing:

  1. Base DTB loading
  2. Overlay loading and application
  3. Error handling and DTB restoration

77-85: LGTM! Ensure comprehensive boot testing.

The kernel loading mechanism has been correctly updated to use the dynamic device type while maintaining the A/B slot management functionality.

Please ensure comprehensive testing of the boot process:

  1. Successful boot from both A and B slots
  2. Proper fallback behavior when a boot fails
  3. Boot counter decrement working correctly
  4. Testing across all supported device types (MMC, USB, NVMe)

@sairon sairon added the board/khadas Khadas VIM Boards label Jan 14, 2025
Copy link
Member

@sairon sairon left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! I'll just reword the title a bit for clearer changelog.

@sairon sairon changed the title Use devtype instead of hardcoding device type to mmc Allow boot from USB and NVMe on Khadas VIM3 Jan 15, 2025
@sairon sairon merged commit cd04812 into home-assistant:dev Jan 15, 2025
3 checks passed
@sairon sairon added the u-boot U-Boot related issue label Jan 15, 2025
@sairon sairon mentioned this pull request Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
board/khadas Khadas VIM Boards cla-signed u-boot U-Boot related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants