xip.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       xip.h
 *
 *  Description:    Defines and prototypes for the XIP peripheral.
 *
 *  Copyright (c) 2024 Texas Instruments Incorporated
 *
 *  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 __XIP_H__
#define __XIP_H__

//*****************************************************************************
//
//
//*****************************************************************************

#include <stdint.h>
#include "ospi.h"
#include "../inc/hw_types.h"
#include "../inc/hw_host_xip.h"

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C" {
#endif

#define XIP_UDMA_BIT_SECURE_MASK 0x04000000

// UDMA peripheral processing status enumerations for use with #XIPGetUDMAChannelProgressingStatus().
#define XIP_UDMA_CHANNEL_STATUS_IDLE     0 
#define XIP_UDMA_CHANNEL_STATUS_PROGRESS 1 

// UDMA data movement direction
#define XIP_UDMA_DIRECTION_EXT_TO_INT 0 
#define XIP_UDMA_DIRECTION_INT_TO_EXT 1 

// UDMA job status
#define XIP_UDMA_JOB_STARTED   0    
#define XIP_UDMA_JOB_NOT_START (-1) 

//*****************************************************************************
//
// UDMA interrupt status values returned by XIPGetUDMAIrqStatus()
//
//*****************************************************************************
#define XIP_UDMA_JOB_IRQ_STATUS_DONE      0 
#define XIP_UDMA_JOB_IRQ_STATUS_BUS_ERROR 1 
#define XIP_UDMA_JOB_IRQ_STATUS_SEC_ERROR 2 

#define XIP_UDMA_NON_SECURE_CHANNEL 0
#define XIP_UDMA_SECURE_CHANNEL     1

//*****************************************************************************
//
// Functions
//
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
uint32_t XIPStartUDMATransaction(const uint32_t *srcAddr,
                                 uint32_t *dstAddr,
                                 uint32_t length,
                                 uint8_t directionMode,
                                 uint32_t channelSelect);

//*****************************************************************************
//
//
//*****************************************************************************
uint32_t XIPGetUDMAChannelProgressingStatus(uint32_t channelSelect);

//*****************************************************************************
//
//
//*****************************************************************************
uint32_t XIPGetUDMAChannelWordsLeft(uint32_t channelSelect);

//*****************************************************************************
//
//
//*****************************************************************************
uint32_t XIPGetUDMAIrqStatus(uint32_t channelSelect);

//*****************************************************************************
//
//
//*****************************************************************************
void XIPDisableOTFDE(void);

//*****************************************************************************
//
//
//*****************************************************************************
void XIPEnableOTFDE(void);

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//*****************************************************************************
//
//
//*****************************************************************************

#endif // __XIP_H__