1752 lines
73 KiB
C
1752 lines
73 KiB
C
/*####COPYRIGHTBEGIN####
|
|
-------------------------------------------
|
|
Copyright (C) 2003 Steve Karg
|
|
|
|
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 2
|
|
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, write to:
|
|
The Free Software Foundation, Inc.
|
|
59 Temple Place - Suite 330
|
|
Boston, MA 02111-1307
|
|
USA.
|
|
|
|
As a special exception, if other files instantiate templates or
|
|
use macros or inline functions from this file, or you compile
|
|
this file and link it with other works to produce a work based
|
|
on this file, this file does not by itself cause the resulting
|
|
work to be covered by the GNU General Public License. However
|
|
the source code for this file must still be made available in
|
|
accordance with section (3) of the GNU General Public License.
|
|
|
|
This exception does not invalidate any other reasons why a work
|
|
based on this file might be covered by the GNU General Public
|
|
License.
|
|
-------------------------------------------
|
|
####COPYRIGHTEND####*/
|
|
|
|
/* This clause describes a Master-Slave/Token-Passing (MS/TP) data link */
|
|
/* protocol, which provides the same services to the network layer as */
|
|
/* ISO 8802-2 Logical Link Control. It uses services provided by the */
|
|
/* EIA-485 physical layer. Relevant clauses of EIA-485 are deemed to be */
|
|
/* included in this standard by reference. The following hardware is assumed: */
|
|
/* (a) A UART (Universal Asynchronous Receiver/Transmitter) capable of */
|
|
/* transmitting and receiving eight data bits with one stop bit */
|
|
/* and no parity. */
|
|
/* (b) An EIA-485 transceiver whose driver may be disabled. */
|
|
/* (c) A timer with a resolution of five milliseconds or less */
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include "mstp.h"
|
|
#include "crc.h"
|
|
#include "rs485.h"
|
|
|
|
/* debug print statements */
|
|
#if PRINT_ENABLED
|
|
#define PRINT_ENABLED_RECEIVE 0
|
|
#define PRINT_ENABLED_RECEIVE_DATA 0
|
|
#define PRINT_ENABLED_RECEIVE_ERRORS 1
|
|
#define PRINT_ENABLED_MASTER 0
|
|
#else
|
|
#define PRINT_ENABLED_RECEIVE 0
|
|
#define PRINT_ENABLED_RECEIVE_DATA 0
|
|
#define PRINT_ENABLED_MASTER 0
|
|
#endif
|
|
|
|
/* MS/TP Frame Format */
|
|
/* All frames are of the following format: */
|
|
/* */
|
|
/* Preamble: two octet preamble: X`55', X`FF' */
|
|
/* Frame Type: one octet */
|
|
/* Destination Address: one octet address */
|
|
/* Source Address: one octet address */
|
|
/* Length: two octets, most significant octet first, of the Data field */
|
|
/* Header CRC: one octet */
|
|
/* Data: (present only if Length is non-zero) */
|
|
/* Data CRC: (present only if Length is non-zero) two octets, */
|
|
/* least significant octet first */
|
|
/* (pad): (optional) at most one octet of padding: X'FF' */
|
|
|
|
/* The number of tokens received or used before a Poll For Master cycle */
|
|
/* is executed: 50. */
|
|
#define Npoll 50
|
|
|
|
/* The number of retries on sending Token: 1. */
|
|
#define Nretry_token 1
|
|
|
|
/* The minimum number of DataAvailable or ReceiveError events that must be */
|
|
/* seen by a receiving node in order to declare the line "active": 4. */
|
|
#define Nmin_octets 4
|
|
|
|
/* The minimum time without a DataAvailable or ReceiveError event within */
|
|
/* a frame before a receiving node may discard the frame: 60 bit times. */
|
|
/* (Implementations may use larger values for this timeout, */
|
|
/* not to exceed 100 milliseconds.) */
|
|
/* At 9600 baud, 60 bit times would be about 6.25 milliseconds */
|
|
/* const uint16_t Tframe_abort = 1 + ((1000 * 60) / 9600); */
|
|
#define Tframe_abort 100
|
|
|
|
/* The maximum idle time a sending node may allow to elapse between octets */
|
|
/* of a frame the node is transmitting: 20 bit times. */
|
|
#define Tframe_gap 20
|
|
|
|
/* The time without a DataAvailable or ReceiveError event before declaration */
|
|
/* of loss of token: 500 milliseconds. */
|
|
#define Tno_token 500
|
|
|
|
/* The maximum time after the end of the stop bit of the final */
|
|
/* octet of a transmitted frame before a node must disable its */
|
|
/* EIA-485 driver: 15 bit times. */
|
|
#define Tpostdrive 15
|
|
|
|
/* The maximum time a node may wait after reception of a frame that expects */
|
|
/* a reply before sending the first octet of a reply or Reply Postponed */
|
|
/* frame: 250 milliseconds. */
|
|
/* note: we always send a reply postponed since a message other than
|
|
the reply may be in the transmit queue */
|
|
#define Treply_delay 10
|
|
|
|
/* The minimum time without a DataAvailable or ReceiveError event */
|
|
/* that a node must wait for a station to begin replying to a */
|
|
/* confirmed request: 255 milliseconds. (Implementations may use */
|
|
/* larger values for this timeout, not to exceed 300 milliseconds.) */
|
|
#define Treply_timeout 255
|
|
|
|
/* Repeater turnoff delay. The duration of a continuous logical one state */
|
|
/* at the active input port of an MS/TP repeater after which the repeater */
|
|
/* will enter the IDLE state: 29 bit times < Troff < 40 bit times. */
|
|
#define Troff 30
|
|
|
|
/* The width of the time slot within which a node may generate a token: */
|
|
/* 10 milliseconds. */
|
|
#define Tslot 10
|
|
|
|
/* The maximum time a node may wait after reception of the token or */
|
|
/* a Poll For Master frame before sending the first octet of a frame: */
|
|
/* 15 milliseconds. */
|
|
#define Tusage_delay 15
|
|
|
|
/* The minimum time without a DataAvailable or ReceiveError event that a */
|
|
/* node must wait for a remote node to begin using a token or replying to */
|
|
/* a Poll For Master frame: 20 milliseconds. (Implementations may use */
|
|
/* larger values for this timeout, not to exceed 100 milliseconds.) */
|
|
#define Tusage_timeout 20
|
|
|
|
/* we need to be able to increment without rolling over */
|
|
#define INCREMENT_AND_LIMIT_UINT8(x) {if (x < 0xFF) x++;}
|
|
|
|
bool MSTP_Line_Active(volatile struct mstp_port_struct_t *mstp_port)
|
|
{
|
|
return (mstp_port->EventCount > Nmin_octets);
|
|
}
|
|
|
|
unsigned MSTP_Create_Frame(uint8_t * buffer, /* where frame is loaded */
|
|
unsigned buffer_len, /* amount of space available */
|
|
uint8_t frame_type, /* type of frame to send - see defines */
|
|
uint8_t destination, /* destination address */
|
|
uint8_t source, /* source address */
|
|
uint8_t * data, /* any data to be sent - may be null */
|
|
unsigned data_len)
|
|
{ /* number of bytes of data (up to 501) */
|
|
uint8_t crc8 = 0xFF; /* used to calculate the crc value */
|
|
uint16_t crc16 = 0xFFFF; /* used to calculate the crc value */
|
|
unsigned index = 0; /* used to load the data portion of the frame */
|
|
|
|
/* not enough to do a header */
|
|
if (buffer_len < 8)
|
|
return 0;
|
|
|
|
buffer[0] = 0x55;
|
|
buffer[1] = 0xFF;
|
|
buffer[2] = frame_type;
|
|
crc8 = CRC_Calc_Header(buffer[2], crc8);
|
|
buffer[3] = destination;
|
|
crc8 = CRC_Calc_Header(buffer[3], crc8);
|
|
buffer[4] = source;
|
|
crc8 = CRC_Calc_Header(buffer[4], crc8);
|
|
buffer[5] = data_len / 256;
|
|
crc8 = CRC_Calc_Header(buffer[5], crc8);
|
|
buffer[6] = data_len % 256;
|
|
crc8 = CRC_Calc_Header(buffer[6], crc8);
|
|
buffer[7] = ~crc8;
|
|
|
|
index = 8;
|
|
while (data_len && data && (index < buffer_len)) {
|
|
buffer[index] = *data;
|
|
crc16 = CRC_Calc_Data(buffer[index], crc16);
|
|
data++;
|
|
index++;
|
|
data_len--;
|
|
}
|
|
/* append the data CRC if necessary */
|
|
if (index > 8) {
|
|
if ((index + 2) <= buffer_len) {
|
|
crc16 = ~crc16;
|
|
buffer[index] = (crc16 & 0x00FF);
|
|
index++;
|
|
buffer[index] = ((crc16 & 0xFF00) >> 8);
|
|
index++;
|
|
} else
|
|
return 0;
|
|
}
|
|
|
|
return index; /* returns the frame length */
|
|
}
|
|
|
|
void MSTP_Create_And_Send_Frame(volatile struct mstp_port_struct_t *mstp_port, /* port to send from */
|
|
uint8_t frame_type, /* type of frame to send - see defines */
|
|
uint8_t destination, /* destination address */
|
|
uint8_t source, /* source address */
|
|
uint8_t * data, /* any data to be sent - may be null */
|
|
unsigned data_len)
|
|
{ /* number of bytes of data (up to 501) */
|
|
mstp_port->TxLength = (uint16_t) MSTP_Create_Frame(
|
|
(uint8_t *)&mstp_port->TxBuffer[0], /* where frame is loaded */
|
|
sizeof(mstp_port->TxBuffer), /* amount of space available */
|
|
frame_type, /* type of frame to send - see defines */
|
|
destination, /* destination address */
|
|
source, /* source address */
|
|
data, /* any data to be sent - may be null */
|
|
data_len); /* number of bytes of data (up to 501) */
|
|
|
|
RS485_Send_Frame(
|
|
mstp_port,
|
|
(uint8_t *)&mstp_port->TxBuffer[0],
|
|
mstp_port->TxLength);
|
|
/* FIXME: be sure to reset SilenceTimer after each octet is sent! */
|
|
}
|
|
|
|
#if PRINT_ENABLED_RECEIVE
|
|
char *mstp_receive_state_text(int state)
|
|
{
|
|
char *text = "unknown";
|
|
|
|
switch (state) {
|
|
case MSTP_RECEIVE_STATE_IDLE:
|
|
text = "IDLE";
|
|
break;
|
|
case MSTP_RECEIVE_STATE_PREAMBLE:
|
|
text = "PREAMBLE";
|
|
break;
|
|
case MSTP_RECEIVE_STATE_HEADER:
|
|
text = "HEADER";
|
|
break;
|
|
case MSTP_RECEIVE_STATE_HEADER_CRC:
|
|
text = "HEADER_CRC";
|
|
break;
|
|
case MSTP_RECEIVE_STATE_DATA:
|
|
text = "DATA";
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return text;
|
|
}
|
|
#endif
|
|
|
|
void MSTP_Receive_Frame_FSM(volatile struct mstp_port_struct_t *mstp_port)
|
|
{
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
static MSTP_RECEIVE_STATE receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
#endif
|
|
#if PRINT_ENABLED_RECEIVE
|
|
fprintf(stderr,
|
|
"MSTP Rx: State=%s Data=%02X hCRC=%02X Index=%u EC=%u DateLen=%u Silence=%u\n",
|
|
mstp_receive_state_text(mstp_port->receive_state),
|
|
mstp_port->DataRegister, mstp_port->HeaderCRC, mstp_port->Index,
|
|
mstp_port->EventCount, mstp_port->DataLength,
|
|
mstp_port->SilenceTimer);
|
|
#endif
|
|
switch (mstp_port->receive_state) {
|
|
/* In the IDLE state, the node waits for the beginning of a frame. */
|
|
case MSTP_RECEIVE_STATE_IDLE:
|
|
/* EatAnError */
|
|
if (mstp_port->ReceiveError == true) {
|
|
mstp_port->ReceiveError = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
} else if (mstp_port->DataAvailable == true) {
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
#if defined(_WIN32)
|
|
extern uint32_t timestamp_ms(void);
|
|
fprintf(stderr, "MSTP Rx %03u: %02X ",
|
|
(unsigned)timestamp_ms(),
|
|
mstp_port->DataRegister);
|
|
#else
|
|
fprintf(stderr, "MSTP Rx: %02X ", mstp_port->DataRegister);
|
|
#endif
|
|
#endif
|
|
/* Preamble1 */
|
|
if (mstp_port->DataRegister == 0x55) {
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* receive the remainder of the frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_PREAMBLE;
|
|
}
|
|
/* EatAnOctet */
|
|
else {
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
fprintf(stderr, "\n");
|
|
#endif
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
}
|
|
break;
|
|
/* In the PREAMBLE state, the node waits for the second octet of the preamble. */
|
|
case MSTP_RECEIVE_STATE_PREAMBLE:
|
|
/* Timeout */
|
|
if (mstp_port->SilenceTimer > Tframe_abort) {
|
|
/* a correct preamble has not been received */
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
/* Error */
|
|
else if (mstp_port->ReceiveError == true) {
|
|
mstp_port->ReceiveError = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
} else if (mstp_port->DataAvailable == true) {
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
fprintf(stderr, "%02X ", mstp_port->DataRegister);
|
|
#endif
|
|
/* Preamble2 */
|
|
if (mstp_port->DataRegister == 0xFF) {
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->Index = 0;
|
|
mstp_port->HeaderCRC = 0xFF;
|
|
/* receive the remainder of the frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_HEADER;
|
|
}
|
|
/* ignore RepeatedPreamble1 */
|
|
else if (mstp_port->DataRegister == 0x55) {
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* wait for the second preamble octet. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_PREAMBLE;
|
|
}
|
|
/* NotPreamble */
|
|
else {
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
}
|
|
break;
|
|
/* In the HEADER state, the node waits for the fixed message header. */
|
|
case MSTP_RECEIVE_STATE_HEADER:
|
|
/* Timeout */
|
|
if (mstp_port->SilenceTimer > Tframe_abort) {
|
|
/* indicate that an error has occurred during the reception of a frame */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
fprintf(stderr,"MSTP: Rx Header: SilenceTimer %d > %d\n",
|
|
mstp_port->SilenceTimer, Tframe_abort);
|
|
}
|
|
/* Error */
|
|
else if (mstp_port->ReceiveError == true) {
|
|
mstp_port->ReceiveError = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* indicate that an error has occurred during the reception of a frame */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
fprintf(stderr,"MSTP: Rx Header: ReceiveError\n");
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
} else if (mstp_port->DataAvailable == true) {
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
fprintf(stderr, "%02X ", mstp_port->DataRegister);
|
|
#endif
|
|
/* FrameType */
|
|
if (mstp_port->Index == 0) {
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->HeaderCRC =
|
|
CRC_Calc_Header(mstp_port->DataRegister,
|
|
mstp_port->HeaderCRC);
|
|
mstp_port->FrameType = mstp_port->DataRegister;
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->Index = 1;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_HEADER;
|
|
}
|
|
/* Destination */
|
|
else if (mstp_port->Index == 1) {
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->HeaderCRC =
|
|
CRC_Calc_Header(mstp_port->DataRegister,
|
|
mstp_port->HeaderCRC);
|
|
mstp_port->DestinationAddress = mstp_port->DataRegister;
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->Index = 2;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_HEADER;
|
|
}
|
|
/* Source */
|
|
else if (mstp_port->Index == 2) {
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->HeaderCRC =
|
|
CRC_Calc_Header(mstp_port->DataRegister,
|
|
mstp_port->HeaderCRC);
|
|
mstp_port->SourceAddress = mstp_port->DataRegister;
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->Index = 3;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_HEADER;
|
|
}
|
|
/* Length1 */
|
|
else if (mstp_port->Index == 3) {
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->HeaderCRC =
|
|
CRC_Calc_Header(mstp_port->DataRegister,
|
|
mstp_port->HeaderCRC);
|
|
mstp_port->DataLength = mstp_port->DataRegister * 256;
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->Index = 4;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_HEADER;
|
|
}
|
|
/* Length2 */
|
|
else if (mstp_port->Index == 4) {
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->HeaderCRC =
|
|
CRC_Calc_Header(mstp_port->DataRegister,
|
|
mstp_port->HeaderCRC);
|
|
mstp_port->DataLength += mstp_port->DataRegister;
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->Index = 5;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_HEADER;
|
|
}
|
|
/* HeaderCRC */
|
|
else if (mstp_port->Index == 5) {
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
mstp_port->HeaderCRC =
|
|
CRC_Calc_Header(mstp_port->DataRegister,
|
|
mstp_port->HeaderCRC);
|
|
mstp_port->HeaderCRCActual = mstp_port->DataRegister;
|
|
mstp_port->DataAvailable = false;
|
|
/* don't wait for next state - do it here */
|
|
/* MSTP_RECEIVE_STATE_HEADER_CRC */
|
|
if (mstp_port->HeaderCRC != 0x55) {
|
|
/* BadCRC */
|
|
/* indicate that an error has occurred during
|
|
the reception of a frame */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
#if PRINT_ENABLED_RECEIVE_ERRORS
|
|
fprintf(stderr,"MSTP: Rx Header: BadCRC [%02X]\n",
|
|
mstp_port->DataRegister);
|
|
#endif
|
|
/* wait for the start of the next frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
} else {
|
|
if ((mstp_port->DestinationAddress ==
|
|
mstp_port->This_Station)
|
|
|| (mstp_port->DestinationAddress ==
|
|
MSTP_BROADCAST_ADDRESS)
|
|
|| (mstp_port->Lurking)) {
|
|
/* FrameTooLong */
|
|
if (mstp_port->DataLength > MAX_MPDU) {
|
|
/* indicate that a frame with an illegal or */
|
|
/* unacceptable data length has been received */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
#if PRINT_ENABLED_RECEIVE_ERRORS
|
|
fprintf(stderr,"MSTP: Rx Header: FrameTooLong %d\n",
|
|
mstp_port->DataLength);
|
|
#endif
|
|
/* wait for the start of the next frame. */
|
|
mstp_port->receive_state =
|
|
MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
/* NoData */
|
|
else if (mstp_port->DataLength == 0) {
|
|
/* indicate that a frame with no data has been received */
|
|
mstp_port->ReceivedValidFrame = true;
|
|
/* wait for the start of the next frame. */
|
|
mstp_port->receive_state =
|
|
MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
/* Data */
|
|
else {
|
|
mstp_port->Index = 0;
|
|
mstp_port->DataCRC = 0xFFFF;
|
|
/* receive the data portion of the frame. */
|
|
mstp_port->receive_state =
|
|
MSTP_RECEIVE_STATE_DATA;
|
|
}
|
|
}
|
|
/* NotForUs */
|
|
else {
|
|
/* wait for the start of the next frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
}
|
|
}
|
|
/* not per MS/TP standard, but it is a case not covered */
|
|
else {
|
|
mstp_port->ReceiveError = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(mstp_port->EventCount);
|
|
/* indicate that an error has occurred during */
|
|
/* the reception of a frame */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
#if PRINT_ENABLED_RECEIVE_ERRORS
|
|
fprintf(stderr,"MSTP: Rx Data: BadIndex %d\n",
|
|
mstp_port->Index);
|
|
#endif
|
|
/* wait for the start of a frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
}
|
|
break;
|
|
/* In the HEADER_CRC state, the node validates the CRC on the fixed */
|
|
/* message header. */
|
|
case MSTP_RECEIVE_STATE_HEADER_CRC:
|
|
break;
|
|
/* In the DATA state, the node waits for the data portion of a frame. */
|
|
case MSTP_RECEIVE_STATE_DATA:
|
|
/* Timeout */
|
|
if (mstp_port->SilenceTimer > Tframe_abort) {
|
|
/* indicate that an error has occurred during the reception of a frame */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
#if PRINT_ENABLED_RECEIVE_ERRORS
|
|
fprintf(stderr,"MSTP: Rx Data: SilenceTimer %d > %d\n",
|
|
mstp_port->SilenceTimer, Tframe_abort);
|
|
#endif
|
|
/* wait for the start of the next frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
/* Error */
|
|
else if (mstp_port->ReceiveError == true) {
|
|
mstp_port->ReceiveError = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
/* indicate that an error has occurred during the reception of a frame */
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
#if PRINT_ENABLED_RECEIVE_ERRORS
|
|
fprintf(stderr,"MSTP: Rx Data: ReceiveError\n");
|
|
#endif
|
|
/* wait for the start of the next frame. */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
} else if (mstp_port->DataAvailable == true) {
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
fprintf(stderr, "%02X ", mstp_port->DataRegister);
|
|
#endif
|
|
/* DataOctet */
|
|
if (mstp_port->Index < mstp_port->DataLength) {
|
|
mstp_port->DataCRC = CRC_Calc_Data(mstp_port->DataRegister,
|
|
mstp_port->DataCRC);
|
|
mstp_port->InputBuffer[mstp_port->Index] =
|
|
mstp_port->DataRegister;
|
|
mstp_port->Index++;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_DATA;
|
|
}
|
|
/* CRC1 */
|
|
else if (mstp_port->Index == mstp_port->DataLength) {
|
|
mstp_port->DataCRC = CRC_Calc_Data(mstp_port->DataRegister,
|
|
mstp_port->DataCRC);
|
|
mstp_port->DataCRCActualMSB = mstp_port->DataRegister;
|
|
mstp_port->Index++;
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_DATA;
|
|
}
|
|
/* CRC2 */
|
|
else if (mstp_port->Index == (mstp_port->DataLength + 1)) {
|
|
mstp_port->DataCRC = CRC_Calc_Data(mstp_port->DataRegister,
|
|
mstp_port->DataCRC);
|
|
mstp_port->DataCRCActualLSB = mstp_port->DataRegister;
|
|
/* STATE DATA CRC - no need for new state */
|
|
/* indicate the complete reception of a valid frame */
|
|
if (mstp_port->DataCRC == 0xF0B8)
|
|
mstp_port->ReceivedValidFrame = true;
|
|
else {
|
|
mstp_port->ReceivedInvalidFrame = true;
|
|
#if PRINT_ENABLED_RECEIVE_ERRORS
|
|
fprintf(stderr,"MSTP: Rx Data: BadCRC [%02X]\n",
|
|
mstp_port->DataRegister);
|
|
#endif
|
|
}
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
}
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->SilenceTimer = 0;
|
|
}
|
|
break;
|
|
default:
|
|
/* shouldn't get here - but if we do... */
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
break;
|
|
}
|
|
#if PRINT_ENABLED_RECEIVE_DATA
|
|
if ((receive_state != MSTP_RECEIVE_STATE_IDLE) &&
|
|
(mstp_port->receive_state == MSTP_RECEIVE_STATE_IDLE)) {
|
|
fprintf(stderr, "\n");
|
|
fflush(stderr);
|
|
}
|
|
receive_state = mstp_port->receive_state;
|
|
#endif
|
|
|
|
return;
|
|
}
|
|
|
|
#if PRINT_ENABLED
|
|
char *mstp_master_state_text(int state)
|
|
{
|
|
char *text = "unknown";
|
|
|
|
switch (state) {
|
|
case MSTP_MASTER_STATE_INITIALIZE:
|
|
text = "INITIALIZE";
|
|
break;
|
|
case MSTP_MASTER_STATE_IDLE:
|
|
text = "IDLE";
|
|
break;
|
|
case MSTP_MASTER_STATE_USE_TOKEN:
|
|
text = "USE_TOKEN";
|
|
break;
|
|
case MSTP_MASTER_STATE_WAIT_FOR_REPLY:
|
|
text = "WAIT_FOR_REPLY";
|
|
break;
|
|
case MSTP_MASTER_STATE_DONE_WITH_TOKEN:
|
|
text = "IDLE";
|
|
break;
|
|
case MSTP_MASTER_STATE_PASS_TOKEN:
|
|
text = "DONE_WITH_TOKEN";
|
|
break;
|
|
case MSTP_MASTER_STATE_NO_TOKEN:
|
|
text = "NO_TOKEN";
|
|
break;
|
|
case MSTP_MASTER_STATE_POLL_FOR_MASTER:
|
|
text = "POLL_FOR_MASTER";
|
|
break;
|
|
case MSTP_MASTER_STATE_ANSWER_DATA_REQUEST:
|
|
text = "ANSWER_DATA_REQUEST";
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return text;
|
|
}
|
|
#endif
|
|
|
|
#if PRINT_ENABLED
|
|
char *mstp_frame_type_text(int type)
|
|
{
|
|
char *text = "unknown";
|
|
|
|
switch (type) {
|
|
case FRAME_TYPE_TOKEN:
|
|
text = "TOKEN";
|
|
break;
|
|
case FRAME_TYPE_POLL_FOR_MASTER:
|
|
text = "POLL_FOR_MASTER";
|
|
break;
|
|
case FRAME_TYPE_REPLY_TO_POLL_FOR_MASTER:
|
|
text = "REPLY_TO_POLL_FOR_MASTER";
|
|
break;
|
|
case FRAME_TYPE_TEST_REQUEST:
|
|
text = "TEST_REQUEST";
|
|
break;
|
|
case FRAME_TYPE_TEST_RESPONSE:
|
|
text = "TEST_RESPONSE";
|
|
break;
|
|
case FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY:
|
|
text = "BACNET_DATA_EXPECTING_REPLY";
|
|
break;
|
|
case FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY:
|
|
text = "BACNET_DATA_NOT_EXPECTING_REPLY";
|
|
break;
|
|
case FRAME_TYPE_REPLY_POSTPONED:
|
|
text = "REPLY_POSTPONED";
|
|
break;
|
|
default:
|
|
if ((type >= FRAME_TYPE_PROPRIETARY_MIN) &&
|
|
(type <= FRAME_TYPE_PROPRIETARY_MAX))
|
|
text = "PROPRIETARY";
|
|
break;
|
|
}
|
|
|
|
return text;
|
|
}
|
|
#endif
|
|
|
|
/* returns true if we need to transition immediately */
|
|
bool MSTP_Master_Node_FSM(volatile struct mstp_port_struct_t * mstp_port)
|
|
{
|
|
uint8_t next_poll_station = 0;
|
|
uint8_t next_this_station = 0;
|
|
uint8_t next_next_station = 0;
|
|
uint16_t my_timeout = 10, ns_timeout = 0;
|
|
/* transition immediately to the next state */
|
|
bool transition_now = false;
|
|
#if PRINT_ENABLED_MASTER
|
|
static MSTP_MASTER_STATE master_state = MSTP_MASTER_STATE_INITIALIZE;
|
|
#endif
|
|
|
|
/* some calculations that several states need */
|
|
next_poll_station = (mstp_port->Poll_Station + 1) %
|
|
(mstp_port->Nmax_master + 1);
|
|
next_this_station = (mstp_port->This_Station + 1) %
|
|
(mstp_port->Nmax_master + 1);
|
|
next_next_station = (mstp_port->Next_Station + 1) %
|
|
(mstp_port->Nmax_master + 1);
|
|
#if PRINT_ENABLED_MASTER
|
|
if (mstp_port->master_state != master_state) {
|
|
master_state = mstp_port->master_state;
|
|
fprintf(stderr,
|
|
"MSTP: TS=%02X[%02X] NS=%02X[%02X] PS=%02X[%02X] EC=%u TC=%u ST=%u %s\n",
|
|
mstp_port->This_Station,
|
|
next_this_station,
|
|
mstp_port->Next_Station,
|
|
next_next_station,
|
|
mstp_port->Poll_Station,
|
|
next_poll_station,
|
|
mstp_port->EventCount,
|
|
mstp_port->TokenCount,
|
|
mstp_port->SilenceTimer,
|
|
mstp_master_state_text(mstp_port->master_state));
|
|
}
|
|
#endif
|
|
|
|
switch (mstp_port->master_state) {
|
|
case MSTP_MASTER_STATE_INITIALIZE:
|
|
/* DoneInitializing */
|
|
/* indicate that the next station is unknown */
|
|
mstp_port->Next_Station = mstp_port->This_Station;
|
|
mstp_port->Poll_Station = mstp_port->This_Station;
|
|
/* cause a Poll For Master to be sent when this node first */
|
|
/* receives the token */
|
|
mstp_port->TokenCount = Npoll;
|
|
mstp_port->SoleMaster = false;
|
|
mstp_port->ReceivedValidFrame = false;
|
|
mstp_port->ReceivedInvalidFrame = false;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
transition_now = true;
|
|
break;
|
|
/* In the IDLE state, the node waits for a frame. */
|
|
case MSTP_MASTER_STATE_IDLE:
|
|
/* LostToken */
|
|
if (mstp_port->SilenceTimer >= Tno_token) {
|
|
/* assume that the token has been lost */
|
|
mstp_port->EventCount = 0; /* Addendum 135-2004d-8 */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_NO_TOKEN;
|
|
transition_now = true;
|
|
}
|
|
/* ReceivedInvalidFrame */
|
|
else if (mstp_port->ReceivedInvalidFrame == true) {
|
|
/* invalid frame was received */
|
|
mstp_port->ReceivedInvalidFrame = false;
|
|
/* wait for the next frame - remain in IDLE */
|
|
} else if (mstp_port->ReceivedValidFrame == true) {
|
|
#if PRINT_ENABLED_MASTER
|
|
fprintf(stderr,
|
|
"MSTP: ReceivedValidFrame Src=%02X Dest=%02X DataLen=%u FC=%u ST=%u Type=%s\n",
|
|
mstp_port->SourceAddress,
|
|
mstp_port->DestinationAddress,
|
|
mstp_port->DataLength,
|
|
mstp_port->FrameCount,
|
|
mstp_port->SilenceTimer,
|
|
mstp_frame_type_text(mstp_port->FrameType));
|
|
#endif
|
|
/* destined for me! */
|
|
if ((mstp_port->DestinationAddress ==
|
|
mstp_port->This_Station) ||
|
|
(mstp_port->DestinationAddress ==
|
|
MSTP_BROADCAST_ADDRESS)) {
|
|
switch (mstp_port->FrameType) {
|
|
/* ReceivedToken */
|
|
case FRAME_TYPE_TOKEN:
|
|
/* tokens can't be broadcast */
|
|
if (mstp_port->DestinationAddress ==
|
|
MSTP_BROADCAST_ADDRESS)
|
|
break;
|
|
mstp_port->ReceivedValidFrame = false;
|
|
mstp_port->FrameCount = 0;
|
|
mstp_port->SoleMaster = false;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_USE_TOKEN;
|
|
transition_now = true;
|
|
break;
|
|
/* ReceivedPFM */
|
|
case FRAME_TYPE_POLL_FOR_MASTER:
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_REPLY_TO_POLL_FOR_MASTER,
|
|
mstp_port->SourceAddress, mstp_port->This_Station,
|
|
NULL, 0);
|
|
break;
|
|
case FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY:
|
|
/* indicate successful reception to the higher layers */
|
|
dlmstp_put_receive(mstp_port->SourceAddress,
|
|
(uint8_t *) & mstp_port->InputBuffer[0],
|
|
mstp_port->DataLength);
|
|
break;
|
|
case FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY:
|
|
/*mstp_port->ReplyPostponedTimer = 0; */
|
|
/* indicate successful reception to the higher layers */
|
|
dlmstp_put_receive(mstp_port->SourceAddress,
|
|
(uint8_t *) & mstp_port->InputBuffer[0],
|
|
mstp_port->DataLength);
|
|
/* broadcast DER just remains IDLE */
|
|
if (mstp_port->DestinationAddress !=
|
|
MSTP_BROADCAST_ADDRESS) {
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_ANSWER_DATA_REQUEST;
|
|
}
|
|
break;
|
|
case FRAME_TYPE_TEST_REQUEST:
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_TEST_RESPONSE,
|
|
mstp_port->SourceAddress, mstp_port->This_Station,
|
|
NULL, 0);
|
|
break;
|
|
case FRAME_TYPE_TEST_RESPONSE:
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
mstp_port->ReceivedValidFrame = false;
|
|
}
|
|
break;
|
|
/* In the USE_TOKEN state, the node is allowed to send one or */
|
|
/* more data frames. These may be BACnet Data frames or */
|
|
/* proprietary frames. */
|
|
case MSTP_MASTER_STATE_USE_TOKEN:
|
|
mstp_port->TxLength = dlmstp_get_send(
|
|
mstp_port->This_Station,
|
|
(uint8_t *)&mstp_port->TxBuffer[0],
|
|
sizeof(mstp_port->TxBuffer),
|
|
0); /* milliseconds to wait for a packet */
|
|
if (mstp_port->TxLength < 1) {
|
|
/* NothingToSend */
|
|
mstp_port->FrameCount = mstp_port->Nmax_info_frames;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
transition_now = true;
|
|
} else if (mstp_port->SilenceTimer > Tusage_delay) {
|
|
/* if we missed our timing deadline, another token will be sent */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
} else {
|
|
uint8_t destination = mstp_port->TxBuffer[3];
|
|
RS485_Send_Frame(mstp_port,
|
|
(uint8_t *) & mstp_port->TxBuffer[0], mstp_port->TxLength);
|
|
mstp_port->FrameCount++;
|
|
switch (mstp_port->TxFrameType) {
|
|
case FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY:
|
|
/* SendAndWait */
|
|
if (destination == MSTP_BROADCAST_ADDRESS)
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
else
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_WAIT_FOR_REPLY;
|
|
break;
|
|
case FRAME_TYPE_TEST_REQUEST:
|
|
mstp_port->master_state = MSTP_MASTER_STATE_WAIT_FOR_REPLY;
|
|
break;
|
|
case FRAME_TYPE_TEST_RESPONSE:
|
|
case FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY:
|
|
default:
|
|
/* SendNoWait */
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
break;
|
|
}
|
|
mstp_port->TxReady = false;
|
|
}
|
|
break;
|
|
/* In the WAIT_FOR_REPLY state, the node waits for */
|
|
/* a reply from another node. */
|
|
case MSTP_MASTER_STATE_WAIT_FOR_REPLY:
|
|
if (mstp_port->SilenceTimer >= Treply_timeout) {
|
|
/* ReplyTimeout */
|
|
/* assume that the request has failed */
|
|
mstp_port->FrameCount = mstp_port->Nmax_info_frames;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
/* Any retry of the data frame shall await the next entry */
|
|
/* to the USE_TOKEN state. (Because of the length of the timeout, */
|
|
/* this transition will cause the token to be passed regardless */
|
|
/* of the initial value of FrameCount.) */
|
|
transition_now = true;
|
|
} else {
|
|
if (mstp_port->ReceivedInvalidFrame == true) {
|
|
/* InvalidFrame */
|
|
/* error in frame reception */
|
|
mstp_port->ReceivedInvalidFrame = false;
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
transition_now = true;
|
|
} else if (mstp_port->ReceivedValidFrame == true) {
|
|
if (mstp_port->DestinationAddress ==
|
|
mstp_port->This_Station) {
|
|
switch (mstp_port->TxFrameType) {
|
|
case FRAME_TYPE_REPLY_POSTPONED:
|
|
/* ReceivedReplyPostponed */
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
break;
|
|
case FRAME_TYPE_TEST_RESPONSE:
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
break;
|
|
case FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY:
|
|
/* ReceivedReply */
|
|
/* or a proprietary type that indicates a reply */
|
|
/* indicate successful reception to the higher layers */
|
|
dlmstp_put_receive(mstp_port->SourceAddress, /* source MS/TP address */
|
|
(uint8_t *) & mstp_port->InputBuffer[0],
|
|
mstp_port->DataLength);
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_DONE_WITH_TOKEN;
|
|
break;
|
|
default:
|
|
/* if proprietary frame was expected, you might
|
|
need to transition to DONE WITH TOKEN */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
break;
|
|
}
|
|
} else {
|
|
/* ReceivedUnexpectedFrame */
|
|
/* an unexpected frame was received */
|
|
/* This may indicate the presence of multiple tokens. */
|
|
/* Synchronize with the network. */
|
|
/* This action drops the token. */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
}
|
|
mstp_port->ReceivedValidFrame = false;
|
|
transition_now = true;
|
|
}
|
|
}
|
|
break;
|
|
/* The DONE_WITH_TOKEN state either sends another data frame, */
|
|
/* passes the token, or initiates a Poll For Master cycle. */
|
|
case MSTP_MASTER_STATE_DONE_WITH_TOKEN:
|
|
/* SendAnotherFrame */
|
|
if (mstp_port->FrameCount < mstp_port->Nmax_info_frames) {
|
|
/* then this node may send another information frame */
|
|
/* before passing the token. */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_USE_TOKEN;
|
|
transition_now = true;
|
|
}
|
|
/* Npoll changed in Errata SSPC-135-2004 */
|
|
else if (mstp_port->TokenCount < (Npoll - 1)) {
|
|
if ((mstp_port->SoleMaster == true) &&
|
|
(mstp_port->Next_Station != next_this_station)) {
|
|
/* SoleMaster */
|
|
/* there are no other known master nodes to */
|
|
/* which the token may be sent (true master-slave operation). */
|
|
mstp_port->FrameCount = 0;
|
|
mstp_port->TokenCount++;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_USE_TOKEN;
|
|
transition_now = true;
|
|
} else {
|
|
/* SendToken */
|
|
/* Npoll changed in Errata SSPC-135-2004 */
|
|
/* The comparison of NS and TS+1 eliminates the Poll For Master */
|
|
/* if there are no addresses between TS and NS, since there is no */
|
|
/* address at which a new master node may be found in that case. */
|
|
mstp_port->TokenCount++;
|
|
/* transmit a Token frame to NS */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_TOKEN,
|
|
mstp_port->Next_Station,
|
|
mstp_port->This_Station, NULL, 0);
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->EventCount = 0;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_PASS_TOKEN;
|
|
}
|
|
} else if (next_poll_station == mstp_port->Next_Station) {
|
|
if (mstp_port->SoleMaster == true) {
|
|
/* SoleMasterRestartMaintenancePFM */
|
|
mstp_port->Poll_Station = next_poll_station;
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_POLL_FOR_MASTER, mstp_port->Poll_Station,
|
|
mstp_port->This_Station, NULL, 0);
|
|
/* no known successor node */
|
|
mstp_port->Next_Station = mstp_port->This_Station;
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->TokenCount = 1; /* changed in Errata SSPC-135-2004 */
|
|
/* mstp_port->EventCount = 0; removed in Addendum 135-2004d-8 */
|
|
/* find a new successor to TS */
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_POLL_FOR_MASTER;
|
|
} else {
|
|
/* ResetMaintenancePFM */
|
|
mstp_port->Poll_Station = mstp_port->This_Station;
|
|
/* transmit a Token frame to NS */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_TOKEN,
|
|
mstp_port->Next_Station,
|
|
mstp_port->This_Station, NULL, 0);
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->TokenCount = 1; /* changed in Errata SSPC-135-2004 */
|
|
mstp_port->EventCount = 0;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_PASS_TOKEN;
|
|
}
|
|
} else {
|
|
/* SendMaintenancePFM */
|
|
mstp_port->Poll_Station = next_poll_station;
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_POLL_FOR_MASTER,
|
|
mstp_port->Poll_Station, mstp_port->This_Station, NULL, 0);
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_POLL_FOR_MASTER;
|
|
}
|
|
break;
|
|
/* The PASS_TOKEN state listens for a successor to begin using */
|
|
/* the token that this node has just attempted to pass. */
|
|
case MSTP_MASTER_STATE_PASS_TOKEN:
|
|
if (mstp_port->SilenceTimer < Tusage_timeout) {
|
|
if (mstp_port->EventCount > Nmin_octets) {
|
|
/* SawTokenUser */
|
|
/* Assume that a frame has been sent by the new token user. */
|
|
/* Enter the IDLE state to process the frame. */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
transition_now = true;
|
|
}
|
|
} else {
|
|
if (mstp_port->RetryCount < Nretry_token) {
|
|
/* RetrySendToken */
|
|
mstp_port->RetryCount++;
|
|
/* Transmit a Token frame to NS */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_TOKEN,
|
|
mstp_port->Next_Station, mstp_port->This_Station, NULL,
|
|
0);
|
|
mstp_port->EventCount = 0;
|
|
/* re-enter the current state to listen for NS */
|
|
/* to begin using the token. */
|
|
} else {
|
|
/* FindNewSuccessor */
|
|
/* Assume that NS has failed. */
|
|
mstp_port->Poll_Station = next_next_station;
|
|
/* Transmit a Poll For Master frame to PS. */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_POLL_FOR_MASTER,
|
|
mstp_port->Poll_Station, mstp_port->This_Station, NULL,
|
|
0);
|
|
/* no known successor node */
|
|
mstp_port->Next_Station = mstp_port->This_Station;
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->TokenCount = 0;
|
|
/* mstp_port->EventCount = 0; removed in Addendum 135-2004d-8 */
|
|
/* find a new successor to TS */
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_POLL_FOR_MASTER;
|
|
}
|
|
}
|
|
break;
|
|
/* The NO_TOKEN state is entered if mstp_port->SilenceTimer becomes greater */
|
|
/* than Tno_token, indicating that there has been no network activity */
|
|
/* for that period of time. The timeout is continued to determine */
|
|
/* whether or not this node may create a token. */
|
|
case MSTP_MASTER_STATE_NO_TOKEN:
|
|
my_timeout = Tno_token + (Tslot * mstp_port->This_Station);
|
|
if (mstp_port->SilenceTimer < my_timeout) {
|
|
if (mstp_port->EventCount > Nmin_octets) {
|
|
/* SawFrame */
|
|
/* Some other node exists at a lower address. */
|
|
/* Enter the IDLE state to receive and process the incoming frame. */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
transition_now = true;
|
|
}
|
|
} else {
|
|
ns_timeout =
|
|
Tno_token + (Tslot * (mstp_port->This_Station + 1));
|
|
if (mstp_port->SilenceTimer < ns_timeout) {
|
|
/* GenerateToken */
|
|
/* Assume that this node is the lowest numerical address */
|
|
/* on the network and is empowered to create a token. */
|
|
mstp_port->Poll_Station = next_this_station;
|
|
/* Transmit a Poll For Master frame to PS. */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_POLL_FOR_MASTER,
|
|
mstp_port->Poll_Station, mstp_port->This_Station, NULL,
|
|
0);
|
|
/* indicate that the next station is unknown */
|
|
mstp_port->Next_Station = mstp_port->This_Station;
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->TokenCount = 0;
|
|
/* mstp_port->EventCount = 0; removed Addendum 135-2004d-8 */
|
|
/* enter the POLL_FOR_MASTER state to find a new successor to TS. */
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_POLL_FOR_MASTER;
|
|
}
|
|
}
|
|
break;
|
|
/* In the POLL_FOR_MASTER state, the node listens for a reply to */
|
|
/* a previously sent Poll For Master frame in order to find */
|
|
/* a successor node. */
|
|
case MSTP_MASTER_STATE_POLL_FOR_MASTER:
|
|
if (mstp_port->ReceivedValidFrame == true) {
|
|
if ((mstp_port->DestinationAddress == mstp_port->This_Station)
|
|
&& (mstp_port->FrameType ==
|
|
FRAME_TYPE_REPLY_TO_POLL_FOR_MASTER)) {
|
|
/* ReceivedReplyToPFM */
|
|
mstp_port->SoleMaster = false;
|
|
mstp_port->Next_Station = mstp_port->SourceAddress;
|
|
mstp_port->EventCount = 0;
|
|
/* Transmit a Token frame to NS */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_TOKEN,
|
|
mstp_port->Next_Station, mstp_port->This_Station, NULL,
|
|
0);
|
|
mstp_port->Poll_Station = mstp_port->This_Station;
|
|
mstp_port->TokenCount = 0;
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_PASS_TOKEN;
|
|
} else {
|
|
/* ReceivedUnexpectedFrame */
|
|
/* An unexpected frame was received. */
|
|
/* This may indicate the presence of multiple tokens. */
|
|
/* enter the IDLE state to synchronize with the network. */
|
|
/* This action drops the token. */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
transition_now = true;
|
|
}
|
|
mstp_port->ReceivedValidFrame = false;
|
|
} else if ((mstp_port->SilenceTimer >= Tusage_timeout) ||
|
|
(mstp_port->ReceivedInvalidFrame == true)) {
|
|
if (mstp_port->SoleMaster == true) {
|
|
/* SoleMaster */
|
|
/* There was no valid reply to the periodic poll */
|
|
/* by the sole known master for other masters. */
|
|
mstp_port->FrameCount = 0;
|
|
/* mstp_port->TokenCount++; removed in 2004 */
|
|
mstp_port->master_state = MSTP_MASTER_STATE_USE_TOKEN;
|
|
transition_now = true;
|
|
} else {
|
|
if (mstp_port->Next_Station != mstp_port->This_Station) {
|
|
/* DoneWithPFM */
|
|
/* There was no valid reply to the maintenance */
|
|
/* poll for a master at address PS. */
|
|
mstp_port->EventCount = 0;
|
|
/* transmit a Token frame to NS */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_TOKEN,
|
|
mstp_port->Next_Station, mstp_port->This_Station,
|
|
NULL, 0);
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_PASS_TOKEN;
|
|
} else {
|
|
if (next_poll_station != mstp_port->This_Station) {
|
|
/* SendNextPFM */
|
|
mstp_port->Poll_Station = next_poll_station;
|
|
/* Transmit a Poll For Master frame to PS. */
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_POLL_FOR_MASTER,
|
|
mstp_port->Poll_Station,
|
|
mstp_port->This_Station, NULL, 0);
|
|
mstp_port->RetryCount = 0;
|
|
/* Re-enter the current state. */
|
|
} else {
|
|
/* DeclareSoleMaster */
|
|
/* to indicate that this station is the only master */
|
|
mstp_port->SoleMaster = true;
|
|
mstp_port->FrameCount = 0;
|
|
mstp_port->master_state =
|
|
MSTP_MASTER_STATE_USE_TOKEN;
|
|
transition_now = true;
|
|
}
|
|
}
|
|
}
|
|
mstp_port->ReceivedInvalidFrame = false;
|
|
}
|
|
break;
|
|
/* The ANSWER_DATA_REQUEST state is entered when a */
|
|
/* BACnet Data Expecting Reply, a Test_Request, or */
|
|
/* a proprietary frame that expects a reply is received. */
|
|
case MSTP_MASTER_STATE_ANSWER_DATA_REQUEST:
|
|
/* FIXME: if we knew the APDU type received, we could
|
|
see if the next message was that same APDU type */
|
|
/* FIXME: we could always defer the reply to be safe */
|
|
if ((mstp_port->SilenceTimer <= Treply_delay) &&
|
|
mstp_port->TxReady) {
|
|
/* Reply */
|
|
/* If a reply is available from the higher layers */
|
|
/* within Treply_delay after the reception of the */
|
|
/* final octet of the requesting frame */
|
|
/* (the mechanism used to determine this is a local matter), */
|
|
/* then call MSTP_Create_And_Send_Frame to transmit the reply frame */
|
|
/* and enter the IDLE state to wait for the next frame. */
|
|
mstp_port->TxLength = dlmstp_get_send(
|
|
mstp_port->This_Station,
|
|
(uint8_t *)&mstp_port->TxBuffer[0],
|
|
sizeof(mstp_port->TxBuffer),
|
|
0); /* milliseconds to wait for a packet */
|
|
if ((mstp_port->FrameType ==
|
|
FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY)
|
|
&& (mstp_port->TxLength > 0)) {
|
|
RS485_Send_Frame(mstp_port,
|
|
(uint8_t *) & mstp_port->TxBuffer[0],
|
|
mstp_port->TxLength);
|
|
mstp_port->TxReady = false;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
}
|
|
}
|
|
/* DeferredReply */
|
|
/* If no reply will be available from the higher layers */
|
|
/* within Treply_delay after the reception of the */
|
|
/* final octet of the requesting frame (the mechanism */
|
|
/* used to determine this is a local matter), */
|
|
/* then an immediate reply is not possible. */
|
|
/* Any reply shall wait until this node receives the token. */
|
|
/* Call MSTP_Create_And_Send_Frame to transmit a Reply Postponed frame, */
|
|
/* and enter the IDLE state. */
|
|
else {
|
|
MSTP_Create_And_Send_Frame(mstp_port,
|
|
FRAME_TYPE_REPLY_POSTPONED,
|
|
mstp_port->SourceAddress,
|
|
mstp_port->This_Station, NULL, 0);
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
}
|
|
break;
|
|
default:
|
|
mstp_port->master_state = MSTP_MASTER_STATE_IDLE;
|
|
break;
|
|
}
|
|
|
|
return transition_now;
|
|
}
|
|
|
|
/* note: This_Station assumed to be set with the MAC address */
|
|
/* note: Nmax_info_frames assumed to be set (default=1) */
|
|
/* note: Nmax_master assumed to be set (default=127) */
|
|
void MSTP_Init(volatile struct mstp_port_struct_t *mstp_port)
|
|
{
|
|
int i; /*loop counter */
|
|
|
|
if (mstp_port) {
|
|
mstp_port->receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
mstp_port->master_state = MSTP_MASTER_STATE_INITIALIZE;
|
|
mstp_port->ReceiveError = false;
|
|
mstp_port->DataAvailable = false;
|
|
mstp_port->DataRegister = 0;
|
|
mstp_port->DataCRC = 0;
|
|
mstp_port->DataCRC = 0;
|
|
mstp_port->DataLength = 0;
|
|
mstp_port->DestinationAddress = 0;
|
|
mstp_port->EventCount = 0;
|
|
mstp_port->FrameType = FRAME_TYPE_TOKEN;
|
|
mstp_port->FrameCount = 0;
|
|
mstp_port->HeaderCRC = 0;
|
|
mstp_port->Index = 0;
|
|
mstp_port->Index = 0;
|
|
for (i = 0; i < sizeof(mstp_port->InputBuffer); i++) {
|
|
mstp_port->InputBuffer[i] = 0;
|
|
}
|
|
mstp_port->Next_Station = mstp_port->This_Station;
|
|
mstp_port->Poll_Station = mstp_port->This_Station;
|
|
mstp_port->ReceivedInvalidFrame = false;
|
|
mstp_port->ReceivedValidFrame = false;
|
|
mstp_port->RetryCount = 0;
|
|
mstp_port->SilenceTimer = 0;
|
|
/* mstp_port->ReplyPostponedTimer = 0; */
|
|
mstp_port->SoleMaster = false;
|
|
mstp_port->SourceAddress = 0;
|
|
mstp_port->TokenCount = 0;
|
|
mstp_port->Lurking = false;
|
|
#if 0
|
|
/* these are adjustable, so should already be set */
|
|
mstp_port->Nmax_info_frames = DEFAULT_MAX_INFO_FRAMES;
|
|
mstp_port->Nmax_master = DEFAULT_MAX_MASTER;
|
|
#endif
|
|
|
|
/* An array of octets, used to store PDU octets prior to being transmitted. */
|
|
/* This array is only used for APDU messages */
|
|
for (i = 0; i < sizeof(mstp_port->TxBuffer); i++) {
|
|
mstp_port->TxBuffer[i] = 0;
|
|
}
|
|
mstp_port->TxLength = 0;
|
|
mstp_port->TxReady = false;
|
|
mstp_port->TxFrameType = 0;
|
|
|
|
}
|
|
}
|
|
|
|
#ifdef TEST
|
|
#include <assert.h>
|
|
#include <string.h>
|
|
#include "ctest.h"
|
|
|
|
/* test stub functions */
|
|
void RS485_Send_Frame(volatile struct mstp_port_struct_t *mstp_port, /* port specific data */
|
|
uint8_t * buffer, /* frame to send (up to 501 bytes of data) */
|
|
uint16_t nbytes)
|
|
{ /* number of bytes of data (up to 501) */
|
|
(void) mstp_port;
|
|
(void) buffer;
|
|
(void) nbytes;
|
|
}
|
|
|
|
#define RING_BUFFER_DATA_SIZE 1
|
|
#define RING_BUFFER_SIZE MAX_MPDU
|
|
static RING_BUFFER Test_Buffer;
|
|
static uint8_t Test_Buffer_Data[RING_BUFFER_DATA_SIZE * RING_BUFFER_SIZE];
|
|
static void Load_Input_Buffer(uint8_t * buffer, size_t len)
|
|
{
|
|
static bool initialized = false; /* tracks our init */
|
|
|
|
|
|
if (!initialized) {
|
|
initialized = true;
|
|
Ringbuf_Init(&Test_Buffer,
|
|
(char *) Test_Buffer_Data,
|
|
RING_BUFFER_DATA_SIZE, RING_BUFFER_SIZE);
|
|
}
|
|
/* empty any the existing data */
|
|
while (!Ringbuf_Empty(&Test_Buffer)) {
|
|
(void) Ringbuf_Pop_Front(&Test_Buffer);
|
|
}
|
|
|
|
if (buffer) {
|
|
while (len) {
|
|
(void) Ringbuf_Put(&Test_Buffer, (char *) buffer);
|
|
len--;
|
|
buffer++;
|
|
}
|
|
}
|
|
}
|
|
|
|
void RS485_Check_UART_Data(volatile struct mstp_port_struct_t *mstp_port)
|
|
{ /* port specific data */
|
|
char *data;
|
|
if (!Ringbuf_Empty(&Test_Buffer) && mstp_port &&
|
|
(mstp_port->DataAvailable == false)) {
|
|
data = Ringbuf_Pop_Front(&Test_Buffer);
|
|
if (data) {
|
|
mstp_port->DataRegister = *data;
|
|
mstp_port->DataAvailable = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
void testReceiveNodeFSM(Test * pTest)
|
|
{
|
|
volatile struct mstp_port_struct_t mstp_port; /* port data */
|
|
unsigned EventCount = 0; /* local counter */
|
|
uint8_t my_mac = 0x05; /* local MAC address */
|
|
uint8_t HeaderCRC = 0; /* for local CRC calculation */
|
|
uint8_t FrameType = 0; /* type of packet that was sent */
|
|
unsigned len; /* used for the size of the message packet */
|
|
size_t i; /* used to loop through the message bytes */
|
|
uint8_t buffer[MAX_MPDU] = { 0 };
|
|
uint8_t data[MAX_MPDU - 8 /*header */ - 2 /*CRC*/] = { 0 };
|
|
|
|
MSTP_Init(&mstp_port, my_mac);
|
|
|
|
/* check the receive error during idle */
|
|
mstp_port.receive_state = MSTP_RECEIVE_STATE_IDLE;
|
|
mstp_port.ReceiveError = true;
|
|
mstp_port.SilenceTimer = 255;
|
|
mstp_port.EventCount = 0;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.ReceiveError == false);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* check for bad packet header */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x11;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* check for good packet header, but timeout */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
/* force the timeout */
|
|
mstp_port.SilenceTimer = Tframe_abort + 1;
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* check for good packet header preamble, but receive error */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
/* force the error */
|
|
mstp_port.ReceiveError = true;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.ReceiveError == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* check for good packet header preamble1, but bad preamble2 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
/* no change of state if no data yet */
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
/* repeated preamble1 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
/* repeated preamble1 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
/* bad data */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x11;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.ReceiveError == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* check for good packet header preamble, but timeout in packet */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
/* preamble2 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0xFF;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 0);
|
|
ct_test(pTest, mstp_port.HeaderCRC == 0xFF);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
/* force the timeout */
|
|
mstp_port.SilenceTimer = Tframe_abort + 1;
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
ct_test(pTest, mstp_port.ReceivedInvalidFrame == true);
|
|
|
|
/* check for good packet header preamble, but error in packet */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
/* preamble2 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0xFF;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 0);
|
|
ct_test(pTest, mstp_port.HeaderCRC == 0xFF);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
/* force the error */
|
|
mstp_port.ReceiveError = true;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.ReceiveError == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* check for good packet header preamble */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x55;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
/* preamble2 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0xFF;
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 0);
|
|
ct_test(pTest, mstp_port.HeaderCRC == 0xFF);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
/* no change of state if no data yet */
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
/* Data is received - index is incremented */
|
|
/* FrameType */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = FRAME_TYPE_TOKEN;
|
|
HeaderCRC = 0xFF;
|
|
HeaderCRC = CRC_Calc_Header(mstp_port.DataRegister, HeaderCRC);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 1);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
ct_test(pTest, FrameType == FRAME_TYPE_TOKEN);
|
|
/* Destination */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0x10;
|
|
HeaderCRC = CRC_Calc_Header(mstp_port.DataRegister, HeaderCRC);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 2);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
ct_test(pTest, mstp_port.DestinationAddress == 0x10);
|
|
/* Source */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = my_mac;
|
|
HeaderCRC = CRC_Calc_Header(mstp_port.DataRegister, HeaderCRC);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 3);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
ct_test(pTest, mstp_port.SourceAddress == my_mac);
|
|
/* Length1 = length*256 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0;
|
|
HeaderCRC = CRC_Calc_Header(mstp_port.DataRegister, HeaderCRC);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 4);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
ct_test(pTest, mstp_port.DataLength == 0);
|
|
/* Length2 */
|
|
mstp_port.DataAvailable = true;
|
|
mstp_port.DataRegister = 0;
|
|
HeaderCRC = CRC_Calc_Header(mstp_port.DataRegister, HeaderCRC);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 5);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER);
|
|
ct_test(pTest, mstp_port.DataLength == 0);
|
|
/* HeaderCRC */
|
|
mstp_port.DataAvailable = true;
|
|
ct_test(pTest, HeaderCRC == 0x73); /* per Annex G example */
|
|
mstp_port.DataRegister = ~HeaderCRC; /* one's compliment of CRC is sent */
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
ct_test(pTest, mstp_port.Index == 5);
|
|
ct_test(pTest,
|
|
mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER_CRC);
|
|
ct_test(pTest, mstp_port.HeaderCRC == 0x55);
|
|
/* NotForUs */
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* BadCRC in header check */
|
|
mstp_port.ReceivedInvalidFrame = false;
|
|
mstp_port.ReceivedValidFrame = false;
|
|
len = MSTP_Create_Frame(buffer, sizeof(buffer), FRAME_TYPE_TOKEN, 0x10, /* destination */
|
|
my_mac, /* source */
|
|
NULL, /* data */
|
|
0); /* data size */
|
|
ct_test(pTest, len > 0);
|
|
/* make the header CRC bad */
|
|
buffer[7] = 0x00;
|
|
Load_Input_Buffer(buffer, len);
|
|
for (i = 0; i < len; i++) {
|
|
RS485_Check_UART_Data(&mstp_port);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
}
|
|
ct_test(pTest,
|
|
mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER_CRC);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.ReceivedInvalidFrame == true);
|
|
ct_test(pTest, mstp_port.ReceivedValidFrame == false);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* NoData for us */
|
|
mstp_port.ReceivedInvalidFrame = false;
|
|
mstp_port.ReceivedValidFrame = false;
|
|
len = MSTP_Create_Frame(buffer, sizeof(buffer), FRAME_TYPE_TOKEN, my_mac, /* destination */
|
|
my_mac, /* source */
|
|
NULL, /* data */
|
|
0); /* data size */
|
|
ct_test(pTest, len > 0);
|
|
Load_Input_Buffer(buffer, len);
|
|
for (i = 0; i < len; i++) {
|
|
RS485_Check_UART_Data(&mstp_port);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
}
|
|
ct_test(pTest,
|
|
mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER_CRC);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.ReceivedInvalidFrame == false);
|
|
ct_test(pTest, mstp_port.ReceivedValidFrame == true);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* FrameTooLong */
|
|
mstp_port.ReceivedInvalidFrame = false;
|
|
mstp_port.ReceivedValidFrame = false;
|
|
len = MSTP_Create_Frame(buffer, sizeof(buffer), FRAME_TYPE_TOKEN, my_mac, /* destination */
|
|
my_mac, /* source */
|
|
NULL, /* data */
|
|
0); /* data size */
|
|
ct_test(pTest, len > 0);
|
|
/* make the header data length bad */
|
|
buffer[5] = 0x02;
|
|
Load_Input_Buffer(buffer, len);
|
|
for (i = 0; i < len; i++) {
|
|
RS485_Check_UART_Data(&mstp_port);
|
|
INCREMENT_AND_LIMIT_UINT8(EventCount);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.DataAvailable == false);
|
|
ct_test(pTest, mstp_port.SilenceTimer == 0);
|
|
ct_test(pTest, mstp_port.EventCount == EventCount);
|
|
}
|
|
ct_test(pTest,
|
|
mstp_port.receive_state == MSTP_RECEIVE_STATE_HEADER_CRC);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
ct_test(pTest, mstp_port.ReceivedInvalidFrame == true);
|
|
ct_test(pTest, mstp_port.ReceivedValidFrame == false);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
/* Data */
|
|
mstp_port.ReceivedInvalidFrame = false;
|
|
mstp_port.ReceivedValidFrame = false;
|
|
memset(data, 0, sizeof(data));
|
|
len = MSTP_Create_Frame(buffer, sizeof(buffer), FRAME_TYPE_PROPRIETARY_MIN, my_mac, /* destination */
|
|
my_mac, /* source */
|
|
data, /* data */
|
|
sizeof(data)); /* data size */
|
|
ct_test(pTest, len > 0);
|
|
Load_Input_Buffer(buffer, len);
|
|
RS485_Check_UART_Data(&mstp_port);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
while (mstp_port.receive_state != MSTP_RECEIVE_STATE_IDLE) {
|
|
RS485_Check_UART_Data(&mstp_port);
|
|
MSTP_Receive_Frame_FSM(&mstp_port);
|
|
}
|
|
ct_test(pTest, mstp_port.DataLength == sizeof(data));
|
|
ct_test(pTest, mstp_port.ReceivedInvalidFrame == false);
|
|
ct_test(pTest, mstp_port.ReceivedValidFrame == true);
|
|
ct_test(pTest, mstp_port.receive_state == MSTP_RECEIVE_STATE_IDLE);
|
|
|
|
return;
|
|
}
|
|
|
|
void testMasterNodeFSM(Test * pTest)
|
|
{
|
|
volatile struct mstp_port_struct_t mstp_port; /* port data */
|
|
uint8_t my_mac = 0x05; /* local MAC address */
|
|
|
|
MSTP_Init(&mstp_port, my_mac);
|
|
ct_test(pTest, mstp_port.master_state == MSTP_MASTER_STATE_INITIALIZE);
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
#ifdef TEST_MSTP
|
|
int main(void)
|
|
{
|
|
Test *pTest;
|
|
bool rc;
|
|
|
|
pTest = ct_create("mstp", NULL);
|
|
|
|
/* individual tests */
|
|
rc = ct_addTestFunction(pTest, testReceiveNodeFSM);
|
|
assert(rc);
|
|
rc = ct_addTestFunction(pTest, testMasterNodeFSM);
|
|
assert(rc);
|
|
|
|
ct_setStream(pTest, stdout);
|
|
ct_run(pTest);
|
|
(void) ct_report(pTest);
|
|
|
|
ct_destroy(pTest);
|
|
|
|
return 0;
|
|
}
|
|
#endif
|