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

Align memory for SDC read on ChibiOS #2889

Closed

Conversation

networkfusion
Copy link
Member

@networkfusion networkfusion commented Mar 1, 2024

Description

There were sporatic failures with firmware releases on STM32F7 series related to the ability to read the content of files. This is a speculative fix that addresses the immediate issue, although might need applying to MMC and also write functions.

It also addresses:

  • A Fix for for Drive Indexes (that should only be a single char).
  • Some comments (spelling) and code formatting.

Motivation and Context

Issues with reading from SD cards.

How Has This Been Tested?

Locally on an ORGPAL_THREE (though had to turn USB MSD OFF for the interpreter not to continually crash). Note: build dir must be cleared!

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • New Features

    • Enhanced disk I/O operations for improved reliability and efficiency when reading from SD cards.
    • Streamlined drive index format for SD card and USB mass storage devices.
  • Bug Fixes

    • Improved handling of buffer initialization during read operations to prevent data residue issues.
  • Documentation

    • Clarified comments regarding function declarations and ChibiOS version within the codebase for better readability.

@networkfusion networkfusion added Series: STM32xx Everything related specifically with STM32 targets Platform: STM32 Everything related specifically with ChibiOS platform labels Mar 1, 2024
@nfbot nfbot added the Type: bug label Mar 1, 2024
networkfusion and others added 2 commits March 3, 2024 22:37
Fix define for Drive Indexes (should only be a single char).
Fixes some comments (spelling).
Automated fixes for code style.
@josesimoes
Copy link
Member

These changes should be addressed in #2911 with the new stream approach and the fixes in ChibiOS community code, therefore OK to close.

@networkfusion
Copy link
Member Author

Closing as fixed.

@nfbot nfbot removed Type: bug Series: STM32xx Everything related specifically with STM32 targets Platform: STM32 Everything related specifically with ChibiOS platform labels Jul 23, 2024
@networkfusion networkfusion deleted the fix-chibios-sd-read branch July 23, 2024 13:22
@nfbot nfbot added the invalid label Jul 23, 2024
Copy link

coderabbitai bot commented Jul 23, 2024

Warning

Rate limit exceeded

@nfbot has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 7 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 19738b2 and e8149e7.

Walkthrough

The changes improve disk I/O functionality, particularly for SD card read operations, by enhancing memory management and state validation. A new aligned buffer is introduced to handle data reads more safely, ensuring proper initialization and cache management. Minor formatting adjustments in function declarations and drive index definitions further improve code readability and consistency without altering logic.

Changes

Files Change Summary
targets/ChibiOS/_FatFS/fatfs_diskio.c Enhanced SD card read operations with a new aligned buffer; added state checks and memory clearing.
targets/ChibiOS/_FatFS/fatfs_syscall.c Minor formatting adjustments for consistency in pointer declarations and improved comments.
targets/ChibiOS/_include/Target_Windows_Storage.h Simplified drive index definitions by removing colons for clarity and consistency.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants