//###########################################################################
//
// FILE:    hw_spi.h
//
// TITLE:   Definitions for the SPI registers.
//
//###########################################################################
// $TI Release: F28004x Support Library v1.10.00.00 $
// $Release Date: Tue May 26 17:06:03 IST 2020 $
// $Copyright:
// Copyright (C) 2020 Texas Instruments Incorporated - http://www.ti.com/
//
// 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 HW_SPI_H
#define HW_SPI_H

//*****************************************************************************
//
// The following are defines for the SPI register offsets
//
//*****************************************************************************
#define SPI_O_CCR                 0x0U         // SPI Configuration Control
                                               // Register
#define SPI_O_CTL                 0x1U         // SPI Operation Control
                                               // Register
#define SPI_O_STS                 0x2U         // SPI Status Register
#define SPI_O_BRR                 0x4U         // SPI Baud Rate Register
#define SPI_O_RXEMU               0x6U         // SPI Emulation Buffer Register
#define SPI_O_RXBUF               0x7U         // SPI Serial Input Buffer
                                               // Register
#define SPI_O_TXBUF               0x8U         // SPI Serial Output Buffer
                                               // Register
#define SPI_O_DAT                 0x9U         // SPI Serial Data Register
#define SPI_O_FFTX                0xAU         // SPI FIFO Transmit Register
#define SPI_O_FFRX                0xBU         // SPI FIFO Receive Register
#define SPI_O_FFCT                0xCU         // SPI FIFO Control Register
#define SPI_O_PRI                 0xFU         // SPI Priority Control Register

//*****************************************************************************
//
// The following are defines for the bit fields in the SPICCR register
//
//*****************************************************************************
#define SPI_CCR_SPICHAR_S         0U
#define SPI_CCR_SPICHAR_M         0xFU         // Character Length Control
#define SPI_CCR_SPILBK            0x10U        // SPI Loopback
#define SPI_CCR_HS_MODE           0x20U        // High Speed mode control
#define SPI_CCR_CLKPOLARITY       0x40U        // Shift Clock Polarity
#define SPI_CCR_SPISWRESET        0x80U        // SPI Software Reset

//*****************************************************************************
//
// The following are defines for the bit fields in the SPICTL register
//
//*****************************************************************************
#define SPI_CTL_SPIINTENA         0x1U         // SPI Interupt Enable
#define SPI_CTL_TALK              0x2U         // Master/Slave Transmit Enable
#define SPI_CTL_MASTER_SLAVE      0x4U         // SPI Network Mode Control
#define SPI_CTL_CLK_PHASE         0x8U         // SPI Clock Phase
#define SPI_CTL_OVERRUNINTENA     0x10U        // Overrun Interrupt Enable

//*****************************************************************************
//
// The following are defines for the bit fields in the SPISTS register
//
//*****************************************************************************
#define SPI_STS_BUFFULL_FLAG      0x20U        // SPI Transmit Buffer Full Flag
#define SPI_STS_INT_FLAG          0x40U        // SPI Interrupt Flag
#define SPI_STS_OVERRUN_FLAG      0x80U        // SPI Receiver Overrun Flag

//*****************************************************************************
//
// The following are defines for the bit fields in the SPIBRR register
//
//*****************************************************************************
#define SPI_BRR_SPI_BIT_RATE_S    0U
#define SPI_BRR_SPI_BIT_RATE_M    0x7FU        // SPI Bit Rate Control

//*****************************************************************************
//
// The following are defines for the bit fields in the SPIFFTX register
//
//*****************************************************************************
#define SPI_FFTX_TXFFIL_S         0U
#define SPI_FFTX_TXFFIL_M         0x1FU        // TXFIFO Interrupt Level
#define SPI_FFTX_TXFFIENA         0x20U        // TXFIFO Interrupt Enable
#define SPI_FFTX_TXFFINTCLR       0x40U        // TXFIFO Interrupt Clear
#define SPI_FFTX_TXFFINT          0x80U        // TXFIFO Interrupt Flag
#define SPI_FFTX_TXFFST_S         8U
#define SPI_FFTX_TXFFST_M         0x1F00U      // Transmit FIFO Status
#define SPI_FFTX_TXFIFO           0x2000U      // TXFIFO Reset
#define SPI_FFTX_SPIFFENA         0x4000U      // FIFO Enhancements Enable
#define SPI_FFTX_SPIRST           0x8000U      // SPI Reset

//*****************************************************************************
//
// The following are defines for the bit fields in the SPIFFRX register
//
//*****************************************************************************
#define SPI_FFRX_RXFFIL_S         0U
#define SPI_FFRX_RXFFIL_M         0x1FU        // RXFIFO Interrupt Level
#define SPI_FFRX_RXFFIENA         0x20U        // RXFIFO Interrupt Enable
#define SPI_FFRX_RXFFINTCLR       0x40U        // RXFIFO Interupt Clear
#define SPI_FFRX_RXFFINT          0x80U        // RXFIFO Interrupt Flag
#define SPI_FFRX_RXFFST_S         8U
#define SPI_FFRX_RXFFST_M         0x1F00U      // Receive FIFO Status
#define SPI_FFRX_RXFIFORESET      0x2000U      // RXFIFO Reset
#define SPI_FFRX_RXFFOVFCLR       0x4000U      // Receive FIFO Overflow Clear
#define SPI_FFRX_RXFFOVF          0x8000U      // Receive FIFO Overflow Flag

//*****************************************************************************
//
// The following are defines for the bit fields in the SPIFFCT register
//
//*****************************************************************************
#define SPI_FFCT_TXDLY_S          0U
#define SPI_FFCT_TXDLY_M          0xFFU        // FIFO Transmit Delay Bits

//*****************************************************************************
//
// The following are defines for the bit fields in the SPIPRI register
//
//*****************************************************************************
#define SPI_PRI_TRIWIRE           0x1U         // 3-wire mode select bit
#define SPI_PRI_STEINV            0x2U         // SPISTE inversion bit
#define SPI_PRI_FREE              0x10U        // Free emulation mode
#define SPI_PRI_SOFT              0x20U        // Soft emulation mode
#endif
