system.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/


 
// The system maintains a configuration record for initialization
 
#ifndef _SYSTEM_STORAGE_H
#define _SYSTEM_STORAGE_H
#include <nettypes.h>
 
// Exceptions
#define EXCPT_REBOOT (0)        /* Reboot after an exception */
#define EXCPT_HALT (1)          /* Halt after an exception */
#define EXCPT_QUIET (2)         /* Reboot quietly after an exception */
#define EXCPT_RESET (3)         /* Reboot quietly after an exception */
#define EXCPT_REBOOT_TO_MON (4) /* Reboot to (Alt)monitor after an exception */
 
// MAC-48 Media Access Control address in bytes (nettypes.h)
#ifndef MACADDRESS_OCTETS_48
#define MACADDRESS_OCTETS_48 (6)
#endif
 
/*
   IEEE 802.11 identifier and key parameters
 
      m_FileName member is used to save service set identity (SSID) and
      either Wired Equivalent Privacy, Wi-Fi Protected Access (WPA) or WPA2
      Pre Shared Key (PSK) on platforms that support the interface.
 
      SSID is restricted to printable ASCII characters, 1 to 32 in length.
 
      WEP Key is 10 or 26 hexadecimal ASCII characters.
      WPA(2) PSK is printable ASCII 8 to 63 characters in length.
 
      The total length of SSID and the key must not exceed 68 characters.
 
      It is stored as a concatenated null terminate string for example:
         "SSID:NetBurner,WPA:XJrLy4GbZe1/3wORx5ja4bBC74284OqbhWwVa3+-"
 
*/
#define SYSTEM_CONFIG_RECORD_SSID_SIZE_MIN (1)
#define SYSTEM_CONFIG_RECORD_SSID_SIZE_MAX (32)
#define SYSTEM_CONFIG_RECORD_SSID_TAG ("SSID:")
#define SYSTEM_CONFIG_RECORD_SSID_TAG_LENGTH (5)
 
#define SYSTEM_CONFIC_RECORD_SEPERATOR (",")
#define SYSTEM_CONFIC_RECORD_SEPERATOR_LENGTH (1)
 
#define SYSTEM_CONFIG_RECORD_WEP_KEY_SIZE_64 (10)
#define SYSTEM_CONFIG_RECORD_WEP_KEY_SIZE_104 (26)
#define SYSTEM_CONFIG_RECORD_WPA_PSK_SIZE_MIN (8)
#define SYSTEM_CONFIG_RECORD_WPA_PSK_SIZE_MAX (63)
#define SYSTEM_CONFIG_RECORD_WEP_KEY_TAG ("WEP:")
#define SYSTEM_CONFIG_RECORD_WPA_PSK_TAG ("WPA:")
#define SYSTEM_CONFIG_RECORD_WPA2_PSK_TAG ("WP2:")
#define SYSTEM_CONFIG_RECORD_KEY_TAG_LENGTH (4)
 
#define SYSTEM_CONFIG_RECORD_M_FILENAME_SIZE (80)
 
#define SYSTEM_CONFIG_RECORD_SSID_KEY_LENGTH_MAX \
    (SYSTEM_CONFIG_RECORD_M_FILENAME_SIZE -      \
     (SYSTEM_CONFIG_RECORD_SSID_TAG_LENGTH + SYSTEM_CONFIC_RECORD_SEPERATOR_LENGTH + SYSTEM_CONFIG_RECORD_KEY_TAG_LENGTH + 1))
 
// These functions replace the system config record with the one that is passed
// in.  It calculates a new checksum, and it ignores the MAC address.
 
class UDPPacket;   // Forward declaration
extern int (*pLegacyUdp)(UDPPacket &p, int ifn);

int SaveUserParameters(void *pCopyFrom, int len);

void *GetUserParameters(void);

const char *GetReleaseTag();
 
// Get starting memory pointer into config record.
uint8_t *GetConfigRecordStart();
 
// Get ending config record storage
uint8_t *GetConfigRecordEnd();
 
// Erase the config record and fixup any legacy records as required....
void EraseWholeConfigRecord();
 
uint32_t GetDefaultBaud();
uint32_t GetDefaultSerialPort();
bool ShowBootMessages();
 
#endif /* _SYSTEM_STORAGE_H */