Report flash memory module capacity in Mebibytes #197

vaibhavkpr · 2024-09-24T01:05:37Z

Implements #150 - Reports memory module's sizes as a 'human-readable' string (as Mebibytes MiB). Also updates to utilize LOG_message instead of DEBUG_uart_print.

Success Output:

========================= UART Telecommand Received =========================
CTS1+flash_each_is_reachable()!
=========================
Parsed telecommand (len=31): 'CTS1+flash_each_is_reachable()!'
0000000000000+0000000930_N [TELECOMMAND:NORMAL]: Executing telecommand from agenda slot 0, sent at tssent=0, scheduled for tsexec=0.
========================= Executing telecommand 'flash_each_is_reachable'=========================
0000000000000+0000000951_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000000964_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000000977_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000000989_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000001002_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000001015_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000001028_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
0000000000000+0000001040_N [FLASH:NORMAL]: SUCCESS: FLASH_is_reachable received IDs: 0x01 0x02 0x20 0x00 0x00    Capacity: 512 MiB
========================= Response (duration=102ms, err=0) =========================
Chip 0 is reachable.
Chip 1 is reachable.
Chip 2 is reachable.
Chip 3 is reachable.
Chip 4 is reachable.
Chip 5 is reachable.
Chip 6 is reachable.
Chip 7 is reachable.
All chips are reachable.

Failure Output:

========================= UART Telecommand Received =========================
CTS1+flash_each_is_reachable()!
=========================
Parsed telecommand (len=31): 'CTS1+flash_each_is_reachable()!'
0000000000000+0000002930_N [TELECOMMAND:NORMAL]: Executing telecommand from agenda slot 0, sent at tssent=0, scheduled for tsexec=0.
========================= Executing telecommand 'flash_each_is_reachable'=========================
0000000000000+0000002951_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000002964_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000002976_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000002988_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000003001_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000003013_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000003026_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
0000000000000+0000003038_N [FLASH:NORMAL]: ERROR: FLASH_is_reachable received IDs: 0x00 0x00 0x00 0x00 0x00    Capacity: 0 MiB
========================= Response (duration=102ms, err=1 !!!!!! ERROR !!!!!!) =========================
Chip 0 is not reachable. Error code: 3
Chip 1 is not reachable. Error code: 3
Chip 2 is not reachable. Error code: 3
Chip 3 is not reachable. Error code: 3
Chip 4 is not reachable. Error code: 3
Chip 5 is not reachable. Error code: 3
Chip 6 is not reachable. Error code: 3
Chip 7 is not reachable. Error code: 3
8/8 chips are not reachable.

…es (MiB)

DeflateAwning · 2024-09-24T07:50:23Z

Implements #150

Would you mind adding example outputs of success and failure in this PR as a code block? Or I can if I get to it before you. Would just be helpful to have a record of what it looks like!

DeflateAwning

This is great, thanks for doing this! Tiny tweaks.

Take a look at the relevant docs/ file to see how to use LOG_message. Would be best to start using it as much as possible for new code

DeflateAwning · 2024-09-24T07:53:10Z

firmware/Core/Src/littlefs/flash_driver.c

@@ -506,8 +509,18 @@ FLASH_error_enum_t FLASH_is_reachable(SPI_HandleTypeDef *hspi, uint8_t chip_numb
        are_bytes_correct = 0;
    }

+    // Extract memory capacity
+    uint32_t capacity_mib = (rx_buffer[2] * 512) / 32;  // Convert to Mebibytes (MiB)


Use const keyword. Avoid unnecessary math (multiply-then-divide). Use bitshifts for power-of-2 operations.

Ideally, include where you got this conversion math from.

Recommend making the variable name include MiB, as Mib/mib means mebibits (one eigth of a mebibyte)

Yeah, initially I had it simpler but just so the logic was clear I left the conversion math there, can simplify it and move it over to the comment!

DeflateAwning · 2024-09-24T07:53:57Z

firmware/Core/Src/littlefs/flash_driver.c

    DEBUG_uart_print_array_hex(rx_buffer, 5);
-    DEBUG_uart_print_str("\n");
+    DEBUG_uart_print_str("\t");


Ideally, use the LOG_message function. Avoid using \t control character; not certain how it's going to behave with the ground station software.

Quick Question! Did we want this log to be part of LOG_SEVERITY_DEBUG or LOG_SEVERITY_NORMAL, since these messages were not setup to be part of the telecommand response buffer? Currently the is_reachable telecommand only prints the chip# availability and error codes if any. If the capacities are important we can have them printed part of the response itself.

Probably NORMAL

…driver

DeflateAwning

Looks solid! Just a tiny detail with the logs severity (log level) first though

DeflateAwning · 2024-09-25T05:15:05Z

