skarg
122 lines
4.6 KiB
C
122 lines
4.6 KiB
C
/*####COPYRIGHTBEGIN####
|
|
-------------------------------------------
|
|
Copyright (C) 2004 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####*/
|
|
|
|
#ifndef MSTPDEF_H
|
|
#define MSTPDEF_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "bacdef.h"
|
|
|
|
/* The value 255 is used to denote broadcast when used as a */
|
|
/* destination address but is not allowed as a value for a station. */
|
|
/* Station addresses for master nodes can be 0-127. */
|
|
/* Station addresses for slave nodes can be 127-254. */
|
|
#define MSTP_BROADCAST_ADDRESS 255
|
|
|
|
/* MS/TP Frame Type */
|
|
/* Frame Types 8 through 127 are reserved by ASHRAE. */
|
|
#define FRAME_TYPE_TOKEN 0
|
|
#define FRAME_TYPE_POLL_FOR_MASTER 1
|
|
#define FRAME_TYPE_REPLY_TO_POLL_FOR_MASTER 2
|
|
#define FRAME_TYPE_TEST_REQUEST 3
|
|
#define FRAME_TYPE_TEST_RESPONSE 4
|
|
#define FRAME_TYPE_BACNET_DATA_EXPECTING_REPLY 5
|
|
#define FRAME_TYPE_BACNET_DATA_NOT_EXPECTING_REPLY 6
|
|
#define FRAME_TYPE_REPLY_POSTPONED 7
|
|
/* Frame Types 128 through 255: Proprietary Frames */
|
|
/* These frames are available to vendors as proprietary (non-BACnet) frames. */
|
|
/* The first two octets of the Data field shall specify the unique vendor */
|
|
/* identification code, most significant octet first, for the type of */
|
|
/* vendor-proprietary frame to be conveyed. The length of the data portion */
|
|
/* of a Proprietary frame shall be in the range of 2 to 501 octets. */
|
|
#define FRAME_TYPE_PROPRIETARY_MIN 128
|
|
#define FRAME_TYPE_PROPRIETARY_MAX 255
|
|
/* The initial CRC16 checksum value */
|
|
#define CRC16_INITIAL_VALUE (0xFFFF)
|
|
|
|
/* receive FSM states */
|
|
typedef enum {
|
|
MSTP_RECEIVE_STATE_IDLE = 0,
|
|
MSTP_RECEIVE_STATE_PREAMBLE = 1,
|
|
MSTP_RECEIVE_STATE_HEADER = 2,
|
|
MSTP_RECEIVE_STATE_HEADER_CRC = 3,
|
|
MSTP_RECEIVE_STATE_DATA = 4
|
|
} MSTP_RECEIVE_STATE;
|
|
|
|
/* master node FSM states */
|
|
typedef enum {
|
|
MSTP_MASTER_STATE_INITIALIZE = 0,
|
|
MSTP_MASTER_STATE_IDLE = 1,
|
|
MSTP_MASTER_STATE_USE_TOKEN = 2,
|
|
MSTP_MASTER_STATE_WAIT_FOR_REPLY = 3,
|
|
MSTP_MASTER_STATE_DONE_WITH_TOKEN = 4,
|
|
MSTP_MASTER_STATE_PASS_TOKEN = 5,
|
|
MSTP_MASTER_STATE_NO_TOKEN = 6,
|
|
MSTP_MASTER_STATE_POLL_FOR_MASTER = 7,
|
|
MSTP_MASTER_STATE_ANSWER_DATA_REQUEST = 8
|
|
} MSTP_MASTER_STATE;
|
|
|
|
/* The time without a DataAvailable or ReceiveError event before declaration */
|
|
/* of loss of token: 500 milliseconds. */
|
|
#define Tno_token 500
|
|
|
|
/* The minimum time after the end of the stop bit of the final octet of a */
|
|
/* received frame before a node may enable its EIA-485 driver: 40 bit times. */
|
|
/* At 9600 baud, 40 bit times would be about 4.166 milliseconds */
|
|
/* At 19200 baud, 40 bit times would be about 2.083 milliseconds */
|
|
/* At 38400 baud, 40 bit times would be about 1.041 milliseconds */
|
|
/* At 57600 baud, 40 bit times would be about 0.694 milliseconds */
|
|
/* At 76800 baud, 40 bit times would be about 0.520 milliseconds */
|
|
/* At 115200 baud, 40 bit times would be about 0.347 milliseconds */
|
|
/* 40 bits is 4 octets including a start and stop bit with each octet */
|
|
#define Tturnaround (40UL)
|
|
/* turnaround_time_milliseconds = (Tturnaround*1000UL)/RS485_Baud; */
|
|
|
|
#define DEFAULT_MAX_INFO_FRAMES 1
|
|
#define DEFAULT_MAX_MASTER 127
|
|
#define DEFAULT_MAC_ADDRESS 127
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|