LIRC(4)

ИМЯ
lirc - устройства lirc

ОПИСАНИЕ

Символьные устройства /dev/lirc* предоставляют низкоуровневый двунаправленный интерфейс к аппаратуре с инфракрасным (IR) управлением. Большинство этих устройств может принимать данные, а не которые и отправлять. При приёме или отправке данных драйвер работает в двух различных режимах, в зависимости от имеющейся аппаратуры.

Некоторая аппаратура (обычно, ТВ-карты) декодирует IR-сигнал самостоятельно и выдаёт обработанные события о нажатых кнопках в виде значений сканкодов. Драйверы такой аппаратуры работают в режиме LIRC_MODE_SCANCODE. Обычно, такая аппаратура не поддерживает отправку IR-сигналов. Кроме того, она может декодировать ограниченный набор IR-протоколов, обычно, только определённых пультов, поставляющихся с ней в комплекте.

Другой вид аппаратуры выдаёт потоки длительностей наличия/отсутствия импульсов. Такие драйверы работают в режиме LIRC_MODE_MODE2. Иногда такая аппаратура также поддерживает отправку данных через IR. Она может использоваться с любым (почти) видом аппаратуры. Этот тип аппаратуры также можно использовать в режиме LIRC_MODE_SCANCODE, в этом случае сигнал декодируют декодеры ядра. Эти декодеры можно писать в расширенных BPF (смотрите bpf(2)) и присоединять к устройству lirc.

Команда ioctl LIRC_GET_FEATURES (смотрите далее) позволяет определить доступность приёма и отправки, режимы, а также другие возможности.

  Чтение входящих данных в режиме LIRC_MODE_MODE2

В режиме LIRC_MODE_MODE2 данные, возвращаемые read(2), представляют собой 32-битные значения длительностей наличия/отсутствуя импульсов. Время длительностей (микросекунды) кодируется в младших 24 битах. Старшими 8 битам определяется тип пакета:

LIRC_MODE2_SPACE
    Значение представляет длительность отсутствия импульса (микросекунды).

LIRC_MODE2_PULSE
    Значение представляет длительность импульса (микросекунды).

LIRC_MODE2_FREQUENCY
    Значение представляет частоту (Гц); смотрите команду ioctl LIRC_SET_MEASURE_CARRIER_MODE.

LIRC_MODE2_TIMEOUT
    Значение представляет длительность отсутствия импульса (микросекунды). Пакет описывает паузу; смотрите ioctl LIRC_SET_REC_TIMEOUT_REPORTS.

  Чтение входящих данных в режиме LIRC_MODE_SCANCODE

В режиме LIRC_MODE_SCANCODE данные, возвращаемые read(2) в структуре lirc_scancode, содержат декодированные нажатия кнопок. Сканкод сохраняется в поле scancode, а протокол IR — в rc_proto. В этом поле хранится одно из значений enum rc_proto.

  Запись выходных данных в режиме LIRC_MODE_PULSE

Данные, записываемые в символьное устройство с помощью write(2), представляют собой последовательность наличия/отсутствия импульсов в виде целых чисел. Импульсы и их отсутствие неявно разделяются только по их положению. Данные должны начинаться и заканчиваться импульсом, то есть всегда должно быть нечётное количество выборок. Функция write(2) блокирует выполнение до тех пор, пока данные не будут переданы аппаратурой. Если данных больше, чем аппаратура может послать, то write(2) завершается с ошибкой EINVAL.

  Запись выходных данных в режиме LIRC_MODE_SCANCODE

Данные, записываемые в символьные устройства, должны храниться в структуре lirc_scancode. Должны быть заполнены поля scancode и rc_proto, остальные должны быть равны 0. IR-кодировщики ядра преобразуют сканкод в импульсы и паузы. При некорректном протоколе, сканкоде или устройстве lirc передача невозможна.

КОМАНДЫ IOCTL

Работа ioctl с устройствами LIRC ограничена определением struct file_operations функции ioctl, что даёт unsigned int для команды ioctl и unsigned long для аргумента. С целью переносимости ioctl между 32-битными и 64-битными архитектурами эти значения ограничены 32-битными значениями.

#include <linux/lirc.h>    /* но смотрите ДЕФЕКТЫ */
int ioctl(int fd, int cmd, ...);

Следующие команды ioctl можно использовать для тестирования или изменения определённых аппаратных настроек через lirc. Для многих команд требуется третий аргумент, обычно с типом int, который обозначается далее как val.

  Всегда поддерживаемые команды

Устройства /dev/lirc* всегда поддерживают следующие команды:

LIRC_GET_FEATURES (void)
    Возвращает битовую маску возможностей; смотрите ВОЗМОЖНОСТИ.

