Skip to content

Commit

Permalink
Chore/refactor automac unit test (bacnet-stack#557)
Browse files Browse the repository at this point in the history 
* move ports automac module into bacnet/datalink and add unit test.
  • Loading branch information
@skarg
skarg authored Jan 12, 2024
1 parent c6dcab8 commit 587e3c5
Show file tree
Hide file tree
Showing 8 changed files with 172 additions and 143 deletions.
2 changes: 1 addition & 1 deletion ports/stm32f10x/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ INCLUDES += -I$(BACNET_INCLUDE)

PLATFORM_SRC = \
$(PLATFORM_DIR)/main.c \
$(PLATFORM_DIR)/automac.c \
$(PLATFORM_DIR)/bacnet.c \
$(PLATFORM_DIR)/bo.c \
$(PLATFORM_DIR)/device.c \
Expand Down Expand Up @@ -62,6 +61,7 @@ BACNET_SRC = \
$(BACNET_CORE)/bacint.c \
$(BACNET_CORE)/bacreal.c \
$(BACNET_CORE)/bacstr.c \
$(BACNET_CORE)/datalink/automac.c \
$(BACNET_CORE)/datalink/crc.c \
$(BACNET_CORE)/datetime.c \
$(BACNET_CORE)/dcc.c \
Expand Down
2 changes: 1 addition & 1 deletion ports/stm32f10x/bacnet.ewp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1130,7 +1130,7 @@
<group>
<name>BACnet-Datalink</name>
<file>
<name>$PROJ_DIR$\automac.c</name>
<name>$PROJ_DIR$\..\..\src\bacnet\datalink\automac.c</name>
</file>
<file>
<name>$PROJ_DIR$\..\..\src\bacnet\datalink\crc.c</name>
Expand Down
2 changes: 1 addition & 1 deletion ports/stm32f10x/dlmstp.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
#include "bacnet/basic/sys/ringbuf.h"
#include "bacnet/datalink/crc.h"
#include "bacnet/datalink/mstpdef.h"
#include "automac.h"
#include "bacnet/datalink/automac.h"
#include "bacnet/basic/object/device.h"

/* This file has been customized for use with small microprocessors */
Expand Down
163 changes: 23 additions & 140 deletions ports/stm32f10x/automac.c → src/bacnet/datalink/automac.c
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,11 @@
/**************************************************************************
/**
* @file
* @brief BACnet MSTP zero-config auto MAC address
* @author Steve Karg <[email protected]>
* @date 2010
*
* Copyright (C) 2010 Steve Karg <[email protected]>
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*********************************************************************/
* SPDX-License-Identifier: MIT
*/
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
Expand All @@ -30,7 +14,7 @@
#include "bacnet/bacenum.h"
#include "bacnet/config.h"
#include "bacnet/datalink/mstpdef.h"
#include "automac.h"
#include "bacnet/datalink/automac.h"

/* MS/TP Auto MAC address functionality */

Expand All @@ -46,11 +30,7 @@ typedef struct {
/* reserve some slots for fixed addresses */
bool reserved : 1;
} AUTO_MAC_DATA;
/* starting number available for AutoMAC */
#define MAC_SLOTS_OFFSET 32
/* total number of slots */
#define MAC_SLOTS_MAX 128
static AUTO_MAC_DATA Auto_MAC_Data[MAC_SLOTS_MAX];
static AUTO_MAC_DATA Auto_MAC_Data[MSTP_MAC_SLOTS_MAX];
/* my automatic MAC address */
static uint8_t My_MAC_Address;
/* my no-token silence timer time slot in milliseconds */
Expand Down Expand Up @@ -99,7 +79,7 @@ static bool automac_address_used(uint8_t mac)
{
bool status = false;

if (mac < MAC_SLOTS_MAX) {
if (mac < MSTP_MAC_SLOTS_MAX) {
if ((Auto_MAC_Data[mac].emitter) || (Auto_MAC_Data[mac].reserved) ||
(Auto_MAC_Data[mac].token)) {
status = true;
Expand All @@ -118,7 +98,7 @@ bool automac_free_address_valid(uint8_t mac)
{
bool status = false;

if (mac < MAC_SLOTS_MAX) {
if (mac < MSTP_MAC_SLOTS_MAX) {
if ((Auto_MAC_Data[mac].pfm) && (!automac_address_used(mac))) {
status = true;
}
Expand All @@ -139,12 +119,12 @@ uint8_t automac_next_station(uint8_t mac)
uint8_t test_station = 0; /* station number to test for token */

test_station = (mac + 1) % 128;
for (i = 0; i < MAC_SLOTS_MAX; i++) {
for (i = 0; i < MSTP_MAC_SLOTS_MAX; i++) {
if (Auto_MAC_Data[test_station].token) {
next_station = test_station;
break;
}
test_station = (test_station + 1) % MAC_SLOTS_MAX;
test_station = (test_station + 1) % MSTP_MAC_SLOTS_MAX;
}

return next_station;
Expand All @@ -160,7 +140,7 @@ uint8_t automac_free_address_count(void)
uint8_t i = 0;
uint8_t slots = 0;

for (i = 0; i < MAC_SLOTS_MAX; i++) {
for (i = 0; i < MSTP_MAC_SLOTS_MAX; i++) {
if (automac_free_address_valid(i)) {
slots++;
}
Expand All @@ -180,7 +160,7 @@ uint8_t automac_free_address_mac(uint8_t count)
uint8_t slots = 0;
uint8_t mac = 255;

for (i = 0; i < MAC_SLOTS_MAX; i++) {
for (i = 0; i < MSTP_MAC_SLOTS_MAX; i++) {
if (automac_free_address_valid(i)) {
if (slots == count) {
mac = i;
Expand Down Expand Up @@ -250,10 +230,10 @@ uint16_t automac_time_slot(void)
*****************************************************************************/
void automac_address_init(void)
{
My_MAC_Address =
MAC_SLOTS_OFFSET + rand() % (MAC_SLOTS_MAX - MAC_SLOTS_OFFSET);
My_MAC_Address = MSTP_MAC_SLOTS_OFFSET +
rand() % (MSTP_MAC_SLOTS_MAX - MSTP_MAC_SLOTS_OFFSET);
/* at least as long as a dropped token - worst case */
My_Time_Slot = Tno_token + (MAC_SLOTS_MAX * Tslot);
My_Time_Slot = Tno_token + (MSTP_MAC_SLOTS_MAX * Tslot);
My_Time_Slot += (uint16_t)My_MAC_Address * Tslot;
}

Expand All @@ -264,7 +244,7 @@ void automac_address_init(void)
*****************************************************************************/
void automac_pfm_set(uint8_t mac)
{
if (mac < MAC_SLOTS_MAX) {
if (mac < MSTP_MAC_SLOTS_MAX) {
if (Auto_MAC_Data[mac].pfm) {
/* indicate that we have completed enough PFM to continue */
if (automac_free_address_count() > 0) {
Expand All @@ -282,7 +262,7 @@ void automac_pfm_set(uint8_t mac)
*****************************************************************************/
void automac_token_set(uint8_t mac)
{
if (mac < MAC_SLOTS_MAX) {
if (mac < MSTP_MAC_SLOTS_MAX) {
Auto_MAC_Data[mac].token = true;
}
}
Expand All @@ -294,7 +274,7 @@ void automac_token_set(uint8_t mac)
*****************************************************************************/
void automac_emitter_set(uint8_t mac)
{
if (mac < MAC_SLOTS_MAX) {
if (mac < MSTP_MAC_SLOTS_MAX) {
Auto_MAC_Data[mac].emitter = true;
}
}
Expand All @@ -308,11 +288,11 @@ void automac_init(void)
{
uint8_t i = 0;

for (i = 0; i < MAC_SLOTS_MAX; i++) {
for (i = 0; i < MSTP_MAC_SLOTS_MAX; i++) {
Auto_MAC_Data[i].token = false;
Auto_MAC_Data[i].emitter = false;
Auto_MAC_Data[i].pfm = false;
if (i < MAC_SLOTS_OFFSET) {
if (i < MSTP_MAC_SLOTS_OFFSET) {
Auto_MAC_Data[i].reserved = true;
} else {
Auto_MAC_Data[i].reserved = false;
Expand All @@ -321,100 +301,3 @@ void automac_init(void)
automac_address_init();
PFM_Cycle_Complete = false;
}

#ifdef BAC_TEST
#include <assert.h>
#include <string.h>
#include <stdio.h>
#include "ctest.h"

/* test the ring buffer */
void test_Auto_MAC(Test *pTest)
{
uint8_t mac = 255;

automac_init();
ct_test(pTest, automac_free_address_count() == 0);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == 255);
automac_pfm_set(MAC_SLOTS_OFFSET);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == MAC_SLOTS_OFFSET);
ct_test(pTest, automac_free_address_count() == 1);
automac_token_set(MAC_SLOTS_OFFSET);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == 255);
ct_test(pTest, automac_free_address_count() == 0);
automac_pfm_set(127);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == 127);
ct_test(pTest, automac_free_address_count() == 1);
automac_token_set(127);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == 255);
ct_test(pTest, automac_free_address_count() == 0);
/* the ANSI rand() uses consistent sequence based on seed */
srand(42);
mac = automac_free_address_random();
ct_test(pTest, mac == 255);
automac_pfm_set(MAC_SLOTS_OFFSET + 1);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == (MAC_SLOTS_OFFSET + 1));
mac = automac_free_address_random();
ct_test(pTest, mac == (MAC_SLOTS_OFFSET + 1));
/* test 2 free addresses */
automac_pfm_set(MAC_SLOTS_OFFSET + 2);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == (MAC_SLOTS_OFFSET + 1));
mac = automac_free_address_mac(1);
ct_test(pTest, mac == (MAC_SLOTS_OFFSET + 2));
mac = automac_free_address_random();
ct_test(pTest,
(mac == (MAC_SLOTS_OFFSET + 1)) || (mac == (MAC_SLOTS_OFFSET + 2)));
/* test 3 free addresses */
automac_pfm_set(126);
mac = automac_free_address_mac(0);
ct_test(pTest, mac == (MAC_SLOTS_OFFSET + 1));
mac = automac_free_address_mac(1);
ct_test(pTest, mac == (MAC_SLOTS_OFFSET + 2));
mac = automac_free_address_mac(2);
ct_test(pTest, mac == 126);
mac = automac_free_address_random();
ct_test(pTest,
(mac == (MAC_SLOTS_OFFSET + 1)) || (mac == (MAC_SLOTS_OFFSET + 2)) ||
(mac == 126));
/* test the stored address */
mac = automac_address();
ct_test(pTest, mac < MAC_SLOTS_MAX);
automac_address_set(MAC_SLOTS_OFFSET);
mac = automac_address();
ct_test(pTest, mac == MAC_SLOTS_OFFSET);

automac_init();
automac_token_set(0x6B);
mac = automac_next_station(0x25);
ct_test(pTest, mac == 0x6B);
}

#ifdef TEST_AUTOMAC
int main(void)
{
Test *pTest;
bool rc;

pTest = ct_create("Auto MAC", NULL);

/* individual tests */
rc = ct_addTestFunction(pTest, test_Auto_MAC);
assert(rc);

ct_setStream(pTest, stdout);
ct_run(pTest);
(void)ct_report(pTest);

ct_destroy(pTest);

return 0;
}
#endif
#endif
6 changes: 6 additions & 0 deletions ports/stm32f10x/automac.h → src/bacnet/datalink/automac.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,14 @@

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>

/* MS/TP Auto MAC address functionality */
/* starting number available for AutoMAC */
#define MSTP_MAC_SLOTS_OFFSET 32
/* total number of slots */
#define MSTP_MAC_SLOTS_MAX 128

#ifdef __cplusplus
extern "C" {
Expand Down
1 change: 1 addition & 0 deletions test/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ list(APPEND testdirs

# bacnet/datalink/*
list(APPEND testdirs
bacnet/datalink/automac
bacnet/datalink/cobs
bacnet/datalink/crc
bacnet/datalink/bvlc
Expand Down
40 changes: 40 additions & 0 deletions test/bacnet/datalink/automac/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# SPDX-License-Identifier: MIT

cmake_minimum_required(VERSION 3.10 FATAL_ERROR)

get_filename_component(basename ${CMAKE_CURRENT_SOURCE_DIR} NAME)
project(test_${basename}
VERSION 1.0.0
LANGUAGES C)

string(REGEX REPLACE
"/test/bacnet/[a-zA-Z_/-]*$"
"/src"
SRC_DIR
${CMAKE_CURRENT_SOURCE_DIR})
string(REGEX REPLACE
"/test/bacnet/[a-zA-Z_/-]*$"
"/test"
TST_DIR
${CMAKE_CURRENT_SOURCE_DIR})
set(ZTST_DIR "${TST_DIR}/ztest/src")

add_compile_definitions(
BIG_ENDIAN=0
CONFIG_ZTEST=1
)

include_directories(
${SRC_DIR}
${TST_DIR}/ztest/include
)

add_executable(${PROJECT_NAME}
# File(s) under test
${SRC_DIR}/bacnet/datalink/automac.c
# Support files and stubs (pathname alphabetical)
# Test and test library files
./src/main.c
${ZTST_DIR}/ztest_mock.c
${ZTST_DIR}/ztest.c
)
Loading

0 comments on commit 587e3c5

Please sign in to comment.