NvmManager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __NVMMANAGER_H__
#define __NVMMANAGER_H__

#include <stdint.h>
#include <sam.h>

#ifndef HIDE_FROM_DOXYGEN
namespace ClearCore {

class NvmManager {
public:

    typedef enum {
        NVM_LOC_USER_START      = 0, // First user-accessible byte after
        // Microchip's reserved 32 bytes (Section
        // 9.4 NVM User Page Mapping in the
        // datasheet)

        NVM_LOC_RESERVED_TEKNIC = 416, // Reserved 64 bytes of data for
        // Teknic use

        NVM_LOC_USER_MAX = NVMCTRL_PAGE_SIZE - 32,   // 480

        NVM_LOC_HW_REVISION = NVM_LOC_USER_MAX - 18,   // 462
        NVM_LOC_SERIAL_NUMBER = NVM_LOC_USER_MAX - 16, // 464

        NVM_LOC_MAC_FIRST  = NVM_LOC_USER_MAX - 12,    // 468
        NVM_LOC_MAC_SECOND = NVM_LOC_USER_MAX - 8,     // 472

        NVM_LOC_DAC_ZERO = NVM_LOC_USER_MAX - 4,       // 476
        NVM_LOC_DAC_SPAN = NVM_LOC_USER_MAX - 2,       // 478

    } NvmLocations;

    static NvmManager &Instance();

    int8_t Byte(NvmLocations nvmLocation);
    bool Byte(NvmLocations nvmLocation, int8_t newValue);


    int16_t Int16(NvmLocations nvmLocation);
    bool Int16(NvmLocations nvmLocation, int16_t newValue);


    int32_t Int32(NvmLocations nvmLocation);
    bool Int32(NvmLocations nvmLocation, int32_t newValue);

    int64_t Int64(NvmLocations nvmLocationStart);
    bool Int64(NvmLocations nvmLocationStart, int64_t newValue);

    void BlockRead(NvmLocations nvmLocationStart, int lengthInBytes, uint8_t * const p_data);

    bool BlockWrite(NvmLocations nvmLocationStart, int lengthInBytes, uint8_t const * const p_data);


    void MacAddress(uint8_t *macAddress);

    uint32_t SerialNumber();

    bool FinishNvmWrite() {
        while (m_pageModified || m_writeState != IDLE) {
            if (WriteCacheToNvmProc()) {
                continue;
            }
            else {
                return false;
            }
        }
        return true;
    }

    bool Synchonized() const {
        return !m_pageModified;
    }

private:

    typedef enum {
        IDLE,
        CLEAR_PAGE_BUFFER,
        ERASE_PAGE,
        WRITE_DATA,
    } WriteCacheState;

    // Page cache is a byte array.
    int8_t m_nvmPageCache[NVMCTRL_PAGE_SIZE];
    // The page cache gets written to NVM as 32-bit pieces
    int32_t *m_nvmPageCache32;
    WriteCacheState m_writeState;
    uint8_t m_quadWordIndex;
    bool m_pageModified;

    NvmManager();

    void PopulateCache();

    bool WriteCacheToNvm();

    bool WriteCacheToNvmProc();

    bool BlockWrite();
}; //NvmManager

} // ClearCore namespace
#endif // HIDE_FROM_DOXYGEN
#endif // __NVMMANAGER_H__