icss_dlr.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef ICSS_DLR_H_
#define ICSS_DLR_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
#include <networking/icss_emac/icss_emac.h>
#include <kernel/dpl/ClockP.h>
#include <kernel/dpl/HwiP.h>
 
#ifdef TEST_DEBUG
#include "testing.h"
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
/*#define DLR_DEBUG*/
 
/*#define IS_A_DLR_SUPERVISOR*/
 
#define DEFAULT_DLR_PACKET_SIZE         60
 
#define ETHERNET_FRAME_SIZE_60 60
 
#define IEP_WD_PRE_DIV_10US     2000
 
#define PORT0_WATCH_DOG_ID   0      /*PD_WD*/
 
#define PORT1_WATCH_DOG_ID   1      /*PDI_WD*/
 
#define IS_A_LINK_STATUS_FRAME      DLR_TRUE
#define IS_A_NEIGHBOR_STAT_FRAME    DLR_FALSE
 
/*Generic flags*/
#define BOTH_LINKS_UP           0x0
#define PORT0_IS_DOWN           0x2
#define PORT1_IS_DOWN           0x1
#define BOTH_LINKS_DOWN         0x3
 
/*PRUSS INTC Mask for PRU EVENT 5*/
#define PORT0_WD_ISR_MASK       0x2000000
/*PRUSS INTC Mask for PRU EVENT 5*/
#define PORT1_WD_ISR_MASK       0x4000000
 
#define PDI_WD_TRIGGER_RX_SOF       (0 << 4)
 
#define PDI_WD_TRIGGER_LATCH_IN     (1 << 4)
 
#define PDI_WD_TRIGGER_SYNC0_OUT    (2 << 4)
 
#define PDI_WD_TRIGGER_SYNC1_OUT    (3 << 4)
 
#ifdef DLR_DEBUG
#define MAX_EVENTS_CAPTURED     1000
 
/*DLR events for debugging*/
#define LINK1_BREAK     1
#define LINK2_BREAK     2
#define BOTH_LINK_DISABLED  3
#define EMPTY_SIGNON_FRAME_RCVD 4
#define COMPLETE_SIGNON_FRAME_RCVD  5
 
#define RING_FAULT_RCVD_PORT0   6
#define RING_FAULT_RCVD_PORT1   7
 
#define RING_FAULT_TRANSITION_PORT0 8
#define RING_FAULT_TRANSITION_PORT1 9
 
#define RING_NORMAL_TRANSITION_PORT0    10
#define RING_NORMAL_TRANSITION_PORT1    11
 
#define START_TIMER0            12
#define START_TIMER1            13
 
#define NCRES_RCVD_PORT0        14
#define NCRES_RCVD_PORT1        15
 
#define NCREQ_RCVD_PORT0        16
#define NCREQ_RCVD_PORT1        17
 
#define LOCFAULT_RCVD_PORT0     18
#define LOCFAULT_RCVD_PORT1     19
 
#define BEACON0_MISSED_FAULT    20
#define BEACON1_MISSED_FAULT    21
#define BEACON0_MISSED_NORMAL   22
#define BEACON1_MISSED_NORMAL   23
 
#define LINK1_FAULT_BREAK   24
#define LINK2_FAULT_BREAK   25
 
#define LINK1_NORMAL_BREAK      27
#define LINK2_NORMAL_BREAK      28
 
#define NEIGHBOR_TIMEOUT_PORT0_RETRY    29
#define NEIGHBOR_TIMEOUT_PORT1_RETRY    30
#define NEIGHBOR_TIMEOUT_PORT0_MAX      31
#define NEIGHBOR_TIMEOUT_PORT1_MAX      32
 
#define DLR_RESET_MACHINE   33
 
#define BEACON0_MISSED  34
#define BEACON1_MISSED  35
 
#define STOP_BOTH_TIMERS_PORT0 36
#define STOP_BOTH_TIMERS_PORT1 37
 
#define PORT0_BEACON_STALL   38
#define PORT1_BEACON_STALL   39
#endif
 
#define DEFAULT_BEACON_INTERVAL_VARIABLE 400 /*in microseconds*/
#define DEFAULT_BEACON_TIMEOUT_VARIABLE (DEFAULT_BEACON_INTERVAL_VARIABLE * 4) /*in microseconds*/
 
#define DEFAULT_NEIGHBOR_TIMEOUT_INTERVAL   200 /*in milliseconds*/
 