Если устройство возвращает код ошибки после LIRC_GET_FEATURES, то можно считать, что это устройство не является lirc.

  Необязательные команды

Некоторые устройства lirc поддерживают команды, перечисленные ниже. Если не утверждается обратное, они завершаются с ошибкой ENOTTY, если операция не поддерживается, или с ошибкой EINVAL, если операция завершилась с ошибкой или указаны некорректные параметры. Если драйвер не анонсирует поддержку определённых возможностей, то вызов соответствующих ioctl завершается с ошибкой ENOTTY.

LIRC_GET_REC_MODE (void)
    Если в устройстве lirc нет приёмника, то эта операция завершается ошибкой ENOTTY. В противном случае возвращается режим приёма, который может быть одним из:

    LIRC_MODE_MODE2
        Драйвер возвращает последовательность длительностей наличия/ отсутствуя импульсов.

    LIRC_MODE_SCANCODE
        Драйвер возвращает значения struct lirc_scancode, каждое из которых представляет декодированное нажатие кнопки.

LIRC_SET_REC_MODE (int)
    Задаёт режим приёма. Значением val может быть LIRC_MODE_SCANCODE или LIRC_MODE_MODE2.Если в устройстве lirc нет приёмника, то эта операция завершается ошибкой ENOTTY.

LIRC_GET_SEND_MODE (void)
    Возвращает режим передачи. Поддерживаются LIRC_MODE_PULSE и LIRC_MODE_SCANCODE. Если в устройстве lirc нет передатчика, то эта операция завершается ошибкой ENOTTY.

LIRC_SET_SEND_MODE (int)
    Задаёт режим передачи. Значением val может быть LIRC_MODE_SCANCODE или LIRC_MODE_PULSE. Если в устройстве lirc нет передатчика, то эта операция завершается ошибкой ENOTTY.

LIRC_SET_SEND_CARRIER (int)
    Задаёт частоту модуляции. Значением аргумента является частота (в Гц).

LIRC_SET_SEND_DUTY_CYCLE (int)
    Задаёт скважность несущей частоты (carrier duty cycle). Значение val — число в диапазоне [0,100], описывающей ширину импульса в виде процента от всего сигнала. Значения 0 и 100 не несут какого-то особенного смысла, но зарезервированы для использования в будущем.

LIRC_GET_MIN_TIMEOUT (void), LIRC_GET_MAX_TIMEOUT (void)
    В некоторых устройствах есть встроенные таймеры, которые можно использовать для обнаружения длительного отсутствия активности IR. Это может помочь lircd(8) обнаружить окончание сигнала IR и что можно запускать процесс декодирования. Такие операции возвращают целочисленные значения минимального/максимального периода ожидания, которое можно задать (в микросекундах). У некоторых устройств период ожидания нельзя изменить. В таких драйверах LIRC_GET_MIN_TIMEOUT и LIRC_GET_MAX_TIMEOUT возвращают ошибку ENOTTY.

LIRC_SET_REC_TIMEOUT (int)
    Задаёт период неактивности IR в виде целого значения (микросекунды). Корректные значения должны находиться в пределах, полученных от LIRC_GET_MIN_TIMEOUT и LIRC_GET_MAX_TIMEOUT. Значение 0 (если поддерживается оборудованием) отключает все аппаратные ожидания и о данных сообщается сразу после появления. Если точное значение установить невозможно, то нужно указать следующее большее возможное значение.

LIRC_GET_REC_TIMEOUT (void)
    Возвращает текущий период неактивности (в микросекундах). Доступен в Linux с версии 4.18.

LIRC_SET_REC_TIMEOUT_REPORTS (int)
    Включает (val равно 1) или выключает пакеты об (val равно 0) ожидании в LIRC_MODE_MODE2. Работа этой операции в разных версиях ядра отличается:

    *   Начиная с Linux 4.16: каждый раз при открытии устройства lirc сообщения о неактивности по умолчанию включается для файлового дескриптора результата. Операцию LIRC_SET_REC_TIMEOUT можно использовать для выключения (и, если нужно, потом включить заново) ожидания на файловом дескрипторе.

    *   В Linux 4.15 и старее: сообщения о неактивности по умолчанию выключено и его включение (LIRC_SET_REC_TIMEOUT) на любом файловом дескрипторе, связанном с устройством lirc, привод к включению ожидания неактивности для всех файловых дескрипторов, которые ссылаются на устройство (пока неактивность не будет снова выключена).

LIRC_SET_REC_CARRIER (int)
    Задаёт верхнюю границу несущей частоты приёмника (Гц). Смотрите LIRC_SET_REC_CARRIER_RANGE.

