lcm_relay.c

Go to the documentation of this file.

/********************************** (C) COPYRIGHT *******************************
 * File Name          : lcm_relay.c
 * Description        : Драйвер 8 реле LCM (GPIO push-pull, активный высокий уровень).
 *
 * Соответствие реле выводам контроллера (по ТЗ):
 *   | Реле | Вывод |
 *   |------|-------|
 *   |  0   |  PC3  |
 *   |  1   |  PC4  |
 *   |  2   |  PC5  |
 *   |  3   |  PC6  |
 *   |  4   |  PC7  |
 *   |  5   |  PD0  |
 *   |  6   |  PD2  |
 *   |  7   |  PD3  |
 *********************************************************************************/
 
#include "lcm_relay.h"
#include "lcm_module.h"
#include "ch32v00x_conf.h"
 
/* Связка «порт + маска пина» для прямого управления реле через GPIO. */
typedef struct {
    GPIO_TypeDef *port;
    uint16_t pin;
} LCM_RelayGpio;
 
/*
 * Таблица GPIO для 8 реле. Индекс массива = номер реле (0…7), совпадает
 * с номером бита в маске s_relay_state (lcm_module.c) и с кодом команды
 * LCM_LAMP_N_ON/OFF (lcm_module.h). Реле физически разнесены по двум
 * портам (5 на GPIOC, 3 на GPIOD) — таблица скрывает эту неоднородность
 * от остального кода: снаружи реле — просто индекс 0…7.
 * SetBits = реле включено (контакты замкнуты), ResetBits = выключено.
 */
static const LCM_RelayGpio s_relay_gpio[LCM_RELAY_COUNT] = {
    { GPIOC, GPIO_Pin_3 },  /* реле 0 — LCM_RELAY_1 */
    { GPIOC, GPIO_Pin_4 },  /* реле 1 — LCM_RELAY_2 */
    { GPIOC, GPIO_Pin_5 },  /* реле 2 — LCM_RELAY_3 */
    { GPIOC, GPIO_Pin_6 },  /* реле 3 — LCM_RELAY_4 */
    { GPIOC, GPIO_Pin_7 },  /* реле 4 — LCM_RELAY_5 */
    { GPIOD, GPIO_Pin_0 },  /* реле 5 — LCM_RELAY_6 */
    { GPIOD, GPIO_Pin_2 },  /* реле 6 — LCM_RELAY_7 */
    { GPIOD, GPIO_Pin_3 }   /* реле 7 — LCM_RELAY_8 */
};
 
/*********************************************************************
 * @fn      LCM_Relay_Init
 *
 * @brief   Настройка выводов реле как цифровых выходов push-pull.
 *
 * @details Выполняется в два приёма — отдельно для GPIOC (5 пинов) и
 *          GPIOD (3 пина), т.к. это разные регистровые блоки периферии
 *          и разные биты RCC_APB2PeriphClockCmd. Перед конфигурированием
 *          каждого порта явно включается его тактирование (APB2) —
 *          без этого запись в регистры GPIO_Init не будет иметь эффекта.
 *
 *          GPIO_ResetBits() сразу после GPIO_Init() гарантирует, что реле
 *          не «дёрнутся» в непредсказуемое состояние между конфигурацией
 *          выхода и первой командой от RC (push-pull выход при сбросе
 *          порта по умолчанию может быть в высокоимпедансном/входном
 *          режиме до явной настройки Mode_Out_PP).
 *
 *          Проверочный цикл читает фактический уровень каждого пина через
 *          GPIO_ReadOutputDataBit() — это readback самого регистра вывода
 *          (ODR), а не физического состояния линии, но позволяет отловить
 *          программную ошибку (например, неверно собранную маску пинов)
 *          сразу при старте, до того как модуль начнёт отвечать на I2C.
 *
 * @return  LCM_ERR_NONE — все 8 выходов в 0;
 *          LCM_ERR_GPIO_GET — ODR вернул значение, не являющееся Bit_SET/RESET
 *          (аппаратно невозможно, но проверяется из защитных соображений);
 *          LCM_ERR_GPIO_INIT — хотя бы один пин после сброса не в 0.
 */
