settings_api.c 12 KB

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