/*
  Settings.h - Configuration handling
  Part of Grbl-Advanced

  Copyright (c) 2011-2016 Sungeun K. Jeon for Gnea Research LLC
  Copyright (c) 2009-2011 Simen Svale Skogsrud
  Copyright (c)	2017 Patrick F.

  Grbl-Advanced 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.

  Grbl-Advanced 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 Grbl-Advanced.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef SETTINGS_H
#define SETTINGS_H

#include <stdint.h>
#include "util.h"


// Version of the EEPROM data. Will be used to migrate existing data from older versions of Grbl
// when firmware is upgraded. Always stored in byte 0 of eeprom
#define SETTINGS_VERSION 					2  // NOTE: Check settings_reset() when moving to next version.


// Define bit flag masks for the boolean settings in settings.system_flags
#define BITFLAG_INVERT_RESET_PIN			BIT(0)
#define BITFLAG_INVERT_FEED_PIN				BIT(1)
#define BITFLAG_INVERT_CYCLE_PIN			BIT(2)
#define BITFLAG_INVERT_SAFETY_PIN			BIT(3)
#define BITFLAG_ENABLE_LIMITS				BIT(4)
#define BITFLAG_FORCE_HARD_LIMIT_CHECK		BIT(5)

// Define bit flag masks for the boolean settings in settings.flag.
#define BITFLAG_REPORT_INCHES      			BIT(0)
#define BITFLAG_LASER_MODE         			BIT(1)
#define BITFLAG_INVERT_ST_ENABLE   			BIT(2)
#define BITFLAG_HARD_LIMIT_ENABLE  			BIT(3)
#define BITFLAG_HOMING_ENABLE      			BIT(4)
#define BITFLAG_SOFT_LIMIT_ENABLE  			BIT(5)
#define BITFLAG_INVERT_LIMIT_PINS 			BIT(6)
#define BITFLAG_INVERT_PROBE_PIN   			BIT(7)

// Define status reporting boolean enable bit flags in settings.status_report_mask
#define BITFLAG_RT_STATUS_POSITION_TYPE     BIT(0)
#define BITFLAG_RT_STATUS_BUFFER_STATE      BIT(1)

// Define settings restore bitflags.
#define SETTINGS_RESTORE_DEFAULTS 			BIT(0)
#define SETTINGS_RESTORE_PARAMETERS 		BIT(1)
#define SETTINGS_RESTORE_STARTUP_LINES 		BIT(2)
#define SETTINGS_RESTORE_BUILD_INFO 		BIT(3)

// Define EEPROM memory address location values for Grbl settings and parameters
// NOTE: The Atmega328p has 1KB EEPROM. The upper half is reserved for parameters and
// the startup script. The lower half contains the global settings and space for future
// developments.
#define EEPROM_ADDR_GLOBAL         			1U
#define EEPROM_ADDR_PARAMETERS     			512U
#define EEPROM_ADDR_STARTUP_BLOCK  			768U
#define EEPROM_ADDR_BUILD_INFO     			942U

// Define EEPROM address indexing for coordinate parameters
#define N_COORDINATE_SYSTEM 				6  // Number of supported work coordinate systems (from index 1)
#define SETTING_INDEX_NCOORD 				N_COORDINATE_SYSTEM+1 // Total number of system stored (from index 0)

// NOTE: Work coordinate indices are (0=G54, 1=G55, ... , 6=G59)
#define SETTING_INDEX_G28    				N_COORDINATE_SYSTEM    // Home position 1
#define SETTING_INDEX_G30    				N_COORDINATE_SYSTEM+1  // Home position 2
// #define SETTING_INDEX_G92    N_COORDINATE_SYSTEM+2  // Coordinate offset (G92.2,G92.3 not supported)

// Define Grbl axis settings numbering scheme. Starts at START_VAL, every INCREMENT, over N_SETTINGS.
#define AXIS_N_SETTINGS          			4
#define AXIS_SETTINGS_START_VAL  			100 // NOTE: Reserving settings values >= 100 for axis settings. Up to 255.
#define AXIS_SETTINGS_INCREMENT  			10  // Must be greater than the number of axis settings

#ifndef SETTINGS_RESTORE_ALL
	#define SETTINGS_RESTORE_ALL 			0xFF // All bitflags
#endif


// Global persistent settings (Stored from byte EEPROM_ADDR_GLOBAL onwards)
typedef struct {
	// Axis settings
	float steps_per_mm[N_AXIS];
	float max_rate[N_AXIS];
	float acceleration[N_AXIS];
	float max_travel[N_AXIS];

	// Remaining Grbl settings
	// TODO: document system_flags
	uint8_t system_flags;
	uint8_t step_invert_mask;
	uint8_t dir_invert_mask;
	uint8_t stepper_idle_lock_time; 	// If max value 255, steppers do not disable.
	uint8_t status_report_mask; 		// Mask to indicate desired report data.
	float junction_deviation;
	float arc_tolerance;

	float rpm_max;
	float rpm_min;

	uint8_t flags;  // Contains default boolean settings

	uint8_t homing_dir_mask;
	float homing_feed_rate;
	float homing_seek_rate;
	uint16_t homing_debounce_delay;
	float homing_pulloff;
} Settings_t;


extern Settings_t settings;


// Initialize the configuration subsystem (load settings from EEPROM)
void Settings_Init(void);

// Helper function to clear and restore EEPROM defaults
void Settings_Restore(uint8_t restore_flag);

// A helper method to set new settings from command line
uint8_t Settings_StoreGlobalSetting(uint8_t parameter, float value);

// Stores the protocol line variable as a startup line in EEPROM
void Settings_StoreStartupLine(uint8_t n, char *line);

// Reads an EEPROM startup line to the protocol line variable
uint8_t Settings_ReadStartupLine(uint8_t n, char *line);

// Stores build info user-defined string
void Settings_StoreBuildInfo(char *line);

// Reads build info user-defined string
uint8_t Settings_ReadBuildInfo(char *line);

// Writes selected coordinate data to EEPROM
void Settings_WriteCoordData(uint8_t coord_select, float *coord_data);

// Reads selected coordinate data from EEPROM
uint8_t Settings_ReadCoordData(uint8_t coord_select, float *coord_data);

// Returns the step pin mask according to Grbl's internal axis numbering
uint8_t Settings_GetStepPinMask(uint8_t i);

// Returns the direction pin mask according to Grbl's internal axis numbering
uint8_t Settings_GetDirectionPinMask(uint8_t i);

// Returns the limit pin mask according to Grbl's internal axis numbering
uint8_t Settings_GetLimitPinMask(uint8_t i);


#endif // SETTINGS_H