fsi/v0/fsi.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 FSI_V0_H_
#define FSI_V0_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
/* Common defines for both FSI TX and RX */
 
#define FSI_MAX_LEN_NWORDS_DATA     ((uint16_t)0xFU)
 
#define FSI_MAX_VALUE_USERDATA      ((uint16_t)0xFFU)
 
#define FSI_MAX_VALUE_BUF_PTR_OFF   ((uint16_t)0xFU)
 
#define FSI_CTRL_REG_KEY            ((uint16_t)0xA5U)
 
 
typedef uint32_t FSI_DataWidth;
#define FSI_DATA_WIDTH_1_LANE       ((uint32_t)0x0U)
 
#define FSI_DATA_WIDTH_2_LANE       ((uint32_t)0x1U)
 
#define FSI_PINGTIMEOUT_ON_HWSWINIT_PING_FRAME ((uint32_t)0x1U)
 
typedef uint32_t FSI_ECCComputeWidth;
 
#define FSI_32BIT_ECC_COMPUTE       ((uint32_t)0x0U)
 
#define FSI_16BIT_ECC_COMPUTE       ((uint32_t)0x1U)
 
typedef uint32_t FSI_InterruptNum;
 
#define FSI_INT1                    ((uint32_t)0x0U)
 
#define FSI_INT2                    ((uint32_t)0x1U)
 
typedef uint32_t FSI_FrameType;
 
#define FSI_FRAME_TYPE_PING         ((uint32_t)0x0U)
 
#define FSI_FRAME_TYPE_ERROR        ((uint32_t)0xFU)
 
#define FSI_FRAME_TYPE_1WORD_DATA   ((uint32_t)0x4U)
 
#define FSI_FRAME_TYPE_2WORD_DATA   ((uint32_t)0x5U)
 
#define FSI_FRAME_TYPE_4WORD_DATA   ((uint32_t)0x6U)
 
#define FSI_FRAME_TYPE_6WORD_DATA   ((uint32_t)0x7U)
 
#define FSI_FRAME_TYPE_NWORD_DATA   ((uint32_t)0x3U)
 
typedef uint32_t FSI_PingTimeoutMode;
 
#define FSI_PINGTIMEOUT_ON_HWINIT_PING_FRAME   ((uint32_t)0x0U)
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef FSI_V0_H_ */