nvs.h

Go to the documentation of this file.

/*
  nvs.h - non-volative storage data structures
 
  Part of grblHAL
 
  Copyright (c) 2017-2025 Terje Io
  Copyright (c) 2009-2011 Simen Svale Skogsrud
 
  grblHAL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  grblHAL 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 General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with grblHAL. If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef _NVS_H_
#define _NVS_H_
 
#ifndef NVS_SIZE
#define NVS_SIZE 2048
#endif
 
#ifndef NVS_SIZE_MAX
#define NVS_SIZE_MAX 4096 // Limit to 4K for now
#endif
 
#ifndef NVS_CRC_BYTES
#define NVS_CRC_BYTES 2
#endif
 
#define NVS_SIZE_PARAMETERS     ((sizeof(coord_data_t) + NVS_CRC_BYTES) * N_CoordinateSystems)
#define NVS_SIZE_BUILD_INFO     (sizeof(stored_line_t) + NVS_CRC_BYTES)
#define NVS_SIZE_STARTUP_BLOCK  (N_STARTUP_LINE * (sizeof(stored_line_t) + NVS_CRC_BYTES))
 
#if N_AXIS > 5
#define GRBL_NVS_END (NVS_ADDR_GLOBAL + ((sizeof(settings_t) + NVS_CRC_BYTES + 4) & 0xFFFC) + NVS_SIZE_PARAMETERS + NVS_SIZE_BUILD_INFO + NVS_SIZE_STARTUP_BLOCK + 1)
#else
#define GRBL_NVS_END 1023
#endif
 
#if NVS_CRC_BYTES > 1
#define calc_checksum(data, length) modbus_crc16x(data, length)
#else
#define calc_checksum(data, length) grbl_crc8(data, length)
#endif
 
#define NVS_ADDR_GLOBAL         1U
#if N_AXIS > 5
#define NVS_ADDR_PARAMETERS     ((sizeof(settings_t) + NVS_CRC_BYTES + 4) & 0xFFFC) // align to word boundary
#else
#define NVS_ADDR_PARAMETERS     512U
#endif
#define NVS_ADDR_BUILD_INFO     (GRBL_NVS_END - NVS_SIZE_BUILD_INFO)
#define NVS_ADDR_STARTUP_BLOCK  (NVS_ADDR_BUILD_INFO - NVS_SIZE_STARTUP_BLOCK - 1)
#if N_TOOLS
#define NVS_ADDR_TOOL_TABLE     (GRBL_NVS_END + 1)
#define GRBL_NVS_SIZE           (GRBL_NVS_END + 1 + N_TOOLS * (sizeof(tool_data_t) + NVS_CRC_BYTES))
#else
#define GRBL_NVS_SIZE (GRBL_NVS_END + 1)
#endif
 
typedef enum {
    NVS_None = 0,   
    NVS_EEPROM,     
    NVS_FRAM,       
    NVS_Flash,      
    NVS_Emulated    
} nvs_type;
 
typedef struct {
    uint8_t *mem_address;   
    uint16_t address;       
    uint16_t size;          
} nvs_driver_area_t;
 
typedef uint8_t (*get_byte_ptr)(uint32_t addr);
 
typedef void (*put_byte_ptr)(uint32_t addr, uint8_t new_value);
 
typedef bool (*memcpy_from_nvs_ptr)(uint8_t *dest, uint32_t source, uint32_t size, bool with_checksum);
 
typedef bool (*memcpy_to_nvs_ptr)(uint32_t dest, uint8_t *source, uint32_t size, bool with_checksum);
 
typedef bool (*memcpy_from_flash_ptr)(uint8_t *dest);
 
typedef bool (*memcpy_to_flash_ptr)(uint8_t *source);
 
typedef struct {
    nvs_type type;                              
    uint32_t size;                              
    uint32_t size_max;                          
    nvs_driver_area_t driver_area;
 
    get_byte_ptr get_byte;                      
    put_byte_ptr put_byte;                      
    memcpy_to_nvs_ptr memcpy_to_nvs;            
    memcpy_from_nvs_ptr memcpy_from_nvs;        
 
    memcpy_from_flash_ptr memcpy_from_flash;    
    memcpy_to_flash_ptr memcpy_to_flash;        
} nvs_io_t;
 
#endif