Использование CRC на примере алгоритма CRC-32Q

В примере будут записаны данные в основной массив 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. Выглядит она так:

static void CRC_Init(void)
{

    hcrc.Instance = CRC;
    
    /* Настройки вычисления CRC */                    
    /*******************************************CRC-32Q*******************************************/
    hcrc.Poly = 0x814141AB;                             
    hcrc.Init = 0x00000000;                                 
    hcrc.InputReverse = CRC_REFIN_FALSE;                 
    hcrc.OutputReverse = CRC_REFOUT_FALSE;                          
    hcrc.OutputInversion = CRC_OUTPUTINVERSION_OFF;

    HAL_CRC_Init(&hcrc);

}

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

void SystemClock_Config(void)
{
    RCC_OscInitTypeDef RCC_OscInit = {0};
    RCC_PeriphCLKInitTypeDef PeriphClkInit = {0};

    RCC_OscInit.OscillatorEnable = RCC_OSCILLATORTYPE_OSC32K | RCC_OSCILLATORTYPE_OSC32M; // Включение 32К и 32М источников
    RCC_OscInit.OscillatorSystem = RCC_OSCILLATORTYPE_OSC32M;                          
    RCC_OscInit.AHBDivider = 0;                             
    RCC_OscInit.APBMDivider = 0;                             
    RCC_OscInit.APBPDivider = 0;                             
    RCC_OscInit.HSI32MCalibrationValue = 0;                  
    RCC_OscInit.LSI32KCalibrationValue = 0;
    HAL_RCC_OscConfig(&RCC_OscInit);

    PeriphClkInit.PMClockAHB = PMCLOCKAHB_DEFAULT | PM_CLOCK_CRC32_M;    
    PeriphClkInit.PMClockAPB_M = PMCLOCKAPB_M_DEFAULT | PM_CLOCK_WU_M;     
    PeriphClkInit.PMClockAPB_P = PMCLOCKAPB_P_DEFAULT | PM_CLOCK_UART_0_M;     
    PeriphClkInit.RTCClockSelection = RCC_RTCCLKSOURCE_NO_CLK;
    PeriphClkInit.RTCClockCPUSelection = RCC_RTCCLKCPUSOURCE_NO_CLK;
    HAL_RCC_ClockConfig(&PeriphClkInit);
}

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

CRC_HandleTypeDef hcrc;

void SystemClock_Config(void);
static void CRC_Init(void);

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

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

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

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

int main()
{    

    SystemClock_Config();

    CRC_Init();

    uint8_t  message[] ={'1', '2', '3', '4', '5', '6', '7', '8', '9'};
    uint32_t CRCValue = 0;
    
    /* Запись по байтам */
    HAL_RTC_WriteData(&hcrc, message, sizeof(message));
    CRCValue = HAL_RTC_ReadCRC(&hcrc);
    #ifdef MIK32_CRC_DEBUG
    xprintf("CRC32 = 0x%08x, ожидалось 0x3010BF7F\n", CRCValue);
    #endif
    
    while (1)
    {    

    }
       
}

Вывод в UART

Если у вас включен UART и в main.c или def_list.h есть #define MIK32_CRC_DEBUG, то можно видеть вывод как на рисунке. Полученное значение CRC совпадает с табличным значением в столбце Check.

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

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

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

Калькулятор CRC

Вывод в UART второго примера

int main()
{    

    SystemClock_Config();

    CRC_Init();

    uint8_t  message[] ={'1', '2', '3', '4', '5', '6', '7', '8', '9'};
    uint32_t data[] = {0xABCDABCD, 0xA1B2C3D4};
    uint32_t CRCValue = 0;
    
    /* Запись по байтам */
    HAL_RTC_WriteData(&hcrc, message, sizeof(message));
    CRCValue = HAL_RTC_ReadCRC(&hcrc);
    #ifdef MIK32_CRC_DEBUG
    xprintf("CRC32 = 0x%08x, ожидалось 0x3010BF7F\n", CRCValue);
    #endif
    
    /* Запись по словам */
    HAL_RTC_WriteData32(&hcrc, data, sizeof(data)/sizeof(*data));
    CRCValue = HAL_RTC_ReadCRC(&hcrc);
    #ifdef MIK32_CRC_DEBUG
    xprintf("CRC32 = 0x%08x, ожидалось 0x6311BC18\n", CRCValue);
    #endif
    

    while (1)
    {    

    }
       
}

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