serial/SerialBurner/src/nvsettings.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NVSETTINGS_H_
#define _NVSETTINGS_H_
 
#include <config_server.h>
 
#define SETTINGS_KEY (0x48666050)   // Flash memory configuration key code
 
#define DATA_SERIAL_PORT (1)
 
/* Debug Notes:
   Debug/informational messages can be sent to the DATA_SERIAL_PORT or to
   the DEBUG_SERIAL_PORT.
   - To send debug messages out the debug serial port, set DEBUG_SERIAL_PORT
     to 0 or 1; whatever port is not the data port.
   - To send debug messages out the same port as the data port, set
     DEBUG_SERIAL_PORT to -1.
   - To send debug messages in either of the above cases, you must also set DEBUG to 1.
*/
#define DEBUG_SERIAL_PORT (0)
#define DEBUG (1)   // 1 = allocate a debug port, 0 = no debug port
 
#define DEF_DATA_BAUDRATE (115200)
#define STOP_BITS (1)
#define DATA_BITS (8)
 
#define SERIAL_FLOWCONTROL_NONE (0)
#define SERIAL_FLOWCONTROL_SOFTWARE (1)
#define SERIAL_FLOWCONTROL_HARDWARE (2)
 
#define TELNET_PORT (23)
#define DEF_SERVER_LISTEN_PORT (TELNET_PORT)
#define DEF_CLIENT_OVERRIDE_TIMEOUT (20)
 
/*
 * The default number of seconds between receiving TCP chars before a timeout occurs.
 * The system default timeout, TCP_WRITE_TIMEOUT, is 10 seconds, which is the minimum
 * timeout value. A timeout value of 0 will disable the timeout feature.
 * */
#define DEF_CLIENT_TIMEOUT (60)   // TCP inactivity timeout in seconds
 
/* If a new client TCP connection is attempted while one is active,
 * one of the following three actions can be taken:
 *      a) Ignore the incoming connection. Leave current connection active.
 *           (set override timeout to 0xFFFFFFFF)
 *      b) Replace the existing connection if it has been idle for a specified number of seconds.
 *           (set override to the number of seconds to wait)
 *      c) Always replace the existing connection.
 *           (set override to 0 seconds)
 */
#define DEF_CLIENT_OVERRIDE_TIMEOUT (20)    // TCP connection override in seconds
 
/*
 *  The use of config objects should be done at a global scope.  Config objects can contain any number of members,
 *  each of which should be given a default value and a name used as an identifier.  The name value for each
 *  member variable should be unique, otherwise it can lead to issues inside the config tree.
 */
class classSerialSettings : public config_obj
{
   public:
    config_uint m_SettingsKey{SETTINGS_KEY, "Flash record verify key"};
    config_uint m_ServerListenPort{DEF_SERVER_LISTEN_PORT, "Server Listen Port"};
    config_uint m_ClientTimeout{DEF_CLIENT_TIMEOUT, "Client inactivity TCP timeout"};
    config_uint m_ClientOverrideTimeout{DEF_CLIENT_OVERRIDE_TIMEOUT, "Timeout to allow new TCP connections"};
    config_chooser m_DataBaudRate{"BaudRate","115200","9600,19200,38400,57600,115200,23400"};
 
    ConfigEndMarker;   // No new data members below this line
 
    classSerialSettings(const char *name, const char *desc = nullptr) : config_obj(name, desc){};
    classSerialSettings(config_obj &owner, const char *name, const char *desc = nullptr) : config_obj(owner, name, desc){};
};
 
#endif