M8BTL-4158: Adding github examples for MDFU Client I2C support

Author: SukanyaPalanisami

README.md

@@ -68,7 +68,8 @@ The following project setup steps will demonstrate the basic configuration of th
 **8-Bit MDFU Client**
 
 This section will guide you through the setup process for UART communication. For more details on configuring and operating other communication protocols, refer to the pages listed below.
-- [SPI Communication](pic16f18446-spi/Readme.md)
+- [SPI Communication](spi/README.md)
+- [I<sup>2</sup>C Communication](i2c/README.md)
 
 **8-Bit MDFU Client with UART Communication**
 
@@ -226,7 +227,8 @@ applicationFooter __attribute__((used, section("application_footer"))) = 0xFFFF;
 
 ## Operation
 In this section, we will walkthrough how to run the examples in this repository. This example shows how to execute the Checksum verification example and update the device Flash memory with the checksum application image to demonstrate a successful Device Firmware Update (DFU) using UART communication. For additional communication protocol operation information, refer to the pages listed below:
-- [SPI Example Operation](pic16f18446-spi/Readme.md#operation)
+- [SPI Example Operation](spi/README.md#operation)
+- [I<sup>2</sup>C Example Operation](i2c/README.md#operation)
 
 **8-Bit MDFU Client Operation**
 

i2c/README.md

@@ -0,0 +1,149 @@
+[![MCHP](../images/microchip.png)](https://www.microchip.com)
+
+# 8-Bit MDFU Client Setup for I<sup>2</sup>C Communication
+
+[Go Back](../README.md)
+
+## Required Hardware
+- [Curiosity Nano Base for Click boards™](https://www.microchip.com/en-us/development-tool/AC164162)
+- [MCP2221A Breakout Module](https://www.microchip.com/en-us/development-tool/ADM00559)
+-  Three female-to-male jumper wires
+
+## Hardware Configuration
+[![MDFU_I2C_HW](../images/i2c/HardwareSetup_I2C.png)](../images/i2c/HardwareSetup_I2C.png)
+
+## 8-Bit MDFU Client I<sup>2</sup>C Communication
+
+- Communication Protocol: I2C
+- Application Start Address: 0x2000
+- Device ID: 0x30D4 (automatically added)
+- I/O Pin Indicator: Enabled
+- I/O Pin Entry: Enabled
+- Memory Verification: CRC32
+
+[![MDFU](../images/i2c/MDFUClientSetup.png)](../images/i2c/MDFUClientSetup.png)
+
+**I2C**
+- Custom Name: SERCOM
+- Client Address: 0x20
+- Client Mask: 0x7F
+- I2C Client PLIB Selector: MSSP2
+
+[![I2C](../images/i2c/I2CDriverSetup.png)](../images/i2c/I2CDriverSetup.png)
+
+**MSSP2 PLIB**
+- Serial Protocol: I2C
+- Interrupt Driven: Enabled
+
+[![I2C_PLIB](../images/i2c/I2CPLIBSetup.png)](../images/i2c/I2CPLIBSetup.png)
+
+**I2C Pins**
+- MSSP SCL: RB7
+- MSSP SDA: RB5
+
+[![I2C_Pins](../images/i2c/I2CPortsSetup.png)](../images/i2c/I2CPortsSetup.png)
+
+**8-Bit MDFU Client I/O**
+- BOOT INDICATE: RA2
+- BOOT ENTRY: RC2
+
+[![IO-Pins](../images/i2c/IOPortSetup.png)](../images/i2c/IOPortSetup.png)
+
+- BOOT INDICATE: Start High
+- BOOT ENTRY: Weak Pull-up
+
+[![IO-Settings](../images/IOPinsSetup.PNG)](../images/IOPinsSetup.PNG)
+
+**8-Bit MDFU Client Project Properties**
+- ROM Ranges: This option is configured based on the application's start address. For example, if the application starts at 0x2000 then this value will reflect as 00-7FF,800-FFF,1000-17FF,1800-1FFF.
+
+[![IO-Settings](../images/i2c/ProjectProperties.png)](../images/i2c/ProjectProperties.png)
+
+### Application Setup
+Refer to the [Application Setup](../README.md#application-setup) section in the main Readme file.
+
+## Operation
+This example shows how to execute the CRC32 verification example and update the device Flash memory with the CRC32 application image to demonstrate a successful device firmware update (DFU) over the I<sup>2</sup>C communication protocol.
+
+**8-Bit MDFU Client Operation**
+
+1. Open the MDFU client project.
+
+[![OpenMDFU](../images/openBtnMDFU.png)](../images/openBtnMDFU.png)
+
+[![OpenMDFUProject](../images/i2c/openProjectMDFU.png)](../images/i2c/openProjectMDFU.png)
+
+2. Set MDFU client project as Main Project.
+
+[![SetAsMainMDFUProject](../images/setAsMainProject_SPI.PNG)](../images/setAsMainProject_SPI.PNG)
+
+3. Right click, then select Clean and Build.
+
+[![CleanBuild](../images/i2c/CleanAndBuildMDFU.png)](../images/i2c/CleanAndBuildMDFU.png)
+
+4. Program the MDFU client project.
+
+[![ProgramMDFU](../images/i2c/ProgramMDFU.png)](../images/i2c/ProgramMDFU.png)
+
+**Bootloader Operation after initial programming**
+
+After initial programming, the LED must be on.
+
+[![MDFU_BootMode](../images/i2c/PIC16F18446_BootMode.png)](../images/i2c/PIC16F18446_BootMode.png)
+
+**Application Operation**
+1. Open the application project configured for the selected verification scheme.
+
+[![OpenApp](../images/openBtnApp_SPI.PNG)](../images/openBtnApp_SPI.PNG)
+
+[![OpenAppProject](../images/i2c/openProjectApp.png)](../images/i2c/openProjectApp.png)
+
+2. Set the application project as the Main Project.
+
+[![MainAppProject](../images/setAppAsMainProject_SPI.PNG)](../images/setAppAsMainProject_SPI.PNG)
+
+3. Build the application project.
+
+Right click, then select Clean and Build.
+
+[![CleanBuild_App](../images/i2c/CleanAndBuildApp.png)](../images/i2c/CleanAndBuildApp.png)
+
+4. Build the Application Image File using [pyfwimagebuilder](https://pypi.org/project/pyfwimagebuilder/).
+
+- Navigate to the Project tab and right click on *Important Files>`build_free_image.bat`* for Windows or *Important Files>`build_free_image.sh`* for Mac and Linux.
+- Select Run.
+
+[![Run_BuildScript](../images/RunBuildScript_SPI.PNG)](../images/RunBuildScript_SPI.PNG)
+
+**Example Command:**
+
+Below is an example of the command used in the above step.
+
+`pyfwimagebuilder build -i "application_hex_file.hex"  -c "mdfu_config_file.toml" -o output.img`
+
+[![build_img](../images/i2c/BuildTheImage.png)](../images/i2c/BuildTheImage.png)
+
+> **Tip**: The configuration TOML file is generated by the MDFU Client project.
+
+[![FindTheTOML_BL](../images/ConfigPathExample_SPI.PNG)](../images/ConfigPathExample_SPI.PNG)
+
+5. Use the [pymdfu](https://pypi.org/project/pymdfu/) Host tool to transfer the application image file to the bootloader.
+
+- Navigate to the project tab and right click, *Important Files>`pymdfu_update.bat`* for Windows or *Important Files>`pymdfu_update.sh`* for Mac and Linux. Double click to open the file.
+- Then right click on the script in the Files tab and select Run.
+
+[![UpdateScript_BL](../images/runUpdateScript_SPI.PNG)](../images/runUpdateScript_SPI.PNG)
+
+**Example Command:**
+
+Below is an example of the command used in the above step.
+
+`pymdfu update --tool mcp2221a --image ./output.img --interface i2c --address 32 --clk-speed 100k`
+
+[![transfer_img](../images/i2c/SendTheImage.png)](../images/i2c/SendTheImage.png)
+
+**Application Has Been Updated Successfully**
+
+[![MDFU_AppMode](../images/i2c/PIC16F18446_AppMode.gif)](../images/i2c/PIC16F18446_AppMode.gif)
+
+[Back to top](#8-bit-mdfu-client-setup-for-i2c-communication)

pic16f18446-checksum/pic16f18446-application-checksum.X/Makefile renamed to i2c/pic16f18446-application-crc32.X/Makefile

@@ -0,0 +1,85 @@
+ /*
+ * MAIN Generated Driver File
+ * 
+ * @file main.c
+ * 
+ * @defgroup main MAIN
+ * 
+ * @brief This is the generated driver implementation file for the MAIN driver.
+ *
+ * @version MAIN Driver Version 1.0.2
+ *
+ * @version Package Version: 3.1.2
+*/
+
+/*
+© [2025] Microchip Technology Inc. and its subsidiaries.
+
+    Subject to your compliance with these terms, you may use Microchip 
+    software and any derivatives exclusively with Microchip products. 
+    You are responsible for complying with 3rd party license terms  
+    applicable to your use of 3rd party software (including open source  
+    software) that may accompany Microchip software. SOFTWARE IS ?AS IS.? 
+    NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS 
+    SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,  
+    MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT 
+    WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
+    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY 
+    KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF 
+    MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE 
+    FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S 
+    TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT 
+    EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR 
+    THIS SOFTWARE.
+*/
+#include "mcc_generated_files/system/system.h"
+#include <stdint.h>
+#ifdef __XC8__
+#include <xc.h>
+#endif
+
+volatile const uint32_t 
+#ifdef __XC8__
+__at(0x3FFC)
+#endif
+
+applicationFooter __attribute__((used, section("application_footer"))) = 0xFFFFFFFF;
+
+void BlinkLED(void)
+{
+    LED_Toggle();
+}
+
+/*
+    Main application
+*/
+
+int main(void)
+{
+    SYSTEM_Initialize();
+    // If using interrupts in PIC18 High/Low Priority Mode you need to enable the Global High and Low Interrupts 
+    // If using interrupts in PIC Mid-Range Compatibility Mode you need to enable the Global and Peripheral Interrupts 
+    // Use the following macros to: 
+
+    // Enable the Global Interrupts 
+    INTERRUPT_GlobalInterruptEnable(); 
+
+    // Disable the Global Interrupts 
+    //INTERRUPT_GlobalInterruptDisable(); 
+
+    // Enable the Peripheral Interrupts 
+    INTERRUPT_PeripheralInterruptEnable(); 
+
+    // Disable the Peripheral Interrupts 
+    //INTERRUPT_PeripheralInterruptDisable(); 
+    
+    TMR0_OverflowCallbackRegister(&BlinkLED);
+
+    while (1)
+    {
+        if (BTN_GetValue() == 0U)
+        {
+            RESET();
+        }
+    }      
+}

pic16f18446-spi/pic16f18446-application-crc32.X/build_free_image.bat renamed to i2c/pic16f18446-application-crc32.X/build_free_image.bat

@@ -0,0 +1,27 @@
+# This file has been autogenerated by MPLAB Code Configurator. Please do not edit this file.
+
+manifest_file_version: 1.0.0
+project: pic16f18446-application-crc32
+creation_date: 2025-01-08T15:18:35.927-07:00[America/Phoenix]
+operating_system: Windows 10
+mcc_mode: IDE
+mcc_mode_version: v6.20
+device_name: PIC16F18446
+compiler: XC8 2.50
+mcc_version: 5.5.1
+mcc_core_version: 5.7.1
+content_manager_version: 5.0.1
+is_mcc_offline: false
+is_using_prerelease_versions: true
+mcc_content_registries: https://registry.npmjs.org/, https://artifacts.microchip.com/artifactory/api/npm/npm
+device_library: {library_class: com.microchip.mcc.melody.Library, name: Melody, version: 2.8.0}
+packs: {name: PIC16F1xxxx_DFP, version: 1.25.389}
+modules:
+- {name: '@mchp-mcc/main-manager', type: MELODY, version: 3.1.2}
+- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.28.4}
+- {name: '@mchp-mcc/pic16-configuration-bits-v3', type: MELODY, version: 1.0.5}
+- {name: '@mchp-mcc/pic16-pin-manager', type: MELODY, version: 3.6.1}
+- {name: '@mchp-mcc/pin-content-processor', type: MELODY, version: 3.9.0}
+- {name: '@mchp-mcc/scf-pic8-interrupt-v2', type: MELODY, version: 5.2.12}
+- {name: '@mchp-mcc/scf-pic8-osc-v1', type: MELODY, version: 4.3.7}
+- {name: '@mchp-mcc/scf-pic8-tmr0-v1', type: MELODY, version: 5.0.0}

pic16f18446-crc32/pic16f18446-application-crc32.X/build_free_image.sh renamed to i2c/pic16f18446-application-crc32.X/build_free_image.sh

@@ -0,0 +1,27 @@
+# This file has been autogenerated by MPLAB Code Configurator. Please do not edit this file.
+
+manifest_file_version: 1.0.0
+project: pic16f18446-application-crc32
+creation_date: 2025-01-08T15:18:35.914-07:00[America/Phoenix]
+operating_system: Windows 10
+mcc_mode: IDE
+mcc_mode_version: v6.20
+device_name: PIC16F18446
+compiler: XC8 2.50
+mcc_version: 5.5.1
+mcc_core_version: 5.7.1
+content_manager_version: 5.0.1
+is_mcc_offline: false
+is_using_prerelease_versions: true
+mcc_content_registries: https://registry.npmjs.org/, https://artifacts.microchip.com/artifactory/api/npm/npm
+device_library: {library_class: com.microchip.mcc.melody.Library, name: Melody, version: 2.8.0}
+packs: {name: PIC16F1xxxx_DFP, version: 1.25.389}
+modules:
+- {name: '@mchp-mcc/main-manager', type: MELODY, version: 3.1.2}
+- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.28.4}
+- {name: '@mchp-mcc/pic16-configuration-bits-v3', type: MELODY, version: 1.0.5}
+- {name: '@mchp-mcc/pic16-pin-manager', type: MELODY, version: 3.6.1}
+- {name: '@mchp-mcc/pin-content-processor', type: MELODY, version: 3.9.0}
+- {name: '@mchp-mcc/scf-pic8-interrupt-v2', type: MELODY, version: 5.2.12}
+- {name: '@mchp-mcc/scf-pic8-osc-v1', type: MELODY, version: 4.3.7}
+- {name: '@mchp-mcc/scf-pic8-tmr0-v1', type: MELODY, version: 5.0.0}