uint8_t LCM_Relay_Init(void)
{
    GPIO_InitTypeDef gpio = {0};
    uint8_t i;
    uint8_t level;
 
    /* --- Порт C: реле 0…4 (PC3…PC7) --- */
    RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOC, ENABLE);
 
    gpio.GPIO_Pin = GPIO_Pin_3 | GPIO_Pin_4 | GPIO_Pin_5 | GPIO_Pin_6 | GPIO_Pin_7;
    gpio.GPIO_Mode = GPIO_Mode_Out_PP;
    gpio.GPIO_Speed = GPIO_Speed_30MHz;
    GPIO_Init(GPIOC, &gpio);
    /* Явный сброс сразу после Init — все реле выключены до первой команды */
    GPIO_ResetBits(GPIOC, GPIO_Pin_3 | GPIO_Pin_4 | GPIO_Pin_5 | GPIO_Pin_6 | GPIO_Pin_7);
 
    /* --- Порт D: реле 5…7 (PD0, PD2, PD3) --- */
    RCC_APB2PeriphClockCmd(RCC_APB2Periph_GPIOD, ENABLE);
    gpio.GPIO_Pin = GPIO_Pin_0 | GPIO_Pin_2 | GPIO_Pin_3;
    gpio.GPIO_Mode = GPIO_Mode_Out_PP;
    gpio.GPIO_Speed = GPIO_Speed_30MHz;
    GPIO_Init(GPIOD, &gpio);
    GPIO_ResetBits(GPIOD, GPIO_Pin_0 | GPIO_Pin_2 | GPIO_Pin_3);
 
    /* Постфактум-проверка: убедиться, что каждый выход реально в 0.
       Порядок обхода — по таблице s_relay_gpio, т.е. по логическому
       номеру реле, а не по физическому порту/пину. */
    for (i = 0U; i < LCM_RELAY_COUNT; i++) {
        level = GPIO_ReadOutputDataBit(s_relay_gpio[i].port, s_relay_gpio[i].pin);
        if (level != Bit_SET && level != Bit_RESET) {
            return LCM_ERR_GPIO_GET;
        }
        if (level != Bit_RESET) {
            return LCM_ERR_GPIO_INIT;
        }
    }
 
    return LCM_ERR_NONE;
}
 
/*********************************************************************
 * @fn      LCM_Relay_Apply
 *
 * @brief   Применить битовую маску реле к физическим выводам GPIO.
 *
 * @param   relay_state — маска реле (LSB = реле 0, бит = 1 → включено).
 *
 * @details Для каждого из 8 реле по таблице s_relay_gpio выставляется
 *          нужный уровень (SetBits/ResetBits), затем СРАЗУ читается ODR
 *          того же пина — это единственный доступный на CH32V003 способ
 *          подтвердить, что запись в регистр действительно прошла
 *          (например, отличить настоящий сбой периферии от опечатки
 *          в номере пина на этапе разработки).
 *
 *          Специальные коды ошибок LCM_ERR_GPIO_SET_ALL / CLEAR_ALL
 *          используются только тогда, когда операция затрагивала ВСЕ
 *          8 реле одновременно (relay_state == 0xFF при включении или
 *          0x00 при выключении, т.е. команды LCM_LAMP_ALL_ON/OFF) — это
 *          позволяет в журнале событий отличить «не включилось одно
 *          конкретное реле» от «не включились все реле сразу» (что чаще
 *          говорит об общей проблеме питания/GPIO, а не о конкретном
 *          канале). Функция прерывает обход при первой обнаруженной
 *          ошибке — оставшиеся реле в маске не проверяются и не трогаются
 *          в этом вызове.
 *
 * @return  LCM_ERR_NONE — маска применена ко всем 8 реле;
 *          LCM_ERR_GPIO_GET/SET/SET_ALL/CLEAR/CLEAR_ALL — см. выше.
 */
uint8_t LCM_Relay_Apply(uint8_t relay_state)
{
    uint8_t i;
    uint8_t bit;
    uint8_t level;
 
    for (i = 0U; i < LCM_RELAY_COUNT; i++) {
        bit = (uint8_t)(1U << i);
        if (relay_state & bit) {
            /* Требуемое состояние реле i — включено */
            GPIO_SetBits(s_relay_gpio[i].port, s_relay_gpio[i].pin);
            level = GPIO_ReadOutputDataBit(s_relay_gpio[i].port, s_relay_gpio[i].pin);
            if (level != Bit_SET && level != Bit_RESET) {
                return LCM_ERR_GPIO_GET;
            }
            if (level != Bit_SET) {
                /* SetBits не подействовал — различаем «все реле» и «одно реле» */
                if (relay_state == 0xFFU) {
                    return LCM_ERR_GPIO_SET_ALL;
                }
                return LCM_ERR_GPIO_SET;
            }
        } else {
            /* Требуемое состояние реле i — выключено */
            GPIO_ResetBits(s_relay_gpio[i].port, s_relay_gpio[i].pin);
            level = GPIO_ReadOutputDataBit(s_relay_gpio[i].port, s_relay_gpio[i].pin);
            if (level != Bit_SET && level != Bit_RESET) {
                return LCM_ERR_GPIO_GET;
            }
            if (level != Bit_RESET) {
                if (relay_state == 0U) {
                    return LCM_ERR_GPIO_CLEAR_ALL;
                }
                return LCM_ERR_GPIO_CLEAR;
            }
        }
    }
 
    return LCM_ERR_NONE;
}