#define DEFAULT_DLR_PERIODIC_INTERVAL   100 /*in milliseconds*/
 
#define MAX_NUM_RETRIES     2
 
#define BEACON_CPU_STALL_THRESHOLD  4
 
#define DLR_DEFAULT_CAPABILITIES    (1 << 7) | (1 << 1)
 
/*DLR Packet Generation Offsets*/
#define DLR_SIGNON_FRAME_SIZE           ICSS_EMAC_MAXMTU
 
#define DLR_COMMON_FRAME_HEADER_SIZE    18
#define DLR_COMMON_FRAME_OFFSET         12
 
#define ICSS_DLR_PORT0_INT_FLAG              0x200000
 
#define ICSS_DLR_PORT1_INT_FLAG              0x400000
 
#define DLR_DMTIMER4_ID     3
 
#define DLR_DMTIMER5_ID     4
 
typedef struct dlr_Config_s *EIP_DLRHandle;
 
typedef enum
{
    NODE_IDLE = 0,
    NODE_FAULT = 1,
    NODE_NORMAL = 2
} nodeState;
typedef enum
{
    RING_NORMAL = 1,
    RING_FAULT = 2
} ringState;
 
typedef enum
{
    LINEAR_TOP = 0,
    RING_TOP = 1
} nwTopology;
 
typedef enum
{
    NORMAL_STAT = 0,
    RING_FAULT_STAT = 1,
    UNEXPECTED_LOOP = 2,
    PARTIAL_FAULT = 3,
    RAPID_FAULT = 4
} nwStatus;
 
typedef enum
{
    /*indicates the node is functioning as a backup*/
    BACKUP_NODE = 0,
    /*indicates the device is functioning as the active ring supervisor*/
    ACTIVE_RING_SUPERVISOR = 1,
    /*indicates the device is functioning as a normal ring node*/
    RING_NODE = 2,
    /*indicates the device is operating in a non-DLR topology*/
    NON_DLR = 3,
    FEATURE_UNSUPPORTED = 4
 
} supervisorStatus;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint8_t MAC[6];
    uint8_t numExceptions;
 
} exceptionList;
 
typedef struct
{
    uint8_t node_state;
    uint8_t ring_state;
    uint8_t topology;
    uint8_t status;
    uint8_t superStatus;
 
} dlrStateMachineVar;
 
typedef struct
{
 
    uint8_t  superEnable;
    uint32_t beaconInterval;
    uint32_t beaconTimeout;
 
    uint16_t vLanId;
 
    uint8_t supPrecedence;
 
} superConfig;
 
typedef struct
{
 
    uint8_t supMACAddress[6];
 
    uint32_t supIPAddress;
 
} activeSuperAddr;
 
typedef struct
{
    uint32_t ipAddr;
    uint8_t macAddr[6];
 
    uint16_t deviceNum;
} lastActiveNode;
 
typedef struct
{
    uint32_t ipAddr;
    uint8_t macAddr[6];
} protocolParticipants;
 
