openthread/examples/platforms/cc1352/flash.c

/*
 *  Copyright (c) 2018, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. Neither the name of the copyright holder 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 HOLDER 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.
 */

#include <string.h>

#include <driverlib/aon_batmon.h>
#include <driverlib/flash.h>
#include <driverlib/interrupt.h>
#include <driverlib/vims.h>

#include <openthread-core-config.h>
#include <openthread/config.h>
#include <openthread/platform/alarm-milli.h>

#include <utils/code_utils.h>

#include "platform-cc1352.h"

/*
 * The settings configuration base address *MUST* be defined in the core config
 * file. The base address *MUST* be aligned on an 8K page boundary or the flash
 * program calls will fail.
 */
#ifndef SETTINGS_CONFIG_BASE_ADDRESS
#error "SETTINGS_CONFIG_BASE_ADDRESS not defined in the OpenThread Core Config"
#endif /* SETTINGS_CONFIG_BASE_ADDRESS */

/*
 * The settings configuration page size *MUST* be defined in the core config
 * file. The page size *MUST* be 8K or the flash program calls will fail.
 */
#if (SETTINGS_CONFIG_PAGE_SIZE != 0x2000)
#error "SETTINGS_CONFIG_PAGE_SIZE must be defined in OpenThread Core Config"
#endif

/*
 * The settings configuration page number _SHOULD_ be defined in the core
 * config file.
 */
#ifndef SETTINGS_CONFIG_PAGE_NUM
#warn "SETTINGS_CONFIG_PAGE_NUM not defined in the OpenThread Core Config"
#endif /* SETTINGS_CONFIG_PAGE_NUM */

enum
{
    MIN_VDD_FLASH       = 0x18, /* 1.50 volts (0.50=128/256 -> 128=0x80) */
    MAX_WRITE_INCREMENT = 8,    /* maximum number of bytes to write at a time to
                                 * avoid interrupt latency while in ROM
                                 */
};

/**
 * Check if the Battery Monitor measurements and calculations are enabled.
 *
 * @return If the Battery Monitor is enabled.
 * @retval true  The Battery Monitor is on.
 * @retval false The Battery Monitor is off.
 */
static bool isBatMonOn(void)
{
    uint32_t batMonCtl = HWREG(AON_BATMON_BASE + AON_BATMON_O_CTL);
    return ((batMonCtl & AON_BATMON_CTL_CALC_EN_M) == AON_BATMON_CTL_CALC_EN &&
            (batMonCtl & AON_BATMON_CTL_MEAS_EN_M) == AON_BATMON_CTL_MEAS_EN);
}

/**
 * Check if the supply voltage is high enough to support flash programming.
 *
 * @return If the Voltage is too low to support flash programming.
 * @retval false The supply voltage is too low.
 * @retval true  The supply voltage is sufficient.
 */
static bool checkVoltage(void)
{
    bool batMonWasOff = !isBatMonOn();
    bool ret          = false;

    if (batMonWasOff)
    {
        AONBatMonEnable();
    }

    if (AONBatMonBatteryVoltageGet() >= MIN_VDD_FLASH)
    {
        ret = true;
    }

    if (batMonWasOff)
    {
        AONBatMonDisable();
    }

    return ret;
}

/**
 * Disable Flash data caching and instruction pre-fetching.
 *
 * It is necessary to disable the caching and VIMS to ensure the cache has
 * valid data while the program is executing.
 *
 * @return The VIMS state before being disabled.
 */
static uint32_t disableFlashCache(void)
{
    uint32_t mode = VIMSModeGet(VIMS_BASE);

    VIMSLineBufDisable(VIMS_BASE);

    if (mode != VIMS_MODE_DISABLED)
    {
        VIMSModeSet(VIMS_BASE, VIMS_MODE_DISABLED);

        while (VIMSModeGet(VIMS_BASE) != VIMS_MODE_DISABLED)
            ;
    }

    return mode;
}

