eeprom_002.h

Go to the documentation of this file.

/*
 * @brief EEPROM registers and driver functions
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __EEPROM_002_H_
#define __EEPROM_002_H_

#include "sys_config.h"
#include "cmsis.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {    /* EEPROM Structure */
 __IO uint32_t CMD;   
 uint32_t RESERVED0;
 __IO uint32_t RWSTATE;  
 __IO uint32_t AUTOPROG;  
 __IO uint32_t WSTATE;  
 __IO uint32_t CLKDIV;  
 __IO uint32_t PWRDWN;  
 uint32_t RESERVED2[1007];
 __O  uint32_t INTENCLR;  
 __O  uint32_t INTENSET;  
 __I  uint32_t INTSTAT;  
 __I  uint32_t INTEN;  
 __O  uint32_t INTSTATCLR; 
 __O  uint32_t INTSTATSET; 
} IP_EEPROM_002_T;

/*
 * @brief Macro defines for EEPROM command register
 */
#define EEPROM_CMD_ERASE_PRG_PAGE       (6)  
/*
 * @brief Macro defines for EEPROM Auto Programming register
 */
#define EEPROM_AUTOPROG_OFF     (0)  
#define EEPROM_AUTOPROG_AFT_1WORDWRITTEN     (1)  
#define EEPROM_AUTOPROG_AFT_LASTWORDWRITTEN  (2)  
/*
 * @brief Macro defines for EEPROM power down register
 */
#define EEPROM_PWRDWN                   (1 << 0)

/*
 * @brief Macro defines for EEPROM interrupt related registers
 */
#define EEPROM_INT_ENDOFPROG               (1 << 2)

STATIC INLINE void IP_EEPROM_SetCmd(IP_EEPROM_002_T *pEEPROM, uint32_t cmd)
{
 pEEPROM->CMD = cmd;
}

STATIC INLINE void IP_EEPROM_SetAutoProg(IP_EEPROM_002_T *pEEPROM, uint32_t mode)
{
 pEEPROM->AUTOPROG = mode;
}

STATIC INLINE void IP_EEPROM_SetReadWaitState(IP_EEPROM_002_T *pEEPROM, uint32_t ws)
{
 pEEPROM->RWSTATE = ws;
}

STATIC INLINE void IP_EEPROM_SetWaitState(IP_EEPROM_002_T *pEEPROM, uint32_t ws)
{
 pEEPROM->WSTATE = ws;
}

STATIC INLINE void IP_EEPROM_EnablePowerDown(IP_EEPROM_002_T *pEEPROM)
{
 pEEPROM->PWRDWN = EEPROM_PWRDWN;
}

STATIC INLINE void IP_EEPROM_DisablePowerDown(IP_EEPROM_002_T *pEEPROM)
{
 pEEPROM->PWRDWN = 0;
}

STATIC INLINE void IP_EEPROM_EnableInt(IP_EEPROM_002_T *pEEPROM, uint32_t mask)
{
 pEEPROM->INTENSET =  mask;
}

STATIC INLINE void IP_EEPROM_DisableInt(IP_EEPROM_002_T *pEEPROM, uint32_t mask)
{
 pEEPROM->INTENCLR =  mask;
}

STATIC INLINE uint32_t IP_EEPROM_GetIntEnable(IP_EEPROM_002_T *pEEPROM)
{
 return pEEPROM->INTEN;
}

STATIC INLINE uint32_t IP_EEPROM_GetIntStatus(IP_EEPROM_002_T *pEEPROM)
{
 return pEEPROM->INTSTAT;
}

STATIC INLINE void IP_EEPROM_SetIntStatus(IP_EEPROM_002_T *pEEPROM, uint32_t mask)
{
 pEEPROM->INTSTATSET =  mask;
}

STATIC INLINE void IP_EEPROM_ClearIntStatus(IP_EEPROM_002_T *pEEPROM, uint32_t mask)
{
 pEEPROM->INTSTATCLR =  mask;
}

void IP_EEPROM_Init(IP_EEPROM_002_T *pEEPROM, uint32_t div);

STATIC INLINE void IP_EEPROM_DeInit(IP_EEPROM_002_T *pEEPROM)
{
 /* Enable EEPROM power down mode */
 IP_EEPROM_EnablePowerDown(pEEPROM);
}

void IP_EEPROM_EraseProgramPage(IP_EEPROM_002_T *pEEPROM);

void IP_EEPROM_WaitForIntStatus(IP_EEPROM_002_T *pEEPROM, uint32_t mask);

#ifdef __cplusplus
}
#endif

#endif /* __EEPROM_002_H_ */