Использование CRC на примере алгоритма CRC-32Q: различия между версиями

Материал из MIK32 микроконтроллер
Нет описания правки
(закомментировал код. добавил подключение UARTa. пронумеровал рисунки (начиная с 3))
Строка 126: Строка 126:


== Использование библиотеки HAL_OTP ==
== Использование библиотеки HAL_OTP ==
В сгенерированном проекте в файле main.c должна быть функция CRC_Init, в которой будут заданы настройки для OTP. Выглядит она так:<syntaxhighlight lang="c" line="1">
В сгенерированном проекте в файле main.c должна быть функция CRC_Init, в которой будут заданы настройки для OTP. Выглядит она так:
{{#spoiler:show=Развернуть код|hide=Свернуть код|
<syntaxhighlight lang="c" line="1">
static void CRC_Init(void)
static void CRC_Init(void)
{
{
Строка 143: Строка 145:


}
}
</syntaxhighlight>Кроме этого в функции SystemClock_Config приведены настройки для тактирования. Убедитесь что в PeriphClkInit.PMClockAPB_M присутствует PM_CLOCK_OTP_CONTROLLER_M. Сама функция должна выглядеть примерно так:
</syntaxhighlight>
 
}}
Кроме этого в функции SystemClock_Config приведены настройки для тактирования. Убедитесь что в PeriphClkInit.PMClockAPB_M присутствует PM_CLOCK_OTP_CONTROLLER_M. Сама функция должна выглядеть примерно так:
{{#spoiler:show=Развернуть код|hide=Свернуть код|
<syntaxhighlight lang="c" line="1">
<syntaxhighlight lang="c" line="1">
void SystemClock_Config(void)
void SystemClock_Config(void)
Строка 167: Строка 171:
     HAL_RCC_ClockConfig(&PeriphClkInit);
     HAL_RCC_ClockConfig(&PeriphClkInit);
}
}
</syntaxhighlight>Для демонстрации вывода текста в PeriphClkInit.PMClockAPB_P присутствует PM_CLOCK_UART_0_M. У вас его может не быть так как UART нужно включить отдельно.
</syntaxhighlight>
}}
Для демонстрации вывода текста в PeriphClkInit.PMClockAPB_P присутствует PM_CLOCK_UART_0_M. У вас его может не быть так как UART нужно включить отдельно. Для этого нужно подключить библиотеки uart_lib и xprintf.
{{#spoiler:show=Развернуть код|hide=Свернуть код|
<syntaxhighlight lang="c" line="1">
#include "mik32_hal_rcc.h"
#include "mik32_hal_crc32.h"
 
#include "uart_lib.h"
#include "xprintf.h"
</syntaxhighlight>
}}
Для инициализации UART в функции main, после функции тактирования SystemClock_Config, следует написать:
<syntaxhighlight lang="c" line="1" start="1">
UART_Init(UART_0, 3333, UART_CONTROL1_TE_M | UART_CONTROL1_M_8BIT_M, 0, 0);
</syntaxhighlight>
Скорость UART задается делителем во втором аргументе функции. При такой записи скорость будет 9600 бод.


В начале main.c можно видеть объявление структуры с набором настроек для CRC, которую использует функция инициализации CRC_Init.<syntaxhighlight lang="c" line="1">
В начале main.c можно видеть объявление структуры с набором настроек для CRC, которую использует функция инициализации CRC_Init.
{{#spoiler:show=Развернуть код|hide=Свернуть код|
<syntaxhighlight lang="c" line="1">
CRC_HandleTypeDef hcrc;
CRC_HandleTypeDef hcrc;


void SystemClock_Config(void);
void SystemClock_Config(void);
static void CRC_Init(void);
static void CRC_Init(void);
</syntaxhighlight>Так как в таблице со стандартными алгоритмами приведена контрольная сумма для стоки "123456789", то используем ее в нашем примере. Нам понадобятся следующие функции:
</syntaxhighlight>
}}
Так как в таблице со стандартными алгоритмами приведена контрольная сумма для стоки "123456789", то используем ее в нашем примере. Нам понадобятся следующие функции:


HAL_RTC_WriteData - запись данных в регистр данных по байтам;
HAL_RTC_WriteData - запись данных в регистр данных по байтам;
Строка 181: Строка 205:


Функция main должна выглядеть примерно так:
Функция main должна выглядеть примерно так:
 
