Skip to content

Commit aba4b7d

Browse files
MPAE-18297: Fixed tool name
1 parent 8a44f20 commit aba4b7d

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This example demonstrates how to utilize the MPLAB Code Configurator (MCC) generated code to set up various basic Microchip Device Firmware Update (MDFU) bootloader solutions for the PIC16F18446 Curiosity Nano Evaluation board.
88

9-
The MDFU is a firmware update system that employs a device-independent host application to update application firmware. The application image loaded into the host adheres to a custom file format, incorporating device and application-specific parameters necessary for the update. This repository offers a foundational setup to configure and customize the MCC Melody 8-Bit MDFU Client library on the PIC16F18446 Curiosity Nano Base for Click boards™, along with instructions for executing the examples.
9+
The MDFU is a firmware update system that employs a device-independent host application to update application firmware. The application image loaded into the host adheres to a custom file format, incorporating device and application-specific parameters necessary for the update. This repository offers a foundational setup to configure and customize the MCC Melody 8-Bit MDFU Client library on the PIC16F18446 Curiosity Nano Evaluation board with instructions for executing the examples.
1010

1111
This example demonstrates:
1212
- How to configure the 8-Bit MDFU Client Library in MCC Melody for different verification schemes
@@ -38,22 +38,22 @@ This example demonstrates:
3838
[![PIC16F18446_CNano](images/190702-MCU8-PHOTO-DM164144-Front-Transparent_crop.png)](images/190702-MCU8-PHOTO-DM164144-Front-Transparent_crop.png)
3939

4040
## Setup
41-
The following project setup steps will demonstrate the basic configuration steps for setting up the 8-Bit MDFU Client with Universal Asynchronous Receiver and Transmitter (UART) communication. The configuration bits, clock, Non-Volatile Memory (NVM), and General Purpose Input/Output (GPIO) settings will be consistent across all examples in this repository and any deviations from this setup due to the chosen communication protocol will be described individually later in this section.
41+
The following project setup steps will demonstrate the basic configuration of the 8-Bit MDFU Client with Universal Asynchronous Receiver and Transmitter (UART) communication. The configuration bits, clock, Non-Volatile Memory (NVM), and General Purpose Input/Output (GPIO) settings will be consistent across all examples in this repository and any deviations from this setup due to the chosen communication protocol will be described individually later in this section.
4242

4343
### Bootloader Client Setup
4444
[![mdfu-builder](images/ProjectConfigurationOverview.PNG)](images/ProjectConfigurationOverview.PNG)
4545

4646
**Configuration Bits**
4747
- External Oscillator Selection bits: Oscillator not enabled
48-
- Reset Oscillator Selection bits: HFINTOSC (1MHz)
48+
- Reset Oscillator Selection bits: HFINTOSC (1 MHz)
4949

5050
[![CFG](images/ConfigBitsSetup.PNG)](images/ConfigBitsSetup.PNG)
5151

5252
**Clock Control**
5353
- Clock Source: HFINTOSC
5454
- HF Internal Clock: 4_MHz
5555

56-
*For CRC16 and CRC32 the Clock is set to 32_MHz*
56+
*For CRC16 and CRC32 the Clock is set to 32 MHz*
5757

5858
- Clock Divider: 1
5959

@@ -67,7 +67,7 @@ The following project setup steps will demonstrate the basic configuration steps
6767

6868
**8-Bit MDFU Client**
6969

70-
This section will guide you through the setup process for UART communication. For more details on configuring and operating other communication protocols, please refer to the pages listed below
70+
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.
7171
- [SPI Communication](pic16f18446-spi/Readme.md)
7272

7373
**8-Bit MDFU Client with UART Communication**
@@ -123,7 +123,7 @@ Configure these pins as follows:
123123

124124
[![IO-Pins](images/IOPortSetup.PNG)](images/IOPortSetup.PNG)
125125
- BOOT INDICATE: Start High
126-
- BOOT ENTRY: Weak Pullup
126+
- BOOT ENTRY: Weak Pull-up
127127

128128
[![IO-Settings](images/IOPinsSetup.PNG)](images/IOPinsSetup.PNG)
129129

@@ -153,7 +153,7 @@ This section is consistent for any example created in this repository.
153153
**I/O Pins**
154154
- GPIO Input: RC2
155155
- Custom Name: BTN
156-
- Weak Pullup: Enabled
156+
- Weak Pull-up: Enabled
157157
- GPIO Output: RA2
158158
- Custom Name: LED
159159

@@ -191,7 +191,7 @@ Fill Flash Memory
191191
**End Application**
192192

193193
* Open `main.c`
194-
* Add logic inside the while loop to toggle the onboard LED with a 200 ms rate
194+
* Add logic inside the while loop to toggle the on-board LED with a 200 ms rate
195195
* Add logic under that to reset the device if the BTN is pressed
196196
```
197197
while(1)
@@ -225,7 +225,7 @@ applicationFooter __attribute__((used, section("application_footer"))) = 0xFFFF;
225225
```
226226

227227
## Operation
228-
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:
228+
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:
229229
- [SPI Example Operation](pic16f18446-spi/Readme.md#operation)
230230

231231
**8-Bit MDFU Client Operation**
@@ -296,7 +296,7 @@ Below is an example of the command used in the above step.
296296
297297
- To run the update with the examples, 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.
298298
- Edit the port number to the CDC port name that is assigned to the Curiosity Nano device
299-
- Then right click on the script and select Run
299+
- Right click on the script and select Run
300300

301301
[![UpdateScript_BL](images/runUpdateScript.PNG)](images/runUpdateScript.PNG)
302302

pic16f18446-spi/Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
[![IO-Pins](../images/IOPortSetup.PNG)](../images/IOPortSetup.PNG)
5353

5454
- BOOT INDICATE: Start High
55-
- BOOT ENTRY: Weak Pullup
55+
- BOOT ENTRY: Weak Pull-up
5656

5757
[![IO-Settings](../images/IOPinsSetup.PNG)](../images/IOPinsSetup.PNG)
5858

0 commit comments

Comments
 (0)