test15_4_phy_tests.h

Go to the documentation of this file.

 
/*
 *  Copyright (c) 2019, Cascoda Ltd.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. Neither the name of the copyright holder 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 HOLDER 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 TEST15_4_PHY_TESTS_H
#define TEST15_4_PHY_TESTS_H
 
#include <stddef.h>
#include <stdint.h>
 
/******************************************************************************/
/****** PHY Testmode Definitions                                         ******/
/******************************************************************************/
#define PHY_TEST_OFF 0x00     
#define PHY_TEST_TX_PKT 0x01  
#define PHY_TEST_TX_CONT 0x02 
#define PHY_TEST_RX_PER 0x03  
#define PHY_TEST_RX_PSN 0x04  
#define PHY_TEST_RX_EDSN 0x05 
#define PHY_TEST_LO_1 0x06    
#define PHY_TEST_LO_2 0x07    
#define PHY_TEST_LO_3 0x08    
#define PHY_TEST_MAX PHY_TEST_LO_3
 
/******************************************************************************/
/****** PHY Testmode Parameter Enumerations                              ******/
/******************************************************************************/
#define PHY_TESTPAR_PACKETPERIOD 0x00   
#define PHY_TESTPAR_PACKETLENGTH 0x01   
#define PHY_TESTPAR_NUMBEROFPKTS 0x02   
#define PHY_TESTPAR_PACKETDATATYPE 0x03 
#define PHY_TESTPAR_CHANNEL 0x04        
#define PHY_TESTPAR_TXPOWER 0x05        
#define PHY_TESTPAR_EDTHRESHOLD 0x06    
#define PHY_TESTPAR_RX_FFSYNC 0x07      
#define PHY_TESTPAR_LO_1_RXTXB 0x08     
#define PHY_TESTPAR_LO_2_FDAC 0x09      
#define PHY_TESTPAR_LO_3_LOCKS 0x0A     
#define PHY_TESTPAR_LO_3_PERIOD 0x0B    
#define PHY_TESTPAR_ATM 0x0C            
#define PHY_TESTPAR_MPW2_OVWR 0x0D      
#define PHY_TESTPAR_MACENABLED 0x0E     
#define PHY_TESTPAR_MAX PHY_TESTPAR_MACENABLED
#define PHY_TESTPAR_ALL (PHY_TESTPAR_MAX + 1) // for Reporting
 
#define PHY_TESTPARDEF_PACKETPERIOD 1000
#define PHY_TESTPARDEF_PACKETLENGTH 20
#define PHY_TESTPARDEF_NUMBEROFPKTS 10000
#define PHY_TESTPARDEF_PACKETDATATYPE TDME_TXD_RANDOM
#define PHY_TESTPARDEF_CHANNEL 0x12
#define PHY_TESTPARDEF_TXPOWER_IB 1
#define PHY_TESTPARDEF_TXPOWER_PB 3
#define PHY_TESTPARDEF_TXPOWER_BOOST 0
#define PHY_TESTPARDEF_TXCONT 0
#define PHY_TESTPARDEF_EDTHRESHOLD 0x80
#define PHY_TESTPARDEF_RX_FFSYNC 0
#define PHY_TESTPARDEF_LO_1_RXTXB 0
#define PHY_TESTPARDEF_LO_2_FDAC 32
#define PHY_TESTPARDEF_LO_3_LOCKS 20
#define PHY_TESTPARDEF_LO_3_PERIOD 10
#define PHY_TESTPARDEF_ATM 0x00
#define PHY_TESTPARDEF_MPW2_OVWR 0x03
#define PHY_TESTPARDEF_MACENABLED 0
 
/* PHY Testmode Setup Parameter Structure */
struct PHYTestPar
{
    uint16_t PACKETPERIOD;   
    uint8_t  PACKETLENGTH;   
    uint32_t NUMBEROFPKTS;   
    uint8_t  PACKETDATATYPE; 
    uint8_t  CHANNEL;        
    uint8_t  TXPOWER_IB;     
    uint8_t  TXPOWER_PB;     
    uint8_t  TXPOWER_BOOST;  
    uint8_t  TXCONT;
    uint8_t  EDTHRESHOLD; 
    uint8_t  RX_FFSYNC;   
    uint8_t  LO_1_RXTXB;  
    uint8_t  LO_2_FDAC;   
    uint8_t  LO_3_LOCKS;  
    uint8_t  LO_3_PERIOD; 
    uint8_t  ATM;         
    uint8_t  MPW2_OVWR;   
    uint8_t  MACENABLED;  
};
 
