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

Disable UAS via usb-storage.quirks on RPi for JMicron JMS583 #3687

Merged

Conversation

RubenKelevra
Copy link
Contributor

@RubenKelevra RubenKelevra commented Nov 21, 2024

Vendor ID: 152d
Product ID: a583

fixes #3674

Summary by CodeRabbit

  • New Features
    • Updated USB storage configuration for improved compatibility with specific devices on Raspberry Pi.

Copy link

coderabbitai bot commented Nov 21, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a modification to the cmdline.txt file for the Raspberry Pi board configuration. An additional entry, 152d:a583:u, has been appended to the existing usb-storage.quirks parameter. This change aims to address potential issues related to USB storage devices without altering any other content or structure of the file.

Changes

File Path Change Summary
buildroot-external/board/raspberrypi/cmdline.txt Updated usb-storage.quirks with additional entry 152d:a583:u

Assessment against linked issues

Objective Addressed Explanation
Address USB storage stability issues related to NVMe SSD (#3674)

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 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

🧹 Outside diff range and nitpick comments (1)
buildroot-external/board/raspberrypi/cmdline.txt (1)

1-1: Consider adding a comment to document this quirk.

To help future maintainers, it would be valuable to document why this quirk was added, perhaps in a README or the kernel configuration documentation.

Example documentation:

+ # Documentation for USB quirks:
+ # 152d:a583:u - JMicron External USB3-to-NVMe adapter
+ #               Added to resolve system stability issues (see #3674)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~1-~1: Probablemente falta un espacio.
Context: ...nsole=tty0 usb-storage.quirks=174c:55aa:u,2109:0715:u,152d:0578:u,152d:0579:u,152d:1561:u,1...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_SPACE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between af833db and 1a236f4.

📒 Files selected for processing (1)
  • buildroot-external/board/raspberrypi/cmdline.txt (1 hunks)
🧰 Additional context used
🪛 LanguageTool
buildroot-external/board/raspberrypi/cmdline.txt

[uncategorized] ~1-~1: Probablemente falta un espacio.
Context: ...nsole=tty0 usb-storage.quirks=174c:55aa:u,2109:0715:u,152d:0578:u,152d:0579:u,152d:1561:u,1...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_SPACE)

🔇 Additional comments (1)
buildroot-external/board/raspberrypi/cmdline.txt (1)

1-1: LGTM! Verified vendor and product IDs.

The added quirk 152d:a583:u follows the correct format and matches JMicron's vendor ID. This should help resolve the stability issues reported in #3674 by disabling command queueing for this specific USB3-to-NVMe adapter.

Let's verify the vendor and product IDs against the USB ID database:

✅ Verification successful

Verified: JMicron vendor ID matches, product ID is within expected range

The vendor ID 152d is confirmed to belong to JMicron Technology Corp., which aligns with the USB-to-NVMe adapter mentioned in the PR. While the specific product ID a583 isn't listed in the public USB ID database (likely being a newer product), it follows JMicron's pattern of USB storage bridges, similar to their other products like JMS567 (152d:0567). The quirk's addition is appropriate for addressing the reported stability issues.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the USB vendor and product IDs
# Expected: Should find JMicron Technology Corp. as vendor

curl -s http://www.linux-usb.org/usb.ids | awk '/^152d/{p=NR+5}(NR<=p){print}'

Length of output: 361

🧰 Tools
🪛 LanguageTool

[uncategorized] ~1-~1: Probablemente falta un espacio.
Context: ...nsole=tty0 usb-storage.quirks=174c:55aa:u,2109:0715:u,152d:0578:u,152d:0579:u,152d:1561:u,1...

(AI_ES_GGEC_MISSING_ORTHOGRAPHY_SPACE)

@sairon sairon added board/raspberrypi Raspberry Pi Boards usb-ssd USB SSD related issue labels Nov 21, 2024
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.

Looks good to me, thanks! Could you maybe just clarify what JMicron chip it is (either from the chip marking or from some product datasheet). If you can't find it, at least tell what product exactly is it used in?

@RubenKelevra
Copy link
Contributor Author

RubenKelevra commented Nov 21, 2024

I don't know what.

But according to the photos it uses a RTL9210B chip. According to the specs on the site however it uses a jms583.

While jms583 seems likely, this page specifies that this chip can do TRIM but my Linux Notebook denied that, so I had to wipe it by writing zeros to it.

https://www.jmicron.com/products/list/13

Here's the product:

https://a.aliexpress.com/_EvCsBGD

@sairon
Copy link
Member

sairon commented Nov 21, 2024

The VID is definitely of JMicron. According to the internet, JMS583 should have PID 0583, but since this is a583, I assume it's just another revision of the same model.

@sairon sairon changed the title add device quirk for JMicron's "External" USB3-to-NVMe adapter Disable UAS via usb-storage.quirks on RPi for JMicron JMS583 Nov 21, 2024
@sairon sairon merged commit a042dc0 into home-assistant:dev Nov 21, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
board/raspberrypi Raspberry Pi Boards cla-signed usb-ssd USB SSD related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

System unstable after switching from SD-Card to NVMe SSD
2 participants