Skip to content

Add HAL CRC test and header file #6831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 13, 2018
Merged

Add HAL CRC test and header file #6831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1eed0b9
Add HAL CRC test and test header file.
mprse May 7, 2018
307021e
Add testing requirements to HAL CRC header file.
mprse May 7, 2018
511f370
HAL CRC test: Fix out of memory issue on NULCLEO_F070RB, NULCLEO_F072…
mprse Jun 7, 2018
68631fc
STM CRC driver: hal_crc_compute_partial() - validate input paramaters.
mprse Jun 7, 2018
da557a5
K64F CRC driver: hal_crc_is_supported() - fix condition which validat…
mprse Jun 7, 2018
ee6a07e
K64F CRC driver: Fix handling of CRC final XOR value
mprse Jun 7, 2018
a499341
K64F CRC driver: Fix coding style
mprse Jun 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions TESTS/mbed_hal/crc/crc_api_tests.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/** \addtogroup hal_crc_tests */
/** @{*/

#ifndef MBED_CRC_API_TESTS_H
#define MBED_CRC_API_TESTS_H

#include "device.h"

#if DEVICE_CRC

#ifdef __cplusplus
extern "C" {
#endif

/** Test that hal_crc_is_supported() function returns true if given polynomial/width
* is supported, false otherwise (at least one predefined polynomial/width must be supported).
*
* Given is platform with hardware CRC support.
*
* When given polynomial/width is supported.
* Then hal_crc_is_supported() function returns true.
*
* When given polynomial/width is not supported.
* Then hal_crc_is_supported() function returns false.
*
* Note:
* At least one predefined polynomial/width config must be supported.
*
*/
void crc_is_supported_test();

/** Test that CRC module can be successfully configured, fed with data and the result can
* be successfully obtained.
*
* Given is platform with hardware CRC support.
*
* When hal_crc_compute_partial_start() function is called.
* Then it configures CRC module with the given polynomial.
*
* When hal_crc_compute_partial() function is called with valid buffer and data length.
* Then it feeds CRC module with data.
*
* When hal_crc_get_result() function is called.
* Then CRC value for the given data is returned.
*
*/
void crc_calc_single_test();

/** Test that hal_crc_compute_partial() function can be call multiple times in
* succession in order to provide additional data to CRC module.
*
* Given is platform with hardware CRC support and CRC module is configured.
* When hal_crc_compute_partial() function is called multiple times.
* Then each call provides additional data to CRC module.
*
*/
void crc_calc_multi_test();

/** Test that calling hal_crc_compute_partial_start() without finalising the
* CRC calculation overrides the current configuration and partial result.
*
* Given is platform with hardware CRC support.
* When CRC module has been configured and fed with data and reconfigured (without reading the result).
* Then the configuration has been overwritten and the new data can be successfully processed.
*
*/
void crc_reconfigure_test();

/** Test that hal_crc_compute_partial() does nothing if pointer to buffer is undefined or
* data length is equal to 0.
*
* Given is platform with hardware CRC support.
* When hal_crc_compute_partial() is called with invalid parameters.
* Then no data is provided to CRC module and no exception is generated.
*
*/
void crc_compute_partial_invalid_param_test();

/** Test that hal_crc_is_supported() returns false if pointer to the config structure is undefined.
*
* Given is platform with hardware CRC support.
* When hal_crc_is_supported() is called with invalid parameter.
* Then function returns false.
*
*/
void crc_is_supported_invalid_param_test();

/**@}*/

#ifdef __cplusplus
}
#endif

#endif

#endif

/**@}*/
281 changes: 281 additions & 0 deletions TESTS/mbed_hal/crc/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,281 @@
/* mbed Microcontroller Library
* Copyright (c) 2018 ARM Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "utest/utest.h"
#include "unity/unity.h"
#include "greentea-client/test_env.h"
#include "mbed.h"
#include "math.h"
#include "crc_api.h"

#if !DEVICE_CRC
#error [NOT_SUPPORTED] CRC not supported for this target
#endif

using namespace utest::v1;

#define POLY_8BIT_MAXIM 0x31
#define POLY_16BIT_MAXIM 0x8005
#define POLY_32BIT_POSIX 0x4C11DB7

#define UNSUPPORTED (-1)
#define POL_CNT (2)

const uint8_t input_data[] = "123456789";

typedef struct
{
const crc_mbed_config config_data;
uint32_t expected_result;

} TEST_CASE;

/* We will allocate test case array on stack since memory limits on some boards
* like NUCLEO_F070RB. */
static TEST_CASE *test_cases;
static uint32_t test_cases_size;