/* PHY Testmode Results/Runtime Parameter Structure */
struct PHYTestRes
{
    uint16_t SEQUENCENUMBER;  
    uint32_t PACKET_COUNT;    
    uint8_t  PACKET_RECEIVED; 
    uint8_t  TEST_RUNNING;    
    uint32_t LOERR_COUNT;     
    uint32_t CRCERR_COUNT;    
    uint32_t PHRERR_COUNT;    
    uint32_t SHRERR_COUNT;    
    uint32_t PREERR_COUNT;    
    uint32_t MISSED_COUNT;    
    int32_t  FO_AVG;          
    uint32_t ED_AVG;          
    uint32_t CS_AVG;          
    int32_t  FO_AVG_TOTAL;    
    uint32_t ED_AVG_TOTAL;    
    uint32_t CS_AVG_TOTAL;    
    uint8_t  ED_MAX;          
    uint8_t  ED_MIN;          
    uint8_t  CS_MAX;          
    uint8_t  CS_MIN;          
};
 
/******************************************************************************/
/****** Locally used Definitions for PHY Tests                           ******/
/******************************************************************************/
#define PHY_TEST_REPORT_PERIOD 5000 
 
/* Modes for PHYTestStatistics() */
#define TEST_STAT_ACCUM 0  /* accumulate */
#define TEST_STAT_INIT 1   /* initialise */
#define TEST_STAT_REPORT 2 /* averages for interim reporting */
#define TEST_STAT_FINAL 3  /* averages for final reporting */
 
/******************************************************************************/
/****** Global Variables defined in test15_4_phy_tests.c                  ******/
/******************************************************************************/
extern uint8_t           PHY_TESTMODE;
extern struct PHYTestPar PHY_TESTPAR;
extern struct PHYTestRes PHY_TESTRES;
 
/******************************************************************************/
/****** Function Declarations for Externally Defined Functions           ******/
/******************************************************************************/
 
/******************************************************************************/
/***************************************************************************/ 
unsigned long test15_4_getms(void);
 
/******************************************************************************/
/****** Function Declarations for test15_4_phy_tests.c                   ******/
/******************************************************************************/
/* PHY Test Functions */
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestModeHandler(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestInitialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestDeinitialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestTransmitPacket(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReceivePacketPER(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReceivePacketPSN(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReceiveED(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestLOLocking(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestExit(char *errmsg);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestInitTestResults(void);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReset(void);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestStatistics(uint8_t mode, uint8_t ed, uint8_t cs, uint8_t fo);
 
/******************************************************************************/
/***************************************************************************/ 
uint32_t PHYTest_divu32round(uint32_t va, uint32_t vb);
 
/******************************************************************************/
/***************************************************************************/ 
int32_t PHYTest_divs32round(int32_t va, int32_t vb);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestCalculateReportTime(uint8_t init);
/* PHY Test Reporting Functions */
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportTestMode(void);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportTestParameters(uint8_t parameter);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportPacketTransmitted(struct MAC_Message *msg, uint8_t status);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportTransmitPacketAnalysis(void);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportPacketReceived(struct TDME_RXPKT_indication_pset *params);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportReceivedPacketAnalysis(void);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportTestResult(void);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportEDReceived(struct TDME_EDDET_indication_pset *params);
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestReportLOLocking(struct TDME_LOTLK_confirm_pset *params, uint8_t ntest);
/* PHY Functions in EVBME Attribute Control */
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestCfg(uint8_t val);
/* PHY Test Wrappers for TDME Commands and Responses */
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHY_TESTMODE_request(uint8_t testmode, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHY_SET_request(uint8_t evbme_attribute, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHY_TXPKT_request(struct MAC_Message *msg, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHY_LOTLK_request(uint8_t ch, uint8_t rx_txb, uint8_t ntest, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
int PHY_RXPKT_indication(struct TDME_RXPKT_indication_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
int PHY_EDDET_indication(struct TDME_EDDET_indication_pset *params, struct ca821x_dev *pDeviceRef);
/******************************************************************************/
/****** Function Declarations for test15_4_phy_tests_mac.c               ******/
/******************************************************************************/
/* PHY_MAC Test Functions */
 
/******************************************************************************/
/***************************************************************************/ 
void PHYTestMACAddInit(void);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestMACTxInitialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestMACRxInitialise(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHYTestMACDeinitialise(struct ca821x_dev *pDeviceRef);
/* PHY_MAC Test Wrappers for MCPS Commands and Responses */
uint8_t PHY_TXPKT_MAC_request(struct MAC_Message *msg, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHY_RXPKT_MAC_indication(struct MCPS_DATA_indication_pset *params, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
uint8_t PHY_TXPKT_MAC_confirm(struct MCPS_DATA_confirm_pset *params, struct ca821x_dev *pDeviceRef);
 
#endif /* TEST15_4_PHY_TESTS_H */