eeprom_emulation_type_b.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_b.h
 *  @brief      EEPROM Emulation Type B
 *  @defgroup   EEPROM_TYPE_B EEPROM Emulation Type B
 *
 *  @anchor EEPROM_EMULATION_TYPE_B_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 B solution is suitable if the user application
 *  needs to store small "variable" data.
 *
 *  <hr>
 ******************************************************************************/
#include <stdbool.h>
#include <stdint.h>

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

#ifndef EEPROM_EMULATION_TYPE_B_H_
#define EEPROM_EMULATION_TYPE_B_H_

/* clang-format off */

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

#define EEPROM_EMULATION_GROUP_ACCOUNT                                       (3)

#define EEPROM_EMULATION_SECTOR_INGROUP_ACCOUNT                              (2)

#define EEPROM_EMULATION_REPAIR_ENABLE                                       (0)

#define EEPROM_EMULATION_DATAITEM_ACCOUNT                                      \
                             (EEPROM_EMULATION_SECTOR_INGROUP_ACCOUNT * 128 - 1)

#define EEPROM_EMULATION_ACTIVE_DATAITEM_NUM_MIN                             (0)

#define EEPROM_EMULATION_ACTIVE_DATAITEM_NUM_MAX                               \
                                             (EEPROM_EMULATION_DATAITEM_ACCOUNT)

#define EEPROM_EMULATION_ACTIVE_GROUP_NUM_MIN                                (1)

#define EEPROM_EMULATION_ACTIVE_GROUP_NUM_MAX   (EEPROM_EMULATION_GROUP_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_TRANSFER_OK                    ((uint32_t) 0x00000000U)

#define EEPROM_EMULATION_TRANSFER_ERROR                 ((uint32_t) 0x00000002U)

#define EEPROM_EMULATION_INIT_OK                        ((uint32_t) 0x00000000U)

#define EEPROM_EMULATION_INIT_OK_FORMAT_REPAIR          ((uint32_t) 0x00000004U)

#define EEPROM_EMULATION_INIT_OK_ALL_ERASE              ((uint32_t) 0x00000040U)

#define EEPROM_EMULATION_INIT_ERROR                     ((uint32_t) 0x00000400U)

#define EEPROM_EMULATION_FINDITEM_NOT_FOUND             ((uint32_t) 0x00000000U)

#define CHECK_ONE_ACTIVE_GROUP                          ((uint32_t) 0x00000000U)

#define CHECK_NO_ACTIVE_ONE_ERROR_GROUP                 ((uint32_t) 0x00000001U)

#define CHECK_NO_ACTIVE_NO_ERROR_GROUP                  ((uint32_t) 0x00000002U)

/* clang-format on */

extern uint16_t gActiveDataItemNum;
extern uint16_t gActiveGroupNum;

extern bool gEEPROMTypeBSearchFlag;
extern bool gEEPROMTypeBEraseFlag;

uint32_t EEPROM_TypeB_write(uint16_t identifier, uint32_t data);

uint32_t EEPROM_TypeB_writeDataItem(uint16_t identifier, uint32_t data,
    uint16_t groupNum, uint16_t dataItemNum);

uint32_t EEPROM_TypeB_transferDataItem(uint16_t groupNum);

uint32_t EEPROM_TypeB_readDataItem(uint16_t identifier);

uint32_t EEPROM_TypeB_findDataItem(
    uint16_t identifier, uint16_t groupNum, uint16_t dataItemNum);

uint32_t EEPROM_TypeB_init(void);

uint32_t EEPROM_TypeB_checkFormat(void);

bool EEPROM_TypeB_eraseGroup(void);

bool EEPROM_TypeB_eraseNonActiveGroups(void);

bool EEPROM_TypeB_eraseAllGroups(void);

#endif /* EEPROM_EMULATION_TYPE_B_H_ */