chili_test.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 CHILI_TEST_H
#define CHILI_TEST_H
 
#include "cascoda-bm/cascoda_types.h"
 
/******************************************************************************/
/****** EVBME TEMPSENSE Command ID Codes                                 ******/
/******************************************************************************/
#define EVBME_TEST_START_TEST (0x9F)   /* start test (automatic by GUI) */
#define EVBME_TEST_START_TEST_2 (0x9E) /* start test (manual command) */
#define EVBME_TEST_SETUP_REF (0x9D)    /* configure reference device */
 
/******************************************************************************/
/****** EVBME Command ID Code for Starting Test (DUT)                    ******/
/******************************************************************************/
/* Test Command Packet Payload for extra Safety */
#define EVBME_TEST_LEN (3)
#define EVBME_TEST_DATA0 (0x5A)
#define EVBME_TEST_DATA1 (0xA5)
#define EVBME_TEST_DATA2 (0x81)
 
/******************************************************************************/
/****** Test Limits                                                      ******/
/******************************************************************************/
#define CHILI_TEST_CS_LIMIT 200    
#define CHILI_TEST_ED_LIMIT 100    
#define CHILI_TEST_DUT_TIMEOUT 400 
 
/******************************************************************************/
/****** Test Mode Definitions                                            ******/
/******************************************************************************/
#define CHILI_TEST_OFF 0 
#define CHILI_TEST_DUT 1 
#define CHILI_TEST_REF 2 
 
/******************************************************************************/
/****** MAC PIB Values for Test                                          ******/
/******************************************************************************/
#define CHILI_TEST_DUT_SHORTADD 0xCAFE 
#define CHILI_TEST_REF_SHORTADD 0xCAFF 
#define CHILI_TEST_CHANNEL 11          
#define CHILI_TEST_PANID 0xCA5C        
 
/******************************************************************************/
/****** Test Communication State Definitions                             ******/
/******************************************************************************/
#define CHILI_TEST_CST_DONE 0x00            
#define CHILI_TEST_CST_DUT_D_REQUESTED 0x01 
#define CHILI_TEST_CST_DUT_D_CONFIRMED 0x02 
#define CHILI_TEST_CST_DUT_DISPLAY 0x03     
#define CHILI_TEST_CST_DUT_FINISHED 0x04    
 
/******************************************************************************/
/****** Test Packet Types, defined by MSDU[0]                            ******/
/******************************************************************************/
#define PT_MSDU_TEST_DUT 0xAA 
#define PT_MSDU_TEST_REF 0xBB 
 
/******************************************************************************/
/****** Test Result/Status Definitions                                   ******/
/******************************************************************************/
#define CHILI_TEST_ST_SUCCESS 0x00          
#define CHILI_TEST_ST_NOCOMMS 0x01          
#define CHILI_TEST_ST_DATA_CNF_UNEXP 0x02   
#define CHILI_TEST_ST_DATA_CNF_TIMEOUT 0x03 
#define CHILI_TEST_ST_DATA_CNF_NO_ACK 0x04  
#define CHILI_TEST_ST_DATA_CNF_CHACCF 0x05  
#define CHILI_TEST_ST_DATA_CNF_TROVFL 0x06  
#define CHILI_TEST_ST_DATA_CNF_OTHERS 0x07  
#define CHILI_TEST_ST_DATA_IND_UNEXP 0x08   
#define CHILI_TEST_ST_DATA_IND_TIMEOUT 0x09 
#define CHILI_TEST_ST_DATA_IND_ID 0x0A      
#define CHILI_TEST_ST_TIMEOUT 0x0B          
#define CHILI_TEST_ST_CS_REF_LOW 0x0C       
#define CHILI_TEST_ST_CS_DUT_LOW 0x0D       
#define CHILI_TEST_ST_ED_REF_LOW 0x0E       
#define CHILI_TEST_ST_ED_DUT_LOW 0x0F       
 
/******************************************************************************/
/****** TEST Functions                                                   ******/
/******************************************************************************/
 
/******************************************************************************/
/***************************************************************************/ 
void CHILI_TEST_Initialise(u8_t status, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
void CHILI_TEST_Handler(struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
int CHILI_TEST_UpStreamDispatch(struct SerialBuffer *SerialRxBuffer, struct ca821x_dev *pDeviceRef);
 
/******************************************************************************/
/***************************************************************************/ 
u8_t CHILI_TEST_IsInTestMode(void);
 
#endif // CHILI_TEST_H