eeprom_emulation_type_a.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, 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.
 */
/*!****************************************************************************
 *  @file       eeprom_emulation_type_a.h
 *  @brief      EEPROM Emulation Type A
 *  @defgroup   EEPROM_TYPE_A EEPROM Emulation Type A
 *
 *  @anchor EEPROM_EMULATION_TYPE_A_H__Overview
 *  # Overview
 *
 *  MSPM0 support EEPROM emulation through its internal Flash. Compared to using
 *  an external serial EEPROM, EEPROM emulation using the internal Flash saves
 *  pin usage and cost.
 *  The EEPROM emulation Type A solution is suitable if the user application
 *  needs to store large "blocks" of data.
 *
 *  <hr>
 ******************************************************************************/
#ifndef EEPROM_EMULATION_TYPE_A_H_
#define EEPROM_EMULATION_TYPE_A_H_

#include <stdbool.h>
#include <stdint.h>

#include <ti/devices/msp/msp.h>
#include <ti/driverlib/driverlib.h>
#include <ti/driverlib/m0p/dl_core.h>

/* clang-format off */

#ifndef EEPROM_EMULATION_ADDRESS
#define EEPROM_EMULATION_ADDRESS                                    (0x00001000)
#endif

#define EEPROM_EMULATION_SECTOR_ACCOUNT                                      (2)

#define EEPROM_EMULATION_RECORD_SIZE                                       (128)

#define EEPROM_EMULATION_DATA_SIZE            (EEPROM_EMULATION_RECORD_SIZE - 8)

#define EEPROM_EMULATION_RECORD_ACCOUNT    (1024 / EEPROM_EMULATION_RECORD_SIZE)

#define EEPROM_EMULATION_ACTIVE_RECORD_NUM_MIN                               (1)

#define EEPROM_EMULATION_ACTIVE_RECORD_NUM_MAX                                 \
                                               (EEPROM_EMULATION_RECORD_ACCOUNT)

#define EEPROM_EMULATION_ACTIVE_SECTOR_NUM_MIN                               (1)

#define EEPROM_EMULATION_ACTIVE_SECTOR_NUM_MAX                                 \
                                               (EEPROM_EMULATION_SECTOR_ACCOUNT)

#define EEPROM_EMULATION_WRITE_OK                       ((uint32_t) 0x00000000U)

#define EEPROM_EMULATION_WRITE_ERROR                    ((uint32_t) 0x00000001U)

#define EEPROM_EMULATION_FORMAT_ERROR                   ((uint32_t) 0x00000010U)

#define EEPROM_EMULATION_INIT_OK                        ((uint32_t) 0x00000000U)

#define EEPROM_EMULATION_INIT_ERROR                     ((uint32_t) 0x00000002U)

/* clang-format on */

extern uint32_t gActiveRecordAddress;
extern uint32_t gNextRecordAddress;
extern uint16_t gActiveRecordNum;
extern uint16_t gActiveSectorNum;

extern bool gEEPROMTypeASearchFlag;
extern bool gEEPROMTypeAEraseFlag;
extern bool gEEPROMTypeAFormatErrorFlag;

uint32_t EEPROM_TypeA_writeData(uint32_t *data);

uint32_t EEPROM_TypeA_init(uint32_t *data);

void EEPROM_TypeA_readData(uint32_t *data);

bool EEPROM_TypeA_repairFormat(uint32_t *data);

void EEPROM_TypeA_searchCheck(void);

bool EEPROM_TypeA_eraseLastSector(void);

bool EEPROM_TypeA_eraseNonActiveSectors(void);

bool EEPROM_TypeA_eraseAllSectors(void);

#endif /* EEPROM_EMULATION_TYPE_A_H_ */