nf-interpreter icon indicating copy to clipboard operation
nf-interpreter copied to clipboard

Sd card map pins, drive index & fix events

Open AdrianSoundy opened this issue 1 year ago • 1 comments

Description

Native side of fixing issues with SD card.

  • Adds mapping of Sd card pins for esp32-s3
  • Fix an issue with GPIO events randomly not working when using de-bounce, found when testing Card detect logic
  • Fixed confusion between drive mounted events and card detect events
  • Added/fixed drive index(slot index) for Sd card

This change requires other PR for

  • System.IO.Filesystem
  • nanoFramework.Hardware.Esp32
  • Samples

Motivation and Context

  • Fixes nanoFramework/Home#1447
  • Fixes nanoFramework/Home#1475

How Has This Been Tested?

Tested locally with updated Mounting sample

Types of changes

  • [ ] Improvement (non-breaking change that improves a feature, code or algorithm)
  • [x] 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/declarations (update dependencies or assembly declarations 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

  • [x] 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).
  • [x] 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

    • Introduced support for multiple SD card slots, enhancing flexibility in pin mapping and event handling.
    • Added a new event type for card detection changes, streamlining event management.
    • Enhanced device mapping capabilities for SDMMC devices on the ESP32 platform.
  • Bug Fixes

    • Improved bounds checking for slot indices to enhance robustness in SD card operations.
  • Refactor

    • Simplified the event posting process by eliminating unnecessary helper functions.
    • Updated GPIO pin configurations based on card detection state for adaptability.

AdrianSoundy avatar Aug 13 '24 05:08 AdrianSoundy

Walkthrough

The changes enhance the ESP32 platform's SD card functionality, particularly in card detection and flexible GPIO pin configuration. New event types related to card detection have been introduced, along with an enumeration for card states. Additionally, modifications to structures and mapping functions improve handling for SDMMC devices, ensuring compatibility with various SD card modules and enhancing the overall robustness of the codebase.

Changes

File Paths Change Summary
src/HAL/Include/nanoHAL_System_IO_FileSystem.h Added StorageEventType_CardDetectChanged and CardDetectState enums; introduced Library_nf_sys_io_filesystem_nanoFramework_System_IO_CardDetectChangedEventArgs structure.
src/System.IO.FileSystem/nf_sys_io_filesystem.h Updated enums and structures related to SD card management; added fields for card detection enhancements.
src/System.IO.FileSystem/nf_sys_io_filesystem.cpp Modified method_lookup array and updated assembly version identifier.
targets/ESP32/_common/DeviceMapping_common.cpp Added Esp32_GetSDmmcDevicePins_C function for SDMMC device pin retrieval; updated mapping logic to include SDMMC support.
targets/ESP32/_common/ESP32_DeviceMapping.cpp Introduced Esp32_SDMMC_DevicePinMap array for SDMMC device configuration.
targets/ESP32/_common/Target_System_IO_FileSystem.c Removed conditional compilation directive, enhanced documentation, and updated logging for SD card initialization.
targets/ESP32/_include/Esp32_DeviceMapping.h Added Esp32SdmmcPin enumeration and updated Esp32_MapDeviceType to include DEV_TYPE_SDMMC.
targets/ESP32/_nanoCLR/System.Device.Gpio/cpu_gpio.cpp Introduced current member in gpio_input_state struct for tracking GPIO input state.
targets/ESP32/_nanoCLR/System.IO.FileSystem/nf_sys_io_filesystem_nanoFramework_System_IO_FileSystem_SDCard.cpp Refactored GetMMCPins to accept slotIndex, enhancing pin mapping logic and simplifying event handling.

Assessment against linked issues

Objective Addressed Explanation
Support configuring GPIO numbers for SDCARD on the ESP32-S3 platform (#1447)
Correct card detection logic for varying pin states to indicate card presence (#1475) Logic needs to correctly reflect pin behavior for card detection.

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

coderabbitai[bot] avatar Aug 13 '24 05:08 coderabbitai[bot]

@josesimoes Any reason why this can't be merged ?

AdrianSoundy avatar Nov 29 '24 21:11 AdrianSoundy