feat(Examples): MSDK-1220: Review and update SDK examples #663

ttmut · 2023-07-13T13:40:18Z

Description

This PR adds MAX32690FTHR board support for examples targeting MAX32690. Most examples need no change to their source code and only require adding instructions on board setup into their readme files. The ones dealing with I/O require a few modifications due to having different pins routed to inputs and outputs.

Notable changes:

Commit 183e81a6b20067875a066f735832692963e28aaf adds MAX32690FTHR board support.
~~Commit 1d84ce4cecd65a78b7393bd32c18dfad74eb196e increases the size of bootloader section because it did not fit inside the allocated space.~~
Commit e8ce3c9ea6a20579b01f57bd9e8d5b5034e7f049 changes the test page location to an address within FLC0 address space. Testing a page in FLC1 failed because the example assumed page size to be uniform.
Commit f5efb3f950a24319b3f5f6d9da4cfca85209a0c7 RTS/CTS pins are not available on MAX32690FTHR board.

Also fix implicit cast warning about float to double conversion.

BLE_otac and BLE_otas are not included since they require an external flash which is not available on the feather board.

Increase size of the flash section allocated to bootloader from 16kB to 40kB due to region overflow.

Use P1.11 as ready pin and update README.md.

FLC0 and FLC1 has different page sizes however the example code was using FLC0 page size to perform r/w/e tests on a page in FLC1. Fix this by using a page in FLC0 as test target.

Specify UART IRQ number and IRQ handler for UART0. RTS/CTS pins are also not used on MAX32690FTHR board.

Interrupt mode is not shown and input pin is changed from P2.11 to P1.11 when using MAX32690FTHR.

Do not prompt user to install jumpers if target board is MAX32690FTHR.

Use SW3 for button-triggered demonstration.

ozersa · 2023-07-18T18:26:23Z

Libraries/Boards/MAX32690/FTHR_APPS_P1/Source/board.c

