From ac6944cc82aecea8d6153ca0e5b1eba8612136b7 Mon Sep 17 00:00:00 2001 From: Thomas Jarosch Date: Fri, 2 Sep 2011 12:59:31 +0200 Subject: [PATCH] Add unit test for existing baudrate calculcation code Implement a table for every chip type which stores the expected calculated result. Highest speed currently tested is 921600 --- src/ftdi.c | 10 ++ test/baudrate.cpp | 237 ++++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 245 insertions(+), 2 deletions(-) diff --git a/src/ftdi.c b/src/ftdi.c index 1616fdb..9691b8f 100644 --- a/src/ftdi.c +++ b/src/ftdi.c @@ -1091,6 +1091,16 @@ static int ftdi_convert_baudrate(int baudrate, struct ftdi_context *ftdi, } /** + * @brief Wrapper function to export ftdi_convert_baudrate() to the unit test + * Do not use, it's only for the unit test framework + **/ +int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi, + unsigned short *value, unsigned short *index) +{ + return ftdi_convert_baudrate(baudrate, ftdi, value, index); +} + +/** Sets the chip baud rate \param ftdi pointer to ftdi_context diff --git a/test/baudrate.cpp b/test/baudrate.cpp index 163950b..cd74d6c 100644 --- a/test/baudrate.cpp +++ b/test/baudrate.cpp @@ -12,13 +12,246 @@ * * ***************************************************************************/ +#include + #define BOOST_TEST_DYN_LINK #include +#include +#include + +using namespace std; + +extern "C" int convert_baudrate_UT_export(int baudrate, struct ftdi_context *ftdi, + unsigned short *value, unsigned short *index); + +/// Basic initialization of libftdi for every test +class BaseFTDIFixture +{ +protected: + ftdi_context *ftdi; + +public: + BaseFTDIFixture() + : ftdi(NULL) + { + ftdi = ftdi_new(); + } + + ~BaseFTDIFixture() + { + delete ftdi; + ftdi = NULL; + } +}; -BOOST_AUTO_TEST_SUITE(Baudrate) +BOOST_FIXTURE_TEST_SUITE(BaudrateAM, BaseFTDIFixture) -BOOST_AUTO_TEST_CASE(Simple) +/// Helper class to store the convert_baudrate_UT_export result +struct calc_result { + int actual_baudrate; + unsigned short expected_value; + unsigned short expected_index; + + calc_result(int actual, int my_value, int my_index) + : actual_baudrate(actual) + , expected_value(my_value) + , expected_index(my_index) + { + } + + calc_result() + : actual_baudrate(0) + , expected_value(0) + , expected_index(0) + { + } +}; + +/** + * @brief Test convert_baudrate code against a list of baud rates + * + * @param baudrates Baudrates to check + **/ +static void test_baudrates(ftdi_context *ftdi, const map &baudrates) +{ + typedef std::pair baudrate_type; + BOOST_FOREACH(const baudrate_type &baudrate, baudrates) + { + unsigned short calc_value = 0, calc_index = 0; + int calc_baudrate = convert_baudrate_UT_export(baudrate.first, ftdi, &calc_value, &calc_index); + + const calc_result *res = &baudrate.second; + + // Aid debugging since this test is a generic function + BOOST_CHECK_MESSAGE(res->actual_baudrate == calc_baudrate && res->expected_value == calc_value && res->expected_index == calc_index, + " baudrate calculation failed for --" << baudrate.first << " baud--. Details below: "); + + BOOST_CHECK_EQUAL(res->actual_baudrate, calc_baudrate); + BOOST_CHECK_EQUAL(res->expected_value, calc_value); + BOOST_CHECK_EQUAL(res->expected_index, calc_index); + } +} + +BOOST_AUTO_TEST_CASE(TypeAMFixedBaudrates) +{ + ftdi->type = TYPE_AM; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 0); + baudrates[600] = calc_result(600, 5000, 0); + baudrates[600] = calc_result(600, 5000, 0); + baudrates[1200] = calc_result(1200, 2500, 0); + baudrates[2400] = calc_result(2400, 1250, 0); + baudrates[4800] = calc_result(4800, 625, 0); + baudrates[9600] = calc_result(9600, 16696, 0); + baudrates[19200] = calc_result(19200, 32924, 0); + baudrates[38400] = calc_result(38400, 49230, 0); + baudrates[57600] = calc_result(57554, 49204, 0); + baudrates[115200] = calc_result(115385, 26, 0); + baudrates[230400] = calc_result(230769, 13, 0); + baudrates[460800] = calc_result(461538, 16390, 0); + baudrates[921600] = calc_result(923077, 32771, 0); + + test_baudrates(ftdi, baudrates); +} + +BOOST_AUTO_TEST_CASE(TypeBMFixedBaudrates) +{ + ftdi->type = TYPE_BM; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 0); + baudrates[600] = calc_result(600, 5000, 0); + baudrates[600] = calc_result(600, 5000, 0); + baudrates[1200] = calc_result(1200, 2500, 0); + baudrates[2400] = calc_result(2400, 1250, 0); + baudrates[4800] = calc_result(4800, 625, 0); + baudrates[9600] = calc_result(9600, 16696, 0); + baudrates[19200] = calc_result(19200, 32924, 0); + baudrates[38400] = calc_result(38400, 49230, 0); + baudrates[57600] = calc_result(57554, 49204, 0); + baudrates[115200] = calc_result(115385, 26, 0); + baudrates[230400] = calc_result(230769, 13, 0); + baudrates[460800] = calc_result(461538, 16390, 0); + baudrates[921600] = calc_result(923077, 32771, 0); + + test_baudrates(ftdi, baudrates); +} + +BOOST_AUTO_TEST_CASE(Type2232CFixedBaudrates) +{ + ftdi->type = TYPE_2232C; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[1200] = calc_result(1200, 2500, 1); + baudrates[2400] = calc_result(2400, 1250, 1); + baudrates[4800] = calc_result(4800, 625, 1); + baudrates[9600] = calc_result(9600, 16696, 1); + baudrates[19200] = calc_result(19200, 32924, 1); + baudrates[38400] = calc_result(38400, 49230, 1); + baudrates[57600] = calc_result(57554, 49204, 1); + baudrates[115200] = calc_result(115385, 26, 1); + baudrates[230400] = calc_result(230769, 13, 1); + baudrates[460800] = calc_result(461538, 16390, 1); + baudrates[921600] = calc_result(923077, 32771, 1); + + test_baudrates(ftdi, baudrates); +} + +BOOST_AUTO_TEST_CASE(TypeRFixedBaudrates) +{ + ftdi->type = TYPE_R; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 0); + baudrates[600] = calc_result(600, 5000, 0); + baudrates[600] = calc_result(600, 5000, 0); + baudrates[1200] = calc_result(1200, 2500, 0); + baudrates[2400] = calc_result(2400, 1250, 0); + baudrates[4800] = calc_result(4800, 625, 0); + baudrates[9600] = calc_result(9600, 16696, 0); + baudrates[19200] = calc_result(19200, 32924, 0); + baudrates[38400] = calc_result(38400, 49230, 0); + baudrates[57600] = calc_result(57554, 49204, 0); + baudrates[115200] = calc_result(115385, 26, 0); + baudrates[230400] = calc_result(230769, 13, 0); + baudrates[460800] = calc_result(461538, 16390, 0); + baudrates[921600] = calc_result(923077, 32771, 0); + + test_baudrates(ftdi, baudrates); +} + +BOOST_AUTO_TEST_CASE(Type2232HFixedBaudrates) +{ + ftdi->type = TYPE_2232H; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[1200] = calc_result(1200, 2500, 1); + baudrates[2400] = calc_result(2400, 1250, 1); + baudrates[4800] = calc_result(4800, 625, 1); + baudrates[9600] = calc_result(9600, 16696, 1); + baudrates[19200] = calc_result(19200, 32924, 1); + baudrates[38400] = calc_result(38400, 49230, 1); + baudrates[57600] = calc_result(57554, 49204, 1); + baudrates[115200] = calc_result(115385, 26, 1); + baudrates[230400] = calc_result(230769, 13, 1); + baudrates[460800] = calc_result(461538, 16390, 1); + baudrates[921600] = calc_result(923077, 32771, 1); + + test_baudrates(ftdi, baudrates); +} + +BOOST_AUTO_TEST_CASE(Type4232HFixedBaudrates) +{ + ftdi->type = TYPE_4232H; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[1200] = calc_result(1200, 2500, 1); + baudrates[2400] = calc_result(2400, 1250, 1); + baudrates[4800] = calc_result(4800, 625, 1); + baudrates[9600] = calc_result(9600, 16696, 1); + baudrates[19200] = calc_result(19200, 32924, 1); + baudrates[38400] = calc_result(38400, 49230, 1); + baudrates[57600] = calc_result(57554, 49204, 1); + baudrates[115200] = calc_result(115385, 26, 1); + baudrates[230400] = calc_result(230769, 13, 1); + baudrates[460800] = calc_result(461538, 16390, 1); + baudrates[921600] = calc_result(923077, 32771, 1); + + test_baudrates(ftdi, baudrates); +} + +BOOST_AUTO_TEST_CASE(Type232HFixedBaudrates) +{ + ftdi->type = TYPE_232H; + + map baudrates; + baudrates[300] = calc_result(300, 10000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[600] = calc_result(600, 5000, 1); + baudrates[1200] = calc_result(1200, 2500, 1); + baudrates[2400] = calc_result(2400, 1250, 1); + baudrates[4800] = calc_result(4800, 625, 1); + baudrates[9600] = calc_result(9600, 16696, 1); + baudrates[19200] = calc_result(19200, 32924, 1); + baudrates[38400] = calc_result(38400, 49230, 1); + baudrates[57600] = calc_result(57554, 49204, 1); + baudrates[115200] = calc_result(115385, 26, 1); + baudrates[230400] = calc_result(230769, 13, 1); + baudrates[460800] = calc_result(461538, 16390, 1); + baudrates[921600] = calc_result(923077, 32771, 1); + + test_baudrates(ftdi, baudrates); } BOOST_AUTO_TEST_SUITE_END() -- 1.7.1