{{#spoiler:show=Развернуть код|hide=Свернуть код|
<syntaxhighlight lang="c" line="1">
<syntaxhighlight lang="c" line="1">
int main()
int main()
Строка 187: Строка 211:


     SystemClock_Config();
     SystemClock_Config();
    UART_Init(UART_0, 3333, UART_CONTROL1_TE_M | UART_CONTROL1_M_8BIT_M, 0, 0);


     CRC_Init();
     CRC_Init();
Строка 196: Строка 222:
     HAL_RTC_WriteData(&hcrc, message, sizeof(message));
     HAL_RTC_WriteData(&hcrc, message, sizeof(message));
     CRCValue = HAL_RTC_ReadCRC(&hcrc);
     CRCValue = HAL_RTC_ReadCRC(&hcrc);
    #ifdef MIK32_CRC_DEBUG
     xprintf("CRC32 = 0x%08x, ожидалось 0x3010BF7F\n", CRCValue);
     xprintf("CRC32 = 0x%08x, ожидалось 0x3010BF7F\n", CRCValue);
    #endif
      
      
     while (1)
     while (1)
Строка 207: Строка 231:
}
}
</syntaxhighlight>
</syntaxhighlight>
[[Файл:CRC. Вывод в UART.png|мини|Вывод в UART]]
}}
Если у вас включен UART и в main.c или def_list.h есть #define MIK32_CRC_DEBUG, то можно видеть вывод как на рисунке. Полученное значение CRC совпадает с табличным значением в столбце Check.
[[Файл:CRC. Вывод в UART.png|мини|Рисунок 3 - вывод в UART]]
Если у вас включен UART, то можно видеть вывод как на рисунке 3. Полученное значение CRC совпадает с табличным значением в столбце Check.


Кроме записи по байтам можно записывать по словам. Для этого используем функцию HAL_RTC_WriteData32. Получим значение CRC для данных из двух слов - 0xABCDABCD и 0xA1B2C3D4.
Кроме записи по байтам можно записывать по словам. Для этого используем функцию HAL_RTC_WriteData32. Получим значение CRC для данных из двух слов - 0xABCDABCD и 0xA1B2C3D4.


