Update Flash Examples, Add API for Critical Sections #357

Jake-Carter · 2023-01-24T22:42:24Z

This PR resolves #287 by fixing and simplifying all micro's Flash examples. It also adds a purely inline API for entering and exiting a critical section of code to all micro's mxc_sys.h.

Flash examples key changes:

Simplify overall program flow and functions
Execute code from Flash instead of RAM like a standard example.
Execute flash writes from a critical section of code to enable the point above
Remove misleading flash clock divider

Critical Section API key changes:

Add MXC_SYS_Crit_Enter/Exit and MXC_SYS_In_Crit_Section functions to mxc_sys.h (supports ARM and RISC-V)
Add MXC_CRITICAL(...) macro to mxc_sys.h
Modify Libraries/CMSIS/5.9.0/Core/Include/core_rv32.h to undefine __CORTEX_M when building for RISC-V

Critical Section Example Usage:

MXC_CRITICAL(myfunction())

or...

MXC_CRITICAL(
    int myvar = 0;
    myvar = myfunction();
    // more critical code...
    )

This macro is equivalent to:

    MXC_SYS_Crit_Enter();
    int myvar = 0;
    myvar = myfunction();
    // more critical code...
    MXC_SYS_Crit_Exit();

How to Review:
Check out the fix/flash-examples branch locally and open the Flash example in your preferred IDE. Review the readme and run through the example on your preferred micro.

Optionally review the critical API implementation in mxc_sys.h for your preferred micro.

Jake-Carter · 2023-01-24T22:51:00Z

Note to self: reverted some commits that accidentally made it from fix/csi2

Jacob-Scheiffler · 2023-01-25T16:07:47Z

Libraries/PeriphDrivers/Include/MAX32655/mxc_sys.h

+static inline void MXC_SYS_Crit_Enter(void)
+{
+    _mxc_crit_get_state();
+    if (_state.ie_status)


Add curly brackets to these if statements.

Jacob-Scheiffler · 2023-01-25T16:14:00Z

Libraries/PeriphDrivers/Include/MAX32655/mxc_sys.h

+ * @brief Exit a critical section of code, re-enabling interrupts if they
+ *        were previously.
+ */
+static inline void MXC_SYS_Crit_Exit(void)


Why these are inline functions? Not saying it's wrong or needs to be changed, just curious.

Inline is used to give the lowest possible timing overhead. Since this API is essentially just a wrapper around an assembly function, it doesn't make sense to add the 2-4uS overhead associated with a normal function call. Especially because the code needs to enter the critical section as soon as possible to avoid getting interrupted on its way there.

It's "static inline" as well because that is a forced requirement for accessing other static member variables and using static function calls.

Jacob-Scheiffler · 2023-01-25T16:29:52Z

Examples/MAX32660/Flash/main.c

-#define TESTSIZE 8192 //2 pages worth so we can do erase functions
-
-#define MXC_FLASH_MEM_SIZE_TEST MXC_FLASH_MEM_SIZE
+#define TEST_ADDRESS 0x0003E000


Define TEST_ADDRESS with MXC_FLASH_ defines. (MXC_FLASH_MEM_SIZE - <page_num>*MXC_FLASH_PAGE_SIZE)

Thanks, I like that. Done in 9be3fd4

Jacob-Scheiffler · 2023-01-25T16:31:00Z

Examples/MAX32660/Flash/main.c

    }
+    printf("Done!\n");


Should the write be validated here as well?

Yes it makes sense to validate again here. Added in 6c58802

Jacob-Scheiffler · 2023-01-25T16:32:16Z

Examples/MAX32660/Flash/main.c

+            printf("----------------\n");
+        )
+        // clang-format on
+        if (err)


Add curly brackets. Same for lines 283, 293, and 296.

sihyung-maxim · 2023-01-26T15:52:57Z

The max32672.h changes were merged into main. And hopefully with the inclusion of Libraries/CMSIS/5.9.0/Core/Include/core_cm4.h, the build examples action will pass. I'll review when it's ready!

- Simplify example and demonstrate Flash values surviving a power cycle/reset

Add API for critical sections to AI85 mxc_sys drivers

- Remove local headers that now live in MiscDrivers - Add MiscDrivers to IPATH/VPATH in board.mk files

Jake-Carter · 2023-01-31T23:15:17Z

@sihyung-maxim build issues are fixed, ready for your review

sihyung-maxim

Nice. I like these new Flash examples.

Only thing I noticed was a small typo present in all the READMEs and main.c printfs.

sihyung-maxim · 2023-02-01T19:58:13Z

Examples/MAX32520/Flash/README.md

