tests/periph_flashpage: test reserving of flash memory

Author: Ollrogge

tests/periph_flashpage/main.c

@@ -55,6 +55,13 @@ static char raw_buf[RAW_BUF_SIZE] ALIGNMENT_ATTR;
  *          requires 64 bit alignment.
  */
 static uint8_t page_mem[FLASHPAGE_SIZE] ALIGNMENT_ATTR;
+
+/**
+ * @brief Reserve 1 page of flash memory
+ */
+static const uint8_t _backing_memory[FLASHPAGE_SIZE]
+        __attribute__((aligned(FLASHPAGE_SIZE)))
+        __attribute__((section(".flash_writable")));
 #endif
 
 static int getpage(const char *str)
@@ -363,6 +370,53 @@ static int cmd_test_last(int argc, char **argv)
     puts("wrote local page buffer to last flash page");
     return 0;
 }
+
+/**
+ * @brief   Does a write and verify test on reserved page
+ */
+static int cmd_test_reserved(int argc, char **argv)
+{
+    (void) argc;
+    (void) argv;
+
+    char fill = 'a';
+    const char sig[] = {"RIOT"};
+    unsigned page = flashpage_page((void *)_backing_memory);
+
+    printf("Reserved page num: %u \n", page);
+
+    flashpage_read(page, page_mem);
+
+    // test is running for the first time so initialize flash
+    if (memcmp(sig, &page_mem[1], sizeof(sig) - 1) != 0) {
+        page_mem[0] = 0;
+        memcpy(&page_mem[1], sig, sizeof(sig));
+    }
+    else {
+        page_mem[0]++;
+    }
+
+    printf("Since the last firmware update this test has been run "
+           "%u times \n", page_mem[0]);
+
+    for (unsigned i = sizeof(sig); i < sizeof(page_mem); i++) {
+        page_mem[i] = (uint8_t)fill++;
+        if (fill > 'z') {
+            fill = 'a';
+        }
+    }
+
+    if (flashpage_write_and_verify(page, page_mem) != FLASHPAGE_OK) {
+        puts("error verifying the content of reserved page");
+        return 1;
+    }
+
+    puts("wrote local page buffer to reserved flash page");
+    puts("\nWhen running on a bootloader, as an extra check, try restarting "
+         "the board and check whether this application still comes up.");
+
+    return 0;
+}
 #endif
 
 /**
@@ -643,6 +697,7 @@ static const shell_command_t shell_commands[] = {
     { "edit", "Write bytes to the local page buffer", cmd_edit },
     { "test", "Write and verify test pattern", cmd_test },
     { "test_last_pagewise", "Write and verify test pattern on last page available", cmd_test_last },
+    { "test_reserved_pagewise", "Write and verify short write on reserved page", cmd_test_reserved},
 #endif
     { "test_last_raw", "Write and verify raw short write on last page available", cmd_test_last_raw },
 #ifdef FLASHPAGE_RWWEE_NUMOF

tests/periph_flashpage/tests/01-run.py

@@ -29,6 +29,15 @@ def testfunc(child):
         child.expect_exact('wrote local page buffer to last flash page')
         child.expect('>')
 
+    # check if board has flash page reservation capability and if so test that as well
+    # capability is deduced from help contents
+    child.sendline("help")
+    index = child.expect(['test_reserved_pagewise', '>'])
+    if index == 0:
+        child.sendline("test_reserved_pagewise")
+        child.expect_exact('wrote local page buffer to reserved flash page')
+        child.expect('>')
+
     # check if board has RWWEE capability and if so test that as well
     # capability is deduced from help contents
     child.sendline("help")