Для проверки можно воспользоваться этим онлайн [https://crccalc.com/ калькулятором CRC] или [http://www.sunshine2k.de/coding/javascript/crc/crc_js.html этим]. Введя в него 0xABCDABCD и 0xA1B2C3D4 можно видеть результат CRC 0x6311BC18.
Для проверки можно воспользоваться этим онлайн [https://crccalc.com/ калькулятором CRC] или [http://www.sunshine2k.de/coding/javascript/crc/crc_js.html этим]. Введя в него 0xABCDABCD и 0xA1B2C3D4 можно видеть результат CRC 0x6311BC18 на рисунке 4.


Функция main должна выглядеть так:
Функция main должна выглядеть так:


[[Файл:Калькулятор CRC.png|мини|Калькулятор CRC]][[Файл:CRC по словам. Вывод в UART .png|мини|Вывод в UART второго примера]]<syntaxhighlight lang="c" line="1">
[[Файл:Калькулятор CRC.png|мини|Рисунок 4 - калькулятор CRC]][[Файл:CRC по словам. Вывод в UART .png|мини|Рисунок 5 - вывод в UART второго примера]]
{{#spoiler:show=Развернуть код|hide=Свернуть код|
<syntaxhighlight lang="c" line="1">
int main()
int main()
{     
{     


     SystemClock_Config();
     SystemClock_Config();
    UART_Init(UART_0, 3333, UART_CONTROL1_TE_M | UART_CONTROL1_M_8BIT_M, 0, 0);


     CRC_Init();
     CRC_Init();
Строка 231: Строка 260:
     HAL_RTC_WriteData(&hcrc, message, sizeof(message));
     HAL_RTC_WriteData(&hcrc, message, sizeof(message));
     CRCValue = HAL_RTC_ReadCRC(&hcrc);
     CRCValue = HAL_RTC_ReadCRC(&hcrc);
    #ifdef MIK32_CRC_DEBUG
     xprintf("CRC32 = 0x%08x, ожидалось 0x3010BF7F\n", CRCValue);
     xprintf("CRC32 = 0x%08x, ожидалось 0x3010BF7F\n", CRCValue);
    #endif
      
      
     /* Запись по словам */
     /* Запись по словам */
     HAL_RTC_WriteData32(&hcrc, data, sizeof(data)/sizeof(*data));
     HAL_RTC_WriteData32(&hcrc, data, sizeof(data)/sizeof(*data));
     CRCValue = HAL_RTC_ReadCRC(&hcrc);
     CRCValue = HAL_RTC_ReadCRC(&hcrc);
    #ifdef MIK32_CRC_DEBUG
     xprintf("CRC32 = 0x%08x, ожидалось 0x6311BC18\n", CRCValue);
     xprintf("CRC32 = 0x%08x, ожидалось 0x6311BC18\n", CRCValue);
    #endif
      
      
     while (1)
     while (1)
     {     
     {     
Строка 250: Строка 274:
}
}
</syntaxhighlight>
</syntaxhighlight>
Вывод в UART изображен на рисунке.
}}
Вывод в UART изображен на рисунке 5.

Версия от 09:27, 24 марта 2023

В примере будут записаны данные в основной массив OTP, тестовый столбец и тестовую строку, после чего они будут считаны.

Работа с конфигуратором (В разработке)

Для начала настроем в конфигураторе тактирование mik32, например, от внешнего кварца 32МГц. Затем настроем делители шины. Так как CRC тактируется от шины AHB_CLK, то зададим делитель AHB_DIV. В данном примере оставим делители по умолчанию. В итоге вкладка с тактированием должна выглядеть так:

(Картинка тактирования из конфигуратора. В работе)

Затем перейдем к настройке самого CRC. Для этого откроем вкладку CRC и нажмем включить.

Появится поле с выбором алгоритма и его настройками. Тут можно настроить свой собственный алгоритм или выбрать один из стандартных, которые приведены в таблице ниже.

  • Название алгоритма (name);
  • Степень порождающего контрольную сумму многочлена (width);
  • Сам производящий полином (poly). Для того, чтобы записать его в виде значения, его сначала записывают как битовую последовательность, при этом старший бит опускается — он всегда равен 1.
  • Стартовые данные (init), то есть начальное значение в регистре данных.
  • Флаг (RefIn), указывающий на начало и направление вычислений. Существует два варианта: False — начиная со старшего значащего бита (MSB-first) или True — с младшего (LSB-first);
  • Флаг (RefOut), определяющий, инвертируется ли порядок битов регистра при входе на элемент XOR;
  • Число (XorOut), с которым складывается по модулю 2 полученный результат;
  • Значение CRC (check) для строки «123456789» .
Стандартные алгоритмы CRC32
Name Width Poly Init RefIn RefOut XorOut Check
CRC-32/zlib 32 0x04C11DB7 0xFFFFFFFF true true 0xFFFFFFFF 0xCBF43926
CRC-32/BZIP2 32 0x04C11DB7 0xFFFFFFFF false false 0xFFFFFFFF 0xFC891918
CRC-32C 32 0x1EDC6F41 0xFFFFFFFF true true 0xFFFFFFFF 0xE3069283
CRC-32D 32 0xA833982B 0xFFFFFFFF true true 0xFFFFFFFF 0x87315576
CRC-32/MPEG-2 32 0x04C11DB7 0xFFFFFFFF false false 0x0 0x376E6E7
CRC-32/POSIX 32 0x04C11DB7 0x0 false false 0xFFFFFFFF 0x765E7680
CRC-32Q 32 0x814141AB 0x0 false false 0x0 0x3010BF7F
CRC-32/JAMCRC 32 0x04C11DB7 0xFFFFFFFF true true 0x0 0x340BC6D9
CRC-32/XFER 32 0xAF 0x0 false false 0x0 0xBD0BE338
Настройки CRC32 в конфигураторе

Выберем алгоритм CRC-32Q.

В итоге настройки CRC в конфигураторе должны выглядеть как на рисунке.

Нажимаем кнопку сохранения и генерации. В итоге у нас появится проект для PlatformIo. Далее работа идет в visual studio code.

Использование библиотеки HAL_OTP

В сгенерированном проекте в файле main.c должна быть функция CRC_Init, в которой будут заданы настройки для OTP. Выглядит она так:

Кроме этого в функции SystemClock_Config приведены настройки для тактирования. Убедитесь что в PeriphClkInit.PMClockAPB_M присутствует PM_CLOCK_OTP_CONTROLLER_M. Сама функция должна выглядеть примерно так:

Для демонстрации вывода текста в PeriphClkInit.PMClockAPB_P присутствует PM_CLOCK_UART_0_M. У вас его может не быть так как UART нужно включить отдельно. Для этого нужно подключить библиотеки uart_lib и xprintf.

Для инициализации UART в функции main, после функции тактирования SystemClock_Config, следует написать:

UART_Init(UART_0, 3333, UART_CONTROL1_TE_M | UART_CONTROL1_M_8BIT_M, 0, 0);

Скорость UART задается делителем во втором аргументе функции. При такой записи скорость будет 9600 бод.

В начале main.c можно видеть объявление структуры с набором настроек для CRC, которую использует функция инициализации CRC_Init.

Так как в таблице со стандартными алгоритмами приведена контрольная сумма для стоки "123456789", то используем ее в нашем примере. Нам понадобятся следующие функции:

HAL_RTC_WriteData - запись данных в регистр данных по байтам;

HAL_RTC_ReadCRC - запись данных в регистр данных по словам.

Функция main должна выглядеть примерно так:

Рисунок 3 - вывод в UART

Если у вас включен UART, то можно видеть вывод как на рисунке 3. Полученное значение CRC совпадает с табличным значением в столбце Check.

Кроме записи по байтам можно записывать по словам. Для этого используем функцию HAL_RTC_WriteData32. Получим значение CRC для данных из двух слов - 0xABCDABCD и 0xA1B2C3D4.

Для проверки можно воспользоваться этим онлайн калькулятором CRC или этим. Введя в него 0xABCDABCD и 0xA1B2C3D4 можно видеть результат CRC 0x6311BC18 на рисунке 4.

Функция main должна выглядеть так:

Рисунок 4 - калькулятор CRC
Рисунок 5 - вывод в UART второго примера

Вывод в UART изображен на рисунке 5.