+/**************************************************************************** */
+void mxc_assert(const char *expr, const char *file, int line)
+{
+    printf("MXC_ASSERT %s #%d: (%s)\n", file, line, expr);


There should be
#ifdef DEBUG
printf("MXC_ASSERT %s #%d: (%s)\n", file, line, expr);
#endif

This will decrease code size for bootloader project, probably by adding this line the bootloader will be fit with existing flash area.

ozersa · 2023-07-18T18:28:36Z

Libraries/Boards/MAX32690/FTHR_APPS_P1/Include/board.h

+#define EXT_FLASH_BAUD 4000000
+#endif
+
+#define FTHR_APPS_P1 1 /// Used in examples to control program flow.


Lets double check board name with hw team,
they may just wish to call the board as FTHR.

HW team prefer just FTHR, please rename it as FTHR to simplify things.

ozersa · 2023-07-18T18:30:27Z

Examples/MAX32690/Bootloader/bootloader.ld

@@ -32,7 +32,7 @@
 ******************************************************************************/

 BOOTLOADER_ORIGIN = 0x10000000;
-BOOTLOADER_LEN = 0x4000;
+BOOTLOADER_LEN = 0xA000;


Need to be double check after apply below change
#663 (comment)

It fits inside 0x4000 after applying above change.

EdwinFairchild · 2023-07-18T18:36:41Z

A change was made for MAX32655 examples with similar issue, the change was to not use the LED functions from the sdk and just implement the functions in the bootloader , thus by passing some asserts and other overhead from the msdk fucntions.
seen here:
808fd3e#diff-bfee91fe905e9af3e7b00f87fd7617bfc2cfbe5028309f016bc16c3325066e54R86-R100

ozersa · 2023-07-18T18:45:47Z

Examples/MAX32690/Flash/main.c

    printf("Press Push Button 1 (PB1/SW1) to continue...\n\n");
-
+#else
+    printf("Press Push Button 1 (PB1/SW3) to continue...\n\n");


In past i added PB_IsPressedAny function to able to eliminate this type comment,
https://github.com/Analog-Devices-MSDK/msdk/blob/main/Libraries/MiscDrivers/PushButton/pb.c#L133C1-L133C1

See usage:
https://github.com/Analog-Devices-MSDK/msdk/blob/main/Examples/MAX32672/Comparator/main.c#L79

It can simplify the startup messages too,
Due to it works in polling mode, the led delay can be decreased...

ozersa · 2023-07-18T18:48:04Z

Examples/MAX32690/CAN/main.c

    printf("Press button SW2 to begin example.\n");
+#else
+    printf("Press button SW3 to begin example.\n");


Same as
#663 (comment)

ozersa · 2023-07-18T18:50:42Z

Examples/MAX32690/LPCMP/main.c

    printf("Press SW2 to begin.\n");
+#else
+    printf("Press SW3 to begin.\n");


Same as
#663 (comment)

Enable printf only if DEBUG is explicitly stated so that the bootloader can fit in 4000h bytes of allocated area.

Helps eliminate preprocessor conditionals.

ttmut · 2023-07-20T13:29:19Z

A change was made for MAX32655 examples with similar issue, the change was to not use the LED functions from the sdk and just implement the functions in the bootloader , thus by passing some asserts and other overhead from the msdk fucntions. seen here: 808fd3e#diff-bfee91fe905e9af3e7b00f87fd7617bfc2cfbe5028309f016bc16c3325066e54R86-R100

Thanks for the feedback. Disabling printf seems sufficient for now.

ttmut added 10 commits July 11, 2023 15:15

Add FTHR to supported MAX32690 boards

183e81a

ADC Example: Update README.md to include MAX32690FTHR

1d6b339

Also fix implicit cast warning about float to double conversion.

BLE Examples: Update README.md to include MAX32690FTHR

4732d3e

BLE_otac and BLE_otas are not included since they require an external flash which is not available on the feather board.

Bootloader Example: Increase size of bootloader section

1d84ce4

Increase size of the flash section allocated to bootloader from 16kB to 40kB due to region overflow.

CAN Example: Add MAX32690FTHR support

1864596

Coremark Example: Update README.md to include MAX32690FTHR

3236ed2

CRC Example: Update README.md to include MAX32690FTHR

9da13f1

CTB_AES Example: Update README.md to include MAX32690FTHR

6113cbd

DMA Example: Update README.md to include MAX32690FTHR

d20c0a6

EEPROM_Emulator Example: Add MAX32690FTHR support

23d4d42

Use P1.11 as ready pin and update README.md.

ttmut added WIP work in progress MAX32690 Related to the MAX32690 (ME18) labels Jul 13, 2023

ttmut self-assigned this Jul 13, 2023

github-actions bot added BLE Related to Bluetooth and removed MAX32690 Related to the MAX32690 (ME18) labels Jul 13, 2023

ttmut added 15 commits July 13, 2023 17:23

Flash Example: Set test address to the end of FLC0

e8ce3c9

FLC0 and FLC1 has different page sizes however the example code was using FLC0 page size to perform r/w/e tests on a page in FLC1. Fix this by using a page in FLC0 as test target.

Flash_CLI Example: Update README.md to include MAX32690FTHR

77994a7

FreeRTOSDemo Example: Add support for MAX32690FTHR

f5efb3f

Specify UART IRQ number and IRQ handler for UART0. RTS/CTS pins are also not used on MAX32690FTHR board.

GPIO Example: Add MAX32690FTHR support

bec14f7

Interrupt mode is not shown and input pin is changed from P2.11 to P1.11 when using MAX32690FTHR.

Hello_World Example: Update README.md to include MAX32690FTHR

c47c1d1

Hello_World_Cpp Example: Update README.md to include MAX32690FTHR

0a5b136

Hash Example: Update README.md to include MAX32690FTHR

2d60465

I2C Example: Update README.md to include MAX32690FTHR

da9261e

I2C_MNGR Example: Update README.md to include MAX32690FTHR

c3194a7

I2C_Scan Example: Add support for MAX32690FTHR

6d6cf39

Do not prompt user to install jumpers if target board is MAX32690FTHR.

I2C_Sensor Example: Update README.md to include MAX32690FTHR

3bfd664

I2S Example: Update README.md to include MAX32690FTHR

4c72dd6

ICC Example: Update README.md to include MAX32690FTHR

8b20e39

Library_Use Example: Update README.md to include MAX32690FTHR

a84bf96

LP Example: Add support for MAX32690FTHR

64ed691

Use SW3 for button-triggered demonstration.

clang formatting fix

95b8ae3

ttmut added MAX32690 Related to the MAX32690 (ME18) and removed WIP work in progress BLE Related to Bluetooth labels Jul 14, 2023

ttmut requested review from EdwinFairchild, ozersa and lorne-maxim July 14, 2023 15:08

github-actions bot added BLE Related to Bluetooth and removed MAX32690 Related to the MAX32690 (ME18) labels Jul 14, 2023

ttmut marked this pull request as ready for review July 14, 2023 15:09

ttmut removed the BLE Related to Bluetooth label Jul 14, 2023

ozersa reviewed Jul 18, 2023

View reviewed changes

Merge branch 'main' into dev/me18_fthr_apps_p1

2735ebe

github-actions bot added MAX32690 Related to the MAX32690 (ME18) BLE Related to Bluetooth labels Jul 19, 2023

ttmut added 3 commits July 20, 2023 15:14

Rename FTHR_APPS_P1 to FTHR

176dbc8

Revert 1d84ce4 and disable printf

e0fc49f

Enable printf only if DEBUG is explicitly stated so that the bootloader can fit in 4000h bytes of allocated area.

Use PB_IsPressedAny where possible

5e07abd

Helps eliminate preprocessor conditionals.

ozersa approved these changes Jul 21, 2023

View reviewed changes

Jake-Carter approved these changes Jul 24, 2023

View reviewed changes

sihyung-maxim approved these changes Jul 25, 2023

View reviewed changes

sihyung-maxim merged commit 9a649af into main Jul 25, 2023

sihyung-maxim deleted the dev/me18_fthr_apps_p1 branch July 25, 2023 14:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(Examples): MSDK-1220: Review and update SDK examples #663

feat(Examples): MSDK-1220: Review and update SDK examples #663

Uh oh!

ttmut commented Jul 13, 2023 •

edited

Loading

Uh oh!

ozersa Jul 18, 2023

Uh oh!

ttmut Jul 20, 2023

Uh oh!

ozersa Jul 18, 2023

Uh oh!

ozersa Jul 20, 2023

Uh oh!

ttmut Jul 20, 2023

Uh oh!

ozersa Jul 18, 2023

Uh oh!

ttmut Jul 20, 2023

Uh oh!

EdwinFairchild commented Jul 18, 2023

Uh oh!

ozersa Jul 18, 2023

Uh oh!

ttmut Jul 20, 2023

Uh oh!

ozersa Jul 18, 2023

Uh oh!

ttmut Jul 20, 2023

Uh oh!

ozersa Jul 18, 2023

Uh oh!

ttmut Jul 20, 2023

Uh oh!

ttmut commented Jul 20, 2023

Uh oh!

Uh oh!

feat(Examples): MSDK-1220: Review and update SDK examples #663

feat(Examples): MSDK-1220: Review and update SDK examples #663

Uh oh!

Conversation

ttmut commented Jul 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EdwinFairchild commented Jul 18, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ttmut commented Jul 20, 2023

Uh oh!

Uh oh!

ttmut commented Jul 13, 2023 •

edited

Loading