/* Test that hal_crc_is_supported() function returns true if given polynomial
* is supported, false otherwise (at least one polynomial from the predefined list must be supported). */
void crc_is_supported_test()
{
/* Check if at least one crc polynomial/config is supported. */
uint32_t num_of_supported_polynomials = 0;

for (unsigned int i = 0; i < (test_cases_size / sizeof(TEST_CASE)); i++) {
if (hal_crc_is_supported(&test_cases[i].config_data) == true) {

num_of_supported_polynomials++;
}
}

TEST_ASSERT(num_of_supported_polynomials > 0);
}

/* Test that CRC module can be successfully configured, fed with data and the result can
* be successfully obtained. */
void crc_calc_single_test()
{
for (unsigned int i = 0; i < (test_cases_size / sizeof(TEST_CASE)); i++) {
if (hal_crc_is_supported(&test_cases[i].config_data) == true) {

hal_crc_compute_partial_start(&test_cases[i].config_data);
hal_crc_compute_partial((uint8_t*) input_data, strlen((const char*) input_data));
const uint32_t crc = hal_crc_get_result();

TEST_ASSERT_EQUAL(test_cases[i].expected_result, crc);
}
}
}

/* Test that hal_crc_compute_partial() function can be call multiple times in
* succession in order to provide additional data to CRC module. */
void crc_calc_multi_test()
{
for (unsigned int i = 0; i < (test_cases_size / sizeof(TEST_CASE)); i++) {
if (hal_crc_is_supported(&test_cases[i].config_data) == true) {

const uint32_t first_part_bytes = 3;
const uint32_t second_part_bytes = 1;
const uint32_t third_part_bytes = strlen((const char*) input_data) - first_part_bytes
- second_part_bytes;

hal_crc_compute_partial_start(&test_cases[i].config_data);
hal_crc_compute_partial((uint8_t*) input_data, first_part_bytes);
hal_crc_compute_partial((uint8_t*) (input_data + first_part_bytes), second_part_bytes);
hal_crc_compute_partial((uint8_t*) (input_data + first_part_bytes + second_part_bytes),
third_part_bytes);
const uint32_t crc = hal_crc_get_result();

TEST_ASSERT_EQUAL(test_cases[i].expected_result, crc);
}
}
}

/* Test that calling hal_crc_compute_partial_start() without finalising the
* CRC calculation overrides the current configuration. */
void crc_reconfigure_test()
{
int pol_idx[POL_CNT] =
{ UNSUPPORTED, UNSUPPORTED };
int pol_cnt = 0;
const uint8_t dummy_input_data[] = "abcdefghijklmnopqrstuvwxyz";

/* At least one configuration must be supported. If two are supported, then
* re-initialize CRC module using different config. */
for (unsigned int i = 0; i < (test_cases_size / sizeof(TEST_CASE)); i++) {

/* Find two supported polynomials if possible. */
if (hal_crc_is_supported(&test_cases[i].config_data) == true) {
if (pol_cnt == 0) {
pol_idx[pol_cnt] = i;
pol_cnt++;
} else if (test_cases[pol_idx[0]].config_data.polynomial != test_cases[i].config_data.polynomial) {
pol_idx[pol_cnt] = i;
pol_cnt++;
}

if (pol_cnt == POL_CNT) {
break;
}
}
}

pol_cnt = 0;

/* Init CRC module and provide some data, but do not read the result. */
hal_crc_compute_partial_start(&test_cases[pol_idx[pol_cnt]].config_data);
hal_crc_compute_partial((uint8_t*) dummy_input_data, strlen((const char*) dummy_input_data));

/* Change index only if more than one supported polynomial has been found. */
if (pol_idx[POL_CNT - 1] != UNSUPPORTED) {
pol_cnt++;
}

/* Now re-init CRC module and provide new data and check the result. */
hal_crc_compute_partial_start(&test_cases[pol_idx[pol_cnt]].config_data);
hal_crc_compute_partial((uint8_t*) input_data, strlen((const char*) input_data));
const uint32_t crc = hal_crc_get_result();

TEST_ASSERT_EQUAL(test_cases[pol_idx[pol_cnt]].expected_result, crc);
}

/* Test that hal_crc_compute_partial() does nothing if pointer to buffer is undefined or
* data length is equal to 0. */
void crc_compute_partial_invalid_param_test()
{
uint32_t crc = 0;

/* At least one polynomial must be supported. */
for (unsigned int i = 0; i < (test_cases_size / sizeof(TEST_CASE)); i++) {
if (hal_crc_is_supported(&test_cases[i].config_data) == true) {

hal_crc_compute_partial_start(&test_cases[i].config_data);

/* Call hal_crc_compute_partial() with invalid parameters. */
hal_crc_compute_partial((uint8_t*) NULL, strlen((const char*) input_data));
hal_crc_compute_partial((uint8_t*) input_data, 0);

/* Now use valid parameters. */
hal_crc_compute_partial((uint8_t*) input_data,
strlen((const char*) input_data));

crc = hal_crc_get_result();

TEST_ASSERT_EQUAL(test_cases[i].expected_result, crc);

break;
}
}
}

