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

Change Cadence i2c and Zynq GPIO from modules to built-in drivers #3821

Merged
merged 1 commit into from
Jan 28, 2025

Conversation

michalsimek
Copy link
Contributor

@michalsimek michalsimek commented Jan 22, 2025

On Kria KD240 slg7xl45106 device is handling reset for USB hub which is providing access to SD card (USB/SD converter). Access to this device is done via i2c which needs to be also enabled in the kernel as built-in driver not as module when rootfs is mounted.

I have tested 14.2.rc2 version and this one is also missing. I pointed via grub to DT without usb hub configuration and it boots properly.

Summary by CodeRabbit

  • New Features
    • Added support for I2C Cadence driver in the kernel configuration, enabling enhanced I2C device compatibility.
    • Enabled GPIO support for Zynq devices in the kernel configuration.

Copy link

coderabbitai bot commented Jan 22, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the kernel configuration for an ARM UEFI generic AArch64 board by changing the state of the CONFIG_GPIO_ZYNQ option from module (m) to enabled (y). It also introduces a new configuration option, CONFIG_I2C_CADENCE=y, which enables the I2C Cadence driver. Additionally, comments regarding future USB support modifications are included, though no existing functionality is adversely affected.

Changes

File Change Summary
buildroot-external/board/arm-uefi/generic-aarch64/kernel.config Changed CONFIG_GPIO_ZYNQ=m to CONFIG_GPIO_ZYNQ=y; added CONFIG_I2C_CADENCE=y for I2C Cadence driver support

Sequence Diagram

sequenceDiagram
    participant Kernel
    participant I2C Cadence Driver
    participant I2C Devices

    Kernel->>I2C Cadence Driver: Load Driver
    I2C Cadence Driver-->>Kernel: Driver Initialized
    Kernel->>I2C Devices: Enable Communication
Loading

The sequence diagram illustrates the basic flow of the I2C Cadence driver initialization, showing how the kernel loads the driver and enables communication with I2C devices.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 18cd466 and 605cb19.

📒 Files selected for processing (1)
  • buildroot-external/board/arm-uefi/generic-aarch64/kernel.config (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • buildroot-external/board/arm-uefi/generic-aarch64/kernel.config

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/arm-uefi/generic-aarch64/kernel.config (1)

72-74: Consider adding a comment explaining the built-in requirement.

To help future maintainers understand why this driver must be built-in rather than a module, consider adding a brief comment.

 # i2c support
+# Must be built-in for early boot I2C access (required for USB hub reset)
 CONFIG_I2C_CADENCE=y
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8233cb9 and 18cd466.

📒 Files selected for processing (1)
  • buildroot-external/board/arm-uefi/generic-aarch64/kernel.config (1 hunks)
🔇 Additional comments (1)
buildroot-external/board/arm-uefi/generic-aarch64/kernel.config (1)

72-74: LGTM! The change correctly enables built-in I2C Cadence driver support.

The modification to build the I2C Cadence driver into the kernel rather than as a module is the right approach, as it ensures I2C functionality is available during early boot when the root filesystem is being mounted.

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.

I will consider pulling it in to final 14.2 release, however, have you verified this is really all it's needed for that platform? It'd be pointless without that.

@michalsimek
Copy link
Contributor Author

I will consider pulling it in to final 14.2 release, however, have you verified this is really all it's needed for that platform? It'd be pointless without that.

I have removed reset part inside usb DWC3 node and try to boot that system and things booted properly.
I have no idea how you are building kernel with all that infrastructure around, but if you tell me how to get 6.6.73 kernel source code out of buildroot (or whatever way you use) I can build it myself and try to be 100% confident.
I have already .config (which I got from kv260 platform via /proc/config.gz) and then load it externally via grub is easy.

@sairon
Copy link
Member

sairon commented Jan 22, 2025

I have no idea how you are building kernel with all that infrastructure around, but if you tell me how to get 6.6.73 kernel source code out of buildroot (or whatever way you use) I can build it myself and try to be 100% confident.

I think there's not an easy way to only build the kernel without building the toolchain, even if you wanted just to generate the kernel's dotconfig in the same way as Buildroot does. On the other hand, the build environment is self-contained by the helper scripts, so to build the kernel, run:

./scripts/enter.sh make -C buildroot O=/build/output_generic_aarch64/ BR2_EXTERNAL=/build/buildroot-external generic_aarch64_defconfig
./scripts/enter.sh make -C buildroot O=/build/output_generic_aarch64/ BR2_EXTERNAL=/build/buildroot-external linux

Alternatively, I can run an on-demand build here in the CI, or send you any of the files built/generated locally on my machine (which would be a bit faster).

On Kria KD240 slg7xl45106 device is handling reset for USB hub which is
providing access to SD card (USB/SD converter). Access to this device is
done via i2c which needs to be also enabled in the kernel as built-in
driver not as module when rootfs is mounted.

Also change ZYNQ_GPIO to be built-in driver because i2c is using gpio for
bus recovery that's why it should be also enabled to probe i2c driver
properly.

v6.6 kernel doesn't have support for usb5744 driver that's why disable it
but add TODO to enable it once v6.12 upgrade is done.
@michalsimek
Copy link
Contributor Author

First of all thank you for providing steps how to do it.

Current v6.6 configuration without this patch is working with DT modification on kd240 (https://www.amd.com/en/products/system-on-modules/kria/k24/kd240-drives-starter-kit.html) and without any DT modification on kv260 (https://www.amd.com/en/products/system-on-modules/kria/k26/kv260-vision-starter-kit.html).

To get it working without DT hack on kd240
CONFIG_I2C_CADENCE=y and CONFIG_GPIO_ZYNQ=y should be setup (The reason for making GPIO as built-in driver is that i2c is having bus recovery via GPIO. ZynqMP pinctrl driver is already enabled.). In ethernet case GPIO as module is working properly on kv260.

But that being said in v6.6 usb5744 driver is not supported and likely would be better (but doesn't really matter) to ignore CONFIG_USB_ONBOARD_HUB completely and enable it in v6.12 where hub is enabled via
CONFIG_USB_ONBOARD_DEV=y and CONFIG_USB_ONBOARD_DEV_USB5744=y.

I also merged #3767 to test v6.12 and validated that USB hub configuration is working properly when above config options are enabled.

That being said I have updated my patch to reflect what described above and it is fine for me if you want to pull it to v6.6 kernel or wait for v6.12 or add it after 14.2 release.

@michalsimek
Copy link
Contributor Author

kd240-bootlog.txt

Just in case if you are interested how that bootlog looks like on v6.6 (with origin kernel modules on rootfs and v6.12 (without kernel modules on rootfs).

@sairon sairon added the board/generic-aarch64 Generic aarch64 machine label Jan 28, 2025
@sairon sairon merged commit 7eccef8 into home-assistant:dev Jan 28, 2025
3 checks passed
@sairon sairon changed the title Change cadence i2c driver from module to built-in driver Change Cadence i2c and Zynq GPIO from modules to built-in drivers Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants