csl_mem.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 04-May-2009 Created for retention mode support on C5505 PG1.4
 * 26-May-2009 Code modified as per the review comments
 * 14-Dec-2009 Added support for partial retention mode for chip C5515
 * ============================================================================
 */

#ifndef _CSL_MEM_H_
#define _CSL_MEM_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <cslr.h>
#include <csl_error.h>
#include <csl_types.h>
#include <soc.h>
#include <csl_general.h>

/*****************************************************************************\
          MEMORY global macro declarations
\*****************************************************************************/

#define CSL_DARAM_BANK_COUNT          (8)

#define CSL_SARAM_BANK_COUNT          (32)

#define CSL_DARAM_BANK_NUM_MAX        (CSL_DARAM_BANK_COUNT - 1)

#define CSL_SARAM_BANK_NUM_MAX        (CSL_SARAM_BANK_COUNT - 1)

#define CSL_MEM_DARAM_BANK0           (0)

#define CSL_MEM_DARAM_BANK7           (7u)

#define CSL_MEM_SARAM_BANK0           (0)

#define CSL_MEM_SARAM_BANK8           (8u)

#define CSL_MEM_SARAM_BANK16          (16u)

#define CSL_MEM_SARAM_BANK24          (24u)

#define CSL_MEM_SARAM_BANK31          (31u)

#define CSL_MEM_ENABLE_ALL_SLEEP      (0xAAAAu)

#define CSL_MEM_DISABLE_ALL_SLEEP     (0xFFFFu)

#define CSL_MEM_ENABLE_BANK_SLEEP     (0x0002)

#define CSL_MEM_DISABLE_BANK_SLEEP    (0x0003)

#define CSL_MEM_SLEEPMODE_BIT_MASK    (0x0003)

#define CSL_MEM_DARAM_BANKMASK        (0xFFu)

#define CSL_MEM_MAKE_BANKMASK(bankNumber)    ((Uint32)1 << bankNumber)

/**************************************************************************\
* MEMORY global typedef declarations                                       *
\**************************************************************************/

typedef enum
{
    CSL_MEM_DARAM,    /* Memory type is DARAM */
    CSL_MEM_SARAM,    /* Memory type is SARAM */
    CSL_MEM_INVALID   /* Invalid Memory type  */
} CSL_MemType;

typedef enum
{
    CSL_MEM_MSDARAM_CLOCK_ON,    /* MSDARAM clock will be set to ON  */
    CSL_MEM_MSDARAM_CLOCK_OFF    /* MSDARAM clock will be set to OFF */
} CSL_MEMmSDRAMClock;

/**************************************************************************\
* MEMORY function declarations                                              *
\**************************************************************************/

CSL_Status MEM_init(void);

CSL_Status MEM_enableRetentionMode (CSL_MemType    memType);

CSL_Status MEM_disableRetentionMode (CSL_MemType    memType);


#if (defined(CHIP_C5505_C5515) || defined(CHIP_C5504_C5514))

CSL_Status MEM_enablePartialRetentionMode (CSL_MemType    memType,
                                           Uint16         bankNumber,
                                           Uint32         bankMask);

CSL_Status MEM_disablePartialRetentionMode (CSL_MemType    memType,
                                            Uint16         bankNum,
                                            Uint32         bankMask);

CSL_Status MEM_setmSDRAMClock (CSL_MEMmSDRAMClock    clockSwitch);

Bool MEM_getmSDRAMClock (void);

#endif


#ifdef __cplusplus
}
#endif

#endif    // _CSL_MEM_H_