hyperRam.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 hyperRam_H_
 #define hyperRam_H_
 
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/hw_include/soc_config.h>
#include <drivers/hyperbus.h>
#include <kernel/dpl/SemaphoreP.h>
 
 #ifdef __cplusplus
 extern "C"
 {
 #endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
 typedef void  *HYPERRAM_Handle;
 
 typedef struct HyperRam_Config_s HyperRam_Config;
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
 typedef struct HyperRam_Attrs_s {
    char *HyperRamName;
    uint32_t driverInstance;
    uint16_t CR0;
    uint16_t CR1;
    uint16_t ID0;
    uint16_t ID1;
 } HyperRam_Attrs;
 
 struct HyperRam_Config_s
 {
    HyperRam_Attrs *attrs;
    void *object;
 };
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void HyperRam_init(void);
 
void HyperRam_deinit(void);
 
HYPERRAM_Handle HyperRam_open(uint32_t instanceId);
 
 void HyperRam_close(HYPERRAM_Handle handle);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
typedef struct {
   HYPERRAM_Handle handle;
   HYPERBUS_Handle hyperbusHandle;
   uint32_t isOpen;
   SemaphoreP_Object       lockObj;
 } HyperRam_Object;
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif /* hyperRam_H_ */