From 3980701e33854ca5f68e1363e047104010f14afe Mon Sep 17 00:00:00 2001 From: Uwe Vogt Date: Sun, 12 May 2024 13:15:57 +0200 Subject: [PATCH 01/12] Set version numbers for development Relates to [CANAPI-89] --- Sources/Version.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/Version.h b/Sources/Version.h index d086c01..b812694 100644 --- a/Sources/Version.h +++ b/Sources/Version.h @@ -52,7 +52,7 @@ #ifdef _MSC_VER #define VERSION_MAJOR 0 #define VERSION_MINOR 5 -#define VERSION_PATCH 1 +#define VERSION_PATCH 99 #else #define VERSION_MAJOR 0 #define VERSION_MINOR 2 From d4ff83d298882669021bdd9a3ccf8e52ded0cea6 Mon Sep 17 00:00:00 2001 From: Uwe Vogt Date: Sun, 12 May 2024 19:03:46 +0200 Subject: [PATCH 02/12] Loosen the upper size limit for property values Relates to [CANAPI-90] --- Sources/Wrapper/can_api.c | 52 +++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/Sources/Wrapper/can_api.c b/Sources/Wrapper/can_api.c index 3d57974..18a66fb 100644 --- a/Sources/Wrapper/can_api.c +++ b/Sources/Wrapper/can_api.c @@ -1357,26 +1357,26 @@ static int lib_parameter(uint16_t param, void *value, size_t nbyte) rc = CANERR_NOERROR; } break; - case CANPROP_GET_LIBRARY_VENDOR: // vendor name of the library (char[256]) - if ((nbyte > strlen(CAN_API_VENDOR)) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_LIBRARY_VENDOR: // vendor name of the library (char[]) + if (nbyte > strlen(CAN_API_VENDOR)) { strcpy((char*)value, CAN_API_VENDOR); rc = CANERR_NOERROR; } break; - case CANPROP_GET_LIBRARY_DLLNAME: // file name of the library (char[256]) - if ((nbyte > strlen(LIB_DLLNAME)) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_LIBRARY_DLLNAME: // file name of the library (char[]) + if (nbyte > strlen(LIB_DLLNAME)) { strcpy((char*)value, LIB_DLLNAME); rc = CANERR_NOERROR; } break; - case CANPROP_GET_DEVICE_VENDOR: // vendor name of the CAN interface (char[256]) - if ((nbyte > strlen(DEV_VENDOR)) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_DEVICE_VENDOR: // vendor name of the CAN interface (char[]) + if (nbyte > strlen(DEV_VENDOR)) { strcpy((char*)value, DEV_VENDOR); rc = CANERR_NOERROR; } break; - case CANPROP_GET_DEVICE_DLLNAME: // file name of the CAN interface DLL (char[256]) - if ((nbyte > strlen(DEV_DLLNAME)) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_DEVICE_DLLNAME: // file name of the CAN interface DLL (char[]) + if (nbyte > strlen(DEV_DLLNAME)) { strcpy((char*)value, DEV_DLLNAME); rc = CANERR_NOERROR; } @@ -1405,8 +1405,8 @@ static int lib_parameter(uint16_t param, void *value, size_t nbyte) rc = CANERR_RESOURCE; } break; - case CANPROP_GET_CHANNEL_NAME: // get channel name at actual index in the interface list (char[256]) - if ((0U < nbyte) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_CHANNEL_NAME: // get channel name at actual index in the interface list (char[]) + if (nbyte >= 1U) { if ((0 <= idx_board) && (idx_board < NUM_CHANNELS) && (can_boards[idx_board].type != EOF)) { strncpy((char*)value, can_boards[idx_board].name, nbyte); @@ -1417,8 +1417,8 @@ static int lib_parameter(uint16_t param, void *value, size_t nbyte) rc = CANERR_RESOURCE; } break; - case CANPROP_GET_CHANNEL_DLLNAME: // get file name of the DLL at actual index in the interface list (char[256]) - if ((0U < nbyte) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_CHANNEL_DLLNAME: // get file name of the DLL at actual index in the interface list (char[]) + if (nbyte >= 1U) { if ((0 <= idx_board) && (idx_board < NUM_CHANNELS) && (can_boards[idx_board].type != EOF)) { strncpy((char*)value, DEV_DLLNAME, nbyte); @@ -1440,8 +1440,8 @@ static int lib_parameter(uint16_t param, void *value, size_t nbyte) rc = CANERR_RESOURCE; } break; - case CANPROP_GET_CHANNEL_VENDOR_NAME: // get vendor name at actual index in the interface list (char[256]) - if ((0U < nbyte) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_CHANNEL_VENDOR_NAME: // get vendor name at actual index in the interface list (char[]) + if (nbyte >= 1U) { if ((0 <= idx_board) && (idx_board < NUM_CHANNELS) && (can_boards[idx_board].type != EOF)) { strncpy((char*)value, DEV_VENDOR, nbyte); @@ -1453,7 +1453,7 @@ static int lib_parameter(uint16_t param, void *value, size_t nbyte) } break; case CANPROP_GET_DEVICE_TYPE: // device type of the CAN interface (int32_t) - case CANPROP_GET_DEVICE_NAME: // device name of the CAN interface (char[256]) + case CANPROP_GET_DEVICE_NAME: // device name of the CAN interface (char[]) case CANPROP_GET_OP_CAPABILITY: // supported operation modes of the CAN controller (uint8_t) case CANPROP_GET_OP_MODE: // active operation mode of the CAN controller (uint8_t) case CANPROP_GET_BITRATE: // active bit-rate of the CAN controller (can_bitrate_t) @@ -1531,8 +1531,8 @@ static int drv_parameter(int handle, uint16_t param, void *value, size_t nbyte) rc = CANERR_NOERROR; } break; - case CANPROP_GET_DEVICE_NAME: // device name of the CAN interface (char[256]) - if ((nbyte >= MAX_LENGTH_HARDWARE_NAME) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_DEVICE_NAME: // device name of the CAN interface (char[]) + if (nbyte >= MAX_LENGTH_HARDWARE_NAME) { if ((sts = CAN_GetValue(can[handle].board, (BYTE)PCAN_HARDWARE_NAME, (void*)value, (DWORD)MAX_LENGTH_HARDWARE_NAME)) == PCAN_ERROR_OK) rc = CANERR_NOERROR; @@ -1540,23 +1540,23 @@ static int drv_parameter(int handle, uint16_t param, void *value, size_t nbyte) rc = pcan_error(sts); } break; - case CANPROP_GET_DEVICE_VENDOR: // vendor name of the CAN interface (char[256]) - if ((nbyte > strlen(DEV_VENDOR)) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_DEVICE_VENDOR: // vendor name of the CAN interface (char[]) + if (nbyte > strlen(DEV_VENDOR)) { strcpy((char*)value, DEV_VENDOR); rc = CANERR_NOERROR; } break; - case CANPROP_GET_DEVICE_DLLNAME: // file name of the CAN interface DLL (char[256]) - if ((nbyte > strlen(DEV_DLLNAME)) && (nbyte <= CANPROP_MAX_BUFFER_SIZE)) { + case CANPROP_GET_DEVICE_DLLNAME: // file name of the CAN interface DLL (char[]) + if (nbyte > strlen(DEV_DLLNAME)) { strcpy((char*)value, DEV_DLLNAME); rc = CANERR_NOERROR; } break; - case CANPROP_GET_DEVICE_PARAM: // device parameter of the CAN interface (char[256]) - if (nbyte >= sizeof(struct _pcan_param)) { - ((struct _pcan_param*)value)->type = (uint8_t)can[handle].brd_type; - ((struct _pcan_param*)value)->port = (uint32_t)can[handle].brd_port; - ((struct _pcan_param*)value)->irq = (uint16_t)can[handle].brd_irq; + case CANPROP_GET_DEVICE_PARAM: // device parameter of the CAN interface (can_pcan_param_t) + if (nbyte >= sizeof(can_pcan_param_t)) { + ((can_pcan_param_t*)value)->type = (uint8_t)can[handle].brd_type; + ((can_pcan_param_t*)value)->port = (uint32_t)can[handle].brd_port; + ((can_pcan_param_t*)value)->irq = (uint16_t)can[handle].brd_irq; rc = CANERR_NOERROR; } break; From 8441f73bc977782e281e6c3da5000eeb85ef5632 Mon Sep 17 00:00:00 2001 From: Uwe Vogt Date: Sun, 19 May 2024 15:26:29 +0200 Subject: [PATCH 03/12] Update CAN API V3 Testing sources to rev. 1300 Relates to [CANAPI-90] - excludes TC09.8, TC09.9 and TC09.10 from quick-run - introduces compiler switch `OPTION_REGRESSION_TEST` --- Tests/Driver.h | 4 ++++ Tests/README.md | 2 +- Tests/Sources/Options.cpp | 5 ++++- Tests/Testcases/TC09_GetStatus.cc | 29 ++++++++++++++++++++++++----- Tests/Version.h | 6 +++--- 5 files changed, 36 insertions(+), 10 deletions(-) diff --git a/Tests/Driver.h b/Tests/Driver.h index ea3ff2c..50c29c4 100644 --- a/Tests/Driver.h +++ b/Tests/Driver.h @@ -104,7 +104,9 @@ typedef CPeakCAN CCanDriver; #endif // (§6) define macros for workarounds (e.g. TC01_3_ISSUE) +#if (OPTION_REGRESSION_TEST == 0) #define TC09_8_ISSUE_BUS_OFF WORKAROUND_ENABLED // 2023-08-25: no bus off from device (investigation required) +#endif // (§6.1) old PCANBasic issues (see macros in 'Settings.h') #define PCBUSB_INIT_DELAY_WORKAROUND WORKAROUND_ENABLED #define PCBUSB_QXMTFULL_WORKAROUND WORKAROUND_ENABLED @@ -148,7 +150,9 @@ typedef CPeakCAN CCanDriver; #endif // (§11) define macros for workarounds for CAN FD operation mode (e.g. TC01_3_ISSUE_FD) +#if (OPTION_REGRESSION_TEST == 0) //#define TC0x_y_ISSUE_FD_ WORKAROUND_ENABLED +#endif // (§12) define macros for CAN FD bit-rate settings to be used in the tests, if supported #define CAN_BITRATE_FD_DEFAULT BITRATE_FD_250K2M diff --git a/Tests/README.md b/Tests/README.md index f2f6dfe..9ca5643 100644 --- a/Tests/README.md +++ b/Tests/README.md @@ -3,7 +3,7 @@ _Copyright © 2004-2024 Uwe Vogt, UV Software, Berlin (info@uv-software.com)_ \ _All rights reserved._ -Version $Rev: 1273 $ +Version $Rev: 1300 $ # CAN Interface Wrapper Specification diff --git a/Tests/Sources/Options.cpp b/Tests/Sources/Options.cpp index 1ca26f1..aa2be46 100644 --- a/Tests/Sources/Options.cpp +++ b/Tests/Sources/Options.cpp @@ -55,6 +55,9 @@ #include #include +#if (DUT1 != 0) || (DUT2 != 1) +#error Definition of DUT1 or DUT2 wrong +#endif #define OPTION_HELP "--can_help" #define OPTION_PATH "--can_path" #define OPTION_DUT1 "--can_dut1" @@ -716,4 +719,4 @@ int COptions::ShowHelp() { return m_fShowHelp; } -// $Id: Options.cpp 1272 2024-04-16 19:55:27Z makemake $ Copyright (c) UV Software, Berlin // +// $Id: Options.cpp 1299 2024-05-19 12:27:49Z makemake $ Copyright (c) UV Software, Berlin // diff --git a/Tests/Testcases/TC09_GetStatus.cc b/Tests/Testcases/TC09_GetStatus.cc index de61569..6e74f82 100644 --- a/Tests/Testcases/TC09_GetStatus.cc +++ b/Tests/Testcases/TC09_GetStatus.cc @@ -388,7 +388,12 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfChannelTornDown, GTEST_ENABLED)) { // // @expected: CANERR_NOERROR but status bit 'bus_off' is set // -TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_ENABLED)) { +#if !defined(__APPLE__) || defined(__MAC_11_0) +#define GTEST_TC09_8_ENABLED GTEST_ENABLED +#else +#define GTEST_TC09_8_ENABLED GTEST_DISABLED +#endif +TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_TC09_8_ENABLED)) { CCanDevice dut1 = CCanDevice(TEST_DEVICE(DUT1)); CCanDevice dut2 = CCanDevice(TEST_DEVICE(DUT2)); CANAPI_Bitrate_t newBtr1 = {}, oldBtr1 = {}; @@ -411,10 +416,13 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_ENABLED)) { trmMsg.dlc = 0; memset(trmMsg.data, 0, CANFD_MAX_LEN); #endif + // @ + // @note: This test can be very fragile + if (g_Options.RunQuick()) + GTEST_SKIP() << "This test can be very fragile!"; #if (TC09_8_ISSUE_BUS_OFF == WORKAROUND_ENABLED) ASSERT_TRUE(false) << "[ TC09.8 ] No bus-off state from device!"; #endif - // @ // @note: This test cannot run if there is another device on bus! if (g_Options.Is3rdDevicePresent()) GTEST_SKIP() << "This test cannot run if there is another device on bus!"; @@ -545,7 +553,12 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_ENABLED)) { // // @expected: CANERR_NOERROR but status bit 'warning_level' is set // -TEST_F(GetStatus, GTEST_TESTCASE(IfWarningLevelReached, GTEST_ENABLED)) { +#if !defined(__APPLE__) || defined(__MAC_11_0) +#define GTEST_TC09_9_ENABLED GTEST_ENABLED +#else +#define GTEST_TC09_9_ENABLED GTEST_DISABLED +#endif +TEST_F(GetStatus, GTEST_TESTCASE(IfWarningLevelReached, GTEST_TC09_9_ENABLED)) { CCanDevice dut1 = CCanDevice(TEST_DEVICE(DUT1)); CCanDevice dut2 = CCanDevice(TEST_DEVICE(DUT2)); CANAPI_Bitrate_t newBtr1 = {}, oldBtr1 = {}; @@ -568,10 +581,13 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfWarningLevelReached, GTEST_ENABLED)) { trmMsg.dlc = 0; memset(trmMsg.data, 0, CANFD_MAX_LEN); #endif + // @ + // @note: This test can be very fragile + if (g_Options.RunQuick()) + GTEST_SKIP() << "This test can be very fragile!"; #if (TC09_9_ISSUE_PCBUSB_WARNING_LEVEL == WORKAROUND_ENABLED) ASSERT_TRUE(false) << "[ TC09.9 ] No warning level from device!"; #endif - // @ // @note: This test cannot run if there is another device on bus! if (g_Options.Is3rdDevicePresent()) GTEST_SKIP() << "This test cannot run if there is another device on bus!"; @@ -728,6 +744,9 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfErrorsOnBus, GTEST_TC09_10_ENABLED)) { memset(trmMsg.data, 0, CANFD_MAX_LEN); #endif // @ + // @note: This test can be very fragile + if (g_Options.RunQuick()) + GTEST_SKIP() << "This test can be very fragile!"; // @note: This test cannot run if there is another device on bus! if (g_Options.Is3rdDevicePresent()) GTEST_SKIP() << "This test cannot run if there is another device on bus!"; @@ -1318,4 +1337,4 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfReceiveQueueFull, GTEST_TC09_14_ENABLED)) { // @end. } -// $Id: TC09_GetStatus.cc 1272 2024-04-16 19:55:27Z makemake $ Copyright (c) UV Software, Berlin. +// $Id: TC09_GetStatus.cc 1300 2024-05-19 13:14:53Z quaoar $ Copyright (c) UV Software, Berlin. diff --git a/Tests/Version.h b/Tests/Version.h index 72b1cb7..46b18a1 100644 --- a/Tests/Version.h +++ b/Tests/Version.h @@ -47,8 +47,8 @@ // #ifndef VERSION_H_INCLUDED #define VERSION_H_INCLUDED -// SVN revision number (update with each commit: XI) -#define REVISION_NO "$Rev: 1273 $" +// SVN revision number (update with each commit: XIII) +#define REVISION_NO "$Rev: 1300 $" #endif // VERSION_H_INCLUDED -// $Id: Version.h 1273 2024-04-18 16:59:22Z makemake $ Copyright (c) UV Software, Berlin // +// $Id: Version.h 1300 2024-05-19 13:14:53Z quaoar $ Copyright (c) UV Software, Berlin // From da38f35eafb0acae2f3b2604092610f1d0bc93d4 Mon Sep 17 00:00:00 2001 From: Uwe Vogt Date: Sun, 19 May 2024 15:26:29 +0200 Subject: [PATCH 04/12] Update CAN API V3 Testing sources to rev. 1300 Relates to [CANAPI-90] - excludes TC09.8, TC09.9 and TC09.10 from quick-run - introduces compiler switch `OPTION_REGRESSION_TEST` --- Tests/Driver.h | 4 ++++ Tests/README.md | 2 +- Tests/Sources/Options.cpp | 5 ++++- Tests/Testcases/TC09_GetStatus.cc | 29 ++++++++++++++++++++++++----- Tests/Version.h | 6 +++--- 5 files changed, 36 insertions(+), 10 deletions(-) diff --git a/Tests/Driver.h b/Tests/Driver.h index ea3ff2c..50c29c4 100644 --- a/Tests/Driver.h +++ b/Tests/Driver.h @@ -104,7 +104,9 @@ typedef CPeakCAN CCanDriver; #endif // (§6) define macros for workarounds (e.g. TC01_3_ISSUE) +#if (OPTION_REGRESSION_TEST == 0) #define TC09_8_ISSUE_BUS_OFF WORKAROUND_ENABLED // 2023-08-25: no bus off from device (investigation required) +#endif // (§6.1) old PCANBasic issues (see macros in 'Settings.h') #define PCBUSB_INIT_DELAY_WORKAROUND WORKAROUND_ENABLED #define PCBUSB_QXMTFULL_WORKAROUND WORKAROUND_ENABLED @@ -148,7 +150,9 @@ typedef CPeakCAN CCanDriver; #endif // (§11) define macros for workarounds for CAN FD operation mode (e.g. TC01_3_ISSUE_FD) +#if (OPTION_REGRESSION_TEST == 0) //#define TC0x_y_ISSUE_FD_ WORKAROUND_ENABLED +#endif // (§12) define macros for CAN FD bit-rate settings to be used in the tests, if supported #define CAN_BITRATE_FD_DEFAULT BITRATE_FD_250K2M diff --git a/Tests/README.md b/Tests/README.md index f2f6dfe..9ca5643 100644 --- a/Tests/README.md +++ b/Tests/README.md @@ -3,7 +3,7 @@ _Copyright © 2004-2024 Uwe Vogt, UV Software, Berlin (info@uv-software.com)_ \ _All rights reserved._ -Version $Rev: 1273 $ +Version $Rev: 1300 $ # CAN Interface Wrapper Specification diff --git a/Tests/Sources/Options.cpp b/Tests/Sources/Options.cpp index 1ca26f1..aa2be46 100644 --- a/Tests/Sources/Options.cpp +++ b/Tests/Sources/Options.cpp @@ -55,6 +55,9 @@ #include #include +#if (DUT1 != 0) || (DUT2 != 1) +#error Definition of DUT1 or DUT2 wrong +#endif #define OPTION_HELP "--can_help" #define OPTION_PATH "--can_path" #define OPTION_DUT1 "--can_dut1" @@ -716,4 +719,4 @@ int COptions::ShowHelp() { return m_fShowHelp; } -// $Id: Options.cpp 1272 2024-04-16 19:55:27Z makemake $ Copyright (c) UV Software, Berlin // +// $Id: Options.cpp 1299 2024-05-19 12:27:49Z makemake $ Copyright (c) UV Software, Berlin // diff --git a/Tests/Testcases/TC09_GetStatus.cc b/Tests/Testcases/TC09_GetStatus.cc index de61569..6e74f82 100644 --- a/Tests/Testcases/TC09_GetStatus.cc +++ b/Tests/Testcases/TC09_GetStatus.cc @@ -388,7 +388,12 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfChannelTornDown, GTEST_ENABLED)) { // // @expected: CANERR_NOERROR but status bit 'bus_off' is set // -TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_ENABLED)) { +#if !defined(__APPLE__) || defined(__MAC_11_0) +#define GTEST_TC09_8_ENABLED GTEST_ENABLED +#else +#define GTEST_TC09_8_ENABLED GTEST_DISABLED +#endif +TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_TC09_8_ENABLED)) { CCanDevice dut1 = CCanDevice(TEST_DEVICE(DUT1)); CCanDevice dut2 = CCanDevice(TEST_DEVICE(DUT2)); CANAPI_Bitrate_t newBtr1 = {}, oldBtr1 = {}; @@ -411,10 +416,13 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_ENABLED)) { trmMsg.dlc = 0; memset(trmMsg.data, 0, CANFD_MAX_LEN); #endif + // @ + // @note: This test can be very fragile + if (g_Options.RunQuick()) + GTEST_SKIP() << "This test can be very fragile!"; #if (TC09_8_ISSUE_BUS_OFF == WORKAROUND_ENABLED) ASSERT_TRUE(false) << "[ TC09.8 ] No bus-off state from device!"; #endif - // @ // @note: This test cannot run if there is another device on bus! if (g_Options.Is3rdDevicePresent()) GTEST_SKIP() << "This test cannot run if there is another device on bus!"; @@ -545,7 +553,12 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfInBusOffState, GTEST_ENABLED)) { // // @expected: CANERR_NOERROR but status bit 'warning_level' is set // -TEST_F(GetStatus, GTEST_TESTCASE(IfWarningLevelReached, GTEST_ENABLED)) { +#if !defined(__APPLE__) || defined(__MAC_11_0) +#define GTEST_TC09_9_ENABLED GTEST_ENABLED +#else +#define GTEST_TC09_9_ENABLED GTEST_DISABLED +#endif +TEST_F(GetStatus, GTEST_TESTCASE(IfWarningLevelReached, GTEST_TC09_9_ENABLED)) { CCanDevice dut1 = CCanDevice(TEST_DEVICE(DUT1)); CCanDevice dut2 = CCanDevice(TEST_DEVICE(DUT2)); CANAPI_Bitrate_t newBtr1 = {}, oldBtr1 = {}; @@ -568,10 +581,13 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfWarningLevelReached, GTEST_ENABLED)) { trmMsg.dlc = 0; memset(trmMsg.data, 0, CANFD_MAX_LEN); #endif + // @ + // @note: This test can be very fragile + if (g_Options.RunQuick()) + GTEST_SKIP() << "This test can be very fragile!"; #if (TC09_9_ISSUE_PCBUSB_WARNING_LEVEL == WORKAROUND_ENABLED) ASSERT_TRUE(false) << "[ TC09.9 ] No warning level from device!"; #endif - // @ // @note: This test cannot run if there is another device on bus! if (g_Options.Is3rdDevicePresent()) GTEST_SKIP() << "This test cannot run if there is another device on bus!"; @@ -728,6 +744,9 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfErrorsOnBus, GTEST_TC09_10_ENABLED)) { memset(trmMsg.data, 0, CANFD_MAX_LEN); #endif // @ + // @note: This test can be very fragile + if (g_Options.RunQuick()) + GTEST_SKIP() << "This test can be very fragile!"; // @note: This test cannot run if there is another device on bus! if (g_Options.Is3rdDevicePresent()) GTEST_SKIP() << "This test cannot run if there is another device on bus!"; @@ -1318,4 +1337,4 @@ TEST_F(GetStatus, GTEST_TESTCASE(IfReceiveQueueFull, GTEST_TC09_14_ENABLED)) { // @end. } -// $Id: TC09_GetStatus.cc 1272 2024-04-16 19:55:27Z makemake $ Copyright (c) UV Software, Berlin. +// $Id: TC09_GetStatus.cc 1300 2024-05-19 13:14:53Z quaoar $ Copyright (c) UV Software, Berlin. diff --git a/Tests/Version.h b/Tests/Version.h index 72b1cb7..46b18a1 100644 --- a/Tests/Version.h +++ b/Tests/Version.h @@ -47,8 +47,8 @@ // #ifndef VERSION_H_INCLUDED #define VERSION_H_INCLUDED -// SVN revision number (update with each commit: XI) -#define REVISION_NO "$Rev: 1273 $" +// SVN revision number (update with each commit: XIII) +#define REVISION_NO "$Rev: 1300 $" #endif // VERSION_H_INCLUDED -// $Id: Version.h 1273 2024-04-18 16:59:22Z makemake $ Copyright (c) UV Software, Berlin // +// $Id: Version.h 1300 2024-05-19 13:14:53Z quaoar $ Copyright (c) UV Software, Berlin // From 611e01e2dfad2b83557def1d3f5191537891b3e0 Mon Sep 17 00:00:00 2001 From: Uwe Vogt Date: Mon, 20 May 2024 17:35:59 +0200 Subject: [PATCH 05/12] Integrate generic CAN API V3 Utilities Relates to [CANAPI-91] - CAN API V3 Utilities from svn rev. 1304 --- Utilities/can_moni/Driver.h | 6 +- Utilities/can_moni/README.md | 9 +- Utilities/can_moni/Sources/.gitignore | 1 + Utilities/can_moni/Sources/COPYING | 674 ++++++++++ Utilities/can_moni/Sources/Options.cpp | 26 + Utilities/can_moni/Sources/Options.h | 87 ++ Utilities/can_moni/Sources/Options_p.cpp | 806 ++++++++++++ Utilities/can_moni/Sources/Options_w.cpp | 909 ++++++++++++++ Utilities/can_moni/Sources/README | 37 + Utilities/can_moni/Sources/main.cpp | 1175 +++++------------- Utilities/can_moni/can_moni.vcxproj | 2 + Utilities/can_moni/can_moni.vcxproj.filters | 6 + Utilities/can_test/Driver.h | 11 +- Utilities/can_test/README.md | 17 +- Utilities/can_test/Sources/.gitignore | 1 + Utilities/can_test/Sources/COPYING | 674 ++++++++++ Utilities/can_test/Sources/Options.cpp | 27 + Utilities/can_test/Sources/Options.h | 102 ++ Utilities/can_test/Sources/Options_p.cpp | 911 ++++++++++++++ Utilities/can_test/Sources/Options_w.cpp | 1032 ++++++++++++++++ Utilities/can_test/Sources/README | 36 + Utilities/can_test/Sources/main.cpp | 1236 ++++++------------- Utilities/can_test/can_test.vcxproj | 2 + Utilities/can_test/can_test.vcxproj.filters | 6 + 24 files changed, 6081 insertions(+), 1712 deletions(-) create mode 100644 Utilities/can_moni/Sources/.gitignore create mode 100644 Utilities/can_moni/Sources/COPYING create mode 100644 Utilities/can_moni/Sources/Options.cpp create mode 100644 Utilities/can_moni/Sources/Options.h create mode 100644 Utilities/can_moni/Sources/Options_p.cpp create mode 100644 Utilities/can_moni/Sources/Options_w.cpp create mode 100644 Utilities/can_moni/Sources/README create mode 100644 Utilities/can_test/Sources/.gitignore create mode 100644 Utilities/can_test/Sources/COPYING create mode 100644 Utilities/can_test/Sources/Options.cpp create mode 100644 Utilities/can_test/Sources/Options.h create mode 100644 Utilities/can_test/Sources/Options_p.cpp create mode 100644 Utilities/can_test/Sources/Options_w.cpp create mode 100644 Utilities/can_test/Sources/README diff --git a/Utilities/can_moni/Driver.h b/Utilities/can_moni/Driver.h index b10c0c7..37fba7a 100644 --- a/Utilities/can_moni/Driver.h +++ b/Utilities/can_moni/Driver.h @@ -27,8 +27,10 @@ #else #define CAN_FD_SUPPORTED 1 // don't touch that dial #endif -#define MONITOR_INTEFACE "Peak-System PCAN Interfaces" -#define MONITOR_COPYRIGHT "2007,2012-2024 by Uwe Vogt, UV Software, Berlin" +#define MONITOR_INTERFACE "Peak-System PCAN Interfaces" +#define MONITOR_COPYRIGHT "2007,2012-2024 by Uwe Vogt, UV Software, Berlin" +#define MONITOR_PLATFORM "Windows" +#define MONITOR_ALIASNAME "PCB:" #if (OPTION_PCAN_BIT_TIMING == 1) #define BITRATE_1M(x) PEAKCAN_BR_1M(x) diff --git a/Utilities/can_moni/README.md b/Utilities/can_moni/README.md index 0a06d36..7bcf748 100644 --- a/Utilities/can_moni/README.md +++ b/Utilities/can_moni/README.md @@ -16,16 +16,17 @@ Options: /XTD-MASK: acceptance mask for 29-bit IDs (default=0x00000000) /Mode:(2.0|FDf[+BRS]) CAN operation mode: CAN 2.0 or CAN FD mode /SHARED shared CAN controller access (if supported) - /MONitor:(No|Yes) | /LISTEN-ONLY monitor mode (listen-only, transmitter is off) + /MONitor:(No|Yes) | /LISTEN-ONLY monitor mode (listen-only mode) /ERR:(No|Yes) | /ERROR-FRAMES allow reception of error frames /RTR:(Yes|No) allow remote frames (RTR frames) /XTD:(Yes|No) allow extended frames (29-bit identifier) /BauDrate: CAN bit-timing in kbps (default=250), or - /BitRate: CAN bit-rate settings (as a string) + /BitRate: CAN bit-rate settings (as key/value list) /Verbose show detailed bit-rate settings - /LIST-BITRATES[:(2.0|FDf[+BRS])] list standard bit-rate settings + /LIST-BITRATES[:(2.0|FDf[+BRS])] list standard bit-rate settings and exit /LIST-BOARDS | /LIST list all supported CAN interfaces and exit /TEST-BOARDS | /TEST list all available CAN interfaces and exit + /JSON-file: write configuration into JSON file and exit /HELP | /? display this help screen and exit /VERSION show version information and exit Arguments: @@ -41,7 +42,7 @@ Arguments: 6 = 50 kbps 7 = 20 kbps 8 = 10 kbps - comma-separated =-list: + comma-separated key/value list: f_clock= frequency in Hz or f_clock_mhz= frequency in MHz nom_brp= bit-rate prescaler (nominal) diff --git a/Utilities/can_moni/Sources/.gitignore b/Utilities/can_moni/Sources/.gitignore new file mode 100644 index 0000000..90ec22b --- /dev/null +++ b/Utilities/can_moni/Sources/.gitignore @@ -0,0 +1 @@ +.svn diff --git a/Utilities/can_moni/Sources/COPYING b/Utilities/can_moni/Sources/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/Utilities/can_moni/Sources/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Utilities/can_moni/Sources/Options.cpp b/Utilities/can_moni/Sources/Options.cpp new file mode 100644 index 0000000..c75e1c7 --- /dev/null +++ b/Utilities/can_moni/Sources/Options.cpp @@ -0,0 +1,26 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// +// CAN Monitor for generic Interfaces (CAN API V3) +// +// Copyright (c) 2007,2012-2024 Uwe Vogt, UV Software, Berlin (info@uv-software.com) +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +#if defined(_WIN32) || defined(_WIN64) +// for Windows OS (x86 and x64) +#include "Options_w.cpp" +#else +// for POSIX OS (Linux, Darwin) +#include "Options_p.cpp" +#endif diff --git a/Utilities/can_moni/Sources/Options.h b/Utilities/can_moni/Sources/Options.h new file mode 100644 index 0000000..fdcd8b5 --- /dev/null +++ b/Utilities/can_moni/Sources/Options.h @@ -0,0 +1,87 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// +// CAN Monitor for generic Interfaces (CAN API V3) +// +// Copyright (c) 2007,2012-2024 Uwe Vogt, UV Software, Berlin (info@uv-software.com) +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +#ifndef CAN_MONI_OPTIONS_H_INCLUDED +#define CAN_MONI_OPTIONS_H_INCLUDED + +#include "Driver.h" +#include "Version.h" + +#include +#include + +#define CAN_MONI_APPLICATION "CAN Monitor for " MONITOR_INTERFACE ", Version " VERSION_STRING +#define CAN_MONI_COPYRIGHT "Copyright (c) " MONITOR_COPYRIGHT +#if !defined(_WIN32) && !defined(_WIN64) +#define CAN_MONI_WARRANTY "This program comes with ABSOLUTELY NO WARRANTY!\n\n" \ + "This is free software, and you are welcome to redistribute it\n" \ + "under certain conditions; type `--version' for details."; +#else +#define CAN_MONI_WARRANTY "This program comes with ABSOLUTELY NO WARRANTY!\n\n" \ + "This is free software, and you are welcome to redistribute it\n" \ + "under certain conditions; type '/VERSION' for details."; +#endif +#define CAN_MONI_LICENSE "This program is free software: you can redistribute it and/or modify\n" \ + "it under the terms of the GNU General Public License as published by\n" \ + "the Free Software Foundation, either version 3 of the License, or\n" \ + "(at your option) any later version.\n\n" \ + "This program is distributed in the hope that it will be useful,\n" \ + "but WITHOUT ANY WARRANTY; without even the implied warranty of\n" \ + "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" \ + "GNU General Public License for more details.\n\n" \ + "You should have received a copy of the GNU General Public License\n" \ + "along with this program. If not, see ." +#define CAN_MONI_PROGRAM "can_moni" + +struct SOptions { + // attributes + char* m_szBasename; + char* m_szInterface; +#if (OPTION_CANAPI_LIBRARY != 0) + char* m_szSearchPath; +#else + char* m_szJsonFilename; +#endif + CANAPI_OpMode_t m_OpMode; + CANAPI_Bitrate_t m_Bitrate; + CANAPI_BusSpeed_t m_BusSpeed; + bool m_bHasDataPhase; + bool m_bHasNoSamp; + struct { + uint32_t m_u32Code; + uint32_t m_u32Mask; + } m_StdFilter, m_XtdFilter; + char* m_szExcludeList; + bool m_fListBitrates; + bool m_fListBoards; + bool m_fTestBoards; + bool m_fVerbose; + bool m_fExit; + // initializer + SOptions(); + // operations + int ScanCommanline(int argc, const char* argv[], FILE* err = stderr, FILE* out = stdout); + void ShowGreetings(FILE* stream); + void ShowFarewell(FILE* stream); + void ShowVersion(FILE* stream); + void ShowHelp(FILE* stream); + void ShowUsage(FILE* stream, bool args = false); +}; + +#endif // CAN_MONI_OPTIONS_H_INCLUDED diff --git a/Utilities/can_moni/Sources/Options_p.cpp b/Utilities/can_moni/Sources/Options_p.cpp new file mode 100644 index 0000000..2d2cae0 --- /dev/null +++ b/Utilities/can_moni/Sources/Options_p.cpp @@ -0,0 +1,806 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +// +// CAN Monitor for generic Interfaces (CAN API V3) +// +// Copyright (c) 2007,2012-2024 Uwe Vogt, UV Software, Berlin (info@uv-software.com) +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . +// +#include "Options.h" +#include "Message.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +#if defined(__linux__) +#define PLATFORM "Linux" +#elif defined(__APPLE__) +#define PLATFORM "macOS" +#elif defined(__CYGWIN__) +#define PLATFORM "Cygwin" +#else +#error Platform not supported +#endif +#ifdef _MSC_VER +//not #if defined(_WIN32) || defined(_WIN64) because we have strncasecmp in mingw +#define strncasecmp _strnicmp +#define strcasecmp _stricmp +#endif +#define USE_BASENAME 1 + +#define DEFAULT_OP_MODE CANMODE_DEFAULT +#define DEFAULT_BAUDRATE CANBTR_INDEX_250K + +static const char* c_szApplication = CAN_MONI_APPLICATION; +static const char* c_szCopyright = CAN_MONI_COPYRIGHT; +static const char* c_szWarranty = CAN_MONI_WARRANTY; +static const char* c_szLicense = CAN_MONI_LICENSE; +static const char* c_szBasename = CAN_MONI_PROGRAM; +static const char* c_szInterface = "(unknown)"; +static const char* c_szExcludeList = "~0x00-0x7FF"; + +SOptions::SOptions() { + // to have default bus speed from bit-timing index + (void)CCanDriver::MapIndex2Bitrate(DEFAULT_BAUDRATE, m_Bitrate); + (void)CCanDriver::MapBitrate2Speed(m_Bitrate, m_BusSpeed); + // initialization + m_szBasename = (char*)c_szBasename; + m_szInterface = (char*)c_szInterface; +#if (OPTION_CANAPI_LIBRARY != 0) + m_szSearchPath = (char*)NULL; +#else + m_szJsonFilename = (char*)NULL; +#endif + m_OpMode.byte = DEFAULT_OP_MODE; + m_Bitrate.index = DEFAULT_BAUDRATE; + m_bHasDataPhase = false; + m_bHasNoSamp = false; + m_StdFilter.m_u32Code = CANACC_CODE_11BIT; + m_StdFilter.m_u32Mask = CANACC_MASK_11BIT; + m_XtdFilter.m_u32Code = CANACC_CODE_29BIT; + m_XtdFilter.m_u32Mask = CANACC_MASK_29BIT; + m_szExcludeList = (char*)c_szExcludeList; + m_fListBitrates = false; + m_fListBoards = false; + m_fTestBoards = false; + m_fVerbose = false; + m_fVerbose = false; + m_fExit = false; +} + +int SOptions::ScanCommanline(int argc, const char* argv[], FILE* err, FILE* out) { + int opt; + int64_t intarg; + + int optBitrate = 0; + int optVerbose = 0; + int optMode = 0; + int optShared = 0; + int optListenOnly = 0; + int optErrorFrames = 0; + int optExtendedFrames = 0; + int optRemoteFrames = 0; + int optStdCode = 0; + int optStdMask = 0; + int optXtdCode = 0; + int optXtdMask = 0; + int optFmtTime = 0; + int optFmtId = 0; + int optFmtData = 0; + int optFmtAscii = 0; + int optFmtWrap = 0; + int optExclude = 0; + int optListBitrates = 0; + int optListBoards = 0; + int optTestBoards = 0; +#if (OPTION_CANAPI_LIBRARY != 0) + int optPath = 0; +#else + int optJson = 0; +#endif + // default format options + CCanMessage::EFormatTimestamp fmtModeTime = CCanMessage::OptionZero; + CCanMessage::EFormatNumber fmtModeId = CCanMessage::OptionHex; + CCanMessage::EFormatNumber fmtModeData = CCanMessage::OptionHex; + CCanMessage::EFormatOption fmtModeAscii = CCanMessage::OptionOn; + CCanMessage::EFormatWraparound fmtWraparound = CCanMessage::OptionWraparoundNo; + (void)CCanMessage::SetTimestampFormat(fmtModeTime); + (void)CCanMessage::SetIdentifierFormat(fmtModeId); + (void)CCanMessage::SetDataFormat(fmtModeData); + (void)CCanMessage::SetAsciiFormat(fmtModeAscii); + (void)CCanMessage::SetWraparound(fmtWraparound); + + // command-line options + int show_version = 0; + struct option long_options[] = { + {"baudrate", required_argument, 0, 'b'}, + {"bitrate", required_argument, 0, 'B'}, + {"verbose", no_argument, 0, 'v'}, + {"mode", required_argument, 0, 'm'}, + {"shared", no_argument, 0, 'S'}, + {"listen-only", no_argument, 0, 'M'}, + {"error-frames", no_argument, 0, 'E'}, + {"no-remote-frames", no_argument, 0, 'R'}, + {"no-extended-frames", no_argument, 0, 'X'}, + {"code", required_argument, 0, '1'}, + {"mask", required_argument, 0, '2'}, + {"xtd-code", required_argument, 0, '3'}, + {"xtd-mask", required_argument, 0, '4'}, + {"time", required_argument, 0, 't'}, + {"id", required_argument, 0, 'i'}, + {"data", required_argument, 0, 'd'}, + {"ascii", required_argument, 0, 'a'}, + {"wrap", required_argument, 0, 'w'}, + {"wraparound", required_argument, 0, 'w'}, + {"exclude", required_argument, 0, 'x'}, + {"script", required_argument, 0, 's'}, + {"list-bitrates", optional_argument, 0, 'l'}, +#if (OPTION_CANAPI_LIBRARY != 0) + {"list-boards", optional_argument, 0, 'L'}, + {"test-boards", optional_argument, 0, 'T'}, + {"path", required_argument, 0, 'p'}, +#else + {"list-boards", no_argument, 0, 'L'}, + {"test-boards", no_argument, 0, 'T'}, + {"json", required_argument, 0, 'j'}, +#endif + {"help", no_argument, 0, 'h'}, + {"version", no_argument, &show_version, 1}, + {0, 0, 0, 0} + }; + // (0) sanity check + if ((argc <= 0) || (argv == NULL)) + return (-1); + if ((err == NULL) || (out == NULL)) + return (-1); + // (1) get basename from command-line +#if (USE_BASENAME != 0) + m_szBasename = basename((char*)argv[0]); +#endif + // (2) scan command-line for options +#if (OPTION_CANAPI_LIBRARY != 0) + while ((opt = getopt_long(argc, (char * const *)argv, "b:vp:m:t:i:d:a:w:x:s:lLTh", long_options, NULL)) != -1) { +#else + while ((opt = getopt_long(argc, (char * const *)argv, "b:vm:t:i:d:a:w:x:s:lLTj:h", long_options, NULL)) != -1) { +#endif + switch (opt) { + /* option '--baudrate=' (-b) */ + case 'b': + if (optBitrate++) { + fprintf(err, "%s: duplicated option `--baudrate' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--baudrate' (%c)\n", m_szBasename, opt); + return 1; + } + if (sscanf(optarg, "%lli", &intarg) != 1) { + fprintf(err, "%s: illegal argument for option `--baudrate' (%c)\n", m_szBasename, opt); + return 1; + } + switch (intarg) { + case 0: case 1000: case 1000000: m_Bitrate.index = (int32_t)CANBTR_INDEX_1M; break; + case 1: case 800: case 800000: m_Bitrate.index = (int32_t)CANBTR_INDEX_800K; break; + case 2: case 500: case 500000: m_Bitrate.index = (int32_t)CANBTR_INDEX_500K; break; + case 3: case 250: case 250000: m_Bitrate.index = (int32_t)CANBTR_INDEX_250K; break; + case 4: case 125: case 125000: m_Bitrate.index = (int32_t)CANBTR_INDEX_125K; break; + case 5: case 100: case 100000: m_Bitrate.index = (int32_t)CANBTR_INDEX_100K; break; + case 6: case 50: case 50000: m_Bitrate.index = (int32_t)CANBTR_INDEX_50K; break; + case 7: case 20: case 20000: m_Bitrate.index = (int32_t)CANBTR_INDEX_20K; break; + case 8: case 10: case 10000: m_Bitrate.index = (int32_t)CANBTR_INDEX_10K; break; + default: m_Bitrate.index = (int32_t)-intarg; break; + } + CANAPI_Bitrate_t bitrate; // in order not to overwrite the index + if (CCanDriver::MapIndex2Bitrate(m_Bitrate.index, bitrate) != CCanApi::NoError) { + fprintf(err, "%s: illegal argument for option `--baudrate' (%c)\n", m_szBasename, opt); + return 1; + } + if (CCanDriver::MapBitrate2Speed(bitrate, m_BusSpeed) != CCanApi::NoError) { + fprintf(err, "%s: illegal argument for option `--baudrate' (%c)\n", m_szBasename, opt); + return 1; + } + break; + /* option '--bitrate=' as string */ + case 'B': + if (optBitrate++) { + fprintf(err, "%s: duplicated option `--bitrate'\n", m_szBasename); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--bitrate'\n", m_szBasename); + return 1; + } + if (CCanDriver::MapString2Bitrate(optarg, m_Bitrate, m_bHasDataPhase, m_bHasNoSamp) != CCanApi::NoError) { + fprintf(err, "%s: illegal argument for option `--bitrate'\n", m_szBasename); + return 1; + } + if (CCanDriver::MapBitrate2Speed(m_Bitrate, m_BusSpeed) != CCanApi::NoError) { + fprintf(err, "%s: illegal argument for option `--bitrate'\n", m_szBasename); + return 1; + } + break; + /* option '--verbose' (-v) */ + case 'v': + if (optVerbose) { + fprintf(err, "%s: duplicated option `--verbose' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--verbose' (%c)\n", m_szBasename, opt); + return 1; + } + m_fVerbose = true; + break; +#if (OPTION_CANAPI_LIBRARY != 0) + /* option '--path=' (-p) */ + case 'p': + if (optPath++) { + fprintf(err, "%s: duplicated option `--path' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--path' (%c)\n", m_szBasename, opt); + return 1; + } + m_szSearchPath = optarg; + break; +#endif + /* option '--mode=(2.0|FDF[+BRS])' (-m) */ + case 'm': + if (optMode++) { + fprintf(err, "%s: duplicated option `--mode' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--mode' (%c)\n", m_szBasename, opt); + return 1; + } + if (!strcasecmp(optarg, "DEFAULT") || !strcasecmp(optarg, "CLASSIC") || !strcasecmp(optarg, "CLASSICAL") || + !strcasecmp(optarg, "CAN20") || !strcasecmp(optarg, "CAN2.0") || !strcasecmp(optarg, "2.0")) + m_OpMode.byte |= CANMODE_DEFAULT; +#if (CAN_FD_SUPPORTED != 0) + else if (!strcasecmp(optarg, "CANFD") || !strcasecmp(optarg, "FD") || !strcasecmp(optarg, "FDF")) + m_OpMode.byte |= CANMODE_FDOE; + else if (!strcasecmp(optarg, "CANFD+BRS") || !strcasecmp(optarg, "FDF+BRS") || !strcasecmp(optarg, "FD+BRS")) + m_OpMode.byte |= CANMODE_FDOE | CANMODE_BRSE; +#endif + else { + fprintf(err, "%s: illegal argument for option `--mode' (%c)\n", m_szBasename, opt); + return 1; + } + break; + /* option '--shared' */ + case 'S': + if (optShared++) { + fprintf(err, "%s: duplicated option `--shared'\n", m_szBasename); + return 1; + } + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--shared'\n", m_szBasename); + return 1; + } + m_OpMode.byte |= CANMODE_SHRD; + break; + /* option '--listen-only' */ + case 'M': + if (optListenOnly++) { + fprintf(err, "%s: duplicated option `--listen-only'\n", m_szBasename); + return 1; + } + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--listen-only'\n", m_szBasename); + return 1; + } + m_OpMode.byte |= CANMODE_MON; + break; + /* option '--error-frames' */ + case 'E': + if (optErrorFrames++) { + fprintf(err, "%s: duplicated option `--error-frames'\n", m_szBasename); + return 1; + } + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--error-frames'\n", m_szBasename); + return 1; + } + m_OpMode.byte |= CANMODE_ERR; + + break; + /* option '--no-extended-frames' */ + case 'X': + if (optExtendedFrames++) { + fprintf(err, "%s: duplicated option `--no-extended-frames'\n", m_szBasename); + return 1; + } + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--no-extended-frames'\n", m_szBasename); + return 1; + } + m_OpMode.byte |= CANMODE_NXTD; + break; + /* option '--no-remote-frames' */ + case 'R': + if (optRemoteFrames++) { + fprintf(err, "%s: duplicated option `--no-remote-frames'\n", m_szBasename); + return 1; + } + if (optarg != NULL) { + fprintf(err, "%s: missing argument for option `--no-remote-frames'\n", m_szBasename); + return 1; + } + m_OpMode.byte |= CANMODE_NRTR; + break; + /* option '--code=<11-bit-code>' */ + case '1': + if (optStdCode++) { + fprintf(err, "%s: duplicated option `--code'\n", m_szBasename); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--code'\n", m_szBasename); + return 1; + } + if (sscanf(optarg, "%llx", &intarg) != 1) { + fprintf(err, "%s: illegal argument for option `--code'\n", m_szBasename); + return 1; + } + if ((intarg & ~CAN_MAX_STD_ID) != 0) { + fprintf(err, "%s: illegal argument for option --code'\n", m_szBasename); + return 1; + } + m_StdFilter.m_u32Code = (uint32_t)intarg; + break; + /* option '--mask=<11-bit-mask>' */ + case '2': + if (optStdMask++) { + fprintf(err, "%s: duplicated option `--mask'\n", m_szBasename); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--mask'\n", m_szBasename); + return 1; + } + if (sscanf(optarg, "%llx", &intarg) != 1) { + fprintf(err, "%s: illegal argument for option --mask'\n", m_szBasename); + return 1; + } + if ((intarg & ~CAN_MAX_STD_ID) != 0) { + fprintf(err, "%s: illegal argument for option --mask'\n", m_szBasename); + return 1; + } + m_StdFilter.m_u32Mask = (uint32_t)intarg; + break; + /* option '--xtd-code=<29-bit-code>' */ + case '3': + if (optXtdCode++) { + fprintf(err, "%s: duplicated option `--xtd-code'\n", m_szBasename); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--xtd-code'\n", m_szBasename); + return 1; + } + if (sscanf(optarg, "%llx", &intarg) != 1) { + fprintf(err, "%s: illegal argument for option --xtd-code'\n", m_szBasename); + return 1; + } + if ((intarg & ~CAN_MAX_XTD_ID) != 0) { + fprintf(err, "%s: illegal argument for option --xtd-code'\n", m_szBasename); + return 1; + } + m_XtdFilter.m_u32Code = (uint32_t)intarg; + break; + /* option '--xtd-mask=<29-bit-mask>' */ + case '4': + if (optXtdMask++) { + fprintf(err, "%s: duplicated option `--xtd-mask'\n", m_szBasename); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--xtd-mask'\n", m_szBasename); + return 1; + } + if (sscanf(optarg, "%llx", &intarg) != 1) { + fprintf(err, "%s: illegal argument for option --xtd-mask'\n", m_szBasename); + return 1; + } + if ((intarg & ~CAN_MAX_XTD_ID) != 0) { + fprintf(err, "%s: illegal argument for option --xtd-mask'\n", m_szBasename); + return 1; + } + m_XtdFilter.m_u32Mask = (uint32_t)intarg; + break; + /* option '--time=(ABS|REL|ZERO)' (-t) */ + case 't': + if (optFmtTime++) { + fprintf(err, "%s: duplicated option `--time' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--time' (%c)\n", m_szBasename, opt); + return 1; + } + if (!strcasecmp(optarg, "ABSOLUTE") || !strcasecmp(optarg, "ABS") || !strcasecmp(optarg, "a")) + fmtModeTime = CCanMessage::OptionAbsolute; + else if (!strcasecmp(optarg, "RELATIVE") || !strcasecmp(optarg, "REL") || !strcasecmp(optarg, "r")) + fmtModeTime = CCanMessage::OptionRelative; + else if (!strcasecmp(optarg, "ZERO") || !strcasecmp(optarg, "0") || !strcasecmp(optarg, "z")) + fmtModeTime = CCanMessage::OptionZero; + else { + fprintf(err, "%s: illegal argument for option `--time' (%c)\n", m_szBasename, opt); + return 1; + } + if (!CCanMessage::SetTimestampFormat(fmtModeTime)) { + fprintf(err, "%s: illegal argument for option `--time' (%c)\n", m_szBasename, opt); + return 1; + } + break; + /* option '--id=(HEX|DEC|OCT)' (-i) */ + case 'i': + if (optFmtId++) { + fprintf(err, "%s: duplicated option `--id' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--id' (%c)\n", m_szBasename, opt); + return 1; + } + if (!strcasecmp(optarg, "HEXADECIMAL") || !strcasecmp(optarg, "HEX") || !strcasecmp(optarg, "h") || !strcasecmp(optarg, "16")) + fmtModeId = CCanMessage::OptionHex; + else if (!strcasecmp(optarg, "DECIMAL") || !strcasecmp(optarg, "DEC") || !strcasecmp(optarg, "d") || !strcasecmp(optarg, "10")) + fmtModeId = CCanMessage::OptionDec; + else if (!strcasecmp(optarg, "OCTAL") || !strcasecmp(optarg, "OCT") || !strcasecmp(optarg, "o") || !strcasecmp(optarg, "8")) + fmtModeId = CCanMessage::OptionOct; + else { + fprintf(err, "%s: illegal argument for option `--id' (%c)\n", m_szBasename, opt); + return 1; + } + if (!CCanMessage::SetIdentifierFormat(fmtModeId)) { + fprintf(err, "%s: illegal argument for option `--id' (%c)\n", m_szBasename, opt); + return 1; + } + break; + /* option '--data=(HEX|DEC|OCT)' (-d) */ + case 'd': + if (optFmtData++) { + fprintf(err, "%s: duplicated option `--data' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--data' (%c)\n", m_szBasename, opt); + return 1; + } + if (!strcasecmp(optarg, "HEXADECIMAL") || !strcasecmp(optarg, "HEX") || !strcasecmp(optarg, "h") || !strcasecmp(optarg, "16")) + fmtModeData = CCanMessage::OptionHex; + else if (!strcasecmp(optarg, "DECIMAL") || !strcasecmp(optarg, "DEC") || !strcasecmp(optarg, "d") || !strcasecmp(optarg, "10")) + fmtModeData = CCanMessage::OptionDec; + else if (!strcasecmp(optarg, "OCTAL") || !strcasecmp(optarg, "OCT") || !strcasecmp(optarg, "o") || !strcasecmp(optarg, "8")) + fmtModeData = CCanMessage::OptionOct; + else { + fprintf(err, "%s: illegal argument for option `--data' (%c)\n", m_szBasename, opt); + return 1; + } + if (!CCanMessage::SetDataFormat(fmtModeData)) { + fprintf(err, "%s: illegal argument for option `--data' (%c)\n", m_szBasename, opt); + return 1; + } + break; + /* option '--ascii=(ON|OFF)' (-a) */ + case 'a': + if (optFmtAscii++) { + fprintf(err, "%s: duplicated option `--ascii' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--ascii' (%c)\n", m_szBasename, opt); + return 1; + } + if (!strcasecmp(optarg, "OFF") || !strcasecmp(optarg, "NO") || !strcasecmp(optarg, "n") || !strcasecmp(optarg, "0")) + fmtModeAscii = CCanMessage::OptionOff; + else if (!strcasecmp(optarg, "ON") || !strcasecmp(optarg, "YES") || !strcasecmp(optarg, "y") || !strcasecmp(optarg, "1")) + fmtModeAscii = CCanMessage::OptionOn; + else { + fprintf(err, "%s: illegal argument for option `--ascii' (%c)\n", m_szBasename, opt); + return 1; + } + if (!CCanMessage::SetAsciiFormat(fmtModeAscii)) { + fprintf(err, "%s: illegal argument for option `--ascii' (%c)\n", m_szBasename, opt); + return 1; + } + break; +#if (CAN_FD_SUPPORTED != 0) + /* option '--wrap=(No|8|10|16|32|64)' (-w) */ + case 'w': + if (optFmtWrap++) { + fprintf(err, "%s: duplicated option `--wrap' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--wrap' (%c)\n", m_szBasename, opt); + return 1; + } + if (!strcasecmp(optarg, "NO") || !strcasecmp(optarg, "n") || !strcasecmp(optarg, "0")) + fmtWraparound = CCanMessage::OptionWraparoundNo; + else if (!strcasecmp(optarg, "8")) + fmtWraparound = CCanMessage::OptionWraparound8; + else if (!strcasecmp(optarg, "10")) + fmtWraparound = CCanMessage::OptionWraparound10; + else if (!strcasecmp(optarg, "16")) + fmtWraparound = CCanMessage::OptionWraparound16; + else if (!strcasecmp(optarg, "32")) + fmtWraparound = CCanMessage::OptionWraparound32; + else if (!strcasecmp(optarg, "64")) + fmtWraparound = CCanMessage::OptionWraparound64; + else { + fprintf(err, "%s: illegal argument for option `--wrap' (%c)\n", m_szBasename, opt); + return 1; + } + if (!CCanMessage::SetWraparound(fmtWraparound)) { + fprintf(err, "%s: illegal argument for option `--wrap' (%c)\n", m_szBasename, opt); + return 1; + } + break; +#endif + /* option '--exclude=[~]' (-x) */ + case 'x': + if (optExclude++) { + fprintf(err, "%s: duplicated option `--exclude' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--exclude' (%c)\n", m_szBasename, opt); + return 1; + } + m_szExcludeList = optarg; + break; + /* option '--list-bitrates[=(2.0|FDF[+BRS])]' */ + case 'l': + if (optListBitrates++) { + fprintf(err, "%s: duplicated option `--list-bitrates'\n", m_szBasename); + return 1; + } + if (optarg != NULL) { + if (optMode++) { + fprintf(err, "%s: option `--list-bitrates' - operation mode already set'\n", m_szBasename); + return 1; + } + if (!strcasecmp(optarg, "DEFAULT") || !strcasecmp(optarg, "CLASSIC") || !strcasecmp(optarg, "CLASSICAL") || + !strcasecmp(optarg, "CAN20") || !strcasecmp(optarg, "CAN2.0") || !strcasecmp(optarg, "2.0")) + m_OpMode.byte |= CANMODE_DEFAULT; +#if (CAN_FD_SUPPORTED != 0) + else if (!strcasecmp(optarg, "CANFD") || !strcasecmp(optarg, "FD") || !strcasecmp(optarg, "FDF")) + m_OpMode.byte |= CANMODE_FDOE; + else if (!strcasecmp(optarg, "CANFD+BRS") || !strcasecmp(optarg, "FDF+BRS") || !strcasecmp(optarg, "FD+BRS")) + m_OpMode.byte |= CANMODE_FDOE | CANMODE_BRSE; +#endif + else { + fprintf(err, "%s: illegal argument for option `--list-bitrates'\n", m_szBasename); + return 1; + } + } + m_fListBitrates = true; + m_fExit = true; + break; + /* option '--list-boards' (-L) */ + case 'L': + if (optListBoards++) { + fprintf(err, "%s: duplicated option `--list-boards' (%c)\n", m_szBasename, opt); + return 1; + } +#if (OPTION_CANAPI_LIBRARY != 0) + if (optarg != NULL) { + if (optPath++) { + fprintf(err, "%s: option `--list-boards' - search path already set' (%c)\n", m_szBasename, opt); + return 1; + } + m_szSearchPath = optarg; // option '--list-boards=' (-L) + } +#else + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--list-boards' (%c)\n", m_szBasename, opt); + return 1; + } +#endif + m_fListBoards = true; + m_fExit = true; + break; + /* option '--test-boards' (-T) */ + case 'T': + if (optTestBoards++) { + fprintf(err, "%s: duplicated option `--test-boards' (%c)\n", m_szBasename, opt); + return 1; + } +#if (OPTION_CANAPI_LIBRARY != 0) + if (optarg != NULL) { + if (optPath++) { + fprintf(err, "%s: option `--test-boards' - search path already set' (%c)\n", m_szBasename, opt); + return 1; + } + m_szSearchPath = optarg; // option '--test-boards=' (-L) + } +#else + if (optarg != NULL) { + fprintf(err, "%s: illegal argument for option `--test-boards' (%c)\n", m_szBasename, opt); + return 1; + } +#endif + m_fTestBoards = true; + m_fExit = true; + break; +#if (OPTION_CANAPI_LIBRARY == 0) + /* option '--json=' (-j) */ + case 'j': + if (optJson++) { + fprintf(err, "%s: duplicated option `--json' (%c)\n", m_szBasename, opt); + return 1; + } + if (optarg == NULL) { + fprintf(err, "%s: missing argument for option `--json' (%c)\n", m_szBasename, opt); + return 1; + } + m_szJsonFilename = optarg; + m_fExit = true; + break; +#endif + /* option '--help' (-h) */ + case 'h': + ShowHelp(out); + m_fExit = true; + return 1; + case '?': + if (!opterr) + ShowUsage(out); + m_fExit = true; + return 1; + default: + if (show_version) + ShowVersion(out); + else + ShowUsage(out); + m_fExit = true; + return 1; + } + } + // (3) scan command-line for argument + // - check if one and only one is given + if (optind + 1 != argc) { + if (optind != argc) + fprintf(err, "%s: too many interface given\n", m_szBasename); + else if (!m_fExit) + fprintf(err, "%s: no arguments given\n", m_szBasename); + return 1; + } else { + m_szInterface = (char*)argv[optind]; + } + // (4) check for illegal combinations +#if (CAN_FD_SUPPORTED != 0) + /* - check bit-timing index (n/a for CAN FD) */ + if (m_OpMode.fdoe && (m_Bitrate.btr.frequency <= CANBTR_INDEX_1M) && !m_fExit) { + fprintf(err, "%s: illegal combination of options `--mode' (m) and `--bitrate'\n", m_szBasename); + return 1; + } +#endif + return 0; +} + +void SOptions::ShowGreetings(FILE* stream) { + if (!stream) + return; + fprintf(stream, "%s\n%s\n\n%s\n\n", c_szApplication, c_szCopyright, c_szWarranty); +} + +void SOptions::ShowFarewell(FILE* stream) { + if (!stream) + return; + fprintf(stream, "%s\n", c_szCopyright); +} + +void SOptions::ShowVersion(FILE* stream) { + if (!stream) + return; + fprintf(stream, "%s\n%s\n\n%s\n\n", c_szApplication, c_szCopyright, c_szLicense); + fprintf(stream, "Written by Uwe Vogt, UV Software, Berlin \n"); +} + +void SOptions::ShowUsage(FILE* stream, bool args) { + if(!stream) + return; + fprintf(stream, "Usage: %s [