Update baudrate unit test to show divisor/fractional bits/clock (suggested by Uwe)

[libftdi] / test / baudrate.cpp

diff --git a/test/baudrate.cpp b/test/baudrate.cpp
index 163950b..614b2fb 100644 (file)
--- a/test/baudrate.cpp
+++ b/test/baudrate.cpp
@@ -12,13 +12,248 @@
  *                                                                         *
  ***************************************************************************/
 
+#include <ftdi.h>
+
 #define BOOST_TEST_DYN_LINK
 #include <boost/test/unit_test.hpp>
+#include <boost/foreach.hpp>
+#include <map>
+
+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_FIXTURE_TEST_SUITE(Baudrate, BaseFTDIFixture)
+
+/// Helper class to store the convert_baudrate_UT_export result
+struct calc_result
+{
+    int actual_baudrate;
+    unsigned short divisor;
+    unsigned short fractional_bits;
+    unsigned short clock;
+
+    calc_result(int actual, unsigned short my_divisor, unsigned short my_fractional_bits, unsigned short my_clock)
+        : actual_baudrate(actual)
+        , divisor(my_divisor)
+        , fractional_bits(my_fractional_bits)
+        , clock(my_clock)
+    {
+    }
+
+    calc_result()
+        : actual_baudrate(0)
+        , divisor(0)
+        , fractional_bits(0)
+        , clock(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<int, calc_result> &baudrates)
+{
+    typedef std::pair<int, calc_result> 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;
+
+        unsigned short divisor = calc_value & 0x3ff;
+        unsigned short fractional_bits = (calc_index & 0x100) ? 4 : (calc_value >> 12);
+        unsigned short clock = (calc_index & 0x100) ? 120 : 48;
+
+        // Aid debugging since this test is a generic function
+        BOOST_CHECK_MESSAGE(res->actual_baudrate == calc_baudrate && res->divisor == divisor && res->fractional_bits == fractional_bits
+                            && res->clock == clock,
+                            "\n\nERROR: baudrate calculation failed for --" << baudrate.first << " baud--. Details below: ");
+
+        BOOST_CHECK_EQUAL(res->actual_baudrate, calc_baudrate);
+        BOOST_CHECK_EQUAL(res->divisor, divisor);
+        BOOST_CHECK_EQUAL(res->fractional_bits, fractional_bits);
+        BOOST_CHECK_EQUAL(res->clock, clock);
+    }
+}
+
+BOOST_AUTO_TEST_CASE(TypeAMFixedBaudrates)
+{
+    ftdi->type = TYPE_AM;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
+
+    test_baudrates(ftdi, baudrates);
+}
+
+BOOST_AUTO_TEST_CASE(TypeBMFixedBaudrates)
+{
+    ftdi->type = TYPE_BM;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
+
+    test_baudrates(ftdi, baudrates);
+}
+
+BOOST_AUTO_TEST_CASE(Type2232CFixedBaudrates)
+{
+    ftdi->type = TYPE_2232C;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
 
-BOOST_AUTO_TEST_SUITE(Baudrate)
+    test_baudrates(ftdi, baudrates);
+}
+
+BOOST_AUTO_TEST_CASE(TypeRFixedBaudrates)
+{
+    ftdi->type = TYPE_R;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
+
+    test_baudrates(ftdi, baudrates);
+}
 
-BOOST_AUTO_TEST_CASE(Simple)
+BOOST_AUTO_TEST_CASE(Type2232HFixedBaudrates)
 {
+    ftdi->type = TYPE_2232H;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
+
+    test_baudrates(ftdi, baudrates);
+}
+
+BOOST_AUTO_TEST_CASE(Type4232HFixedBaudrates)
+{
+    ftdi->type = TYPE_4232H;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
+
+    test_baudrates(ftdi, baudrates);
+}
+
+BOOST_AUTO_TEST_CASE(Type232HFixedBaudrates)
+{
+    ftdi->type = TYPE_232H;
+
+    map<int, calc_result> baudrates;
+    baudrates[300] = calc_result(300, 784, 2, 48);
+    baudrates[600] = calc_result(600, 904, 1, 48);
+    baudrates[1200] = calc_result(1200, 452, 0, 48);
+    baudrates[2400] = calc_result(2400, 226, 0, 48);
+    baudrates[4800] = calc_result(4800, 625, 0, 48);
+    baudrates[9600] = calc_result(9600, 312, 4, 48);
+    baudrates[19200] = calc_result(19200, 156, 8, 48);
+    baudrates[38400] = calc_result(38400, 78, 12, 48);
+    baudrates[57600] = calc_result(57554, 52, 12, 48);
+    baudrates[115200] = calc_result(115385, 26, 0, 48);
+    baudrates[230400] = calc_result(230769, 13, 0, 48);
+    baudrates[460800] = calc_result(461538, 6, 4, 48);
+    baudrates[921600] = calc_result(923077, 3, 8, 48);
+
+    test_baudrates(ftdi, baudrates);
 }
 
 BOOST_AUTO_TEST_SUITE_END()