typedef struct
{
    superConfig supConfig;
    activeSuperAddr addr;
    dlrStateMachineVar SMVariables;
 
#ifdef IS_A_DLR_SUPERVISOR
 
    lastActiveNode activeNode[2];
#endif
 
    uint32_t dlrCapabilities;
 
    uint8_t activeSuperPred;
 
    HwiP_Object port0IntObject;
    HwiP_Object port1IntObject;
    HwiP_Object beaconTimeoutIntP0Object;
    HwiP_Object beaconTimeoutIntP1Object;
 
    uint8_t port0IntNum;
 
    uint8_t port1IntNum;
 
    uint8_t beaconTimeoutIntNum_P0;
 
    uint8_t beaconTimeoutIntNum_P1;
 
#ifdef IS_A_DLR_SUPERVISOR
 
    uint32_t numRingFaultsPowerUp;
 
    uint16_t ringParticipantsCount;
 
    protocolParticipants **ringNodes;
#endif
 
} dlrStruct;
 
 
typedef struct dlr_Config_s
{
    dlrStruct           *dlrObj;
    ICSS_EMAC_Handle    emacHandle;
    uint8_t             macId[6];
    /* MAC ID passed to ICSS-EMAC during ICSS-EMAC initialization*/
    PRUICSS_Handle      pruicssHandle;
    uint32_t            deviceIP;
    uint32_t            sequenceID;
    exceptionList       *exclusionList;
    ClockP_Object       dlrNeighborTimeoutClock[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
    /*Clock handle for DLR periodic processing*/
    ClockP_Object       dlrPeriodicTimerObject;
    uint8_t             dlrEmptyFrame[DEFAULT_DLR_PACKET_SIZE];
    uint8_t             checkForLoop;
    uint32_t            tracePktIntervalCount;
    uint32_t            stateMachineCount;
    uint8_t             pktSendCounter;
    uint8_t             ISRcountPort[ICSS_EMAC_MAX_PORTS_PER_INSTANCE];
} dlr_Config;
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
void EIP_DLR_init(EIP_DLRHandle dlrHandle);
void EIP_DLR_deinit(EIP_DLRHandle dlrHandle);
void EIP_DLR_start(EIP_DLRHandle dlrHandle) ;
void EIP_DLR_stop(EIP_DLRHandle dlrHandle);
void EIP_DLR_port0ISR(uintptr_t arg);
void EIP_DLR_port1ISR(uintptr_t arg);
void EIP_DLR_beaconTimeoutISR_P0(uintptr_t arg);
 
void EIP_DLR_beaconTimeoutISR_P1(uintptr_t arg);
 
void EIP_DLR_port0ProcessLinkBrk(uint8_t linkStatus, void *arg2);
void EIP_DLR_port1ProcessLinkBrk(uint8_t linkStatus, void *arg2);
void EIP_DLR_neighborTimeoutISR0(ClockP_Object *obj, void *arg);
void EIP_DLR_neighborTimeoutISR1(ClockP_Object *obj, void *arg);
void EIP_DLR_addVlanID(uint8_t *src, uint16_t vlanID);
void EIP_DLR_genNCReqFrame(EIP_DLRHandle dlrHandle, uint8_t *src,
                           uint8_t sourcePort);
void EIP_DLR_genNCResFrame(uint8_t *src, uint8_t sourcePort, uint8_t reqSrcPort,
                           uint32_t sequenceId);
void EIP_DLR_genNeighborLinkStatFrame(EIP_DLRHandle dlrHandle, uint8_t *src,
                                      uint8_t sourcePort,
                                      uint8_t linkOrNeighbor, uint8_t linkStatus);
void EIP_DLR_initDLRFrameHeader(uint8_t *src, uint8_t *header);
 
void EIP_DLR_addSignOnNumNodes(uint8_t *src, uint16_t numNodes);
void EIP_DLR_processDLRFrame(EIP_DLRHandle dlrHandle, uint8_t *pktBuffer,
                             uint8_t portNum, uint16_t size);
void EIP_DLR_dRAMInit(EIP_DLRHandle dlrHandle);
void EIP_DLR_resetStateMachine(EIP_DLRHandle dlrHandle);
void EIP_DLR_setDefaultValue(EIP_DLRHandle dlrHandle);
void EIP_DLR_switchToFault(EIP_DLRHandle dlrHandle);
void EIP_DLR_switchToNormal(EIP_DLRHandle dlrHandle);
int32_t EIP_DLR_isrInit(EIP_DLRHandle dlrHandle);
void EIP_DLR_periodicProcessing(ClockP_Object *obj, void *userArg);
 
#ifdef DLR_DEBUG
void genSeqOfEvents(uint8_t event);
#endif
 
void EIP_DLR_addToExceptionList(EIP_DLRHandle dlrHandle, uint8_t *macId);
void EIP_DLR_clearExceptionList(EIP_DLRHandle dlrHandle);
 
uint8_t EIP_DLR_checkSupervisorException(uint8_t *macId,
        EIP_DLRHandle dlrHandle);
void EIP_DLR_addModuleIPAddress(EIP_DLRHandle dlrHandle, uint32_t newIP);
 
void EIP_DLR_setDivider_WD_IEP(EIP_DLRHandle dlrHandle);
 
void EIP_DLR_enable_WD_IEP(EIP_DLRHandle dlrHandle, uint8_t id);
 
void EIP_DLR_disable_WD_IEP(EIP_DLRHandle dlrHandle, uint8_t id);
 
void EIP_DLR_setTimeout_WD_IEP(EIP_DLRHandle dlrHandle,
                               uint16_t periodInMicroSec, uint8_t id);
void EIP_DLR_set_pdi_wd_trigger_mode(EIP_DLRHandle dlrHandle, uint32_t mode);
 
#endif /* ICSS_DLR_H_ */