VirtualPage.h

Go to the documentation of this file.

/*
  VirtualPage.h - Flash page management
  Original Copyright (c) 2017 Frank Holtz.  All right reserved.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
#pragma once
 
#include "Flash.h"
#include <Arduino.h>
 
class VirtualPageClass
{
public:
    //----------------------------------------------------------------------------
    VirtualPageClass() {};
    //----------------------------------------------------------------------------
    void begin() {};
    //----------------------------------------------------------------------------
    void end() {};
    //----------------------------------------------------------------------------
    uint16_t size() const;
    //----------------------------------------------------------------------------
    uint16_t length() const;
    //----------------------------------------------------------------------------
    uint16_t page_count() const;
    //----------------------------------------------------------------------------
    uint32_t wear_level();
    //----------------------------------------------------------------------------
    uint32_t *get(uint32_t magic);
    //----------------------------------------------------------------------------
    uint32_t *allocate(uint32_t magic);
    //----------------------------------------------------------------------------
    uint32_t *allocate(uint32_t magic, uint32_t max_writes);
    //----------------------------------------------------------------------------
    void release_prepare(uint32_t *address);
    //----------------------------------------------------------------------------
    void release(uint32_t *address);
    //----------------------------------------------------------------------------
    bool release_started(uint32_t *address);
    //----------------------------------------------------------------------------
    void fail(uint32_t *address);
    //----------------------------------------------------------------------------
    void clean_up();
    //----------------------------------------------------------------------------
    void format();
 
private:
    // convert page number 1..max_pages into an address
    uint32_t *get_page_address(uint16_t page);
    // build a page
    void build_page(uint32_t *address, uint32_t magic);
    // return number of erase cycles
    uint32_t get_page_erase_cycles(uint32_t *address);
};
 
extern VirtualPageClass VirtualPage;