LIRC_SET_REC_CARRIER_RANGE (int)
    Задаёт нижнюю границу несущей частоты приёмника (Гц). Для выполнения этой операции сначала нужно задать нижнюю границу с помощью ioctl LIRC_SET_REC_CARRIER_RANGE, а затем верхнюю границу с помощью ioctl LIRC_SET_REC_CARRIER.

LIRC_SET_MEASURE_CARRIER_MODE (int)
    Включает (val равно 1) или выключает (val равно 0) режим измерения. Если режим включён, то после следующего нажатия клавиши драйвер пошлёт пакеты LIRC_MODE2_FREQUENCY. По умолчанию должен быть выключен.

LIRC_GET_REC_RESOLUTION (void)
    Возвращает точность разрешения драйвера (в микросекундах).

LIRC_SET_TRANSMITTER_MASK (int)
    Включает набор передатчиков, указанных в val в виде битовой маски, где каждый включаемый передатчик обозначен 1. Первый передатчик кодируется в самом младшем бите и т. д. Если указана некорректная битовая маска, например, указан бит, но в устройстве нет столько передатчиков, то данная операция возвращает количество доступных передатчиков и ничего не делает.

LIRC_SET_WIDEBAND_RECEIVER (int)
    У некоторых устройств есть специальный широкополосный приёмник, который предназначен для обучения выводу существующего пульта. Данную ioctl можно использовать для включения (val равно 1) или отключения (val равно 0) этого свойства. Это может быть полезно для устройств с узкополосными приёмниками, которые не могут работать с некоторыми пультами. Широкополосные приёмники могут иметь большую точность. С другой стороны, их недостаток в меньшей дальности приёма.

    Замечание: широкополосные приёмники могут неявно включаться, если вы включаете сообщения о несущей. В этом случае, он отключится сразу после отключения сообщений о несущей. Попытка отключить широкополосный приёмник при включённых сообщениях о несущей ни к чему не приводит.

ВОЗМОЖНОСТИ

ioctl LIRC_GET_FEATURES возвращает битовую маску, описывающую свойства драйвера. В маске могут быть установлены следующие биты:

LIRC_CAN_REC_MODE2
    Драйвер способен вести приём в режиме LIRC_MODE_MODE2.

LIRC_CAN_REC_SCANCODE
    Драйвер способен вести приём в режиме LIRC_MODE_SCANCODE.

LIRC_CAN_SET_SEND_CARRIER
    Драйвер поддерживает изменение частоты модуляции с помощью LIRC_SET_SEND_CARRIER.

LIRC_CAN_SET_SEND_DUTY_CYCLE
    Драйвер поддерживает изменение опорного сигнала с помощью LIRC_SET_SEND_DUTY_CYCLE.

LIRC_CAN_SET_TRANSMITTER_MASK
    Драйвер поддерживает изменение передатчика(ов) с помощью LIRC_SET_TRANSMITTER_MASK.

LIRC_CAN_SET_REC_CARRIER
    Драйвер поддерживает установку частоты приёмной несущей с помощью LIRC_SET_REC_CARRIER. Из-за объединения драйверов в ядре версии 2.6.36 любое устройство lirc должно устанавливать LIRC_CAN_SET_REC_CARRIER_RANGE, если указано свойство LIRC_CAN_SET_REC_CARRIER.

LIRC_CAN_SET_REC_CARRIER_RANGE
    Драйвер поддерживает LIRC_SET_REC_CARRIER_RANGE. Перед использованием ioctl LIRC_SET_REC_CARRIER для указания верхней границы,нужно вызвать ioctl LIRC_SET_REC_CARRIER_RANGE для указания нижней границы несущей.

LIRC_CAN_GET_REC_RESOLUTION
    Драйвер поддерживает LIRC_GET_REC_RESOLUTION.

LIRC_CAN_SET_REC_TIMEOUT
    Драйвер поддерживает LIRC_SET_REC_TIMEOUT.

LIRC_CAN_MEASURE_CARRIER
    Драйвер поддерживает измерение частоты модуляции с помощью LIRC_SET_MEASURE_CARRIER_MODE.

LIRC_CAN_USE_WIDEBAND_RECEIVER
    Драйвер поддерживает режим обучения с помощью LIRC_SET_WIDEBAND_RECEIVER.

LIRC_CAN_SEND_PULSE
    Драйвер поддерживает отправку в режиме LIRC_MODE_SCANCODE или LIRC_MODE_SCANCODE.

ДЕФЕКТЫ
Для использования этих устройств требуется заголовочный файл ядра lirc.h. Этот файл был недоступен до ядра версии 4.6. Пользователи старых ядер могут использовать файл с сайта http://www.lirc.org.

СМОТРИТЕ ТАКЖЕ
ir-ctl(1), lircd(8), bpf(2)

https://www.kernel.org/doc/html/latest/media/uapi/rc/lirc-dev.html