Skip to content

fix:(port/ch32/usb_dc_usbhs.c) Add isochronous out transfer support and fix endpoint config bug#310

Merged
sakumisu merged 2 commits intocherry-embedded:masterfrom
sumengqi:fix-ch32
May 9, 2025
Merged

fix:(port/ch32/usb_dc_usbhs.c) Add isochronous out transfer support and fix endpoint config bug#310
sakumisu merged 2 commits intocherry-embedded:masterfrom
sumengqi:fix-ch32

Conversation

@sumengqi
Copy link
Copy Markdown
Contributor

@sumengqi sumengqi commented May 8, 2025

Add Synchronous Out transmission of devices.

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of USB endpoint configuration, including more accurate enable/disable and stall status reporting.
    • Enhanced support for isochronous endpoints to ensure correct data transfer behavior.
  • Refactor
    • Refined endpoint initialization and management for greater reliability and clarity.

Add Synchronous Out transmission of devices.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented May 8, 2025

Walkthrough

The changes refine endpoint management in the USB device controller for the CH32 platform. Endpoint enabling, type configuration, and stall status handling are now performed on a per-endpoint, per-direction basis, rather than globally or generically. Isochronous endpoint handling during read operations is also made more precise.

Changes

File(s) Change Summary
port/ch32/usb_dc_usbhs.c Refined endpoint initialization to avoid enabling all endpoints by default; updated endpoint open/close logic to set or clear enable/type bits per endpoint and direction; improved stall status reading; adjusted isochronous endpoint read setup; minor formatting changes.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant usb_dc_init
    participant usbd_ep_open
    participant usbd_ep_close
    participant usbd_ep_is_stalled
    participant usbd_ep_start_read
    participant USBHS_DEVICE

    App->>usb_dc_init: Initialize USB device
    usb_dc_init->>USBHS_DEVICE: Do not enable all endpoints by default

    App->>usbd_ep_open: Open endpoint (IN/OUT)
    usbd_ep_open->>USBHS_DEVICE: Set endpoint enable/type bits per endpoint/direction

    App->>usbd_ep_close: Close endpoint (IN/OUT)
    usbd_ep_close->>USBHS_DEVICE: Clear endpoint enable bit for specified endpoint/direction

    App->>usbd_ep_is_stalled: Check if endpoint is stalled
    usbd_ep_is_stalled->>USBHS_DEVICE: Read stall status from RX/TX control register

    App->>usbd_ep_start_read: Start read on endpoint
    usbd_ep_start_read->>USBHS_DEVICE: Set RX control for isochronous or other endpoints
Loading

Poem

🐇
A hop, a skip, endpoints anew,
Now each one knows just what to do!
Isochronous reads, stalls checked with care,
Directions and types set everywhere.
With every bit and mask precise,
The USBHS code feels extra nice!
🌱✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.


📜 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 209ac25 and 21b63bd.

📒 Files selected for processing (1)
  • port/ch32/usb_dc_usbhs.c (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • port/ch32/usb_dc_usbhs.c
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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
Copy Markdown

@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: 2

🧹 Nitpick comments (1)
port/ch32/usb_dc_usbhs.c (1)

138-143: Type bit is left uncleared on ep_close

usbd_ep_close() disables the endpoint in ENDP_CONFIG, but the corresponding ENDP_TYPE bit remains set.
If the application later re-opens the same index with a different transfer type, the leftover bit will override the new configuration.

Consider clearing the type bit when you disable the endpoint:

-        USBHS_DEVICE->ENDP_CONFIG &= ~(1 << (ep_idx + 16));
+        USBHS_DEVICE->ENDP_CONFIG &= ~(1 << (ep_idx + 16));
+        USBHS_DEVICE->ENDP_TYPE   &= ~(1 << (ep_idx + 16));

(similar change for the IN branch).

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c659bdc and 209ac25.

📒 Files selected for processing (1)
  • port/ch32/usb_dc_usbhs.c (5 hunks)
🔇 Additional comments (2)
port/ch32/usb_dc_usbhs.c (2)

113-117: Verify OUT/IN bit-mapping against datasheet

For OUT endpoints you set ENDP_TYPE using 1 << (ep_idx + 16), while IN endpoints use 1 << ep_idx.
The same mapping is employed for ENDP_CONFIG, so this is probably intentional, but the CH32 USBHS manual places the RX (OUT) bits in the lower half and TX (IN) bits in the upper half (some revisions swap them).

Please double-check with the latest reference manual for your exact chip revision to avoid silent data corruption.


266-270: Potentially clears AUTOTOG and current toggle on isochronous OUT

For isochronous OUT you clear both RES and TOG masks and force TOG_0.
On this controller the hardware still manages toggling for ISO endpoints when AUTOTOG is set; by masking-out USBHS_EP_R_AUTOTOG you might inadvertently break the next micro-frame.

If the intention is only to ensure an ACK response, preserve the other bits:

-            USB_SET_RX_CTRL(ep_idx, (USB_GET_RX_CTRL(ep_idx) & ~(USBHS_EP_R_RES_MASK | USBHS_EP_R_TOG_MASK)) | USBHS_EP_R_RES_ACK | USBHS_EP_R_TOG_0);
+            USB_SET_RX_CTRL(ep_idx,
+                (USB_GET_RX_CTRL(ep_idx) & ~(USBHS_EP_R_RES_MASK)) | USBHS_EP_R_RES_ACK);

Please confirm with hardware tests before merging.

@sumengqi sumengqi changed the title Update usb_dc_usbhs.c fix:(port/ch32/usb_dc_usbhs.c) Add isochronous out transfer support and fix endpoint config bug May 9, 2025
@sakumisu sakumisu merged commit 9d06a94 into cherry-embedded:master May 9, 2025
1 check 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.

2 participants