ram.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-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:
 *
 *    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 RAM_H_
#define RAM_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/hw_include/soc_config.h>
 
typedef void  *Ram_Handle;
 
typedef struct Ram_Config_s Ram_Config;
 
typedef struct Ram_Params_s Ram_Params;
 
typedef struct Ram_Devconfig_s 
{
    uint8_t cmdRd;
    uint8_t cmdWr;
    uint8_t cmdReset;
    uint8_t cmdRegRd;
    uint8_t cmdRegWr;
    uint8_t dummyClksRd;
    uint8_t dummyClksWr;
    uint8_t dummyClksCmd;
 
} Ram_DevConfig;
 
typedef struct Ram_Attrs_s {
 
    uint32_t ramType;      
    char *ramName;         
    uint32_t deviceId;       
    uint32_t manufacturerId; 
    uint32_t driverInstance; 
    uint32_t ramSize;      
} Ram_Attrs;
 
typedef int32_t (*Ram_OpenFxn)(Ram_Config *config);
 
typedef void (*Ram_CloseFxn)(Ram_Config *config);
 
typedef int32_t (*Ram_ReadFxn)(Ram_Config *config, uint32_t offset,
                                   uint8_t *buf, uint32_t len) ;
 
typedef int32_t (*Ram_WriteFxn)(Ram_Config *config, uint32_t offset,
                                   uint8_t *buf, uint32_t len) ;
 
typedef struct Ram_Fxns_s
{
    Ram_OpenFxn  openFxn;  
    Ram_CloseFxn closeFxn; 
    Ram_ReadFxn  readFxn;  
    Ram_WriteFxn writeFxn; 
} Ram_Fxns;
 
typedef struct Ram_Config_s
{
    Ram_Attrs                *attrs;       
    Ram_Fxns                 *fxns;        
    Ram_DevConfig            *devConfig;
    void                     *object;      
} Ram_Config;
 
typedef int32_t (*Ram_quirksFxn)(Ram_Config *config);
 
typedef int32_t (*Ram_custProtocolFxn)(Ram_Config *config);
 
typedef struct Ram_Params_s {
 
    Ram_quirksFxn quirksFxn;
    Ram_custProtocolFxn custProtoFxn;
 
} Ram_Params;
 
#if defined (DRV_VERSION_RAM_V0)
#include <board/ram/gpmc/psram_gpmc.h>
#endif
 
#if defined (DRV_VERSION_RAM_V0) && defined (DRV_VERSION_OSPI_V0)
#include <board/ram/ospi/psram_ospi.h>
#endif
 
Ram_Attrs *Ram_getAttrs(uint32_t instanceId);
 
Ram_Handle Ram_open(uint32_t instanceId, Ram_Params *params);
 
void Ram_close(Ram_Handle handle);
 
int32_t Ram_write(Ram_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len);
 
int32_t Ram_read(Ram_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RAM_H_ */