/**
 * Restore the Flash data caching and instruction pre-fetching.
 *
 * @param [in] mode The VIMS mode returned by @ref disableFlashCache.
 */
static void restoreFlashCache(uint32_t mode)
{
    if (mode != VIMS_MODE_DISABLED)
    {
        VIMSModeSet(VIMS_BASE, mode);
    }

    VIMSLineBufEnable(VIMS_BASE);
}

/**
 * Translate the errors from the Flash programming FSM to OpenThread error
 * codes.
 *
 * @param [in] error Return from the Flash programming function.
 *
 * @return The corresponding OpenThread @ref otError value.
 */
static otError fsmErrorToOtError(uint32_t error)
{
    otError ret = OT_ERROR_GENERIC;

    switch (error)
    {
    case FAPI_STATUS_SUCCESS:
        ret = OT_ERROR_NONE;
        break;

    case FAPI_STATUS_INCORRECT_DATABUFFER_LENGTH:
        ret = OT_ERROR_INVALID_ARGS;
        break;

    case FAPI_STATUS_FSM_ERROR:
        ret = OT_ERROR_FAILED;
        break;

    default:
        break;
    }

    return ret;
}

/**
 * Function documented in platforms/utils/flash.h
 */
otError utilsFlashInit(void)
{
    return OT_ERROR_NONE;
}

/**
 * Function documented in platforms/utils/flash.h
 */
uint32_t utilsFlashGetSize(void)
{
    return FlashSizeGet();
}

/**
 * Function documented in platforms/utils/flash.h
 */
otError utilsFlashErasePage(uint32_t aAddress)
{
    uint32_t mode;
    uint32_t fsmRet;
    otError  ret;

    otEXPECT_ACTION(checkVoltage(), ret = OT_ERROR_FAILED);

    mode = disableFlashCache();

    fsmRet = FlashSectorErase(aAddress);

    restoreFlashCache(mode);

    ret = fsmErrorToOtError(fsmRet);

exit:
    return ret;
}

/**
 * Function documented in platforms/utils/flash.h
 */
otError utilsFlashStatusWait(uint32_t aTimeout)
{
    uint32_t start = otPlatAlarmMilliGetNow();
    otError  ret   = OT_ERROR_BUSY;

    while ((otPlatAlarmMilliGetNow() - start) < aTimeout)
    {
        if (FlashCheckFsmForReady() == FAPI_STATUS_FSM_READY)
        {
            ret = OT_ERROR_NONE;
            break;
        }
    }

    return ret;
}

/**
 * Function documented in platforms/utils/flash.h
 */
uint32_t utilsFlashWrite(uint32_t aAddress, uint8_t *aData, uint32_t aSize)
{
    uint32_t mode;
    uint32_t written = 0;

    otEXPECT(checkVoltage());

    mode = disableFlashCache();

    while (written < aSize)
    {
        uint32_t toWrite = aSize - written;
        uint8_t *data    = aData + written;
        uint32_t address = aAddress + written;
        uint32_t fsmRet;
        bool     interruptsWereDisabled;

        if (toWrite > MAX_WRITE_INCREMENT)
        {
            toWrite = MAX_WRITE_INCREMENT;
        }

        /* The CPU may not execute code from flash while a program is
         * happening. We disable interrupts to ensure one does not preempt the
         * ROM fsm.
         */
        interruptsWereDisabled = IntMasterDisable();

        fsmRet = FlashProgram(data, address, toWrite);

        if (!interruptsWereDisabled)
        {
            IntMasterEnable();
        }

        if (fsmRet != FAPI_STATUS_SUCCESS)
        {
            break;
        }

        written += toWrite;
    }

    restoreFlashCache(mode);

exit:
    return written;
}

/**
 * Function documented in platforms/utils/flash.h
 */
uint32_t utilsFlashRead(uint32_t aAddress, uint8_t *aData, uint32_t aSize)
{
    memcpy(aData, (void *)aAddress, (size_t)aSize);

    return aSize;
}