+Press Push Button 1 (PB1/SW1) to continue...
+
+---(Critical)---
+Sucessfully erased page 64 of flash (addr 0x1007e000)


Typo for Successfully.

sihyung-maxim · 2023-02-01T20:06:05Z

Examples/MAX32520/Flash/main.c

-    if (retval != E_NO_ERROR) {
-        return retval;
-    }
+    printf("Sucessfully verified test pattern!\n\n");


Typo for successfully.

sihyung-maxim · 2023-02-01T20:06:45Z

Examples/MAX32572/Flash/main.c

    }

-    retval = MXC_FLC_Write(end, end_len, buffer);
+    printf("Sucessfully verified test pattern!\n\n");


Typo for successfully

Jacob-Scheiffler suggested changes Jan 25, 2023

View reviewed changes

Jake-Carter requested a review from Jacob-Scheiffler January 25, 2023 20:15

Jacob-Scheiffler approved these changes Jan 26, 2023

View reviewed changes

Jake-Carter added 25 commits January 26, 2023 11:42

Preliminary modifications for AI85 Flash example

75d0a21

- Simplify example and demonstrate Flash values surviving a power cycle/reset

Further simplify example and demonstrate flash modification

248e7aa

Use new crit section API to demonstrate FLC interrupts

67d745f

Add API for critical sections to AI85 mxc_sys drivers

Update mxc_crit.c implementation

ea42578

Move mxc_crit implementation to be purely inline

ad48458

Use renamed MXC_CRITICAL

b370733

Undefine __CORTEX_M when building for RISCV

fa1ac27

Support MXC_CRITICAL on RISCV

101ecb8

Clean up printfs and comments

d88bb02

Clean up comments and printf

b191a32

Update README

7eabec4

Clean up project.mk

85e7353

Clean up unused definitions

ebae562

Sync Makefile with latest template

4382179

Lint & format

b988579

Lint & format

84c508d

clang-format

f1d4f97

Port mxc_crit implementation to all micros

f3e7a7c

Port Flash example to AI87

a002825

Port Flash example to all micros (TODO: match addresses/readmes

1c0505f

Clean up doxygen comment

a33592d

Port Flash example to MAX32690

eea5d14

Port Flash example to MAX32680

e8711fb

Port Flash example to MAX32675

d1e3b15

Port Flash example to MAX32670

df2a68f

Jake-Carter and others added 17 commits January 26, 2023 11:42

Port Flash example to MAX32665

ae0a99c

Port Flash example to MAX32662

397d52b

Port Flash example to MAX32660

5cd99f5

Port Flash example to MAX32655

1f7be25

Port Flash example to MAX32650

ddeb665

Port Flash example to MAX32520

5e994d4

Add missing LED1/LED2 definitions

ee0bffd

Port Flash example to MAX32672

a84cb2b

Match readme section

9cccb01

Clean up doxygen comment

ab6b0fd

Update readmes

c51fe65

clang-format

fd44ad0

Calculate TEST_ADDRESS with FLC #defines

a9dcfb3

Validate test pattern after first write

42d8d12

Remove misleading FLC clock div

7cfcf26

Fix MAX32672 build issue

9eea3a3

- Remove local headers that now live in MiscDrivers - Add MiscDrivers to IPATH/VPATH in board.mk files

Fix MAX32672 build issue

324896d

Jake-Carter force-pushed the fix/flash-examples branch from 4c2327e to 324896d Compare January 26, 2023 17:43

Jake-Carter added 2 commits January 31, 2023 13:02

Locate MISC_DRIVER_DIR off of BOARD_DIR rel path

fa00271

Define MXC_FLASH_MEM_SIZE for MAX32690 (Flash0 + Flash1)

b598124

sihyung-maxim approved these changes Feb 1, 2023

View reviewed changes

Suc(c)essfully fixed typo

fd9b96b

Jake-Carter merged commit ae65f87 into main Feb 1, 2023

Jake-Carter deleted the fix/flash-examples branch February 1, 2023 23:20

Jake-Carter mentioned this pull request Apr 27, 2023

Added support for >1MHz I2C and corrected SPI Mode 1 and 2. Various bug fixes including ME16 timers, USB Suspend / Resume operation and ME18 USB peripheral reset bit. #564

Merged

Update Flash Examples, Add API for Critical Sections #357

Update Flash Examples, Add API for Critical Sections #357

Uh oh!

Conversation

Jake-Carter commented Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jake-Carter commented Jan 24, 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!

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!

sihyung-maxim commented Jan 26, 2023

Uh oh!

Jake-Carter commented Jan 31, 2023

Uh oh!

sihyung-maxim left a comment

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!

Uh oh!

Jake-Carter commented Jan 24, 2023 •

edited

Loading