tests/lib/crc_byte-test.c

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2
   3 #include <tests/test.h>
   4 #include <crc_byte.h>
   5
   6 static const uint8_t test_data_bytes[] = {
   7         0x2f, 0x8f, 0x2d, 0x06, 0xc2, 0x11, 0x0c, 0xaf, 0xd7, 0x4b, 0x48, 0x71, 0xce, 0x3c,
   8         0xfe, 0x29, 0x90, 0xf6, 0x33, 0x6d, 0x79, 0x23, 0x9d, 0x84, 0x58, 0x5c, 0xcc, 0xf1,
   9         0xa1, 0xf2, 0x39, 0x22, 0xdc, 0x63, 0xe0, 0x44, 0x0a, 0x95, 0x36, 0xee, 0x53, 0xb3,
  10         0x61, 0x2c, 0x4a, 0xf4, 0x8b, 0x32, 0xeb, 0x94, 0x86, 0x55, 0x41, 0x27, 0xa4, 0xbd,
  11         0x0f, 0xc1, 0x4f, 0xfb, 0xb6, 0xa3, 0xc5, 0x38, 0x99, 0xfc, 0xca, 0xf8, 0x8e, 0x72,
  12         0xaa, 0xed, 0x6b, 0xb2, 0xd3, 0xd4, 0xd6, 0x81, 0x7d, 0x24, 0x56, 0x9f, 0x7a, 0x21,
  13         0x67, 0xac, 0x6a, 0x98, 0xf7, 0xd1, 0xad, 0x01, 0xdb, 0xc6, 0x80, 0x34, 0x8d, 0x51,
  14         0x60, 0x3e, 0xd2, 0x52, 0x0e, 0x26, 0x12, 0xb1, 0x13, 0xa2, 0x88, 0x04, 0x66, 0xb0,
  15         0x3b, 0xc8, 0x1b, 0x7f, 0x92, 0x4e, 0xb8, 0xe9, 0x70, 0xe3, 0xfa, 0x76, 0x3a, 0xa7,
  16         0x4c, 0x25, 0x91, 0x54, 0x19, 0xea, 0x50, 0x37, 0xd8, 0xb4, 0x47, 0x49, 0xbf, 0xc4,
  17         0xb7, 0xd0, 0x93, 0xda, 0x6c, 0x03, 0x9b, 0x15, 0xbb, 0xfd, 0xe7, 0xdd, 0x2e, 0x31,
  18         0x68, 0x46, 0xa0, 0x43, 0xcd, 0x08, 0x8c, 0xff, 0x40, 0xcf, 0x1a, 0x7c, 0x69, 0x59,
  19         0xc0, 0x5b, 0x83, 0x17, 0x10, 0x14, 0x9e, 0x1d, 0xc3, 0xa6, 0x5f, 0x4d, 0x9c, 0xa5,
  20         0x73, 0x77, 0x87, 0x96, 0x65, 0x0b, 0xec, 0xc7, 0xd9, 0x85, 0x1c, 0xae, 0x18, 0x5e,
  21         0x09, 0x78, 0x2b, 0x82, 0x1f, 0xe6, 0xc9, 0x64, 0x6f, 0x20, 0x16, 0x57, 0x9a, 0xbe,
  22         0xd5, 0xe2, 0x89, 0x3f, 0xdf, 0xe4, 0x7e, 0xde, 0x30, 0xa9, 0x74, 0xe5, 0xab, 0x07,
  23         0x35, 0x5d, 0x2a, 0x28, 0xcb, 0xf0, 0x8a, 0xef, 0x5a, 0xe1, 0x75, 0x42, 0xf9, 0xba,
  24         0x02, 0xbc, 0xf5, 0x45, 0x05, 0x0d, 0x3d, 0x62, 0xb9, 0x00, 0x7b, 0x1e, 0xe8, 0xb5,
  25         0x97, 0x6e, 0xa8, 0xf3,
  26 };
  27 static const size_t test_data_bytes_sz = ARRAY_SIZE(test_data_bytes);
  28 static const uint8_t test_data_crc7_checksum = 0x30;
  29 static const uint16_t test_data_crc16_checksum = 0x1263;
  30 static const uint32_t test_data_crc32_checksum = 0xc7f52a93;
  31
  32 static void test_crc7_byte_zeros(void **state)
  33 {
  34         uint8_t crc_value = 0u;
  35
  36         /* Expect zero as crc value after calculating it for single zero byte */
  37         crc_value = crc7_byte(crc_value, 0);
  38         assert_int_equal(0, crc_value);
  39
  40         /* Expect zero crc for zero-byte stream */
  41         for (size_t i = 0; i < 3000; ++i) {
  42                 crc_value = crc7_byte(crc_value, 0);
  43                 assert_int_equal(0, crc_value);
  44         }
  45 }
  46
  47 static void test_crc7_byte_same_byte_twice_different_value(void **state)
  48 {
  49         uint8_t crc_value = 0u;
  50
  51         /* Expect value to change after feeding crc function with the same byte twice. */
  52         crc_value = crc7_byte(crc_value, 0xAD);
  53         assert_int_equal(0x2C, crc_value);
  54
  55         crc_value = crc7_byte(crc_value, 0xAD);
  56         assert_int_equal(0x90, crc_value);
  57 }
  58
  59 static void test_crc7_byte_repeat_stream(void **state)
  60 {
  61         uint8_t crc_value_1 = 0u;
  62         uint8_t crc_value_2 = 0u;
  63         const size_t iterations = 25600;
  64
  65         /* Calculate CRC7 twice for the same data and expect the same result.
  66            Ensure deterministic and repeatable behavior. */
  67         for (size_t i = 0; i < iterations; i++) {
  68                 const uint8_t value = (i & 0xFF) ^ ((i >> 8) & 0xFF);
  69                 crc_value_1 = crc7_byte(crc_value_1, value);
  70         }
  71
  72         for (size_t i = 0; i < iterations; i++) {
  73                 const uint8_t value = (i & 0xFF) ^ ((i >> 8) & 0xFF);
  74                 crc_value_2 = crc7_byte(crc_value_2, value);
  75         }
  76
  77         assert_int_equal(crc_value_1, crc_value_2);
  78 }
  79
  80 static void test_crc7_byte_single_bit_difference(void **state)
  81 {
  82         uint8_t crc_value_1 = 0u;
  83         uint8_t crc_value_2 = 0u;
  84
  85         for (size_t i = 0; i < 1000; ++i) {
  86                 crc_value_1 = crc7_byte(crc_value_1, (i % 128) << 1);
  87                 crc_value_2 = crc7_byte(crc_value_2, (i % 128) << 1);
  88         }
  89         crc_value_1 = crc7_byte(crc_value_1, 0xF0);
  90         crc_value_2 = crc7_byte(crc_value_2, 0xF1);
  91
  92         /* Expect different CRC values for byte streams differing by one bit. */
  93         assert_int_not_equal(crc_value_1, crc_value_2);
  94 }
  95
  96 /* This test uses CRC() macro to check if it works correctly with provided crc function */
  97 static void test_crc7_byte_static_data(void **state)
  98 {
  99         uint8_t crc_value = CRC(test_data_bytes, test_data_bytes_sz, crc7_byte);
 100
 101         assert_int_equal(test_data_crc7_checksum, crc_value);
 102
 103         /* Calculating CRC of data with its CRC should yield zero if data
 104            and/or checksum is correct */
 105         assert_int_equal(0, crc7_byte(crc_value, test_data_crc7_checksum));
 106 }
 107
 108 static void test_crc16_byte_zeros(void **state)
 109 {
 110         uint16_t crc_value = 0u;
 111
 112         /* Expect zero as crc value after calculating it for single zero byte */
 113         crc_value = crc16_byte(crc_value, 0);
 114         assert_int_equal(0, crc_value);
 115
 116         /* Expect zero crc for zero-byte stream */
 117         for (size_t i = 0; i < 3000; ++i) {
 118                 crc_value = crc16_byte(crc_value, 0);
 119                 assert_int_equal(0, crc_value);
 120         }
 121 }
 122
 123 static void test_crc16_same_data_twice_different_value(void **state)
 124 {
 125         uint16_t crc_value = 0u;
 126
 127         /* Expect value to change after feeding crc function with the same byte twice. */
 128         crc_value = crc16_byte(crc_value, 0xDF);
 129         assert_int_equal(0x3a92, crc_value);
 130
 131         crc_value = crc16_byte(crc_value, 0xDF);
 132         assert_int_equal(0x3f8b, crc_value);
 133 }
 134
 135 static void test_crc16_byte_repeat_stream(void **state)
 136 {
 137         uint16_t crc_value_1 = 0u;
 138         uint16_t crc_value_2 = 0u;
 139         const size_t iterations = 17777;
 140
 141         /* Calculate CRC16 twice for the same data and expect the same result.
 142            Ensure deterministic and repeatable behavior. */
 143         for (size_t i = 0; i < iterations; i++) {
 144                 const uint8_t value = (i & 0xFF) ^ ((i >> 8) & 0xFF);
 145                 crc_value_1 = crc16_byte(crc_value_1, value);
 146         }
 147
 148         for (size_t i = 0; i < iterations; i++) {
 149                 const uint8_t value = (i & 0xFF) ^ ((i >> 8) & 0xFF);
 150                 crc_value_2 = crc16_byte(crc_value_2, value);
 151         }
 152
 153         assert_int_equal(crc_value_1, crc_value_2);
 154 }
 155
 156 static void test_crc16_byte_single_bit_difference(void **state)
 157 {
 158         uint16_t crc_value_1 = 0u;
 159         uint16_t crc_value_2 = 0u;
 160
 161         for (size_t i = 0; i < 2000; ++i) {
 162                 crc_value_1 = crc16_byte(crc_value_1, (i % 128) << 1);
 163                 crc_value_2 = crc16_byte(crc_value_2, (i % 128) << 1);
 164         }
 165         crc_value_1 = crc16_byte(crc_value_1, 0x1A);
 166         crc_value_2 = crc16_byte(crc_value_2, 0x0A);
 167
 168         /* Expect different CRC values for byte streams differing by one bit. */
 169         assert_int_not_equal(crc_value_1, crc_value_2);
 170 }
 171
 172 /* This test uses CRC() macro to check if it works correctly with provided crc function */
 173 static void test_crc16_byte_static_data(void **state)
 174 {
 175         uint16_t crc_value = CRC(test_data_bytes, test_data_bytes_sz, crc16_byte);
 176
 177         assert_int_equal(test_data_crc16_checksum, crc_value);
 178
 179         /* Calculating CRC of data with its CRC should yield zero if data
 180            and/or checksum is correct */
 181         assert_int_equal(0, crc16_byte(crc16_byte(crc_value, test_data_crc16_checksum >> 8),
 182                                        test_data_crc16_checksum & 0xFF));
 183 }
 184
 185 static void test_crc32_byte_zeros(void **state)
 186 {
 187         uint32_t crc_value = 0u;
 188
 189         /* Expect zero as crc value after calculating it for single zero byte */
 190         crc_value = crc32_byte(crc_value, 0);
 191         assert_int_equal(0, crc_value);
 192
 193         /* Expect zero crc for zero-byte stream */
 194         for (size_t i = 0; i < 1553; ++i) {
 195                 crc_value = crc32_byte(crc_value, 0);
 196                 assert_int_equal(0, crc_value);
 197         }
 198 }
 199
 200 static void test_crc32_same_data_twice_different_value(void **state)
 201 {
 202         uint32_t crc_value = 0u;
 203
 204         /* Expect value to change after feeding crc function with the same byte twice. */
 205         crc_value = crc32_byte(crc_value, 0xDF);
 206         assert_int_equal(0x29d4f654, crc_value);
 207
 208         crc_value = crc32_byte(crc_value, 0xDF);
 209         assert_int_equal(0x47c8e4bb, crc_value);
 210 }
 211
 212 static void test_crc32_byte_repeat_stream(void **state)
 213 {
 214         uint32_t crc_value_1 = 0u;
 215         uint32_t crc_value_2 = 0u;
 216         const size_t iterations = 8935;
 217
 218         /* Calculate CRC16 twice for the same data and expect the same result.
 219            Ensure deterministic and repeatable behavior. */
 220         for (size_t i = 0; i < iterations; i++) {
 221                 const uint8_t value = (i & 0xFF) ^ ((i >> 8) & 0xFF);
 222                 crc_value_1 = crc32_byte(crc_value_1, value);
 223         }
 224
 225         for (size_t i = 0; i < iterations; i++) {
 226                 const uint8_t value = (i & 0xFF) ^ ((i >> 8) & 0xFF);
 227                 crc_value_2 = crc32_byte(crc_value_2, value);
 228         }
 229
 230         assert_int_equal(crc_value_1, crc_value_2);
 231 }
 232
 233 static void test_crc32_byte_single_bit_difference(void **state)
 234 {
 235         uint32_t crc_value_1 = 0u;
 236         uint32_t crc_value_2 = 0u;
 237
 238         for (size_t i = 0; i < 1338; ++i) {
 239                 crc_value_1 = crc32_byte(crc_value_1, (i % 128) << 1);
 240                 crc_value_2 = crc32_byte(crc_value_2, (i % 128) << 1);
 241         }
 242         crc_value_1 = crc32_byte(crc_value_1, 0x33);
 243         crc_value_2 = crc32_byte(crc_value_2, 0x32);
 244
 245         /* Expect different CRC values for byte streams differing by one bit. */
 246         assert_int_not_equal(crc_value_1, crc_value_2);
 247 }
 248
 249 /* This test uses CRC() macro to check if it works correctly with provided crc function */
 250 static void test_crc32_byte_static_data(void **state)
 251 {
 252         uint32_t crc_value = CRC(test_data_bytes, test_data_bytes_sz, crc32_byte);
 253
 254         assert_int_equal(test_data_crc32_checksum, crc_value);
 255
 256         /* Calculating CRC of data with its CRC should yield zero if data
 257            and/or checksum is correct */
 258         for (int i = 3; i >= 0; --i)
 259                 crc_value = crc32_byte(crc_value, (test_data_crc32_checksum >> 8 * i) & 0xFF);
 260         assert_int_equal(0, crc_value);
 261 }
 262
 263 int main(void)
 264 {
 265         const struct CMUnitTest tests[] = {
 266                 cmocka_unit_test(test_crc7_byte_zeros),
 267                 cmocka_unit_test(test_crc7_byte_same_byte_twice_different_value),
 268                 cmocka_unit_test(test_crc7_byte_repeat_stream),
 269                 cmocka_unit_test(test_crc7_byte_single_bit_difference),
 270                 cmocka_unit_test(test_crc7_byte_static_data),
 271
 272                 cmocka_unit_test(test_crc16_byte_zeros),
 273                 cmocka_unit_test(test_crc16_same_data_twice_different_value),
 274                 cmocka_unit_test(test_crc16_byte_repeat_stream),
 275                 cmocka_unit_test(test_crc16_byte_single_bit_difference),
 276                 cmocka_unit_test(test_crc16_byte_static_data),
 277
 278                 cmocka_unit_test(test_crc32_byte_zeros),
 279                 cmocka_unit_test(test_crc32_same_data_twice_different_value),
 280                 cmocka_unit_test(test_crc32_byte_repeat_stream),
 281                 cmocka_unit_test(test_crc32_byte_single_bit_difference),
 282                 cmocka_unit_test(test_crc32_byte_static_data),
 283         };
 284
 285         return cb_run_group_tests(tests, NULL, NULL);
 286 }