/* Test that hal_crc_is_supported() returns false if pointer to the config structure is undefined. */
void crc_is_supported_invalid_param_test()
{
TEST_ASSERT_EQUAL(false, hal_crc_is_supported(NULL));
}

Case cases[] = {
Case("test: supported polynomials.", crc_is_supported_test),
Case("test: CRC calculation - single input.", crc_calc_single_test),
Case("test: CRC calculation - multi input.", crc_calc_multi_test),
Case("test: re-configure without getting the result.", crc_reconfigure_test),
Case("test: hal_crc_compute_partial() - invalid parameters.", crc_compute_partial_invalid_param_test),
Case("test: hal_crc_is_supported() - invalid parameter.", crc_is_supported_invalid_param_test),
};

utest::v1::status_t greentea_test_setup(const size_t number_of_cases)
{
GREENTEA_SETUP(30, "default_auto");
return greentea_test_setup_handler(number_of_cases);
}

Specification specification(greentea_test_setup, cases, greentea_test_teardown_handler);

int main()
{
TEST_CASE local_test_cases[] = {
/* Predefined polynomials. */
/* 00 */{ {POLY_7BIT_SD , 7, 0x00000000, 0x00000000, false, false}, 0xEA },
/* 01 */{ {POLY_7BIT_SD , 7, 0x0000007F, 0x00000000, false, false}, 0xA0 },
/* 02 */{ {POLY_7BIT_SD , 7, 0x0000002B, 0x00000000, false, false}, 0x74 },
/* 03 */{ {POLY_7BIT_SD , 7, 0x00000000, 0x0000007F, false, false}, 0x95 },
/* 04 */{ {POLY_7BIT_SD , 7, 0x00000000, 0x0000002B, false, false}, 0xC1 },
/* 05 */{ {POLY_7BIT_SD , 7, 0x00000000, 0x00000000, true , false}, 0xA4 },
/* 06 */{ {POLY_7BIT_SD , 7, 0x00000000, 0x00000000, false, true }, 0x57 },

/* 07 */{ {POLY_8BIT_CCITT , 8, 0x00000000, 0x00000000, false, false}, 0xF4 },
/* 08 */{ {POLY_8BIT_CCITT , 8, 0x000000FF, 0x00000000, false, false}, 0xFB },
/* 09 */{ {POLY_8BIT_CCITT , 8, 0x000000AB, 0x00000000, false, false}, 0x87 },
/* 10 */{ {POLY_8BIT_CCITT , 8, 0x00000000, 0x000000FF, false, false}, 0x0B },
/* 11 */{ {POLY_8BIT_CCITT , 8, 0x00000000, 0x000000AB, false, false}, 0x5F },
/* 12 */{ {POLY_8BIT_CCITT , 8, 0x00000000, 0x00000000, true , false}, 0x04 },
/* 13 */{ {POLY_8BIT_CCITT , 8, 0x00000000, 0x00000000, false, true }, 0x2F },

/* 14 */{ {POLY_16BIT_CCITT , 16, 0x00000000, 0x00000000, false, false}, 0x31C3 },
/* 15 */{ {POLY_16BIT_CCITT , 16, 0x0000FFFF, 0x00000000, false, false}, 0x29B1 },
/* 16 */{ {POLY_16BIT_CCITT , 16, 0x0000ABAB, 0x00000000, false, false}, 0x7D70 },
/* 17 */{ {POLY_16BIT_CCITT , 16, 0x00000000, 0x0000FFFF, false, false}, 0xCE3C },
/* 18 */{ {POLY_16BIT_CCITT , 16, 0x00000000, 0x0000ABAB, false, false}, 0x9A68 },
/* 19 */{ {POLY_16BIT_CCITT , 16, 0x00000000, 0x00000000, true , false}, 0x9184 },
/* 20 */{ {POLY_16BIT_CCITT , 16, 0x00000000, 0x00000000, false, true }, 0xC38C },

/* 21 */{ {POLY_16BIT_IBM , 16, 0x00000000, 0x00000000, false, false}, 0xFEE8 },
/* 22 */{ {POLY_16BIT_IBM , 16, 0x0000FFFF, 0x00000000, false, false}, 0xAEE7 },
/* 23 */{ {POLY_16BIT_IBM , 16, 0x0000ABAB, 0x00000000, false, false}, 0x0887 },
/* 24 */{ {POLY_16BIT_IBM , 16, 0x00000000, 0x0000FFFF, false, false}, 0x0117 },
/* 25 */{ {POLY_16BIT_IBM , 16, 0x00000000, 0x0000ABAB, false, false}, 0x5543 },
/* 26 */{ {POLY_16BIT_IBM , 16, 0x00000000, 0x00000000, true , false}, 0xBCDD },
/* 27 */{ {POLY_16BIT_IBM , 16, 0x00000000, 0x00000000, false, true }, 0x177F },

/* 28 */{ {POLY_32BIT_ANSI , 32, 0x00000000, 0x00000000, false, false}, 0x89A1897F },
/* 29 */{ {POLY_32BIT_ANSI , 32, 0xFFFFFFFF, 0x00000000, false, false}, 0x0376E6E7 },
/* 30 */{ {POLY_32BIT_ANSI , 32, 0xABABABAB, 0x00000000, false, false}, 0x871A2FAA },
/* 31 */{ {POLY_32BIT_ANSI , 32, 0x00000000, 0xFFFFFFFF, false, false}, 0x765E7680 },
/* 32 */{ {POLY_32BIT_ANSI , 32, 0x00000000, 0xABABABAB, false, false}, 0x220A22D4 },
/* 33 */{ {POLY_32BIT_ANSI , 32, 0x00000000, 0x00000000, true , false}, 0x11B4BFB4 },
/* 34 */{ {POLY_32BIT_ANSI , 32, 0x00000000, 0x00000000, false, true }, 0xFE918591 },

/* Not-predefined polynomials. */
/* 35 */{ {POLY_8BIT_MAXIM , 8, 0x00000000, 0x00000000, false, false}, 0xA2 },
/* 36 */{ {POLY_8BIT_MAXIM , 8, 0x000000FF, 0x00000000, false, false}, 0xF7 },
/* 37 */{ {POLY_8BIT_MAXIM , 8, 0x000000AB, 0x00000000, false, false}, 0x71 },
/* 38 */{ {POLY_8BIT_MAXIM , 8, 0x00000000, 0x000000FF, false, false}, 0x5D },
/* 39 */{ {POLY_8BIT_MAXIM , 8, 0x00000000, 0x000000AB, false, false}, 0x09 },
/* 40 */{ {POLY_8BIT_MAXIM , 8, 0x00000000, 0x00000000, true , false}, 0x85 },
/* 41 */{ {POLY_8BIT_MAXIM , 8, 0x00000000, 0x00000000, false, true }, 0x45 },

/* 42 */{ {POLY_16BIT_MAXIM , 16, 0x00000000, 0x00000000, false, false}, 0xFEE8 },
/* 43 */{ {POLY_16BIT_MAXIM , 16, 0x0000FFFF, 0x00000000, false, false}, 0xAEE7 },
/* 44 */{ {POLY_16BIT_MAXIM , 16, 0x0000ABAB, 0x00000000, false, false}, 0x0887 },
/* 45 */{ {POLY_16BIT_MAXIM , 16, 0x00000000, 0x0000FFFF, false, false}, 0x0117 },
/* 46 */{ {POLY_16BIT_MAXIM , 16, 0x00000000, 0x0000ABAB, false, false}, 0x5543 },
/* 47 */{ {POLY_16BIT_MAXIM , 16, 0x00000000, 0x00000000, true , false}, 0xBCDD },
/* 48 */{ {POLY_16BIT_MAXIM , 16, 0x00000000, 0x00000000, false, true }, 0x177F },

/* 49 */{ {POLY_32BIT_POSIX , 32, 0x00000000, 0x00000000, false, false}, 0x89A1897F },
/* 50 */{ {POLY_32BIT_POSIX , 32, 0xFFFFFFFF, 0x00000000, false, false}, 0x0376E6E7 },
/* 51 */{ {POLY_32BIT_POSIX , 32, 0xABABABAB, 0x00000000, false, false}, 0x871A2FAA },
/* 52 */{ {POLY_32BIT_POSIX , 32, 0x00000000, 0xFFFFFFFF, false, false}, 0x765E7680 },
/* 53 */{ {POLY_32BIT_POSIX , 32, 0x00000000, 0xABABABAB, false, false}, 0x220A22D4 },
/* 54 */{ {POLY_32BIT_POSIX , 32, 0x00000000, 0x00000000, true , false}, 0x11B4BFB4 },
/* 55 */{ {POLY_32BIT_POSIX , 32, 0x00000000, 0x00000000, false, true }, 0xFE918591 },
};

test_cases = local_test_cases;
test_cases_size = sizeof(local_test_cases);

Harness::run(specification);
}
Loading