settings_api.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. /********************************* (C) РОТЕК ***********************************
  2. * @module settings_api
  3. * @file settings_api.h
  4. * @version 1.0.0
  5. * @date XX.XX.XXXX
  6. * $brief settings_api
  7. *******************************************************************************
  8. * @history Version Author Comment
  9. * XX.XX.XXXX 1.0.0 Telenkov D.A. First release.
  10. *******************************************************************************
  11. */
  12. /* Define to prevent recursive ----------------------------------------------*/
  13. #ifndef SETTINGS_API_H
  14. #define SETTINGS_API_H
  15. #include "stm32f4xx.h"
  16. #include <stdbool.h>
  17. #ifndef DEVICE_SERIAL
  18. #define DEVICE_SERIAL "7023000"
  19. #endif
  20. /**
  21. * @brief Параметры обновления ПО
  22. */
  23. typedef struct
  24. {
  25. uint8_t loadMode; // 0 - основная прошивка, 1 - режим обновления ПО
  26. uint8_t bootTry; // Признак
  27. } BOOT_PARAMS_t;
  28. /**
  29. * @brief Параметры сетевого подключения
  30. */
  31. typedef struct
  32. {
  33. char ip[16];
  34. char gate[16];
  35. char mask[16];
  36. uint8_t dhcpEnable; // 0 - DHCP отключен, 1 - включен
  37. } WEB_PARAMS_t;
  38. /**
  39. * @brief Параметры SNMP
  40. */
  41. typedef struct
  42. {
  43. char sysDescr[160];
  44. char readCommunity[20];
  45. char writeCommunity[20];
  46. char sysContact[50];
  47. char sysName[20];
  48. char sysLocation[110];
  49. char managerIP[20];
  50. char managerIP2[20];
  51. char managerIP3[20];
  52. } SNMP_t;
  53. /**
  54. * @brief Информация об устройстве
  55. */
  56. typedef struct
  57. {
  58. char productionData[40]; // Дата производства
  59. char mac[18]; // MAC адрес
  60. char serialNumber[16]; // Серийный номер
  61. char comments[110]; // Комментарии
  62. } DEVICE_INFO_t;
  63. /**
  64. * @brief Флаги, ключи и т.д.
  65. */
  66. typedef struct
  67. {
  68. bool netsettingsChanged; // Признак изменения сетевых настроек пользователем
  69. char testState[16]; // Статус производственного тестирования
  70. } FLAGS_t;
  71. /**
  72. * @brief Общая структура настроек
  73. */
  74. typedef struct
  75. {
  76. BOOT_PARAMS_t bootParams;
  77. WEB_PARAMS_t sWebParams;
  78. WEB_PARAMS_t sWebTempParams;
  79. DEVICE_INFO_t sInfo;
  80. uint32_t CritSecCRC;
  81. //uint32_t controlWorld; // Слово для контроля целостности структуры настроек
  82. } SETTINGS_t;
  83. /**
  84. * @brief
  85. * @retval
  86. */
  87. uint32_t SETTINGS_GetCritSecCRC(void);
  88. /**
  89. * @brief Установить параметры обновления ПО по умолчанию
  90. */
  91. void SETTINGS_SetBootParamsDef(void);
  92. /**
  93. * @brief Установить параметры сетевого подключения по умолчанию
  94. */
  95. void SETTINGS_SetWebParamsDef(void);
  96. /**
  97. * @brief Установить временные параметры сетевого подключения по умолчанию
  98. */
  99. void SETTINGS_SetTempWebParamsDef(void);
  100. /**
  101. * @brief Установить Информацию об устройстве по умолчанию
  102. */
  103. void SETTINGS_SetInfoDef(void);
  104. /**
  105. * @brief Очистка сектора настроек
  106. */
  107. void SETTINGS_EraseFlashSector(void);
  108. /**
  109. * @brief Сброс всех настроек в значения по умолчанию кроме сетевых настроек
  110. */
  111. void SETTINGS_SetPartDefault(void);
  112. /**
  113. * @brief Сброс всех настроек в значения по умолчанию
  114. */
  115. void SETTINGS_SetAllDefault(void);
  116. /**
  117. * @brief Установка настроек для отладки
  118. */
  119. void SETTINGS_SetDefaultDebug(void);
  120. /**
  121. * @brief Запись структуры настроек во flesh
  122. */
  123. void SETTINGS_Save(void);
  124. /**
  125. * @brief Загрузка структуры настроек из flesh
  126. */
  127. void SETTINGS_Load(void);
  128. /**
  129. * @brief
  130. */
  131. void SETTINGS_WriteToFlash(uint8_t *data, uint32_t size);
  132. /**
  133. * @brief
  134. */
  135. void SETTINGS_ReadFromFlash(uint8_t *data, uint32_t size);
  136. /**
  137. * @brief
  138. */
  139. uint32_t SETTINGS_GetCRC(void);
  140. /**
  141. * @brief Преобразует mac адрес строкового формата в массив uint8_t
  142. * @param mac - буфер для вывода mac адреса
  143. */
  144. void SETTINGS_GetMac(uint8_t *mac);
  145. /**
  146. * @brief Установить дату производства
  147. */
  148. void SETTINGS_SetProDate(char *proDate, uint8_t len);
  149. /**
  150. * @brief Установить статус тестирования "T2OK"
  151. */
  152. void SETTINGS_SetT2OK(void);
  153. /**
  154. * @brief Включить DHCP
  155. */
  156. void SETTINGS_SetDHCPOn(void);
  157. #endif /* #ifndef SETTINGS_API_H */
  158. /********************************* (C) РОТЕК **********************************/