settings_api.c 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  1. /********************************* (C) ROTEK ***********************************
  2. * @module settings_api
  3. * @file settings_api.c
  4. * @version 1.0.0
  5. * @date XX.XX.XXXX
  6. * $brief Settings
  7. *******************************************************************************
  8. * @history Version Author Comment
  9. * XX.XX.XXXX 1.0.0 Telenkov D.A. First release.
  10. *******************************************************************************
  11. */
  12. #include "stm32f4xx.h"
  13. #include "settings_api.h"
  14. #include "common_config.h"
  15. #include "snmp_api.h"
  16. #include "trap_api.h"
  17. #include "log.h"
  18. #include "FreeRTOS.h"
  19. #include "task.h"
  20. #include <string.h>
  21. #include <stdlib.h>
  22. #ifdef PRINTF_STDLIB
  23. #include <stdio.h>
  24. #endif
  25. #ifdef PRINTF_CUSTOM
  26. #include "tinystdio.h"
  27. #endif
  28. #define DBG if(0)
  29. #if defined ( __ICCARM__ )
  30. #define DEVICE_MAC "00-00-00-00-00-02"
  31. #endif
  32. /**
  33. * @brief Флаг подтверждения новых сетевых параметров пользователем
  34. */
  35. bool fConfirmWebParams = false;
  36. /**
  37. * @brief Общая структура настроек
  38. */
  39. SETTINGS_t sSettings;
  40. /**
  41. * @brief Установить параметры обновления ПО по умолчанию
  42. */
  43. void SETTINGS_SetBootParamsDef(void)
  44. {
  45. sSettings.bootParams.loadMode = 0;
  46. sSettings.bootParams.bootTry = 0;
  47. }
  48. /**
  49. * @brief Установить параметры сетевого подключения по умолчанию
  50. */
  51. void SETTINGS_SetWebParamsDef(void)
  52. {
  53. strcpy(sSettings.sWebParams.ip, "192.168.1.8");
  54. strcpy(sSettings.sWebParams.gate, "192.168.1.1");
  55. strcpy(sSettings.sWebParams.mask, "255.255.255.0");
  56. sSettings.sWebParams.dhcpEnable = 1;
  57. }
  58. /**
  59. * @brief Установить временные параметры сетевого подключения по умолчанию
  60. */
  61. void SETTINGS_SetTempWebParamsDef(void)
  62. {
  63. strcpy(sSettings.sWebParams.ip, "192.168.1.2");
  64. strcpy(sSettings.sWebParams.gate, "192.168.1.1");
  65. strcpy(sSettings.sWebParams.mask, "255.255.255.0");
  66. sSettings.sWebParams.dhcpEnable = 1;
  67. }
  68. /**
  69. * @brief Установить параметры SNMP по умолчанию
  70. */
  71. void SETTINGS_SetSnmpDef(void)
  72. {
  73. strcpy(sSettings.sSnmp.sysDescr, "");
  74. strcpy(sSettings.sSnmp.readCommunity, "public");
  75. strcpy(sSettings.sSnmp.writeCommunity, "public");
  76. strcpy(sSettings.sSnmp.sysContact, "");
  77. strcpy(sSettings.sSnmp.sysName, "BT6702");
  78. strcpy(sSettings.sSnmp.sysLocation, "");
  79. strcpy(sSettings.sSnmp.managerIP, "0.0.0.0");
  80. strcpy(sSettings.sSnmp.managerIP2, "0.0.0.0");
  81. strcpy(sSettings.sSnmp.managerIP3, "0.0.0.0");
  82. strcpy(sSettings.sSnmp.managerIP4, "0.0.0.0");
  83. strcpy(sSettings.sSnmp.managerIP5, "0.0.0.0");
  84. }
  85. /**
  86. * @brief Установить Информацию об устройстве по умолчанию
  87. */
  88. void SETTINGS_SetInfoDef(void)
  89. {
  90. strcpy(sSettings.sInfo.productionData, "09.10.2015");
  91. strcpy(sSettings.sInfo.mac, DEVICE_MAC);
  92. strcpy(sSettings.sInfo.serialNumber, SERIAL);
  93. strcpy(sSettings.sInfo.comments, "");
  94. }
  95. /**
  96. * @brief Установить флаги по умолчанию
  97. */
  98. void SETTINGS_SetFlagsDef(void)
  99. {
  100. sSettings.sFlags.netsettingsChanged = false;
  101. }
  102. /**
  103. * @brief Установить значение сервисных настроек по умолчанию
  104. */
  105. void SETTINGS_SetServiceDef(void)
  106. {
  107. uint8_t user_id;
  108. for (user_id = 0; user_id < MAX_WEB_USERS; user_id++) {
  109. switch (user_id) {
  110. /* First users in the system is always ADMIN.
  111. * Others are USER */
  112. case 0:
  113. sSettings.sAuth[user_id].level = ADMIN;
  114. strcpy(sSettings.sAuth[user_id].login, "admin");
  115. strcpy(sSettings.sAuth[user_id].password, "12345");
  116. break;
  117. case 1:
  118. default:
  119. sSettings.sAuth[user_id].level = USER;
  120. strcpy(sSettings.sAuth[user_id].login, "user");
  121. strcpy(sSettings.sAuth[user_id].password, "1234");
  122. break;
  123. }
  124. }
  125. }
  126. /**
  127. * @brief Установить параметры SNTP по умолчанию
  128. */
  129. void SETTINGS_SetSntpDef(void)
  130. {
  131. sSettings.sSNTP.sntpEnable = true;
  132. strcpy(sSettings.sSNTP.ip, "88.147.254.235");
  133. sSettings.sSNTP.timeZone = 3.0;
  134. strcpy(sSettings.sSNTP.data, "none");
  135. }
  136. /**
  137. * @brief Установить параметры настроек сухих контактов / реле по умолчанию
  138. */
  139. void SETTINGS_SetINOUTSDef(void)
  140. {
  141. sSettings.sInOuts.ro_type_source[0] = CRITICAL;
  142. sSettings.sInOuts.ro_type_source[1] = SNMP_SET;
  143. sSettings.sInOuts.din_type_act[0] = SNMP_TRAP;
  144. }
  145. /**
  146. * @brief Установить параметры RADIUS по умолчанию
  147. */
  148. void SETTINGS_SetRADIUSDef(void)
  149. {
  150. sSettings.sRADIUS.Auth_enable = true;
  151. sSettings.sRADIUS.RDSEnable = true;
  152. strcpy(sSettings.sRADIUS.ServerIP, "127.0.0.1");
  153. sSettings.sRADIUS.port = 1227;
  154. sSettings.sRADIUS.key_access = 123;
  155. strcpy(sSettings.sRADIUS.rds_password, "12345");
  156. }
  157. /**
  158. * @brief Сброс настроек в значения по умолчанию
  159. */
  160. void SETTINGS_SetDefault(void)
  161. {
  162. SETTINGS_SetWebParamsDef();
  163. SETTINGS_SetTempWebParamsDef();
  164. SETTINGS_SetSnmpDef();
  165. SETTINGS_SetServiceDef();
  166. SETTINGS_SetSntpDef();
  167. SETTINGS_SetINOUTSDef();
  168. SETTINGS_SetRADIUSDef();
  169. sSettings.CritSecCRC = SETTINGS_GetCritSecCRC();
  170. }
  171. /**
  172. * @brief Сброс всех настроек в значения по умолчанию кроме сетевых настроек
  173. */
  174. void SETTINGS_SetPartDefault(void)
  175. {
  176. SETTINGS_SetBootParamsDef();
  177. SETTINGS_SetSnmpDef();
  178. SETTINGS_SetFlagsDef();
  179. // SETTINGS_SetServiceDef();
  180. SETTINGS_SetSntpDef();
  181. SETTINGS_SetINOUTSDef();
  182. SETTINGS_SetRADIUSDef();
  183. sSettings.CritSecCRC = SETTINGS_GetCritSecCRC();
  184. sSettings.controlWorld = SETTINGS_CONTROL_WORD;
  185. }
  186. /**
  187. * @brief Сброс всех настроек в значения по умолчанию
  188. */
  189. void SETTINGS_SetAllDefault(void)
  190. {
  191. SETTINGS_SetBootParamsDef();
  192. SETTINGS_SetWebParamsDef();
  193. SETTINGS_SetTempWebParamsDef();
  194. SETTINGS_SetSnmpDef();
  195. SETTINGS_SetInfoDef();
  196. SETTINGS_SetFlagsDef();
  197. SETTINGS_SetServiceDef();
  198. SETTINGS_SetSntpDef();
  199. SETTINGS_SetINOUTSDef();
  200. SETTINGS_SetRADIUSDef();
  201. sSettings.CritSecCRC = SETTINGS_GetCritSecCRC();
  202. sSettings.controlWorld = SETTINGS_CONTROL_WORD;
  203. }
  204. /**
  205. * @brief Установка настроек для отладки
  206. */
  207. void SETTINGS_SetDefaultDebug(void)
  208. {
  209. SETTINGS_SetWebParamsDef();
  210. SETTINGS_SetTempWebParamsDef();
  211. SETTINGS_SetSnmpDef();
  212. SETTINGS_SetBootParamsDef();
  213. SETTINGS_SetFlagsDef();
  214. //SETTINGS_SetServiceDef();
  215. SETTINGS_SetSntpDef();
  216. SETTINGS_SetINOUTSDef();
  217. SETTINGS_SetRADIUSDef();
  218. //SETTINGS_SetInfoDef();
  219. sSettings.CritSecCRC = SETTINGS_GetCritSecCRC();
  220. sSettings.controlWorld = SETTINGS_CONTROL_WORD;
  221. }
  222. /**
  223. * @brief Запись структуры настроек во flesh
  224. */
  225. void SETTINGS_Save(void)
  226. {
  227. /* Calc critical section CRC and store to the settings structure */
  228. sSettings.CritSecCRC = SETTINGS_GetCritSecCRC();
  229. SETTINGS_WriteToFlash((uint8_t*)&sSettings, sizeof(sSettings));
  230. }
  231. /**
  232. * @brief Загрузка структуры настроек из flesh
  233. */
  234. void SETTINGS_Load(void)
  235. {
  236. uint32_t loadCRC; // CRC из flash
  237. uint32_t newCRC; // CRC загруженной структуры настроек
  238. SETTINGS_ReadFromFlash((uint8_t*)&sSettings, sizeof(sSettings));
  239. /* Считываем CRC из флеш памяти */
  240. loadCRC = (*(uint32_t*)CRC_ADDRESS);
  241. /* Рассчитываем CRC для структуры настроек */
  242. newCRC = SETTINGS_GetCRC();
  243. if (loadCRC != newCRC) {
  244. SETTINGS_SetAllDefault();
  245. SETTINGS_Save();
  246. }
  247. }
  248. /**
  249. * @brief
  250. */
  251. void SETTINGS_WriteToFlash(uint8_t *data, uint32_t size)
  252. {
  253. uint32_t baseAddress = SETTINGS_SECTOR;
  254. uint32_t checkCrc = 0;
  255. uint32_t crc = SETTINGS_GetCRC();
  256. bool fAlarm = 0;
  257. FLASH_Status status;
  258. for (uint8_t i = 0; i < 3; i++)
  259. {
  260. fAlarm = 0;
  261. FLASH_Unlock();
  262. SETTINGS_EraseFlashSector();
  263. for (uint32_t i = 0; i < size; i++)
  264. if ((status = FLASH_ProgramByte(baseAddress++, *data++)) != FLASH_COMPLETE) {
  265. DBG printf("FLASH_ProgramByte error: status = %d\r\n", status);
  266. break;
  267. }
  268. if ((status = FLASH_ProgramWord((uint32_t)CRC_ADDRESS, crc)) != FLASH_COMPLETE) {
  269. DBG printf("FLASH_ProgramWord error: status = %d\r\n", status);
  270. }
  271. FLASH_Lock();
  272. /* Считываем что записали */
  273. SETTINGS_ReadFromFlash((uint8_t*)&sSettings, sizeof(sSettings));
  274. checkCrc = SETTINGS_GetCRC();
  275. /* Проверяем CRC того что было записано */
  276. if (checkCrc == crc)
  277. break;
  278. else
  279. fAlarm = 1; // Авария
  280. }
  281. /* Произошел сбой при записи - висим */
  282. if (fAlarm)
  283. while (1)
  284. {};
  285. }
  286. /**
  287. * @brief
  288. */
  289. void SETTINGS_ReadFromFlash(uint8_t *data, uint32_t size)
  290. {
  291. uint32_t baseAddress = SETTINGS_SECTOR;
  292. for (uint32_t i = 0; i < size; i++)
  293. *data++ = (*(uint32_t*)baseAddress++);;
  294. }
  295. /**
  296. * @brief Очистка сектора настроек
  297. * @retval
  298. */
  299. void SETTINGS_EraseFlashSector(void)
  300. {
  301. FLASH_Status status;
  302. if ((status = FLASH_EraseSector(FLASH_Sector_1, VoltageRange_3)) != FLASH_COMPLETE) {
  303. DBG printf("SETTINGS_EraseFlashSector error: status = %d/r/n", status);
  304. }
  305. }
  306. /**
  307. * @brief
  308. * @retval
  309. */
  310. uint32_t SETTINGS_GetCRC(void)
  311. {
  312. CRC_ResetDR();
  313. return CRC_CalcBlockCRC((uint32_t*)&sSettings, sizeof(sSettings)/4 - 1);
  314. }
  315. /**
  316. * @brief
  317. * @retval
  318. */
  319. uint32_t SETTINGS_GetCritSecCRC(void)
  320. {
  321. CRC_ResetDR();
  322. uint32_t critsec_len = (uint32_t)((uint8_t *)(&sSettings.CritSecCRC) - (uint8_t *)&sSettings) / 4;
  323. return CRC_CalcBlockCRC((uint32_t *)&sSettings, critsec_len);
  324. }
  325. /**
  326. * @brief Сброс флага boottry в регистре RTC
  327. */
  328. void SETTINGS_ResetBootTry(void)
  329. {
  330. uint8_t bootTry = RTC_ReadBackupRegister(RTC_BKP_DR2);
  331. if (bootTry > 0 )
  332. {
  333. bootTry = 0;
  334. RTC_WriteBackupRegister(RTC_BKP_DR2, 0);
  335. /* Check FW update flag */
  336. if (RTC_ReadBackupRegister(RTC_BKP_DR3)) {
  337. /* Отправка трапа об успешном обновлении ПО */
  338. SNMP_SendUserTrap(FW_VERSION_UPDATED);
  339. log_event_data(LOG_UPDATE_SOFT, "Успешно");
  340. /* Clear FW update flag */
  341. RTC_WriteBackupRegister(RTC_BKP_DR3, 0);
  342. }
  343. }
  344. /* if (sSettings.bootParams.bootTry != 0)
  345. {
  346. sSettings.bootParams.bootTry = 0;
  347. // Отправка трапа об успешном обновлении ПО
  348. SNMP_SendUserTrap(FW_VERSION_UPDATED);
  349. //taskENTER_CRITICAL();
  350. SETTINGS_Save();
  351. //taskEXIT_CRITICAL();
  352. } */
  353. }
  354. /**
  355. * @brief Преобразует mac адрес строкового формата в массив uint8_t
  356. * @param mac - буфер для вывода mac адреса
  357. */
  358. void SETTINGS_GetMac(uint8_t *mac)
  359. {
  360. char dummy[2];
  361. char *macPtr = sSettings.sInfo.mac;
  362. #if defined ( __ICCARM__ )
  363. macPtr = DEVICE_MAC;
  364. #endif
  365. for (uint8_t i = 0; i < 6; i++)
  366. {
  367. strncpy(dummy, macPtr+i*3, 2);
  368. mac[i] = (uint8_t)strtol(dummy, NULL, 16);
  369. }
  370. }
  371. /**
  372. * @brief Установить дату производства
  373. */
  374. void SETTINGS_SetProDate(char *proDate, uint8_t len)
  375. {
  376. memset(sSettings.sInfo.productionData, 0, 40);
  377. memcpy(sSettings.sInfo.productionData, proDate, len);
  378. }
  379. /**
  380. * @brief Установить статус тестирования "T2OK"
  381. */
  382. void SETTINGS_SetT2OK(void)
  383. {
  384. memset(sSettings.sFlags.testState, 0, 16);
  385. memcpy(sSettings.sFlags.testState, "T2OK", 4);
  386. }
  387. /**
  388. * @brief Включить DHCP
  389. */
  390. void SETTINGS_SetDHCPOn(void)
  391. {
  392. sSettings.sWebParams.dhcpEnable = 1;
  393. }
  394. /********************************* (C) ROTEK **********************************/