dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e3ef352f2d76ba98a04cebd4e507fbf56b4be677
bacnet_stack/ports/linux/dlmstp.c
T

1242 lines
38 KiB
C
Raw Blame History

/**
* @file
* @brief Provides Linux-specific DataLink functions for MS/TP.
* @author Steve Karg <skarg@users.sourceforge.net>
* @author Nikola Jelic 2011 <nikola.jelic@euroicc.com>
* @date 2008
* @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0
*/
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <sys/time.h>
/* BACnet Stack defines - first */
#include "bacnet/bacdef.h"
/* BACnet Stack API */
#include "bacnet/bacaddr.h"
#include "bacnet/npdu.h"
#include "bacnet/datalink/mstp.h"
#include "bacnet/datalink/dlmstp.h"
#include "bacnet/basic/sys/ringbuf.h"
#include "bacnet/basic/sys/debug.h"
#include "bacnet/basic/sys/mstimer.h"
/* OS Specific include */
#include "bacport.h"
/* port specific */
#include "rs485.h"
/* packet queues */
#ifndef MSTP_RECEIVE_PACKET_COUNT
#define MSTP_RECEIVE_PACKET_COUNT 8
#endif
static DLMSTP_PACKET Receive_Buffer[MSTP_RECEIVE_PACKET_COUNT];
static RING_BUFFER Receive_Queue;
/* mechanism to wait for a packet */
static pthread_cond_t Receive_Packet_Flag;
static pthread_mutex_t Receive_Packet_Mutex;
static pthread_cond_t Received_Frame_Flag;
static pthread_mutex_t Received_Frame_Mutex;
static pthread_cond_t Master_Done_Flag;
static pthread_mutex_t Master_Done_Mutex;
static pthread_mutex_t Ring_Buffer_Mutex;
static pthread_mutex_t Thread_Mutex;
static pthread_t hThread;
static struct timespec Clock_Get_Time_Start;
static bool Thread_Run;
/* local MS/TP port data - shared with RS-485 */
static struct mstp_port_struct_t MSTP_Port;
/* buffers needed by mstp port struct */
static uint8_t TxBuffer[DLMSTP_MPDU_MAX];
static uint8_t RxBuffer[DLMSTP_MPDU_MAX];
/* data structure for MS/TP PDU Queue */
struct mstp_pdu_packet {
bool data_expecting_reply;
uint8_t destination_mac;
uint16_t length;
uint8_t buffer[DLMSTP_MPDU_MAX];
};
/* count must be a power of 2 for ringbuf library */
#ifndef MSTP_PDU_PACKET_COUNT
#define MSTP_PDU_PACKET_COUNT 8
#endif
static struct mstp_pdu_packet PDU_Buffer[MSTP_PDU_PACKET_COUNT];
static RING_BUFFER PDU_Queue;
/* local timer for tracking silence on the wire */
static struct mstimer Silence_Timer;
/* local timer for tracking the last valid frame on the wire */
static struct mstimer Valid_Frame_Timer;
/* callbacks for monitoring */
static dlmstp_hook_frame_rx_start_cb Preamble_Callback;
static dlmstp_hook_frame_rx_complete_cb Valid_Frame_Rx_Callback;
static dlmstp_hook_frame_rx_complete_cb Valid_Frame_Not_For_Us_Rx_Callback;
static dlmstp_hook_frame_rx_complete_cb Invalid_Frame_Rx_Callback;
static DLMSTP_STATISTICS DLMSTP_Statistics;
static bool DLMSTP_Initialized;
/**
* @brief Cleanup the MS/TP datalink
*/
void dlmstp_cleanup(void)
{
pthread_mutex_lock(&Thread_Mutex);
Thread_Run = false;
pthread_mutex_unlock(&Thread_Mutex);
pthread_join(hThread, NULL);
pthread_cond_destroy(&Received_Frame_Flag);
pthread_cond_destroy(&Receive_Packet_Flag);
pthread_cond_destroy(&Master_Done_Flag);
pthread_mutex_destroy(&Received_Frame_Mutex);
pthread_mutex_destroy(&Receive_Packet_Mutex);
pthread_mutex_destroy(&Master_Done_Mutex);
pthread_mutex_destroy(&Ring_Buffer_Mutex);
DLMSTP_Initialized = false;
}
/**
* @brief send an PDU via MSTP
* @param dest - BACnet destination address
* @param npdu_data - network layer information
* @param pdu - PDU data to send
* @param pdu_len - number of bytes of PDU data to send
* @return number of bytes sent on success, zero on failure
*/
int dlmstp_send_pdu(
BACNET_ADDRESS *dest,
BACNET_NPDU_DATA *npdu_data,
uint8_t *pdu,
unsigned pdu_len)
{
int bytes_sent = 0;
struct mstp_pdu_packet *pkt;
unsigned i = 0;
pthread_mutex_lock(&Ring_Buffer_Mutex);
pkt = (struct mstp_pdu_packet *)Ringbuf_Data_Peek(&PDU_Queue);
if (pkt) {
pkt->data_expecting_reply = npdu_data->data_expecting_reply;
for (i = 0; i < pdu_len; i++) {
pkt->buffer[i] = pdu[i];
}
pkt->length = pdu_len;
if (dest && dest->mac_len) {
pkt->destination_mac = dest->mac[0];
} else {
/* mac_len = 0 is a broadcast address */
pkt->destination_mac = MSTP_BROADCAST_ADDRESS;
}
if (Ringbuf_Data_Put(&PDU_Queue, (uint8_t *)pkt)) {
bytes_sent = pdu_len;
}
}
pthread_mutex_unlock(&Ring_Buffer_Mutex);
if (!pkt) {
debug_printf("DLMSTP: PDU Queue Full!\n");
}
return bytes_sent;
}
/**
* @brief The MS/TP state machine uses this function for getting data to send
* @param mstp_port - specific MSTP port that is used for this datalink
* @param timeout - number of milliseconds to wait for the data
* @return amount of PDU data
*/
uint16_t MSTP_Get_Send(struct mstp_port_struct_t *mstp_port, unsigned timeout)
{ /* milliseconds to wait for a packet */
uint16_t pdu_len = 0;
uint8_t frame_type = 0;
struct mstp_pdu_packet *pkt;
(void)timeout;
pthread_mutex_lock(&Ring_Buffer_Mutex);
if (Ringbuf_Empty(&PDU_Queue)) {
pthread_mutex_unlock(&Ring_Buffer_Mutex);
return 0;
}
pkt = (struct mstp_pdu_packet *)Ringbuf_Peek(&PDU_Queue);
if (pkt->data_expecting_reply) {
frame_type = FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY;
} else {
frame_type = FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY;
}
/* convert the PDU into the MSTP Frame */
pdu_len = MSTP_Create_Frame(
&mstp_port->OutputBuffer[0], /* <-- loading this */
mstp_port->OutputBufferSize, frame_type, pkt->destination_mac,
mstp_port->This_Station, (uint8_t *)&pkt->buffer[0], pkt->length);
(void)Ringbuf_Pop(&PDU_Queue, NULL);
pthread_mutex_unlock(&Ring_Buffer_Mutex);
return pdu_len;
}
/**
* @brief Determine if the reply packet is the data expected
* @param request_pdu - PDU of the data
* @param request_pdu_len - number of bytes of PDU data
* @param src_address - source address of the request
* @param reply_pdu - PDU of the data
* @param reply_pdu_len - number of bytes of PDU data
* @param dest_address - the destination address for this data
* @return true if the reply packet is the data expected
*/
static bool dlmstp_compare_data_expecting_reply(
const uint8_t *request_pdu,
uint16_t request_pdu_len,
uint8_t src_address,
const uint8_t *reply_pdu,
uint16_t reply_pdu_len,
uint8_t dest_address)
{
uint16_t offset;
/* One way to check the message is to compare NPDU
src, dest, along with the APDU type, invoke id.
Seems a bit overkill */
struct DER_compare_t {
BACNET_NPDU_DATA npdu_data;
BACNET_ADDRESS address;
uint8_t pdu_type;
uint8_t invoke_id;
uint8_t service_choice;
};
struct DER_compare_t request;
struct DER_compare_t reply;
/* unused parameters */
(void)request_pdu_len;
(void)reply_pdu_len;
/* decode the request data */
request.address.mac[0] = src_address;
request.address.mac_len = 1;
offset = (uint16_t)bacnet_npdu_decode(
request_pdu, request_pdu_len, NULL, &request.address,
&request.npdu_data);
if (request.npdu_data.network_layer_message) {
debug_printf("DLMSTP: DER Compare failed: "
"Request is Network message.\n");
return false;
}
request.pdu_type = request_pdu[offset] & 0xF0;
if (request.pdu_type != PDU_TYPE_CONFIRMED_SERVICE_REQUEST) {
debug_printf("DLMSTP: DER Compare failed: "
"Not Confirmed Request.\n");
return false;
}
request.invoke_id = request_pdu[offset + 2];
/* segmented message? */
if (request_pdu[offset] & BIT(3)) {
request.service_choice = request_pdu[offset + 5];
} else {
request.service_choice = request_pdu[offset + 3];
}
/* decode the reply data */
reply.address.mac[0] = dest_address;
reply.address.mac_len = 1;
offset = (uint16_t)bacnet_npdu_decode(
reply_pdu, reply_pdu_len, &reply.address, NULL, &reply.npdu_data);
if (reply.npdu_data.network_layer_message) {
debug_printf("DLMSTP: DER Compare failed: "
"Reply is Network message.\n");
return false;
}
/* reply could be a lot of things:
confirmed, simple ack, abort, reject, error */
reply.pdu_type = reply_pdu[offset] & 0xF0;
switch (reply.pdu_type) {
case PDU_TYPE_SIMPLE_ACK:
reply.invoke_id = reply_pdu[offset + 1];
reply.service_choice = reply_pdu[offset + 2];
break;
case PDU_TYPE_COMPLEX_ACK:
reply.invoke_id = reply_pdu[offset + 1];
/* segmented message? */
if (reply_pdu[offset] & BIT(3)) {
reply.service_choice = reply_pdu[offset + 4];
} else {
reply.service_choice = reply_pdu[offset + 2];
}
break;
case PDU_TYPE_ERROR:
reply.invoke_id = reply_pdu[offset + 1];
reply.service_choice = reply_pdu[offset + 2];
break;
case PDU_TYPE_REJECT:
case PDU_TYPE_ABORT:
case PDU_TYPE_SEGMENT_ACK:
reply.invoke_id = reply_pdu[offset + 1];
break;
default:
/* A queued request, just look for another */
return false;
}
if (request.invoke_id != reply.invoke_id) {
/* Normal to have multiple replies queued, just look for another */
return false;
}
/* these don't have service choice included */
if ((request.pdu_type != PDU_TYPE_REJECT) &&
(request.pdu_type != PDU_TYPE_ABORT) &&
(request.pdu_type != PDU_TYPE_SEGMENT_ACK)) {
if (request.service_choice != reply.service_choice) {
debug_printf("DLMSTP: DER Compare failed: "
"Service choice mismatch.\n");
return false;
}
}
if (request.npdu_data.protocol_version !=
reply.npdu_data.protocol_version) {
debug_printf("DLMSTP: DER Compare failed: "
"NPDU Protocol Version mismatch.\n");
return false;
}
#if 0
/* the NDPU priority doesn't get passed through the stack, and
all outgoing messages have NORMAL priority */
if (request.npdu_data.priority != reply.npdu_data.priority) {
debug_printf(
"DLMSTP: DER Compare failed: " "NPDU Priority mismatch.\n");
return false;
}
#endif
if (!bacnet_address_same(&request.address, &reply.address)) {
debug_printf("DLMSTP: DER Compare failed: "
"BACnet Address mismatch.\n");
return false;
}
return true;
}
/**
* Add a certain number of nanoseconds to the specified time.
*
* @param ts - The time to which to add to.
* @param ns - The number of nanoseconds to add. Allowed range
* is -NS_PER_S..NS_PER_S (i.e., plus minus one second).
*/
static void timespec_add_ns(struct timespec *ts, long ns)
{
/* nano-seconds per second */
const long NS_PER_S = 1000000000L;
ts->tv_nsec += ns;
if (ts->tv_nsec > NS_PER_S) {
ts->tv_nsec -= NS_PER_S;
ts->tv_sec += 1;
} else if (ts->tv_nsec < 0) {
ts->tv_nsec += NS_PER_S;
ts->tv_sec -= 1;
}
}
/**
* @brief Get abstime for use in thread
* @param abstime - place to put the absolute time
* @param milliseconds - number of milliseconds to add
*/
static void get_abstime(struct timespec *abstime, unsigned long milliseconds)
{
clock_gettime(CLOCK_MONOTONIC, abstime);
if (milliseconds > 1000) {
fprintf(
stderr, "DLMSTP: limited timeout of %lums to 1000ms\n",
milliseconds);
milliseconds = 1000;
}
timespec_add_ns(abstime, 1000000 * milliseconds);
}
static void millisleep(const unsigned long milliseconds)
{
struct timespec abstime;
get_abstime(&abstime, milliseconds);
while (EINTR ==
clock_nanosleep(CLOCK_MONOTONIC, TIMER_ABSTIME, &abstime, NULL)) { }
}
/**
* @brief The MS/TP state machine uses this function for getting data to send
* as the reply to a DATA_EXPECTING_REPLY frame, or nothing
* @param mstp_port MSTP port structure for this port
* @param timeout number of milliseconds to wait for a packet
* @return number of bytes, or 0 if no reply is available
*/
uint16_t MSTP_Get_Reply(struct mstp_port_struct_t *mstp_port, unsigned timeout)
{
uint16_t pdu_len = 0;
bool matched = false;
uint8_t frame_type = 0;
struct mstp_pdu_packet *pkt;
(void)timeout;
pthread_mutex_lock(&Ring_Buffer_Mutex);
for (pkt = (struct mstp_pdu_packet *)Ringbuf_Peek(&PDU_Queue); pkt;
pkt = (struct mstp_pdu_packet *)Ringbuf_Peek_Next(
&PDU_Queue, (uint8_t *)pkt)) {
/* is this the reply to the DER? */
matched = dlmstp_compare_data_expecting_reply(
&mstp_port->InputBuffer[0], mstp_port->DataLength,
mstp_port->SourceAddress, (uint8_t *)&pkt->buffer[0], pkt->length,
pkt->destination_mac);
if (matched) {
break;
}
}
if (matched) {
if (pkt->data_expecting_reply) {
frame_type = FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY;
} else {
frame_type = FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY;
}
/* convert the PDU into the MSTP Frame */
pdu_len = MSTP_Create_Frame(
&mstp_port->OutputBuffer[0], /* <-- loading this */
mstp_port->OutputBufferSize, frame_type, pkt->destination_mac,
mstp_port->This_Station, (uint8_t *)&pkt->buffer[0], pkt->length);
DLMSTP_Statistics.transmit_pdu_counter++;
/* This will pop the element no matter where we found it */
(void)Ringbuf_Pop_Element(&PDU_Queue, (uint8_t *)pkt, NULL);
}
pthread_mutex_unlock(&Ring_Buffer_Mutex);
if (pdu_len <= 0) {
/* Didn't find a match so wait for application layer to provide one */
millisleep(1);
}
return pdu_len;
}
/**
* @brief Send an MSTP frame
* @param mstp_port - port specific data
* @param buffer - data to send
* @param nbytes - number of bytes of data to send
*/
void MSTP_Send_Frame(
struct mstp_port_struct_t *mstp_port,
const uint8_t *buffer,
uint16_t nbytes)
{
RS485_Send_Frame(mstp_port, buffer, nbytes);
DLMSTP_Statistics.transmit_frame_counter++;
}
/**
* @brief MS/TP state machine received a frame
* @return number of bytes queued, or 0 if unable to be queued
*/
uint16_t MSTP_Put_Receive(struct mstp_port_struct_t *mstp_port)
{
uint16_t pdu_len = 0;
DLMSTP_PACKET *pkt;
pthread_mutex_lock(&Receive_Packet_Mutex);
pkt = (DLMSTP_PACKET *)Ringbuf_Data_Peek(&Receive_Queue);
if (!pkt) {
debug_printf("MS/TP: Dropped! Not Ready.\n");
} else {
/* bounds check - maybe this should send an abort? */
pdu_len = mstp_port->DataLength;
if (pdu_len > sizeof(pkt->pdu)) {
pdu_len = sizeof(pkt->pdu);
}
if (pdu_len == 0) {
debug_printf("MS/TP: PDU Length is 0!\n");
}
memmove(
(void *)&pkt->pdu[0], (void *)&mstp_port->InputBuffer[0], pdu_len);
dlmstp_fill_bacnet_address(&pkt->address, mstp_port->SourceAddress);
pkt->pdu_len = mstp_port->DataLength;
pkt->ready = true;
if (Ringbuf_Data_Put(&Receive_Queue, (uint8_t *)pkt)) {
pthread_cond_signal(&Receive_Packet_Flag);
}
}
pthread_mutex_unlock(&Receive_Packet_Mutex);
return pdu_len;
}
/**
* @brief Run the MS/TP state machines, and get packet if available
* @param pdu - place to put PDU data for the caller
* @param max_pdu - number of bytes of PDU data that caller can receive
* @return number of bytes in received packet, or 0 if no packet was received
*/
uint16_t dlmstp_receive(
BACNET_ADDRESS *src, /* source address */
uint8_t *pdu, /* PDU data */
uint16_t max_pdu, /* amount of space available in the PDU */
unsigned timeout)
{ /* milliseconds to wait for a packet */
uint16_t pdu_len = 0;
struct timespec abstime;
DLMSTP_PACKET *pkt;
(void)max_pdu;
pthread_mutex_lock(&Receive_Packet_Mutex);
if (timeout > 0) {
get_abstime(&abstime, timeout);
pthread_cond_timedwait(
&Receive_Packet_Flag, &Receive_Packet_Mutex, &abstime);
}
/* see if there is a packet available, and a place
to put the reply (if necessary) and process it */
pkt = (DLMSTP_PACKET *)Ringbuf_Peek(&Receive_Queue);
if (pkt) {
if (pkt->pdu_len) {
DLMSTP_Statistics.receive_pdu_counter++;
if (src) {
memmove(src, &pkt->address, sizeof(pkt->address));
}
if (pdu) {
memmove(pdu, &pkt->pdu, sizeof(pkt->pdu));
}
pdu_len = pkt->pdu_len;
}
pkt->ready = false;
(void)Ringbuf_Pop(&Receive_Queue, NULL);
}
pthread_mutex_unlock(&Receive_Packet_Mutex);
return pdu_len;
}
/**
* @brief Thread for the MS/TP state machines
* @param pArg not used
*/
static void *dlmstp_thread(void *pArg)
{
uint32_t silence_milliseconds = 0;
bool run_master = false;
bool thread_alive = true;
bool run_loop;
MSTP_MASTER_STATE master_state;
(void)pArg;
while (thread_alive) {
/* only do receive state machine while we don't have a frame */
if ((MSTP_Port.ReceivedValidFrame == false) &&
(MSTP_Port.ReceivedValidFrameNotForUs == false) &&
(MSTP_Port.ReceivedInvalidFrame == false)) {
RS485_Check_UART_Data(&MSTP_Port);
MSTP_Receive_Frame_FSM(&MSTP_Port);
if (MSTP_Port.receive_state == MSTP_RECEIVE_STATE_PREAMBLE) {
if (Preamble_Callback) {
Preamble_Callback();
}
}
}
if (MSTP_Port.ReceivedValidFrame) {
DLMSTP_Statistics.receive_valid_frame_counter++;
if (MSTP_Port.FrameType == FRAME_TYPE_POLL_FOR_MASTER) {
DLMSTP_Statistics.poll_for_master_counter++;
}
if (Valid_Frame_Rx_Callback) {
Valid_Frame_Rx_Callback(
MSTP_Port.SourceAddress, MSTP_Port.DestinationAddress,
MSTP_Port.FrameType, MSTP_Port.InputBuffer,
MSTP_Port.DataLength);
}
run_master = true;
} else if (MSTP_Port.ReceivedValidFrameNotForUs) {
DLMSTP_Statistics.receive_valid_frame_not_for_us_counter++;
if (Valid_Frame_Not_For_Us_Rx_Callback) {
Valid_Frame_Not_For_Us_Rx_Callback(
MSTP_Port.SourceAddress, MSTP_Port.DestinationAddress,
MSTP_Port.FrameType, MSTP_Port.InputBuffer,
MSTP_Port.DataLength);
}
run_master = true;
/* we don't run the master state machine for this frame */
MSTP_Port.ReceivedValidFrameNotForUs = false;
} else if (MSTP_Port.ReceivedInvalidFrame) {
if (Invalid_Frame_Rx_Callback) {
DLMSTP_Statistics.receive_invalid_frame_counter++;
Invalid_Frame_Rx_Callback(
MSTP_Port.SourceAddress, MSTP_Port.DestinationAddress,
MSTP_Port.FrameType, MSTP_Port.InputBuffer,
MSTP_Port.DataLength);
}
run_master = true;
} else {
silence_milliseconds = MSTP_Port.SilenceTimer(&MSTP_Port);
switch (MSTP_Port.master_state) {
case MSTP_MASTER_STATE_IDLE:
if (silence_milliseconds >= Tno_token) {
run_master = true;
}
break;
case MSTP_MASTER_STATE_WAIT_FOR_REPLY:
if (silence_milliseconds >= MSTP_Port.Treply_timeout) {
run_master = true;
}
break;
case MSTP_MASTER_STATE_POLL_FOR_MASTER:
if (silence_milliseconds >= MSTP_Port.Tusage_timeout) {
run_master = true;
}
break;
default:
run_master = true;
break;
}
}
if (run_master) {
run_master = false;
if (MSTP_Port.SlaveNodeEnabled) {
MSTP_Slave_Node_FSM(&MSTP_Port);
} else {
if (MSTP_Port.ZeroConfigEnabled || MSTP_Port.CheckAutoBaud) {
/* if we are in auto baud or zero config mode,
we need to run the master state machine */
} else if (MSTP_Port.This_Station > DEFAULT_MAX_MASTER) {
/* Master node address must be restricted */
continue;
}
master_state = MSTP_Port.master_state;
run_loop = true;
while (run_loop) {
/* wait while some states fast transition */
run_loop = MSTP_Master_Node_FSM(&MSTP_Port);
if (master_state != MSTP_Port.master_state) {
if (MSTP_Port.master_state ==
MSTP_MASTER_STATE_NO_TOKEN) {
DLMSTP_Statistics.lost_token_counter++;
}
master_state = MSTP_Port.master_state;
}
pthread_mutex_lock(&Thread_Mutex);
if (!Thread_Run) {
run_loop = false;
}
pthread_mutex_unlock(&Thread_Mutex);
}
}
}
pthread_mutex_lock(&Thread_Mutex);
thread_alive = Thread_Run;
pthread_mutex_unlock(&Thread_Mutex);
}
return NULL;
}
/**
* @brief Fill a BACnet address with the MSTP address
* @param src the BACnet address to fill
* @param mstp_address the MSTP MAC address
*/
void dlmstp_fill_bacnet_address(BACNET_ADDRESS *src, uint8_t mstp_address)
{
int i = 0;
if (mstp_address == MSTP_BROADCAST_ADDRESS) {
/* mac_len = 0 if broadcast address */
src->mac_len = 0;
src->mac[0] = 0;
} else {
src->mac_len = 1;
src->mac[0] = mstp_address;
}
/* fill with 0's starting with index 1; index 0 filled above */
for (i = 1; i < MAX_MAC_LEN; i++) {
src->mac[i] = 0;
}
src->net = 0;
src->len = 0;
for (i = 0; i < MAX_MAC_LEN; i++) {
src->adr[i] = 0;
}
}
/**
* @brief Set the MSTP MAC address
* @param mac_address - MAC address to set
*/
void dlmstp_set_mac_address(uint8_t mac_address)
{
MSTP_Port.This_Station = mac_address;
}
/**
* @brief Get the MSTP MAC address
* @return MSTP MAC address
*/
uint8_t dlmstp_mac_address(void)
{
return MSTP_Port.This_Station;
}
/**
* @brief Set the Max_Info_Frames parameter value
*
* @note This parameter represents the value of the Max_Info_Frames property
* of the node's Device object. The value of Max_Info_Frames specifies the
* maximum number of information frames the node may send before it must
* pass the token. Max_Info_Frames may have different values on different
* nodes. This may be used to allocate more or less of the available link
* bandwidth to particular nodes. If Max_Info_Frames is not writable in a
* node, its value shall be 1.
*
* @param max_info_frames - parameter value to set
*/
void dlmstp_set_max_info_frames(uint8_t max_info_frames)
{
if (max_info_frames >= 1) {
MSTP_Port.Nmax_info_frames = max_info_frames;
}
return;
}
/**
* @brief Get the MSTP max-info-frames value
* @return the MSTP max-info-frames value
*/
uint8_t dlmstp_max_info_frames(void)
{
return MSTP_Port.Nmax_info_frames;
}
/**
* @brief Set the Max_Master property value for this MSTP datalink
*
* @note This parameter represents the value of the Max_Master property of
* the node's Device object. The value of Max_Master specifies the highest
* allowable address for master nodes. The value of Max_Master shall be
* less than or equal to 127. If Max_Master is not writable in a node,
* its value shall be 127.
*
* @param max_master - value to be set
*/
void dlmstp_set_max_master(uint8_t max_master)
{
if (max_master <= 127) {
MSTP_Port.Nmax_master = max_master;
}
return;
}
/**
* @brief Get the largest peer MAC address that we will seek
* @return largest peer MAC address
*/
uint8_t dlmstp_max_master(void)
{
return MSTP_Port.Nmax_master;
}
/**
* @brief Initialize the data link broadcast address
* @param my_address - address to be filled with unicast designator
*/
void dlmstp_get_my_address(BACNET_ADDRESS *my_address)
{
int i = 0; /* counter */
my_address->mac_len = 1;
my_address->mac[0] = MSTP_Port.This_Station;
my_address->net = 0; /* local only, no routing */
my_address->len = 0;
for (i = 0; i < MAX_MAC_LEN; i++) {
my_address->adr[i] = 0;
}
return;
}
/**
* @brief Initialize the a data link broadcast address
* @param dest - address to be filled with broadcast designator
*/
void dlmstp_get_broadcast_address(BACNET_ADDRESS *dest)
{ /* destination address */
int i = 0; /* counter */
if (dest) {
dest->mac_len = 1;
dest->mac[0] = MSTP_BROADCAST_ADDRESS;
dest->net = BACNET_BROADCAST_NETWORK;
dest->len = 0; /* always zero when DNET is broadcast */
for (i = 0; i < MAX_MAC_LEN; i++) {
dest->adr[i] = 0;
}
}
return;
}
/**
* @brief Get the MSTP port SoleMaster status
* @return true if the MSTP port is the SoleMaster
*/
bool dlmstp_sole_master(void)
{
return MSTP_Port.SoleMaster;
}
/**
* @brief Get the MSTP port SlaveNodeEnabled status
* @return true if the MSTP port has SlaveNodeEnabled
*/
bool dlmstp_slave_mode_enabled(void)
{
return MSTP_Port.SlaveNodeEnabled;
}
/**
* @brief Set the MSTP port SlaveNodeEnabled flag
* @param flag - true if the MSTP port has SlaveNodeEnabled
* @return true if the MSTP port SlaveNodeEnabled was set
* @note This flag is used to enable the Slave Node state machine
* for the MSTP port. The Slave Node state machine is used to
* respond to requests from the Master Node.
*/
bool dlmstp_slave_mode_enabled_set(bool flag)
{
MSTP_Port.SlaveNodeEnabled = flag;
return true;
}
/**
* @brief Get the MSTP port ZeroConfigEnabled status
* @return true if the MSTP port has ZeroConfigEnabled
*/
bool dlmstp_zero_config_enabled(void)
{
return MSTP_Port.ZeroConfigEnabled;
}
/**
* @brief Set the MSTP port ZeroConfigEnabled flag
* @param flag - true if the MSTP port has ZeroConfigEnabled
* @return true if the MSTP port ZeroConfigEnabled was set
* @note This flag is used to enable the Zero Configuration state machine
* for the MSTP port. The Zero Configuration state machine is used to
* automatically assign a MAC address to the MSTP port.
*/
bool dlmstp_zero_config_enabled_set(bool flag)
{
MSTP_Port.ZeroConfigEnabled = flag;
return true;
}
/**
* @brief Get the MSTP port AutoBaudEnabled status
* @return true if the MSTP port has AutoBaudEnabled
*/
bool dlmstp_check_auto_baud(void)
{
return MSTP_Port.CheckAutoBaud;
}
/**
* @brief Set the MSTP port AutoBaudEnabled flag
* @param flag - true if the MSTP port has AutoBaudEnabled
* @return true if the MSTP port AutoBaudEnabled was set
* @note This flag is used to enable the Zero Configuration state machine
* for the MSTP port. The Zero Configuration state machine is used to
* automatically assign a MAC address to the MSTP port.
*/
bool dlmstp_check_auto_baud_set(bool flag)
{
MSTP_Port.CheckAutoBaud = flag;
if (flag) {
MSTP_Port.Auto_Baud_State = MSTP_AUTO_BAUD_STATE_INIT;
}
return true;
}
/**
* @brief Get the MSTP port MAC address that this node prefers to use.
* @return ZeroConfigStation value, or an out-of-range value if invalid
* @note valid values are between Nmin_poll_station and Nmax_poll_station
* but other values such as 0 or 255 could mean 'unconfigured'
*/
uint8_t dlmstp_zero_config_preferred_station(void)
{
return MSTP_Port.Zero_Config_Preferred_Station;
}
/**
* @brief Set the MSTP port MAC address that this node prefers to use.
* @param station - Zero_Config_Preferred_Station value
* @return true if the MSTP port Zero_Config_Preferred_Station was set
* @note valid values are between Nmin_poll_station and Nmax_poll_station
* but other values such as 0 or 255 could mean 'unconfigured'
*/
bool dlmstp_zero_config_preferred_station_set(uint8_t station)
{
MSTP_Port.Zero_Config_Preferred_Station = station;
return true;
}
/**
* @brief Initialize the RS-485 baud rate
* @param baudrate - RS-485 baud rate in bits per second (bps)
* @return true if the baud rate was valid
*/
void dlmstp_set_baud_rate(uint32_t baud)
{
RS485_Set_Baud_Rate(baud);
}
/**
* @brief Return the RS-485 baud rate
* @return baud - RS-485 baud rate in bits per second (bps)
*/
uint32_t dlmstp_baud_rate(void)
{
return RS485_Get_Baud_Rate();
}
/**
* @brief Set the MS/TP Frame Complete callback
* @param cb_func - callback function to be called when a frame is received
*/
void dlmstp_set_frame_rx_complete_callback(
dlmstp_hook_frame_rx_complete_cb cb_func)
{
Valid_Frame_Rx_Callback = cb_func;
}
/**
* @brief Set the MS/TP Frame Complete callback
* @param cb_func - callback function to be called when a frame is received
*/
void dlmstp_set_frame_not_for_us_rx_complete_callback(
dlmstp_hook_frame_rx_complete_cb cb_func)
{
Valid_Frame_Not_For_Us_Rx_Callback = cb_func;
}
/**
* @brief Set the MS/TP Frame Complete callback
* @param cb_func - callback function to be called when a frame is received
*/
void dlmstp_set_invalid_frame_rx_complete_callback(
dlmstp_hook_frame_rx_complete_cb cb_func)
{
Invalid_Frame_Rx_Callback = cb_func;
}
/**
* @brief Set the MS/TP Preamble callback
* @param cb_func - callback function to be called when a preamble is received
*/
void dlmstp_set_frame_rx_start_callback(dlmstp_hook_frame_rx_start_cb cb_func)
{
Preamble_Callback = cb_func;
}
/**
* @brief Reset the MS/TP statistics
*/
void dlmstp_reset_statistics(void)
{
memset(&DLMSTP_Statistics, 0, sizeof(struct dlmstp_statistics));
}
/**
* @brief Copy the MSTP port statistics if they exist
* @param statistics - MSTP port statistics
*/
void dlmstp_fill_statistics(struct dlmstp_statistics *statistics)
{
if (statistics == NULL) {
return;
}
memmove(statistics, &DLMSTP_Statistics, sizeof(struct dlmstp_statistics));
}
/**
* @brief Get the MSTP port Max-Info-Frames limit
* @return Max-Info-Frames limit
*/
uint8_t dlmstp_max_info_frames_limit(void)
{
return DLMSTP_MAX_INFO_FRAMES;
}
/**
* @brief Get the MSTP port Max-Master limit
* @return Max-Master limit
*/
uint8_t dlmstp_max_master_limit(void)
{
return DLMSTP_MAX_MASTER;
}
/**
* @brief Return the RS-485 silence time in milliseconds
* @param arg - pointer to MSTP port structure
* @return silence time in milliseconds
*/
uint32_t dlmstp_silence_milliseconds(void *arg)
{
(void)arg;
return mstimer_elapsed(&Silence_Timer);
}
/**
* @brief Return the valid frame time in milliseconds
* @param arg - pointer to MSTP port structure
* @return valid frame time in milliseconds
*/
uint32_t dlmstp_valid_frame_milliseconds(void *arg)
{
(void)arg;
return mstimer_elapsed(&Valid_Frame_Timer);
}
/**
* @brief Reset the valid frame timer
* @param arg - pointer to MSTP port structure
* @return valid frame time in milliseconds
*/
void dlmstp_valid_frame_milliseconds_reset(void *arg)
{
(void)arg;
mstimer_restart(&Valid_Frame_Timer);
}
/**
* @brief Reset the RS-485 silence time to zero
* @param arg - pointer to MSTP port structure
*/
void dlmstp_silence_reset(void *arg)
{
(void)arg;
mstimer_set(&Silence_Timer, 0);
}
/**
* @brief Configures the interface name
* @param ifname = the interface name
*/
void dlmstp_set_interface(const char *ifname)
{
/* note: expects a constant char, or char from the heap */
if (ifname) {
RS485_Set_Interface((char *)ifname);
}
}
/**
* @brief Returns the interface name
* @return the interface name
*/
const char *dlmstp_get_interface(void)
{
return RS485_Interface();
}
/**
* @brief Initialize this MS/TP datalink
* @param ifname user data structure
* @return true if the MSTP datalink is initialized
*/
bool dlmstp_init(char *ifname)
{
pthread_attr_t thread_attr;
struct sched_param sch_param;
pthread_condattr_t attr;
int rv = 0;
if (DLMSTP_Initialized) {
dlmstp_cleanup();
RS485_Cleanup();
}
DLMSTP_Initialized = true;
if (ifname) {
RS485_Set_Interface(ifname);
debug_fprintf(stderr, "MS/TP Interface: %s\n", ifname);
} else {
ifname = (char *)RS485_Interface();
}
pthread_condattr_init(&attr);
if ((rv = pthread_condattr_setclock(&attr, CLOCK_MONOTONIC)) != 0) {
fprintf(
stderr, "MS/TP Interface: %s\n failed to set MONOTONIC clock\n",
ifname);
exit(1);
}
pthread_mutex_init(&Thread_Mutex, NULL);
rv = pthread_mutex_init(&Ring_Buffer_Mutex, NULL);
if (rv != 0) {
fprintf(
stderr, "MS/TP Interface: %s\n cannot allocate PThread Mutex.\n",
ifname);
exit(1);
}
/* initialize PDU queue */
Ringbuf_Init(
&PDU_Queue, (uint8_t *)&PDU_Buffer, sizeof(struct mstp_pdu_packet),
MSTP_PDU_PACKET_COUNT);
/* initialize packet queue */
Ringbuf_Init(
&Receive_Queue, (uint8_t *)&Receive_Buffer, sizeof(DLMSTP_PACKET),
MSTP_RECEIVE_PACKET_COUNT);
rv = pthread_cond_init(&Receive_Packet_Flag, &attr);
if (rv != 0) {
fprintf(
stderr,
"MS/TP Interface: %s\n cannot allocate PThread Condition.\n",
ifname);
exit(1);
}
rv = pthread_mutex_init(&Receive_Packet_Mutex, NULL);
if (rv != 0) {
fprintf(
stderr, "MS/TP Interface: %s\n cannot allocate PThread Mutex.\n",
ifname);
exit(1);
}
clock_gettime(CLOCK_MONOTONIC, &Clock_Get_Time_Start);
/* initialize hardware */
mstimer_set(&Silence_Timer, 0);
RS485_Initialize();
MSTP_Port.InputBuffer = &RxBuffer[0];
MSTP_Port.InputBufferSize = sizeof(RxBuffer);
MSTP_Port.OutputBuffer = &TxBuffer[0];
MSTP_Port.OutputBufferSize = sizeof(TxBuffer);
MSTP_Port.SilenceTimer = dlmstp_silence_milliseconds;
MSTP_Port.SilenceTimerReset = dlmstp_silence_reset;
MSTP_Port.ValidFrameTimer = dlmstp_valid_frame_milliseconds;
MSTP_Port.ValidFrameTimerReset = dlmstp_valid_frame_milliseconds_reset;
MSTP_Port.BaudRate = dlmstp_baud_rate;
MSTP_Port.BaudRateSet = dlmstp_set_baud_rate;
MSTP_Init(&MSTP_Port);
#if PRINT_ENABLED
fprintf(stderr, "MS/TP MAC: %02X\n", MSTP_Port.This_Station);
fprintf(stderr, "MS/TP Max_Master: %02X\n", MSTP_Port.Nmax_master);
fprintf(
stderr, "MS/TP Max_Info_Frames: %u\n",
(unsigned)MSTP_Port.Nmax_info_frames);
fprintf(
stderr, "MS/TP RxBuf[%u] TxBuf[%u]\n",
(unsigned)MSTP_Port.InputBufferSize,
(unsigned)MSTP_Port.OutputBufferSize);
fprintf(
stderr,
"MS/TP SlaveModeEnabled"
": %s\n",
(MSTP_Port.SlaveNodeEnabled ? "true" : "false"));
fprintf(
stderr,
"MS/TP ZeroConfigEnabled"
": %s\n",
(MSTP_Port.ZeroConfigEnabled ? "true" : "false"));
fprintf(
stderr,
"MS/TP CheckAutoBaud"
": %s\n",
(MSTP_Port.CheckAutoBaud ? "true" : "false"));
fflush(stderr);
#endif
pthread_attr_init(&thread_attr);
/* Set scheduling policy to SCHED_FIFO and priority */
rv = pthread_attr_setinheritsched(&thread_attr, PTHREAD_EXPLICIT_SCHED);
if (rv != 0) {
fprintf(
stderr,
"MS/TP Interface: %s\n cannot setup thread schedule to "
"explicit.\n",
ifname);
exit(1);
}
rv = pthread_attr_setschedpolicy(&thread_attr, SCHED_FIFO);
if (rv != 0) {
fprintf(
stderr,
"MS/TP Interface: %s\n cannot setup thread schedule policy to "
"FIFO.\n",
ifname);
exit(1);
}
sch_param.sched_priority = 99;
rv = pthread_attr_setschedparam(&thread_attr, &sch_param);
if (rv != 0) {
fprintf(
stderr, "MS/TP Interface: %s\n cannot setup thread priority.\n",
ifname);
exit(1);
}
/* start one thread */
Thread_Run = true;
rv = pthread_create(&hThread, &thread_attr, dlmstp_thread, NULL);
if (rv == EPERM) {
fprintf(
stdout,
"MS/TP Interface: %s\n"
" Insufficient permissions to create thread with priority.\n"
" A thread without priority will be created.\n"
" Run this executable as a user with thread priority permission\n"
" or grant capability with \"setcap 'cap_sys_nice=eip'\"",
ifname);
rv = pthread_create(&hThread, NULL, dlmstp_thread, NULL);
}
if (rv != 0) {
fprintf(
stderr, "MS/TP Interface: %s\n Failed to start MS/TP thread.\n",
ifname);
exit(1);
}
return true;
}
#ifdef TEST_DLMSTP
#include <stdio.h>
void apdu_handler(
BACNET_ADDRESS *src, /* source address */
uint8_t *apdu, /* APDU data */
uint16_t pdu_len)
{ /* for confirmed messages */
(void)src;
(void)apdu;
(void)pdu_len;
}
static char *Network_Interface = NULL;
int main(int argc, char *argv[])
{
uint16_t pdu_len;
/* argv has the "/dev/ttyUSB0" or some other device */
if (argc > 1) {
Network_Interface = argv[1];
}
dlmstp_set_baud_rate(38400);
dlmstp_set_mac_address(0x05);
dlmstp_set_max_info_frames(DEFAULT_MAX_INFO_FRAMES);
dlmstp_set_max_master(DEFAULT_MAX_MASTER);
dlmstp_init(Network_Interface);
/* forever task */
for (;;) {
pdu_len = dlmstp_receive(NULL, NULL, 0, UINT_MAX);
MSTP_Create_And_Send_Frame(
&MSTP_Port, FRAME_TYPE_TEST_REQUEST, MSTP_Port.SourceAddress,
MSTP_Port.This_Station, NULL, 0);
(void)pdu_len;
}
return 0;
}
#endif
Reference in New Issue View Git Blame Copy Permalink