firmware/Core/Src/littlefs/flash_driver.c

@@ -290,7 +301,10 @@ FLASH_error_enum_t FLASH_erase(SPI_HandleTypeDef *hspi, uint8_t chip_number, lfs

        if ((status_reg_buffer[0] & FLASH_SR1_ERASE_ERROR_MASK) > 0) {
            // Flash module returned "erase error" via the status register.
-            DEBUG_uart_print_str("Flash erase error\n");
+            LOG_message(


Shouldn't errors be reported as a LOG_SEVERITY_WARNING or ERROR?

Good Catch! Must have missed it!

…being logged * timeout logs set to LOG_SEVERITY_WARNING * error logs respectively assigned LOG_SEVERITY_ERROR

DeflateAwning · 2024-09-25T05:35:12Z

Are you sure the output is right? You're showing a size of 512 MiB (512 mebibytes). I thought these devices were way smaller than that (maybe 512 Mib [mebibits])?

I also see this comment in the code: // rx_buffer[2] is 0x20=512 for 512 Mib (mebibits), which reinforces my quandry.

I just tacked on a small commit; make sure you pull it if you make more changes.

* New chip only returns two bytes: Manufacturer ID & Device ID

NuclearTea · 2024-10-16T19:53:59Z

@vaibhavkpr Update on this PR? Been open for a while.

vaibhavkpr · 2024-10-16T20:06:02Z

@NuclearTea I took a break off this issue as I didn't have a memory module to test this with, but I was able to pick one up last week. Once the other PR is complete, I was going to try testing the new memory module and see what we can do to find the capacity off it.

FLASH_is_reachable now prints flash memory module capacity in Mebibyt…

a0dc3eb

…es (MiB)

DeflateAwning requested changes Sep 24, 2024

View reviewed changes

Updates to use LOG_message instead of DEBUG_uart_print_str for flash_…

f4349fa

…driver

DeflateAwning requested changes Sep 25, 2024

View reviewed changes

vaibhavkpr and others added 2 commits September 24, 2024 23:26

Updated log message severities to better reflect the type of message …

43a0bfa

…being logged * timeout logs set to LOG_SEVERITY_WARNING * error logs respectively assigned LOG_SEVERITY_ERROR

Clean up log messages

001e1e6

Modifications to support new NAND chip READ ID command

c436939

* New chip only returns two bytes: Manufacturer ID & Device ID

NuclearTea assigned vaibhavkpr Oct 6, 2024

DeflateAwning added pr-awaiting-testing pr-awaiting-changes labels Oct 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report flash memory module capacity in Mebibytes #197

Report flash memory module capacity in Mebibytes #197

vaibhavkpr commented Sep 24, 2024 •

edited

Loading

DeflateAwning commented Sep 24, 2024 •

edited

Loading

DeflateAwning left a comment

DeflateAwning Sep 24, 2024 •

edited

Loading

vaibhavkpr Sep 24, 2024

DeflateAwning Sep 24, 2024

vaibhavkpr Sep 24, 2024

DeflateAwning Sep 24, 2024

DeflateAwning left a comment

DeflateAwning Sep 25, 2024

vaibhavkpr Sep 25, 2024

DeflateAwning commented Sep 25, 2024 •

edited

Loading

NuclearTea commented Oct 16, 2024

vaibhavkpr commented Oct 16, 2024

Report flash memory module capacity in Mebibytes #197

Are you sure you want to change the base?

Report flash memory module capacity in Mebibytes #197

Conversation

vaibhavkpr commented Sep 24, 2024 • edited Loading

DeflateAwning commented Sep 24, 2024 • edited Loading

DeflateAwning left a comment

Choose a reason for hiding this comment

DeflateAwning Sep 24, 2024 • edited Loading

Choose a reason for hiding this comment

vaibhavkpr Sep 24, 2024

Choose a reason for hiding this comment

DeflateAwning Sep 24, 2024

Choose a reason for hiding this comment

vaibhavkpr Sep 24, 2024

Choose a reason for hiding this comment

DeflateAwning Sep 24, 2024

Choose a reason for hiding this comment

DeflateAwning left a comment

Choose a reason for hiding this comment

DeflateAwning Sep 25, 2024

Choose a reason for hiding this comment

vaibhavkpr Sep 25, 2024

Choose a reason for hiding this comment

DeflateAwning commented Sep 25, 2024 • edited Loading

NuclearTea commented Oct 16, 2024

vaibhavkpr commented Oct 16, 2024

vaibhavkpr commented Sep 24, 2024 •

edited

Loading

DeflateAwning commented Sep 24, 2024 •

edited

Loading

DeflateAwning Sep 24, 2024 •

edited

Loading

DeflateAwning commented Sep 25, 2024 •

edited

Loading