event_log.h

Go to the documentation of this file.

/********************************** (C) COPYRIGHT *******************************
 * File Name          : event_log.h
 * Description        : Подробное логирование событий LCM на USART1 (PD6, 115200 8N1).
 *********************************************************************************/
 
#ifndef __EVENT_LOG_H
#define __EVENT_LOG_H
 
#include <stdint.h>
#include "user_data.h"
 
/* 1 — логирование включено; 0 — все вызовы EventLog_* не делают вывода */
#ifndef EVENT_LOG_ENABLE
#define EVENT_LOG_ENABLE          1
#endif
 
/*********************************************************************
 * @fn      EventLog_Init
 *
 * @brief   Инициализация USART1: TX = PD6 (PartialRemap2), 115200 8N1.
 */
void EventLog_Init(void);
 
/*********************************************************************
 * @fn      EventLog_Process
 *
 * @brief   Вывести на UART события из кольцевого буфера (вызывать из main).
 */
void EventLog_Process(void);
 
/*********************************************************************
 * @fn      EventLog_Printf
 *
 * @brief   Немедленный вывод строки (только из main, не из ISR).
 */
void EventLog_Printf(const char *fmt, ...);
 
/*********************************************************************
 * @fn      EventLog_BootBanner
 *
 * @brief   Стартовый баннер прошивки.
 */
void EventLog_BootBanner(void);
 
/*********************************************************************
 * @fn      EventLog_UserDataInit
 *
 * @brief   Результат UserData_Init().
 */
void EventLog_UserDataInit(UserData_Status st);
 
/*********************************************************************
 * @fn      EventLog_LcmConfig
 *
 * @brief   Конфигурация LCM после загрузки NVM.
 */
void EventLog_LcmConfig(uint8_t i2c_addr, const uint8_t group_mask[4], uint8_t relay_state);
 
/*********************************************************************
 * @fn      EventLog_PushI2cCmd
 *
 * @brief   Поставить в очередь событие I2C-команды (безопасно из ISR).
 */
void EventLog_PushI2cCmd(uint8_t cmd, uint8_t param, uint8_t has_param);
 
/*********************************************************************
 * @fn      EventLog_PushI2cReadArm
 *
 * @brief   Команда чтения (arm READ): status/error/id.
 */
void EventLog_PushI2cReadArm(uint8_t cmd);
 
/*********************************************************************
 * @fn      EventLog_PushLcmError
 *
 * @brief   Код ошибки LCM (LCM_ERR_*, включая ошибки шины I2C BERR/OVR/ARLO).
 */
void EventLog_PushLcmError(uint8_t lcm_err_code);
 
/*********************************************************************
 * @fn      EventLog_PushNvm
 *
 * @brief   Событие NVM: источник операции (tag) + её результат (status).
 *
 * @param   tag    — 1: запись в RAM-кэш user_data (LCM_NvmWriteConfig/
 *                       LCM_LoadConfig); 2: UserData_Commit() (сама
 *                       запись во flash); 3: сброс кэша к заводским
 *                       значениям (LCM_RESET). Иные значения допустимы,
 *                       но печатаются как generic "tag=N" — см.
 *                       EventLog_FormatRecord() в event_log.c.
 * @param   status — UserData_Status (обычно USER_DATA_OK).
 */
void EventLog_PushNvm(uint8_t tag, uint8_t status);
 
/*********************************************************************
 * @fn      EventLog_PushSystem
 *
 * @brief   Системное событие (reset, watchdog, factory_reset).
 *
 * @param   tag — 1: запрошена программная перезагрузка (перед
 *                    NVIC_SystemReset()); 2: IWDG успешно взведён при
 *                    старте (~2 с). Иные значения печатаются как
 *                    generic "tag=N".
 */
void EventLog_PushSystem(uint8_t tag);
 
#endif /* __EVENT_LOG_H */