Skip to content

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Feb 22, 2025

Description

When creating and disposing a number of I2CDevice objects the driver was disposed wrongly due to error in code counting open devices.

This fixes the counter logic.

The scan example should be changed to dispose I2CDevice objects otherwise memory is filled with unused objects until GC runs.
Other code should do the same when I2CDevcie is no longer in use.

Motivation and Context

How Has This Been Tested?

Tested with I2C scan program

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

  • 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

  • Refactor
    • Enhanced I2C bus management by updating internal tracking to support a broader range of values.
    • Adjusted the initialization logic to reliably update device activation counts for greater consistency.

Automated fixes for code style.
Copy link
Contributor

coderabbitai bot commented Feb 22, 2025

Walkthrough

The changes update the data type of the Esp_I2C_Initialised_Flag array from uint8_t to int16_t in both the header and corresponding source file, allowing the flag to represent a broader range of integer values. Additionally, the control flow in the NativeInit___VOID method (in the I2C device source file) has been modified so that the initialization flag is incremented on every call rather than only during the first initialization.

Changes

File(s) Change Summary
targets/ESP32/_include/.../targetPAL_I2c.h, targets/ESP32/_nanoCLR/.../targetPAL_I2c.cpp Updated the data type of Esp_I2C_Initialised_Flag from uint8_t to int16_t.
targets/ESP32/_nanoCLR/.../sys_dev_i2c_native_System_Device_I2c_I2cDevice.cpp Moved the increment of Esp_I2C_Initialised_Flag[bus] outside the conditional block in NativeInit___VOID.

Possibly related PRs

Suggested labels

Area: Common libs, Platform: ESP32

Suggested reviewers

  • josesimoes

📜 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 77d7ed5 and 956a838.

📒 Files selected for processing (1)
  • targets/ESP32/_nanoCLR/System.Device.I2c/sys_dev_i2c_native_System_Device_I2c_I2cDevice.cpp (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • targets/ESP32/_nanoCLR/System.Device.I2c/sys_dev_i2c_native_System_Device_I2c_I2cDevice.cpp
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_ETHERNET_KIT_1.2)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_S3_ALL)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_H2_THREAD)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_C6_THREAD)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_C3)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_BLE_REV0)
  • GitHub Check: nf-interpreter (Build_ESP32_targets ESP32_PSRAM_REV0)
  • GitHub Check: nf-interpreter (Check_Code_Style)
  • GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
  • GitHub Check: nf-interpreter (Check_Build_Options)

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

@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)
targets/ESP32/_nanoCLR/System.Device.I2c/sys_dev_i2c_native_System_Device_I2c_I2cDevice.cpp (1)

121-128: Add bounds check in disposal logic.

The disposal logic should validate that the counter is positive before decrementing to prevent potential underflow issues.

-    Esp_I2C_Initialised_Flag[bus]--;
+    if (Esp_I2C_Initialised_Flag[bus] > 0)
+    {
+        Esp_I2C_Initialised_Flag[bus]--;
+    }

     if (Esp_I2C_Initialised_Flag[bus] <= 0)
     {
         i2c_driver_delete(bus);
         Esp_I2C_Initialised_Flag[bus] = 0;
     }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 25f8391 and 77d7ed5.

📒 Files selected for processing (3)
  • targets/ESP32/_include/targetPAL_I2c.h (1 hunks)
  • targets/ESP32/_nanoCLR/System.Device.I2c/sys_dev_i2c_native_System_Device_I2c_I2cDevice.cpp (2 hunks)
  • targets/ESP32/_nanoCLR/targetPAL_I2c.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: nf-interpreter (Check_Code_Style)
  • GitHub Check: nf-interpreter (Nightly build) (Check_Build_Options)
  • GitHub Check: nf-interpreter (Check_Build_Options)
🔇 Additional comments (3)
targets/ESP32/_include/targetPAL_I2c.h (1)

13-13: LGTM! The data type change improves robustness.

The change from uint8_t to int16_t for Esp_I2C_Initialised_Flag provides a much wider range for tracking I2C device initialization counts, which helps prevent potential overflow issues and allows for better detection of mismatched init/dispose calls.

targets/ESP32/_nanoCLR/targetPAL_I2c.cpp (1)

10-16: LGTM! Implementation is consistent with the header.

The data type change to int16_t is properly implemented while maintaining the same initialization logic and cleanup behavior.

targets/ESP32/_nanoCLR/System.Device.I2c/sys_dev_i2c_native_System_Device_I2c_I2cDevice.cpp (1)

97-98: LGTM! Fixed device initialization tracking.

Moving the increment operation outside the initialization block ensures accurate tracking of I2C device instances, fixing the issue where devices weren't being properly counted.

Copy link
Member

@Ellerbach Ellerbach 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! Good finding :-)

@AdrianSoundy AdrianSoundy merged commit aee8329 into nanoframework:main Feb 22, 2025
14 checks passed
@AdrianSoundy AdrianSoundy deleted the I2C-fix branch February 22, 2025 10:41
@josesimoes josesimoes added the Series: ESP32 Everything related specifically with ESP32 series targets label Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Series: ESP32 Everything related specifically with ESP32 series targets Type: bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

New firmware 1.12.3.x thrown a System.InvalidOperationException at the I2C channel

4 participants