Marlin_Firmware/Marlin/src/module/settings.h

108 lines
3.5 KiB
C
Raw Normal View History

/**
2016-03-24 13:01:20 -05:00
* Marlin 3D Printer Firmware
2020-02-03 08:00:57 -06:00
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
2016-03-24 13:01:20 -05:00
*
* Based on Sprinter and grbl.
2019-06-27 23:57:50 -05:00
* Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
2016-03-24 13:01:20 -05:00
*
* This program 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.
*
* This program 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
2020-07-22 22:20:14 -05:00
* along with this program. If not, see <https://www.gnu.org/licenses/>.
2016-03-24 13:01:20 -05:00
*
*/
#pragma once
2017-09-06 06:28:32 -05:00
#include "../inc/MarlinConfig.h"
#if ENABLED(EEPROM_SETTINGS)
2020-03-27 17:29:17 -05:00
#include "../HAL/shared/eeprom_api.h"
#endif
2017-04-09 21:47:49 -05:00
class MarlinSettings {
public:
2018-01-04 20:01:25 -06:00
static uint16_t datasize();
2019-02-23 22:53:01 -06:00
static void reset();
static bool save(); // Return 'true' if data was saved
2017-04-09 21:47:49 -05:00
2018-01-01 15:18:25 -06:00
FORCE_INLINE static bool init_eeprom() {
reset();
#if ENABLED(EEPROM_SETTINGS)
2018-05-11 18:06:04 -05:00
const bool success = save();
2020-04-22 16:35:03 -05:00
if (TERN0(EEPROM_CHITCHAT, success)) report();
2018-05-11 18:06:04 -05:00
return success;
#else
return true;
2018-01-01 15:18:25 -06:00
#endif
}
#if ENABLED(SD_FIRMWARE_UPDATE)
static bool sd_update_status(); // True if the SD-Firmware-Update EEPROM flag is set
static bool set_sd_update_status(const bool enable); // Return 'true' after EEPROM is set (-> always true)
#endif
2017-04-09 21:47:49 -05:00
#if ENABLED(EEPROM_SETTINGS)
2019-02-23 22:53:01 -06:00
static bool load(); // Return 'true' if data was loaded ok
static bool validate(); // Return 'true' if EEPROM data is ok
static inline void first_load() {
static bool loaded = false;
if (!loaded && load()) loaded = true;
}
#if ENABLED(AUTO_BED_LEVELING_UBL) // Eventually make these available if any leveling system
// That can store is enabled
2018-06-15 15:51:45 -05:00
static uint16_t meshes_start_index();
FORCE_INLINE static uint16_t meshes_end_index() { return meshes_end; }
static uint16_t calc_num_meshes();
static int mesh_slot_offset(const int8_t slot);
static void store_mesh(const int8_t slot);
static void load_mesh(const int8_t slot, void * const into=nullptr);
//static void delete_mesh(); // necessary if we have a MAT
//static void defrag_meshes(); // "
#endif
2017-04-09 21:47:49 -05:00
#else
FORCE_INLINE
static bool load() { reset(); report(); return true; }
FORCE_INLINE
static void first_load() { (void)load(); }
2017-04-09 21:47:49 -05:00
#endif
#if DISABLED(DISABLE_M503)
2019-02-23 22:53:01 -06:00
static void report(const bool forReplay=false);
2017-04-09 21:47:49 -05:00
#else
FORCE_INLINE
2019-09-30 21:44:07 -05:00
static void report(const bool=false) {}
2017-04-09 21:47:49 -05:00
#endif
private:
static void postprocess();
#if ENABLED(EEPROM_SETTINGS)
2018-01-04 19:51:18 -06:00
static bool eeprom_error, validating;
#if ENABLED(AUTO_BED_LEVELING_UBL) // Eventually make these available if any leveling system
// That can store is enabled
static const uint16_t meshes_end; // 128 is a placeholder for the size of the MAT; the MAT will always
// live at the very end of the eeprom
#endif
2019-02-23 22:53:01 -06:00
static bool _load();
static bool size_error(const uint16_t size);
2017-04-09 21:47:49 -05:00
#endif
};
extern MarlinSettings settings;