ran the indent program on the source files to make them consistent.
This commit is contained in:
skarg
+124
-126
@@ -66,134 +66,131 @@
|
||||
#define FRAME_TYPE_PROPRIETARY_MAX 255
|
||||
|
||||
// receive FSM states
|
||||
typedef enum
|
||||
{
|
||||
MSTP_RECEIVE_STATE_IDLE,
|
||||
MSTP_RECEIVE_STATE_PREAMBLE,
|
||||
MSTP_RECEIVE_STATE_HEADER,
|
||||
MSTP_RECEIVE_STATE_HEADER_CRC,
|
||||
MSTP_RECEIVE_STATE_DATA,
|
||||
MSTP_RECEIVE_STATE_DATA_CRC
|
||||
typedef enum {
|
||||
MSTP_RECEIVE_STATE_IDLE,
|
||||
MSTP_RECEIVE_STATE_PREAMBLE,
|
||||
MSTP_RECEIVE_STATE_HEADER,
|
||||
MSTP_RECEIVE_STATE_HEADER_CRC,
|
||||
MSTP_RECEIVE_STATE_DATA,
|
||||
MSTP_RECEIVE_STATE_DATA_CRC
|
||||
} MSTP_RECEIVE_STATE;
|
||||
|
||||
// master node FSM states
|
||||
typedef enum
|
||||
{
|
||||
MSTP_MASTER_STATE_INITIALIZE,
|
||||
MSTP_MASTER_STATE_IDLE,
|
||||
MSTP_MASTER_STATE_USE_TOKEN,
|
||||
MSTP_MASTER_STATE_WAIT_FOR_REPLY,
|
||||
MSTP_MASTER_STATE_DONE_WITH_TOKEN,
|
||||
MSTP_MASTER_STATE_PASS_TOKEN,
|
||||
MSTP_MASTER_STATE_NO_TOKEN,
|
||||
MSTP_MASTER_STATE_POLL_FOR_MASTER,
|
||||
MSTP_MASTER_STATE_ANSWER_DATA_REQUEST
|
||||
typedef enum {
|
||||
MSTP_MASTER_STATE_INITIALIZE,
|
||||
MSTP_MASTER_STATE_IDLE,
|
||||
MSTP_MASTER_STATE_USE_TOKEN,
|
||||
MSTP_MASTER_STATE_WAIT_FOR_REPLY,
|
||||
MSTP_MASTER_STATE_DONE_WITH_TOKEN,
|
||||
MSTP_MASTER_STATE_PASS_TOKEN,
|
||||
MSTP_MASTER_STATE_NO_TOKEN,
|
||||
MSTP_MASTER_STATE_POLL_FOR_MASTER,
|
||||
MSTP_MASTER_STATE_ANSWER_DATA_REQUEST
|
||||
} MSTP_MASTER_STATE;
|
||||
|
||||
struct mstp_port_struct_t
|
||||
{
|
||||
MSTP_RECEIVE_STATE receive_state;
|
||||
// When a master node is powered up or reset,
|
||||
// it shall unconditionally enter the INITIALIZE state.
|
||||
MSTP_MASTER_STATE master_state;
|
||||
// A Boolean flag set to TRUE by the Receive State Machine
|
||||
// if an error is detected during the reception of a frame.
|
||||
// Set to FALSE by the main state machine.
|
||||
unsigned ReceiveError:1;
|
||||
// There is data in the buffer
|
||||
unsigned DataAvailable:1;
|
||||
unsigned FramingError:1; // TRUE if we got a framing error
|
||||
unsigned ReceivedInvalidFrame:1;
|
||||
// A Boolean flag set to TRUE by the Receive State Machine
|
||||
// if a valid frame is received.
|
||||
// Set to FALSE by the main state machine.
|
||||
unsigned ReceivedValidFrame:1;
|
||||
// A Boolean flag set to TRUE by the master machine if this node is the
|
||||
// only known master node.
|
||||
unsigned SoleMaster:1;
|
||||
// After receiving a frame this value will be TRUE until Tturnaround
|
||||
// has expired
|
||||
unsigned Turn_Around_Waiting:1;
|
||||
// stores the latest received data
|
||||
uint8_t DataRegister;
|
||||
// Used to accumulate the CRC on the data field of a frame.
|
||||
uint16_t DataCRC;
|
||||
// Used to store the data length of a received frame.
|
||||
unsigned DataLength;
|
||||
// Used to store the destination address of a received frame.
|
||||
uint8_t DestinationAddress;
|
||||
// Used to count the number of received octets or errors.
|
||||
// This is used in the detection of link activity.
|
||||
unsigned EventCount;
|
||||
// Used to store the frame type of a received frame.
|
||||
uint8_t FrameType;
|
||||
// The number of frames sent by this node during a single token hold.
|
||||
// When this counter reaches the value Nmax_info_frames, the node must
|
||||
// pass the token.
|
||||
unsigned FrameCount;
|
||||
// Used to accumulate the CRC on the header of a frame.
|
||||
uint8_t HeaderCRC;
|
||||
// Used as an index by the Receive State Machine, up to a maximum value of
|
||||
// InputBufferSize.
|
||||
unsigned Index;
|
||||
// An array of octets, used to store octets as they are received.
|
||||
// InputBuffer is indexed from 0 to InputBufferSize-1.
|
||||
// The maximum size of a frame is 501 octets.
|
||||
uint8_t InputBuffer[MAX_MPDU];
|
||||
// "Next Station," the MAC address of the node to which This Station passes
|
||||
// the token. If the Next_Station is unknown, Next_Station shall be equal to
|
||||
// This_Station.
|
||||
uint8_t Next_Station;
|
||||
// "Poll Station," the MAC address of the node to which This Station last
|
||||
// sent a Poll For Master. This is used during token maintenance.
|
||||
uint8_t Poll_Station;
|
||||
// A counter of transmission retries used for Token and Poll For Master
|
||||
// transmission.
|
||||
unsigned RetryCount;
|
||||
// A timer with nominal 5 millisecond resolution used to measure and
|
||||
// generate silence on the medium between octets. It is incremented by a
|
||||
// timer process and is cleared by the Receive State Machine when activity
|
||||
// is detected and by the SendFrame procedure as each octet is transmitted.
|
||||
// Since the timer resolution is limited and the timer is not necessarily
|
||||
// synchronized to other machine events, a timer value of N will actually
|
||||
// denote intervals between N-1 and N
|
||||
unsigned SilenceTimer;
|
||||
struct mstp_port_struct_t {
|
||||
MSTP_RECEIVE_STATE receive_state;
|
||||
// When a master node is powered up or reset,
|
||||
// it shall unconditionally enter the INITIALIZE state.
|
||||
MSTP_MASTER_STATE master_state;
|
||||
// A Boolean flag set to TRUE by the Receive State Machine
|
||||
// if an error is detected during the reception of a frame.
|
||||
// Set to FALSE by the main state machine.
|
||||
unsigned ReceiveError:1;
|
||||
// There is data in the buffer
|
||||
unsigned DataAvailable:1;
|
||||
unsigned FramingError:1; // TRUE if we got a framing error
|
||||
unsigned ReceivedInvalidFrame:1;
|
||||
// A Boolean flag set to TRUE by the Receive State Machine
|
||||
// if a valid frame is received.
|
||||
// Set to FALSE by the main state machine.
|
||||
unsigned ReceivedValidFrame:1;
|
||||
// A Boolean flag set to TRUE by the master machine if this node is the
|
||||
// only known master node.
|
||||
unsigned SoleMaster:1;
|
||||
// After receiving a frame this value will be TRUE until Tturnaround
|
||||
// has expired
|
||||
unsigned Turn_Around_Waiting:1;
|
||||
// stores the latest received data
|
||||
uint8_t DataRegister;
|
||||
// Used to accumulate the CRC on the data field of a frame.
|
||||
uint16_t DataCRC;
|
||||
// Used to store the data length of a received frame.
|
||||
unsigned DataLength;
|
||||
// Used to store the destination address of a received frame.
|
||||
uint8_t DestinationAddress;
|
||||
// Used to count the number of received octets or errors.
|
||||
// This is used in the detection of link activity.
|
||||
unsigned EventCount;
|
||||
// Used to store the frame type of a received frame.
|
||||
uint8_t FrameType;
|
||||
// The number of frames sent by this node during a single token hold.
|
||||
// When this counter reaches the value Nmax_info_frames, the node must
|
||||
// pass the token.
|
||||
unsigned FrameCount;
|
||||
// Used to accumulate the CRC on the header of a frame.
|
||||
uint8_t HeaderCRC;
|
||||
// Used as an index by the Receive State Machine, up to a maximum value of
|
||||
// InputBufferSize.
|
||||
unsigned Index;
|
||||
// An array of octets, used to store octets as they are received.
|
||||
// InputBuffer is indexed from 0 to InputBufferSize-1.
|
||||
// The maximum size of a frame is 501 octets.
|
||||
uint8_t InputBuffer[MAX_MPDU];
|
||||
// "Next Station," the MAC address of the node to which This Station passes
|
||||
// the token. If the Next_Station is unknown, Next_Station shall be equal to
|
||||
// This_Station.
|
||||
uint8_t Next_Station;
|
||||
// "Poll Station," the MAC address of the node to which This Station last
|
||||
// sent a Poll For Master. This is used during token maintenance.
|
||||
uint8_t Poll_Station;
|
||||
// A counter of transmission retries used for Token and Poll For Master
|
||||
// transmission.
|
||||
unsigned RetryCount;
|
||||
// A timer with nominal 5 millisecond resolution used to measure and
|
||||
// generate silence on the medium between octets. It is incremented by a
|
||||
// timer process and is cleared by the Receive State Machine when activity
|
||||
// is detected and by the SendFrame procedure as each octet is transmitted.
|
||||
// Since the timer resolution is limited and the timer is not necessarily
|
||||
// synchronized to other machine events, a timer value of N will actually
|
||||
// denote intervals between N-1 and N
|
||||
unsigned SilenceTimer;
|
||||
|
||||
// A timer used to measure and generate Reply Postponed frames. It is
|
||||
// incremented by a timer process and is cleared by the Master Node State
|
||||
// Machine when a Data Expecting Reply Answer activity is completed.
|
||||
unsigned ReplyPostponedTimer;
|
||||
// A timer used to measure and generate Reply Postponed frames. It is
|
||||
// incremented by a timer process and is cleared by the Master Node State
|
||||
// Machine when a Data Expecting Reply Answer activity is completed.
|
||||
unsigned ReplyPostponedTimer;
|
||||
|
||||
// Used to store the Source Address of a received frame.
|
||||
uint8_t SourceAddress;
|
||||
// Used to store the Source Address of a received frame.
|
||||
uint8_t SourceAddress;
|
||||
|
||||
// The number of tokens received by this node. When this counter reaches the
|
||||
// value Npoll, the node polls the address range between TS and NS for
|
||||
// additional master nodes. TokenCount is set to zero at the end of the
|
||||
// polling process.
|
||||
unsigned TokenCount;
|
||||
// The number of tokens received by this node. When this counter reaches the
|
||||
// value Npoll, the node polls the address range between TS and NS for
|
||||
// additional master nodes. TokenCount is set to zero at the end of the
|
||||
// polling process.
|
||||
unsigned TokenCount;
|
||||
|
||||
// "This Station," the MAC address of this node. TS is generally read from a
|
||||
// hardware DIP switch, or from nonvolatile memory. Valid values for TS are
|
||||
// 0 to 254. The value 255 is used to denote broadcast when used as a
|
||||
// destination address but is not allowed as a value for TS.
|
||||
uint8_t This_Station;
|
||||
// "This Station," the MAC address of this node. TS is generally read from a
|
||||
// hardware DIP switch, or from nonvolatile memory. Valid values for TS are
|
||||
// 0 to 254. The value 255 is used to denote broadcast when used as a
|
||||
// destination address but is not allowed as a value for TS.
|
||||
uint8_t This_Station;
|
||||
|
||||
// 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.
|
||||
unsigned Nmax_info_frames;
|
||||
// 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.
|
||||
unsigned Nmax_info_frames;
|
||||
|
||||
// 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.
|
||||
unsigned Nmax_master;
|
||||
// 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.
|
||||
unsigned Nmax_master;
|
||||
};
|
||||
|
||||
#define DEFAULT_MAX_INFO_FRAMES 1
|
||||
@@ -206,17 +203,18 @@ struct mstp_port_struct_t
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif /* __cplusplus */
|
||||
#endif /* __cplusplus */
|
||||
|
||||
void MSTP_Init(
|
||||
volatile struct mstp_port_struct_t *mstp_port,
|
||||
uint8_t this_station_mac);
|
||||
void MSTP_Millisecond_Timer(volatile struct mstp_port_struct_t *mstp_port);
|
||||
void MSTP_Receive_Frame_FSM(volatile struct mstp_port_struct_t *mstp_port);
|
||||
void MSTP_Master_Node_FSM(volatile struct mstp_port_struct_t *mstp_port);
|
||||
void MSTP_Init(volatile struct mstp_port_struct_t *mstp_port,
|
||||
uint8_t this_station_mac);
|
||||
void MSTP_Millisecond_Timer(volatile struct mstp_port_struct_t
|
||||
*mstp_port);
|
||||
void MSTP_Receive_Frame_FSM(volatile struct mstp_port_struct_t
|
||||
*mstp_port);
|
||||
void MSTP_Master_Node_FSM(volatile struct mstp_port_struct_t
|
||||
*mstp_port);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif /* __cplusplus */
|
||||
|
||||
#endif /* __cplusplus */
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user