v0.2.0

- добавлен сброс бита CMP в статус-регистре 2 flash-памяти перед переходом в основную программу
- добавлена проверка успешности записи страницы во flash-память
- добавлена команда на получение версии начального загрузчика
Co-authored-by: KLASSENTS <klassen@elron.tech>
Co-committed-by: KLASSENTS <klassen@elron.tech>

.gitignore

@@ -0,0 +1,6 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch
+.vscode/

platformio.ini

@@ -14,3 +14,4 @@ platform = MIK32
 board = mik32v2
 framework = framework-mik32v2-sdk
 board_debug.ldscript = eeprom
+board_upload.maximum_size=5000

src/bootloader.c

@@ -11,6 +11,11 @@
 
 #include "string.h"
 
+// версия начального загрузчика
+#define MAJOR_VER   0
+#define MINOR_VER   2
+#define BUGFIX_VER  0
+
 #define JALR_TO_SPIFI()                           \
     asm volatile(	"la ra, 0x80000000\n\t"     \
                     "jalr ra"                   \
@@ -24,11 +29,13 @@
 #define TIMEOUT_VALUE 1000000 /* Время ожидания загрузчика до прыжка по умолчанию в RAM 1000000 */
 
 /* Виды команд */
+#define FULL_ERASE_CMD_LEN   4
 typedef enum
 {
     PACKAGE_SIZE = 0x30,        /* Команда размера пакета */
     SEND_PACKAGE = 0x60,        /* Команда отправить пакет */
-    FULL_ERASE   = 0xFE         /* Команда стирания spifi */
+    VERSION      = 0x90,        /* Команда получения версии начального загрузчика */
+    FULL_ERASE   = 0xBADC0FEE   /* Команда стирания spifi */
 } BotloaderComand;
 
 typedef enum
@@ -41,6 +48,7 @@ typedef enum
 {
     ERROR_NONE = 0,
     ERROR_TIMEOUT = 1,  // Время ожидания истекло
+    ERROR_CRC,          // Ошибка при получении строки hex от ПК или при записи страницы данных на flash
 } Bootloader_error;
 
 typedef struct
@@ -51,8 +59,11 @@ typedef struct
     uint8_t command; // Текущая принятая загрузчиком команда
 } Bootloader_attributes;
 
-Bootloader_attributes hBootloader = {(uint8_t*) SPIFI_ADDRESS, MAX_PACKAGE_SIZE, ERROR_NONE, 0};
+Bootloader_attributes hBootloader = {(uint8_t*) SPIFI_ADDRESS, 0, ERROR_NONE, 0};
 uint32_t timeout = 0;
+uint32_t validCommandsTimeout = 0;
+
+void go_to_spifi();
 
 
 /* Инициализация UART */
