eeprom.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. #ifndef EEPROM_H
  2. #define EEPROM_H
  3. #include <stdint.h>
  4. #define MAX_SHEETS 8
  5. #define MAX_SHEET_NAME_LENGTH 7
  6. typedef struct
  7. {
  8. char name[MAX_SHEET_NAME_LENGTH]; //!< Can be null terminated, doesn't need to be null terminated
  9. int16_t z_offset; //!< Z_BABYSTEP_MIN .. Z_BABYSTEP_MAX = Z_BABYSTEP_MIN*2/1000 [mm] .. Z_BABYSTEP_MAX*2/1000 [mm]
  10. uint8_t bed_temp; //!< 0 .. 254 [°C]
  11. uint8_t pinda_temp; //!< 0 .. 254 [°C]
  12. } Sheet;
  13. typedef struct
  14. {
  15. Sheet s[MAX_SHEETS];
  16. uint8_t active_sheet;
  17. } Sheets;
  18. // sizeof(Sheets). Do not change it unless EEPROM_Sheets_base is last item in EEPROM.
  19. // Otherwise it would move following items.
  20. #define EEPROM_SHEETS_SIZEOF 89
  21. #ifdef __cplusplus
  22. static_assert(sizeof(Sheets) == EEPROM_SHEETS_SIZEOF, "Sizeof(Sheets) is not EEPROM_SHEETS_SIZEOF.");
  23. #endif
  24. #define EEPROM_EMPTY_VALUE 0xFF
  25. #define EEPROM_EMPTY_VALUE16 0xFFFF
  26. // The total size of the EEPROM is
  27. // 4096 for the Atmega2560
  28. #define EEPROM_TOP 4096
  29. #define EEPROM_SILENT 4095
  30. #define EEPROM_LANG 4094
  31. #define EEPROM_BABYSTEP_X 4092 //unused
  32. #define EEPROM_BABYSTEP_Y 4090 //unused
  33. #define EEPROM_BABYSTEP_Z 4088 //legacy, multiple values stored now in EEPROM_Sheets_base
  34. #define EEPROM_CALIBRATION_STATUS 4087
  35. #define EEPROM_BABYSTEP_Z0 4085
  36. #define EEPROM_FILAMENTUSED 4081
  37. // uint32_t
  38. #define EEPROM_TOTALTIME 4077
  39. #define EEPROM_BED_CALIBRATION_CENTER (EEPROM_TOTALTIME-2*4)
  40. #define EEPROM_BED_CALIBRATION_VEC_X (EEPROM_BED_CALIBRATION_CENTER-2*4)
  41. #define EEPROM_BED_CALIBRATION_VEC_Y (EEPROM_BED_CALIBRATION_VEC_X-2*4)
  42. // Offsets of the Z heiths of the calibration points from the first point.
  43. // The offsets are saved as 16bit signed int, scaled to tenths of microns.
  44. #define EEPROM_BED_CALIBRATION_Z_JITTER (EEPROM_BED_CALIBRATION_VEC_Y-2*8)
  45. #define EEPROM_FARM_MODE (EEPROM_BED_CALIBRATION_Z_JITTER-1)
  46. #define EEPROM_FARM_NUMBER (EEPROM_FARM_MODE-3)
  47. // Correction of the bed leveling, in micrometers.
  48. // Maximum 50 micrometers allowed.
  49. // Bed correction is valid if set to 1. If set to zero or 255, the successive 4 bytes are invalid.
  50. #define EEPROM_BED_CORRECTION_VALID (EEPROM_FARM_NUMBER-1)
  51. #define EEPROM_BED_CORRECTION_LEFT (EEPROM_BED_CORRECTION_VALID-1)
  52. #define EEPROM_BED_CORRECTION_RIGHT (EEPROM_BED_CORRECTION_LEFT-1)
  53. #define EEPROM_BED_CORRECTION_FRONT (EEPROM_BED_CORRECTION_RIGHT-1)
  54. #define EEPROM_BED_CORRECTION_REAR (EEPROM_BED_CORRECTION_FRONT-1)
  55. #define EEPROM_TOSHIBA_FLASH_AIR_COMPATIBLITY (EEPROM_BED_CORRECTION_REAR-1)
  56. #define EEPROM_PRINT_FLAG (EEPROM_TOSHIBA_FLASH_AIR_COMPATIBLITY-1)
  57. #define EEPROM_PROBE_TEMP_SHIFT (EEPROM_PRINT_FLAG - 2*5) //5 x int for storing pinda probe temp shift relative to 50 C; unit: motor steps
  58. #define EEPROM_TEMP_CAL_ACTIVE (EEPROM_PROBE_TEMP_SHIFT - 1)
  59. #define EEPROM_BOWDEN_LENGTH (EEPROM_TEMP_CAL_ACTIVE - 2*4) //4 x int for bowden lengths for multimaterial
  60. #define EEPROM_CALIBRATION_STATUS_PINDA (EEPROM_BOWDEN_LENGTH - 1) //0 - not calibrated; 1 - calibrated
  61. #define EEPROM_UVLO (EEPROM_CALIBRATION_STATUS_PINDA - 1) //1 - uvlo during print
  62. #define EEPROM_UVLO_CURRENT_POSITION (EEPROM_UVLO-2*4) // 2 x float for current_position in X and Y axes
  63. #define EEPROM_FILENAME (EEPROM_UVLO_CURRENT_POSITION - 8) //8chars to store filename without extension
  64. #define EEPROM_FILE_POSITION (EEPROM_FILENAME - 4) //32 bit for uint32_t file position
  65. #define EEPROM_UVLO_CURRENT_POSITION_Z (EEPROM_FILE_POSITION - 4) //float for current position in Z
  66. #define EEPROM_UVLO_UNUSED_001 (EEPROM_UVLO_CURRENT_POSITION_Z - 1) // uint8_t (unused)
  67. #define EEPROM_UVLO_TARGET_BED (EEPROM_UVLO_UNUSED_001 - 1)
  68. #define EEPROM_UVLO_FEEDRATE (EEPROM_UVLO_TARGET_BED - 2) //uint16_t
  69. #define EEPROM_UVLO_FAN_SPEED (EEPROM_UVLO_FEEDRATE - 1)
  70. #define EEPROM_FAN_CHECK_ENABLED (EEPROM_UVLO_FAN_SPEED - 1)
  71. #define EEPROM_UVLO_MESH_BED_LEVELING (EEPROM_FAN_CHECK_ENABLED - 9*2)
  72. #define EEPROM_UVLO_Z_MICROSTEPS (EEPROM_UVLO_MESH_BED_LEVELING - 2) // uint16_t (could be removed)
  73. #define EEPROM_UVLO_E_ABS (EEPROM_UVLO_Z_MICROSTEPS - 1)
  74. #define EEPROM_UVLO_CURRENT_POSITION_E (EEPROM_UVLO_E_ABS - 4) //float for current position in E
  75. // Crash detection mode EEPROM setting
  76. #define EEPROM_CRASH_DET (EEPROM_UVLO_CURRENT_POSITION_E - 5) // float (orig EEPROM_UVLO_MESH_BED_LEVELING-12)
  77. // Crash detection counter Y (last print)
  78. #define EEPROM_CRASH_COUNT_Y (EEPROM_CRASH_DET - 1) // uint8 (orig EEPROM_UVLO_MESH_BED_LEVELING-15)
  79. // Filament sensor on/off EEPROM setting
  80. #define EEPROM_FSENSOR (EEPROM_CRASH_COUNT_Y - 1) // uint8 (orig EEPROM_UVLO_MESH_BED_LEVELING-14)
  81. // Crash detection counter X (last print)
  82. #define EEPROM_CRASH_COUNT_X (EEPROM_FSENSOR - 1) // uint8 (orig EEPROM_UVLO_MESH_BED_LEVELING-15)
  83. // Filament runout/error coutner (last print)
  84. #define EEPROM_FERROR_COUNT (EEPROM_CRASH_COUNT_X - 1) // uint8 (orig EEPROM_UVLO_MESH_BED_LEVELING-16)
  85. // Power loss errors (last print)
  86. #define EEPROM_POWER_COUNT (EEPROM_FERROR_COUNT - 1) // uint8 (orig EEPROM_UVLO_MESH_BED_LEVELING-17)
  87. #define EEPROM_XYZ_CAL_SKEW (EEPROM_POWER_COUNT - 4) // float for skew backup
  88. #define EEPROM_WIZARD_ACTIVE (EEPROM_XYZ_CAL_SKEW - 1)
  89. #define EEPROM_BELTSTATUS_X (EEPROM_WIZARD_ACTIVE - 2) // uint16
  90. #define EEPROM_BELTSTATUS_Y (EEPROM_BELTSTATUS_X - 2) // uint16
  91. #define EEPROM_DIR_DEPTH (EEPROM_BELTSTATUS_Y-1)
  92. #define EEPROM_DIRS (EEPROM_DIR_DEPTH-80) //8 chars for each dir name, max 10 levels
  93. #define EEPROM_SD_SORT (EEPROM_DIRS - 1) //0 -time, 1-alpha, 2-none
  94. #define EEPROM_SECOND_SERIAL_ACTIVE (EEPROM_SD_SORT - 1)
  95. #define EEPROM_FSENS_AUTOLOAD_ENABLED (EEPROM_SECOND_SERIAL_ACTIVE - 1)
  96. // Crash detection counter X (total)
  97. #define EEPROM_CRASH_COUNT_X_TOT (EEPROM_FSENS_AUTOLOAD_ENABLED - 2) // uint16
  98. // Crash detection counter Y (total)
  99. #define EEPROM_CRASH_COUNT_Y_TOT (EEPROM_CRASH_COUNT_X_TOT - 2) // uint16
  100. // Filament runout/error coutner (total)
  101. #define EEPROM_FERROR_COUNT_TOT (EEPROM_CRASH_COUNT_Y_TOT - 2) // uint16
  102. // Power loss errors (total)
  103. #define EEPROM_POWER_COUNT_TOT (EEPROM_FERROR_COUNT_TOT - 2) // uint16
  104. ////////////////////////////////////////
  105. // TMC2130 Accurate sensorless homing
  106. // X-axis home origin (stepper phase in microsteps, 0..63 for 16ustep resolution)
  107. #define EEPROM_TMC2130_HOME_X_ORIGIN (EEPROM_POWER_COUNT_TOT - 1) // uint8
  108. // X-axis home bsteps (number of microsteps backward)
  109. #define EEPROM_TMC2130_HOME_X_BSTEPS (EEPROM_TMC2130_HOME_X_ORIGIN - 1) // uint8
  110. // X-axis home fsteps (number of microsteps forward)
  111. #define EEPROM_TMC2130_HOME_X_FSTEPS (EEPROM_TMC2130_HOME_X_BSTEPS - 1) // uint8
  112. // Y-axis home origin (stepper phase in microsteps, 0..63 for 16ustep resolution)
  113. #define EEPROM_TMC2130_HOME_Y_ORIGIN (EEPROM_TMC2130_HOME_X_FSTEPS - 1) // uint8
  114. // X-axis home bsteps (number of microsteps backward)
  115. #define EEPROM_TMC2130_HOME_Y_BSTEPS (EEPROM_TMC2130_HOME_Y_ORIGIN - 1) // uint8
  116. // X-axis home fsteps (number of microsteps forward)
  117. #define EEPROM_TMC2130_HOME_Y_FSTEPS (EEPROM_TMC2130_HOME_Y_BSTEPS - 1) // uint8
  118. // Accurate homing enabled
  119. #define EEPROM_TMC2130_HOME_ENABLED (EEPROM_TMC2130_HOME_Y_FSTEPS - 1) // uint8
  120. ////////////////////////////////////////
  121. // TMC2130 uStep linearity correction
  122. // Linearity correction factor (XYZE)
  123. #define EEPROM_TMC2130_WAVE_X_FAC (EEPROM_TMC2130_HOME_ENABLED - 1) // uint8
  124. #define EEPROM_TMC2130_WAVE_Y_FAC (EEPROM_TMC2130_WAVE_X_FAC - 1) // uint8
  125. #define EEPROM_TMC2130_WAVE_Z_FAC (EEPROM_TMC2130_WAVE_Y_FAC - 1) // uint8
  126. #define EEPROM_TMC2130_WAVE_E_FAC (EEPROM_TMC2130_WAVE_Z_FAC - 1) // uint8
  127. ////////////////////////////////////////
  128. // TMC2130 uStep resolution
  129. // microstep resolution (XYZE): usteps = (256 >> mres)
  130. #define EEPROM_TMC2130_X_MRES (EEPROM_TMC2130_WAVE_E_FAC - 1) // uint8
  131. #define EEPROM_TMC2130_Y_MRES (EEPROM_TMC2130_X_MRES - 1) // uint8
  132. #define EEPROM_TMC2130_Z_MRES (EEPROM_TMC2130_Y_MRES - 1) // uint8
  133. #define EEPROM_TMC2130_E_MRES (EEPROM_TMC2130_Z_MRES - 1) // uint8
  134. // HW
  135. #define EEPROM_PRINTER_TYPE (EEPROM_TMC2130_E_MRES - 2) // uint16
  136. #define EEPROM_BOARD_TYPE (EEPROM_PRINTER_TYPE - 2) // uint16
  137. // Extruder multiplier for power panic
  138. #define EEPROM_EXTRUDER_MULTIPLIER_0 (EEPROM_BOARD_TYPE - 4) //float
  139. #define EEPROM_EXTRUDER_MULTIPLIER_1 (EEPROM_EXTRUDER_MULTIPLIER_0 - 4) //float
  140. #define EEPROM_EXTRUDER_MULTIPLIER_2 (EEPROM_EXTRUDER_MULTIPLIER_1 - 4) //float
  141. #define EEPROM_EXTRUDEMULTIPLY (EEPROM_EXTRUDER_MULTIPLIER_2 - 2) // uint16
  142. #define EEPROM_UVLO_TINY_CURRENT_POSITION_Z (EEPROM_EXTRUDEMULTIPLY-4) // float
  143. #define EEPROM_UVLO_TARGET_HOTEND (EEPROM_UVLO_TINY_CURRENT_POSITION_Z-2) // uint16
  144. // Sound Mode
  145. #define EEPROM_SOUND_MODE (EEPROM_UVLO_TARGET_HOTEND-1) // uint8
  146. #define EEPROM_AUTO_DEPLETE (EEPROM_SOUND_MODE-1) //bool
  147. #define EEPROM_FSENS_OQ_MEASS_ENABLED (EEPROM_AUTO_DEPLETE - 1) //bool
  148. #define EEPROM_MMU_FAIL_TOT (EEPROM_FSENS_OQ_MEASS_ENABLED - 2) //uint16_t
  149. #define EEPROM_MMU_FAIL (EEPROM_MMU_FAIL_TOT - 1) //uint8_t
  150. #define EEPROM_MMU_LOAD_FAIL_TOT (EEPROM_MMU_FAIL - 2) //uint16_t
  151. #define EEPROM_MMU_LOAD_FAIL (EEPROM_MMU_LOAD_FAIL_TOT - 1) //uint8_t
  152. #define EEPROM_MMU_CUTTER_ENABLED (EEPROM_MMU_LOAD_FAIL - 1)
  153. #define EEPROM_UVLO_MESH_BED_LEVELING_FULL (EEPROM_MMU_CUTTER_ENABLED - 12*12*2) //allow 12 calibration points for future expansion
  154. #define EEPROM_MBL_TYPE (EEPROM_UVLO_MESH_BED_LEVELING_FULL-1) //uint8_t for mesh bed leveling precision
  155. #define EEPROM_MBL_MAGNET_ELIMINATION (EEPROM_MBL_TYPE -1)
  156. #define EEPROM_MBL_POINTS_NR (EEPROM_MBL_MAGNET_ELIMINATION -1) //uint8_t number of points in one exis for mesh bed leveling
  157. #define EEPROM_MBL_PROBE_NR (EEPROM_MBL_POINTS_NR-1) //number of measurements for each point
  158. #define EEPROM_MMU_STEALTH (EEPROM_MBL_PROBE_NR-1)
  159. #define EEPROM_CHECK_MODE (EEPROM_MMU_STEALTH-1) // uint8
  160. #define EEPROM_NOZZLE_DIAMETER (EEPROM_CHECK_MODE-1) // uint8
  161. #define EEPROM_NOZZLE_DIAMETER_uM (EEPROM_NOZZLE_DIAMETER-2) // uint16
  162. #define EEPROM_CHECK_MODEL (EEPROM_NOZZLE_DIAMETER_uM-1) // uint8
  163. #define EEPROM_CHECK_VERSION (EEPROM_CHECK_MODEL-1) // uint8
  164. #define EEPROM_CHECK_GCODE (EEPROM_CHECK_VERSION-1) // uint8
  165. #define EEPROM_SHEETS_BASE (EEPROM_CHECK_GCODE - EEPROM_SHEETS_SIZEOF) // Sheets
  166. static Sheets * const EEPROM_Sheets_base = (Sheets*)(EEPROM_SHEETS_BASE);
  167. #define EEPROM_FSENSOR_PCB (EEPROM_SHEETS_BASE-1) // uint8
  168. #define EEPROM_FSENSOR_ACTION_NA (EEPROM_FSENSOR_PCB-1) // uint8
  169. #define EEPROM_UVLO_SAVED_TARGET (EEPROM_FSENSOR_ACTION_NA - 4*4) // 4 x float for saved target for all axes
  170. #define EEPROM_UVLO_FEEDMULTIPLY (EEPROM_UVLO_SAVED_TARGET - 2) // uint16_t for feedmultiply
  171. #define EEPROM_BACKLIGHT_LEVEL_HIGH (EEPROM_UVLO_FEEDMULTIPLY-1) // uint8
  172. #define EEPROM_BACKLIGHT_LEVEL_LOW (EEPROM_BACKLIGHT_LEVEL_HIGH-1) // uint8
  173. #define EEPROM_BACKLIGHT_MODE (EEPROM_BACKLIGHT_LEVEL_LOW-1) // uint8
  174. #define EEPROM_BACKLIGHT_TIMEOUT (EEPROM_BACKLIGHT_MODE-2) // uint16
  175. #define EEPROM_UVLO_LA_K (EEPROM_BACKLIGHT_TIMEOUT-4) // float
  176. //This is supposed to point to last item to allow EEPROM overrun check. Please update when adding new items.
  177. #define EEPROM_LAST_ITEM EEPROM_UVLO_LA_K
  178. // !!!!!
  179. // !!!!! this is end of EEPROM section ... all updates MUST BE inserted before this mark !!!!!
  180. // !!!!!
  181. // Currently running firmware, each digit stored as uint16_t.
  182. // The flavor differentiates a dev, alpha, beta, release candidate or a release version.
  183. #define EEPROM_FIRMWARE_VERSION_END (FW_PRUSA3D_MAGIC_LEN+8)
  184. #define EEPROM_FIRMWARE_VERSION_FLAVOR (FW_PRUSA3D_MAGIC_LEN+6)
  185. #define EEPROM_FIRMWARE_VERSION_REVISION (FW_PRUSA3D_MAGIC_LEN+4)
  186. #define EEPROM_FIRMWARE_VERSION_MINOR (FW_PRUSA3D_MAGIC_LEN+2)
  187. #define EEPROM_FIRMWARE_VERSION_MAJOR FW_PRUSA3D_MAGIC_LEN
  188. // Magic string, indicating that the current or the previous firmware running was the Prusa3D firmware.
  189. #define EEPROM_FIRMWARE_PRUSA_MAGIC 0
  190. #ifdef __cplusplus
  191. #include "ConfigurationStore.h"
  192. static_assert(EEPROM_FIRMWARE_VERSION_END < 20, "Firmware version EEPROM address conflicts with EEPROM_M500_base");
  193. static constexpr M500_conf * const EEPROM_M500_base = reinterpret_cast<M500_conf*>(20); //offset for storing settings using M500
  194. static_assert(((sizeof(M500_conf) + 20) < EEPROM_LAST_ITEM), "M500_conf address space conflicts with previous items.");
  195. #endif
  196. enum
  197. {
  198. EEPROM_MMU_CUTTER_ENABLED_enabled = 1,
  199. EEPROM_MMU_CUTTER_ENABLED_always = 2,
  200. };
  201. #ifdef __cplusplus
  202. void eeprom_init();
  203. bool eeprom_is_sheet_initialized(uint8_t sheet_num);
  204. struct SheetName
  205. {
  206. char c[sizeof(Sheet::name) + 1];
  207. };
  208. void eeprom_default_sheet_name(uint8_t index, SheetName &sheetName);
  209. int8_t eeprom_next_initialized_sheet(int8_t sheet);
  210. void eeprom_switch_to_next_sheet();
  211. #endif
  212. #endif // EEPROM_H