ospi.h

Go to the documentation of this file.

/******************************************************************************
 *  Filename:       ospi.h
 *
 *  Description:    Defines and prototypes for the OSPI 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 __OSPI_H__
#define __OSPI_H__

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

#include "../inc/hw_memmap.h"
#include "../inc/hw_ospi.h"
#include "../inc/hw_types.h"

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

//*****************************************************************************
//
// Configuration values that can be passed to \ref OSPIGetSTIGDataRegister() as the regSelect parameter
//
//*****************************************************************************
#define OSPI_STIG_READ_DATA_LOWER OSPI_O_FLASH_RD_DATA_LOWER
#define OSPI_STIG_READ_DATA_UPPER OSPI_O_FLASH_RD_DATA_UPPER

//*****************************************************************************
//
// Configuration values that can be passed to OSPIExecuteSTIGWriteCommand() as the OSPISTIGConfig_t parameter
//
//*****************************************************************************
#define OSPI_STIG_MEMORY_BANK_TRANSFER_ENABLE  OSPI_FLASH_CMD_CTRL_STIG_MEM_BANK_EN_ENABLE
#define OSPI_STIG_MEMORY_BANK_TRANSFER_DISABLE OSPI_FLASH_CMD_CTRL_STIG_MEM_BANK_EN_DISABLE

#define OSPI_STIG_WRITE_DATA_ENABLE  OSPI_FLASH_CMD_CTRL_ENB_WRITE_DATA_ENABLE
#define OSPI_STIG_WRITE_DATA_DISABLE OSPI_FLASH_CMD_CTRL_ENB_MODE_BIT_DISABLE

#define OSPI_STIG_MODE_BIT_ENABLE  OSPI_FLASH_CMD_CTRL_ENB_MODE_BIT_ENABLE
#define OSPI_STIG_MODE_BIT_DISABLE OSPI_FLASH_CMD_CTRL_ENB_MODE_BIT_DISABLE

#define OSPI_STIG_COMMAND_ADDRESS_ENABLE  OSPI_FLASH_CMD_CTRL_ENB_COMD_ADDR_ENABLE
#define OSPI_STIG_COMMAND_ADDRESS_DISABLE OSPI_FLASH_CMD_CTRL_ENB_COMD_ADDR_DISABLE

#define OSPI_STIG_READ_DATA_ENABLE  OSPI_FLASH_CMD_CTRL_ENB_READ_DATA_ENABLE
#define OSPI_STIG_READ_DATA_DISABLE OSPI_FLASH_CMD_CTRL_ENB_READ_DATA_DISABLE

//*****************************************************************************
//
// Enumerations
//
//*****************************************************************************

typedef enum
{
    OSPI_FLASH_STA_REG_WIP  = 0x01, 
    OSPI_FLASH_STA_REG_WEL  = 0x02, 
    OSPI_FLASH_STA_REG_BP0  = 0x04, 
    OSPI_FLASH_STA_REG_BP1  = 0x08, 
    OSPI_FLASH_STA_REG_BP2  = 0x10, 
    OSPI_FLASH_STA_REG_BP3  = 0x20, 
    OSPI_FLASH_STA_REG_QE   = 0x40, 
    OSPI_FLASH_STA_REG_SRWD = 0x80  
} OSPIFlashStatusRegister;

typedef enum
{
    OSPI_COMMAND_WRSR      = 0x01, 
    OSPI_COMMAND_WRITE     = 0x02, 
    OSPI_COMMAND_READ      = 0x03, 
    OSPI_COMMAND_FAST_READ = 0x0B, 
    OSPI_COMMAND_RDSR      = 0x05, 
    OSPI_COMMAND_WREN      = 0x06, 
    OSPI_COMMAND_SE        = 0x20, 
    OSPI_COMMAND_CE        = 0x60, 
    OSPI_COMMAND_QEN       = 0x35, 
    OSPI_COMMAND_QDIS      = 0xF5, 
    OSPI_COMMAND_RSTEN     = 0x66, 
    OSPI_COMMAND_RST       = 0x99  
} OSPISTIGCommand;

typedef enum
{
    OSPI_INSTR_TYPE_SPI          = 0, 
    OSPI_INSTR_TYPE_DUAL_SPI     = 1, 
    OSPI_INSTR_TYPE_QUAD_IO_SPI  = 2, 
    OSPI_INSTR_TYPE_OCTAL_IO_SPI = 3  
} OSPIInstructionType;

typedef struct
{
    uint8_t stigOpcode;
    uint8_t stigRdEn;
    uint8_t stigRDNumBytes;
    uint8_t stigAddrEn;
    uint8_t stigAddrNumBytes;
    uint8_t stigModeBitEN;
    uint8_t stigWrEn;
    uint8_t stigWrNumBytes;
    uint8_t stigNumDummyCycles;
    uint8_t stigMemoryEn;
} OSPISTIGConfig_t;

//*****************************************************************************
//
//
//*****************************************************************************
uint32_t OSPIGetSTIGDataRegister(uint32_t regSelect);

//*****************************************************************************
//
//
//*****************************************************************************
void OSPIExecuteSTIGWriteCommand(OSPISTIGConfig_t OspiStigCommand);

//*****************************************************************************
//
//
//*****************************************************************************
void OSPIStartSTIGCommand(uint32_t configReg);

//*****************************************************************************
//
//
//*****************************************************************************
void OSPISetCommandAddress(uint32_t address);

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

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

#endif // __OSPI_H__