@@ -60,7 +71,10 @@ void Bootloader_UART_Init()
 {
     PM->CLK_APB_P_SET = PM_CLOCK_APB_P_UART_0_M; // Включение тактирования UART0
 
-    PAD_CONFIG->PORT_0_CFG |= (0b01 << (5 << 1)) | (0b01 << (6 << 1)); // Настройка выводов PORT0.5 и PORT0.6
+    // Настройка выводов PORT0.5 и PORT0.6 на последовательный интерфейс
+    PAD_CONFIG->PORT_0_CFG |= (0b01 << (5 << 1)) | (0b01 << (6 << 1)); 
+    // Включение притяжки к питанию на линии rx
+    PAD_CONFIG->PORT_0_PUPD |= (0b01 << (5 << 1));
 
     /*
      * Настройки USART:
@@ -89,9 +103,12 @@ void Bootloader_UART_Deinit()
     UART_0->FLAGS = 0xFFFFFFFF; // сброс всех флагов
     UART_0->TXDATA = 0x00;
 
-    PAD_CONFIG->PORT_0_CFG &= ~((0b11 << (5 << 1)) | (0b11 << (6 << 1))); // Настройка выводов PORT0.5 и PORT0.6
+    // Настройка выводов PORT0.5 и PORT0.6 на порт общего назначения
+    PAD_CONFIG->PORT_0_CFG &= ~((0b11 << (5 << 1)) | (0b11 << (6 << 1))); 
+    // Отключение притяжки на линии rx
+    PAD_CONFIG->PORT_0_PUPD &= ~(0b01 << (5 << 1));
 
-    PM->CLK_APB_P_SET &= !PM_CLOCK_APB_P_UART_0_M; // Выключение тактирования UART0   
+    PM->CLK_APB_P_CLEAR = PM_CLOCK_APB_P_UART_0_M; // Выключение тактирования UART0   
 }
 
 /* Отправить байт */
@@ -110,6 +127,7 @@ uint16_t Bootloader_UART_ReadByte()
     while ((!(UART_0->FLAGS & UART_FLAGS_RXNE_M)) && (timeout != TIMEOUT_VALUE))
     {
         timeout++;
+        validCommandsTimeout++; // Увеличить таймаут валидных команд
     }
 
     if (timeout == TIMEOUT_VALUE)
@@ -123,15 +141,21 @@ uint16_t Bootloader_UART_ReadByte()
 /* Обработчик ошибок */
 void Bootloader_ErrorHandler()
 {
-        
     switch (hBootloader.error)
     {
     case ERROR_TIMEOUT:
-            Bootloader_UART_WriteByte(NACK);
         if (UART_0->FLAGS & UART_FLAGS_ORE_M)
-            {
             UART_0->FLAGS |= UART_FLAGS_ORE_M;
-            }
+        
+        go_to_spifi(); // переход в основную программу, если в течение TIMEOUT_VALUE нет принятых данных
+        break;
+    case ERROR_CRC:
+        // отправить nack и перейти в основную программу, если приняли некорректные данные
+        Bootloader_UART_WriteByte(NACK);
+
+        if (UART_0->FLAGS & UART_FLAGS_ORE_M)
+            UART_0->FLAGS |= UART_FLAGS_ORE_M;
+        go_to_spifi(); 
         break;
     }
 
@@ -156,26 +180,15 @@ uint8_t erase_chip(SPIFI_HandleTypeDef *spifi)
 
 /* Загрузить данные пакета в RAM */
 #define SIZE_4K 4096
-void Bootloader_LoadArrayInRam(uint8_t uart_data[])
-{
-    static uint32_t relative_write_address;
-
-    if ((relative_write_address % SIZE_4K) == 0)
-        HAL_SPIFI_W25_SectorErase4K(&spifi, relative_write_address);
-
-    HAL_SPIFI_W25_PageProgram(&spifi, (uint32_t)hBootloader.address, hBootloader.size_package, uart_data);
-    hBootloader.address += hBootloader.size_package;
-    relative_write_address += hBootloader.size_package;
-}
 
 // разметка строки в хекс-файле
 #define BYTE_COUNT_POS  0   // индекс счетчика байт данных
-#define ADDRES_POS      1   // индекс адреса
+#define ADDRESS_POS     1   // индекс адреса
-#define ADDRES_QTY      2   // количество байт адреса
+#define ADDRESS_QTY     2   // количество байт адреса
 #define RECORD_TYPE_POS 3   // индекс типа записи
 #define DATA_POS        4   // индекс начала данных в команде
 
-// типы записей в хекс-фйле
+// типы записей в хекс-файле
 #define REC_TYPE_DATA           0x00
 #define REC_TYPE_EOF            0x01
 #define REC_TYPE_EXT_LIN_ADDR   0x04
@@ -185,8 +198,22 @@ uint32_t rel_addr = 0; // адрес от начала области spifi, п
 #define TAIL_SIZE 15             // если попадутся строки хекса, в которых не 16 байт, то мы рискуем записать данные уарта мимо буфера package_data. а если больше 16 байт, то это проблема завтрашнего дня
 uint8_t page_data[MAX_PACKAGE_SIZE + TAIL_SIZE] = {0}; // сюда собираем распарсенные данные из хекса
 uint16_t page_fill_size = 0;  // счетчик, сколько заполнно в page_data. когда page_data заполнена до конца - будем записывать в spifi
+uint8_t read_data[MAX_PACKAGE_SIZE] = {0};
 
-void go_to_spifi();
+bool page_data_is_written(void)
+{
+    // читаем ту же страницу в другой буфер
+    memset(read_data, 0xFF, MAX_PACKAGE_SIZE);
+    HAL_SPIFI_W25_ReadData(&spifi, (uint32_t)hBootloader.address, MAX_PACKAGE_SIZE, read_data);
+    // побайтово сравниваем содержимое двух буферов
+    for (uint16_t i = 0; i < MAX_PACKAGE_SIZE; i++)
+    {
+        if (read_data[i] != page_data[i])
+            // если не сходится хоть один байт, прерываем проверку
+            return false;
+    }
+    return true;
+}
 
 void mem_write()
 {
@@ -197,18 +224,27 @@ void mem_write()
 
     // записываем страницу в 256 байт в spifi
     HAL_SPIFI_W25_PageProgram(&spifi, (uint32_t)hBootloader.address, MAX_PACKAGE_SIZE, page_data);
+    
+    // проверить, записалось ли действительно содержимое буфера
+    if (!page_data_is_written()) 
+    {
+        // если не записалось, выставим ошибку по crc и выходим
+        hBootloader.error = ERROR_CRC;
+        return;
+    }
+
     // увеличиваем адреса, по которым писать и стирать
     hBootloader.address += MAX_PACKAGE_SIZE;
-    // обнуляем часть буфера, которая была записана в память и уменьшаем счетчик заполнения буфера на столько, сколько было записано
+    // очищаем часть буфера, которая была записана в память и уменьшаем счетчик заполнения буфера на столько, сколько было записано
     if (page_fill_size <= MAX_PACKAGE_SIZE)
         page_fill_size = 0;
     else
         page_fill_size -= MAX_PACKAGE_SIZE;
-    memset(&page_data[0], 0, MAX_PACKAGE_SIZE);
+    memset(&page_data[0], 0xFF, MAX_PACKAGE_SIZE);
     // хвост копируем в начало буфера, чтобы записать его в следующий раз
     memcpy(&page_data[0], &page_data[MAX_PACKAGE_SIZE], TAIL_SIZE);
-    // а сам хвост обнуляем 
+    // а сам хвост очищаем 
-    memset(&page_data[MAX_PACKAGE_SIZE], 0, TAIL_SIZE);
+    memset(&page_data[MAX_PACKAGE_SIZE], 0xFF, TAIL_SIZE);
 }
 void Bootloader_parseHexAndLoadInMemory(uint8_t rx_data[])
 {
@@ -230,7 +266,7 @@ void Bootloader_parseHexAndLoadInMemory(uint8_t rx_data[])
             memcpy(&page_data[page_fill_size], &rx_data[DATA_POS], rx_data[BYTE_COUNT_POS]);
             // указываем, на сколько заполнился буфер
             page_fill_size += rx_data[BYTE_COUNT_POS];
-            // если пора записывать целую страницу - пишемм
+            // если пора записывать целую страницу - пишем
             if (page_fill_size >= 256)
                 mem_write();
             break;
@@ -239,7 +275,12 @@ void Bootloader_parseHexAndLoadInMemory(uint8_t rx_data[])
             Bootloader_UART_WriteByte(ACK);
             // если есть недозаполненная страница, записываем ее как есть
             if (page_fill_size != 0)
+            {
                 mem_write();
+                // если при записи остатков возникли ошибки, здесь в основную программу не будем переходить
+                if (hBootloader.error)
+                    return; 
+            }
             // и идем в записанную программу
             go_to_spifi();
             break;
@@ -249,72 +290,106 @@ void Bootloader_parseHexAndLoadInMemory(uint8_t rx_data[])
     }
 }
 uint8_t uart_data[MAX_PACKAGE_SIZE] = {0}; // Массив данных из полученного пакета
+uint32_t crc_acc = 0;
+uint8_t crc = 0;
 void Bootloader_UART_ReadPackage()
 {
+    crc_acc = 0;
     for (uint32_t counter = 0; counter < hBootloader.size_package; counter++)
     {
         timeout = 0;
         while ((!(UART_0->FLAGS & UART_FLAGS_RXNE_M)) && (timeout != TIMEOUT_VALUE)) // Ожидание байта пакета
-        {
             timeout++;
-        }
 
         if (timeout == TIMEOUT_VALUE)
         {
             hBootloader.error = ERROR_TIMEOUT;
             break;
         }
-        
         uart_data[counter] = UART_0->RXDATA;
+
+        // контрольная сумма идет последним байтом в пакете. Суммируем всё, кроме нее
+        if (counter < (hBootloader.size_package-1))
+            crc_acc += uart_data[counter];
+        else
+        {
+            // посчитать контрольную сумму и сравнить
+            crc = (256 - crc_acc % 256) % 256;
+            if (crc != uart_data[counter])
+                hBootloader.error = ERROR_CRC;
+        }
     }
 
-    if (!hBootloader.error)
+    if (hBootloader.error == ERROR_NONE)
-    {
         Bootloader_parseHexAndLoadInMemory(uart_data);
 }
-}
 
+uint8_t eraseChipBufferIndex = 0;  // Индекс для накопления команды erase chip
 void Bootloader_Commands()
 {
     while (1)
     {
         hBootloader.command = Bootloader_UART_ReadByte(); // Ожидание и считывание команды
+
+        // если долго не приходили валидные команды, переход в основную программу
+        if (validCommandsTimeout >= TIMEOUT_VALUE)
+            go_to_spifi();
+
         if (hBootloader.error)
-        {
             Bootloader_ErrorHandler(); // Обработчик ошибок
-        }
         else 
         {
             switch (hBootloader.command)
             {
+            case VERSION:
+                validCommandsTimeout = 0;           // Сброс таймаута валидных команд
+                eraseChipBufferIndex = 0;
+                Bootloader_UART_WriteByte(ACK);     // Подтвердить команду
+                // отправить все составляющие версии загрузчика
+                Bootloader_UART_WriteByte((uint16_t)MAJOR_VER);
+                Bootloader_UART_WriteByte((uint16_t)MINOR_VER);
+                Bootloader_UART_WriteByte((uint16_t)BUGFIX_VER);
+                break;
             case PACKAGE_SIZE:
+                validCommandsTimeout = 0;           // Сброс таймаута валидных команд
+                eraseChipBufferIndex = 0;
                 Bootloader_UART_WriteByte(ACK);     // Подтвердить команду
                 hBootloader.size_package = Bootloader_UART_ReadByte() + 1; // Прочитать размер пакета
                 Bootloader_UART_WriteByte(ACK);     // Подтвердить
-
                 break;
             case SEND_PACKAGE:
+                validCommandsTimeout = 0;           // Сброс таймаута валидных команд
+                eraseChipBufferIndex = 0;
                 Bootloader_UART_WriteByte(ACK);     // Подтвердить команду
                 Bootloader_UART_ReadPackage();      // Получить пакет и скопировать его в RAM
-
                 if (hBootloader.error)
-                {
                     Bootloader_ErrorHandler();      // Обработчик ошибок
-                }
                 else
-                {
                     Bootloader_UART_WriteByte(ACK); // Подтвердить считывание и копирования пакета в RAM
-                }
-                
                 break;
-
+            default:
-            case FULL_ERASE:
+                // Вычислить ожидаемый байт команды FULL_ERASE на основе текущего индекса
+                uint8_t expectedByte = (FULL_ERASE >> ((FULL_ERASE_CMD_LEN - eraseChipBufferIndex - 1) * 8)) & 0xFF;
+                // Если полученный байт совпадает с ожидаемым байтом команды FULL_ERASE
+                if (hBootloader.command == expectedByte)
+                {
+                    // Переход к следующему байту
+                    eraseChipBufferIndex++;
+                    // Если команда FULL_ERASE полностью получена
+                    if (eraseChipBufferIndex == FULL_ERASE_CMD_LEN)
+                    {
+                        Bootloader_UART_WriteByte(ACK);     // Подтвердить получение команды
+                        // Очистка чипа
                         if (erase_chip(&spifi) != HAL_OK)
                             Bootloader_UART_WriteByte(NACK);
                         else    
-                    Bootloader_UART_WriteByte(ACK);
+                            Bootloader_UART_WriteByte(ACK); // Подтвердить успешную очистку
-                break;
+                        eraseChipBufferIndex = 0;           // Сброс индекса для следующего приема
-            default:
+                    }
+                    validCommandsTimeout = 0;               // Сброс таймаута валидных команд
+                } 
+                else // Если байт не совпал ни с какими валидными командами
+                    eraseChipBufferIndex = 0;               // Сброс индекса команды FULL_ERASE
                 break;
             }
         }
@@ -324,7 +399,6 @@ void Bootloader_Commands()
 
 void SystemClock_Config();
 
-
 int main() 
 {
     SystemClock_Config();
@@ -356,22 +430,9 @@ int main()
     HAL_SPIFI_SendCommand_LL(&spifi, cmd_qpi_disable, 0, 0, 0, 0, 0, HAL_SPIFI_TIMEOUT);
 #endif
 
-    Bootloader_UART_Init(); // Инициализация UART. НАстройка выводов и тактирования
+    Bootloader_UART_Init(); // Инициализация UART. Настройка выводов и тактирования
       
-    timeout = 0;
+    Bootloader_Commands(); // Обработка и ожидание команд
-    while ((!(UART_0->FLAGS & UART_FLAGS_RXNE_M)) && (timeout != TIMEOUT_VALUE)) // Загрузчик ожидает команду
-    {
-        timeout++;
-    }
-
-    if (timeout == TIMEOUT_VALUE)
-    {
-        go_to_spifi();
-    }
-    else
-    {     
-        Bootloader_Commands(); // Обработка и ожидания команд
-    }
 
     while (1)
     {
@@ -406,12 +467,12 @@ void SPIFI_Init()
     HAL_SPIFI_Reset(&spifi);
 
     /* В Winbond для выставления QE используется команда 0x01 в 1-м бите 2го статус регистра. */
-    uint8_t sreg2 = HAL_SPIFI_W25_ReadSREG(&spifi, W25_SREG2);
-    if (!(sreg2 & (1 << 1)))
-    {
     uint8_t sreg1 = HAL_SPIFI_W25_ReadSREG(&spifi, W25_SREG1);
-        HAL_SPIFI_W25_WriteSREG(&spifi, sreg1, sreg2 | (1 << 1)); // ? HAL_SPIFI_W25_QuadEnable(&spifi); 
+    if (sreg1 > 0x03)       sreg1 = 0;      // снятие защиты от записи (protection bits)
-    }
+    uint8_t sreg2 = HAL_SPIFI_W25_ReadSREG(&spifi, W25_SREG2);
+    if (!(sreg2 & 0x02))    sreg2 |= 0x02;  // установка бита QE (quad enable)
+    if (sreg2 & 0x40)       sreg2 &= ~0x40; // сброс бита CMP. Если вдруг он выставился по какой-то причине, часть или вся память можеть быть заблокирована для записи
+    HAL_SPIFI_W25_WriteSREG(&spifi, sreg1, sreg2);
 	
 #if CHIP_MODE == 1
     /* Переключение флеш-памяти в режим QPI, когда весь обмен четырёхпроводной */