settings_api.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. #ifndef SETTINGS_API_H
  2. #define SETTINGS_API_H
  3. #include "at32f403a_407.h"
  4. #include "model_cfg.h"
  5. #include "usart.h"
  6. #include "sys_api.h"
  7. #include "io.h"
  8. #include "mb.h"
  9. #include "mbport.h"
  10. #include <stdbool.h>
  11. // Изменить версию если поменялась структура настроек
  12. #define SETTINGS_VERSION 0x01
  13. // ------------------------------------------------------------------- //
  14. // Draft
  15. // ------------------------------------------------------------------- //
  16. /*
  17. 1. Uptime (uint32_t) // +
  18. 2. Realtime (unix timestamp, uint32_t) // +
  19. 3. Версия прошивки // +
  20. 4. Модель (char 16 байт) // +
  21. */
  22. // ------------------------------------------------------------------- //
  23. // Modbus
  24. // ------------------------------------------------------------------- //
  25. #define MB_STOP_BIT_MASK 0x03
  26. #define MB_STOP_BIT_1 0x00
  27. #define MB_STOP_BIT_2 0x02
  28. #define MB_PARITY_MASK (0x03 << 3)
  29. #define MB_NO_PAR (0x00 << 3)
  30. #define MB_EVEN_PAR (0x02 << 3)
  31. #define MB_ODD_PAR (0x03 << 3)
  32. #define MB_BRD_MASK (0x07 << 5)
  33. #define MB_BRD_2400 (0x00 << 5)
  34. #define MB_BRD_4800 (0x01 << 5)
  35. #define MB_BRD_9600 (0x02 << 5)
  36. #define MB_BRD_19200 (0x03 << 5)
  37. #define MB_BRD_38400 (0x04 << 5)
  38. #define MB_BRD_57600 (0x05 << 5)
  39. #define MB_BRD_115200 (0x06 << 5)
  40. // Modbus
  41. typedef struct
  42. {
  43. rate_t baud; // Скорость порта
  44. parity_t parity; // Четность
  45. databits_t databits; // Число бит данных
  46. stopbits_t stopbits; // Число стоп-бит
  47. } modbus_t;
  48. // Общая структура настроек для IAP и FW
  49. typedef struct
  50. {
  51. uint16_t mb_port; // Настройки порта для modbus
  52. char model[MODEL_LEN]; // Модель
  53. } com_settings_t;
  54. #if 0
  55. // Дискретные входы
  56. typedef struct
  57. {
  58. uint16_t debounce_time; // период антидребезга в мс (0 - 10 сек)
  59. } dinput_t;
  60. #endif
  61. // Полная структура настроек
  62. typedef struct
  63. {
  64. com_settings_t com_settings;
  65. uint32_t critical_section_crc;
  66. /* WARNING! До поля CritSecCRC включительно структура настроек должна быть
  67. * идентичной между бутлоадером и основным ПО и не должна изменяться при обновлении ПО.
  68. * Контроль целостности настроек внутри IAP выполняется только для критической секции,
  69. * т.к. контроль целостности всей структуры не имеет смысла
  70. * (структура настроек всегда будет отличаться внутри основного ПО).
  71. * В случае повреждения критического сектора, загружаются параметры по умолчанию. */
  72. uint16_t settings_version; // Версия структуры настроек
  73. uint32_t control_word; // Слово для контроля целостности структуры настроек
  74. uint16_t di_mode_bits; // режим работы, 0 - вход, 1 - счетчик импульсов
  75. uint16_t di_norm_state_bits; // нормальное состояние (0 - разомкнут, 1 - замкнут)
  76. uint16_t di_debounce[DI_NUMBER]; // Дискретные входы
  77. uint16_t do_mode_bits; // режим работы выхода 0 - выход, 1 - ШИМ
  78. uint16_t do_bits; // последнее сохраненное значение на выходах
  79. uint16_t do_save_bits; // значение на выходах в бесопасном режиме работы
  80. uint16_t do_pwm[DO_NUMBER]; // значение заполнения ШИМ
  81. uint16_t do_pwm_save[DO_NUMBER]; // значение заполнения ШИМ в безопасном режиме
  82. uint16_t do_pwm_period[DO_NUMBER]; // период ШИМ в [0.1с (10..1000)]
  83. uint16_t do_pwm_period_save[DO_NUMBER]; // период ШИМ в безопасном режиме [0.1с (10..1000)]
  84. bool save_mode; // безопасный режим, 0 - выкл, 1 - вкл
  85. uint16_t save_delay; // время ожидания опроса (сек.)
  86. uint16_t period_archive; // период архивирования
  87. } settings_t;
  88. // Загрузка структуры настроек из flesh
  89. void settings_load(settings_t *settings);
  90. //
  91. void init_settings(void);
  92. //
  93. void settings_read_from_flash(uint8_t *data, uint32_t size);
  94. //
  95. uint32_t settings_get_crc(settings_t *settings);
  96. //
  97. uint32_t settings_get_crit_sec_crc(settings_t *settings);
  98. // Сброс всех настроек в значения по умолчанию
  99. void settings_set_all_default(void);
  100. // -------------------------------------------------------------------------- //
  101. // Настройки по умолчанию
  102. //
  103. void settings_set_modbus_def(uint16_t *mb_port);
  104. //
  105. void settings_conv_modbus_def(modbus_t *mb_settings, uint16_t *mb_port);
  106. // Установка параметров Modbus
  107. void settings_set_modbus_params(uint16_t mb_port);
  108. //
  109. uint32_t settings_get_mb_baud(modbus_t *mb_settings);
  110. //
  111. eMBParity settings_get_mb_par(modbus_t *mb_settings);
  112. //
  113. void settings_init_mb_port(uint8_t mb_addr);
  114. // Установить параметры дискретных входов по умолчанию
  115. void settings_din_def(settings_t *settings);
  116. // Выходы
  117. void settings_do_def(settings_t *settings);
  118. // -------------------------------------------------------------------------- //
  119. // Запись структуры настроек во flash
  120. void settings_save(settings_t *settings);
  121. //
  122. void settings_write_to_flash(uint8_t *data, uint32_t size);
  123. // Очистка сектора настроек
  124. void settings_erase_flash_sector(void);
  125. //
  126. void settings_print(void);
  127. // Системные настройки
  128. extern sys_settings_t sys_settings;
  129. // Общая структура настроек
  130. extern settings_t settings;
  131. #endif /* #ifndef SETTINGS_API_H */