From 6f75496550e57519e9b6588a79b227a3c3afdce5 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sat, 12 Sep 2020 15:37:36 +0300 Subject: [PATCH 01/19] libgpiod initials --- Makefile | 19 +++++++++++++++++-- PKGBUILD | 1 + testenv/Dockerfile | 15 +++++++++++++++ 3 files changed, 33 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index b0e6a8fb..a134acac 100644 --- a/Makefile +++ b/Makefile @@ -3,8 +3,11 @@ TESTENV_IMAGE ?= kvmd-testenv TESTENV_HID ?= /dev/ttyS10 TESTENV_VIDEO ?= /dev/video0 +TESTENV_GPIO ?= /dev/gpiochip0 TESTENV_RELAY ?= $(if $(shell ls /dev/hidraw0 2>/dev/null || true),/dev/hidraw0,) +LIBGPIOD_VERSION ?= 1.5.2 + USTREAMER_MIN_VERSION ?= $(shell grep -o 'ustreamer>=[^"]\+' PKGBUILD | sed 's/ustreamer>=//g') DEFAULT_PLATFORM ?= v2-hdmi-rpi4 @@ -23,6 +26,7 @@ all: @ echo " make textenv # Build test environment" @ echo " make tox # Run tests and linters" @ echo " make tox E=pytest # Run selected test environment" + @ echo " make gpio # Create gpio mockup" @ echo " make run # Run kvmd" @ echo " make run CMD=... # Run specified command inside kvmd environment" @ echo " make run-ipmi # Run kvmd-ipmi" @@ -44,6 +48,7 @@ testenv: $(if $(call optbool,$(NC)),--no-cache,) \ --rm \ --tag $(TESTENV_IMAGE) \ + --build-arg LIBGPIOD_VERSION=$(LIBGPIOD_VERSION) \ --build-arg USTREAMER_MIN_VERSION=$(USTREAMER_MIN_VERSION) \ -f testenv/Dockerfile . @@ -66,8 +71,15 @@ tox: testenv " -run: testenv +$(TESTENV_GPIO): + test ! -e $(TESTENV_GPIO) + sudo modprobe gpio-mockup gpio_mockup_ranges=0,40 + test -c $(TESTENV_GPIO) + + +run: testenv $(TESTENV_GPIO) - docker run --rm --name kvmd \ + --cap-add SYS_ADMIN \ --volume `pwd`/testenv/run:/run/kvmd:rw \ --volume `pwd`/testenv:/testenv:ro \ --volume `pwd`/kvmd:/kvmd:ro \ @@ -76,10 +88,13 @@ run: testenv --volume `pwd`/configs:/usr/share/kvmd/configs.default:ro \ --volume `pwd`/contrib/keymaps:/usr/share/kvmd/keymaps:ro \ --device $(TESTENV_VIDEO):$(TESTENV_VIDEO) \ + --device $(TESTENV_GPIO):$(TESTENV_GPIO) \ $(if $(TESTENV_RELAY),--device $(TESTENV_RELAY):$(TESTENV_RELAY),) \ --publish 8080:80/tcp \ -it $(TESTENV_IMAGE) /bin/bash -c " \ - (socat PTY,link=$(TESTENV_HID) PTY,link=/dev/ttyS11 &) \ + mount -t debugfs none /sys/kernel/debug \ + && test -d /sys/kernel/debug/gpio-mockup/`basename $(TESTENV_GPIO)`/ \ + && (socat PTY,link=$(TESTENV_HID) PTY,link=/dev/ttyS11 &) \ && cp -r /usr/share/kvmd/configs.default/nginx/* /etc/kvmd/nginx \ && cp /usr/share/kvmd/configs.default/kvmd/*.yaml /etc/kvmd \ && cp /usr/share/kvmd/configs.default/kvmd/*passwd /etc/kvmd \ diff --git a/PKGBUILD b/PKGBUILD index 54ba25fe..062e16b1 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -51,6 +51,7 @@ depends=( python-pillow python-xlib python-hidapi + libgpiod freetype2 v4l-utils nginx-mainline diff --git a/testenv/Dockerfile b/testenv/Dockerfile index 8b67d272..87ed5f8f 100644 --- a/testenv/Dockerfile +++ b/testenv/Dockerfile @@ -6,6 +6,9 @@ RUN pacman -Syu --noconfirm \ && pacman -S --needed --noconfirm \ base \ base-devel \ + autoconf-archive \ + help2man \ + m4 \ vim \ git \ libjpeg \ @@ -30,6 +33,18 @@ RUN npm install htmlhint -g \ && npm install pug \ && npm install pug-cli -g +ARG LIBGPIOD_VERSION +ENV LIBGPIOD_PKG libgpiod-$LIBGPIOD_VERSION +RUN curl \ + -o $LIBGPIOD_PKG.tar.gz \ + https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/snapshot/$LIBGPIOD_PKG.tar.gz \ + && tar -xzvf $LIBGPIOD_PKG.tar.gz \ + && cd $LIBGPIOD_PKG \ + && ./autogen.sh --prefix=/usr --enable-tools=yes --enable-bindings-python \ + && make PREFIX=/usr install \ + && cd - \ + && rm -rf $LIBGPIOD_PKG{,.tar.gz} + ARG USTREAMER_MIN_VERSION ENV USTREAMER_MIN_VERSION $USTREAMER_MIN_VERSION RUN echo $USTREAMER_MIN_VERSION From fa5e6735edababe8f1d429ec98162fb7d508e1e0 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sat, 12 Sep 2020 20:03:51 +0300 Subject: [PATCH 02/19] using libgpiod for the serial hid --- kvmd/apps/cleanup/__init__.py | 4 -- kvmd/plugins/hid/serial.py | 71 ++++++++++++++++++++++++----------- 2 files changed, 49 insertions(+), 26 deletions(-) diff --git a/kvmd/apps/cleanup/__init__.py b/kvmd/apps/cleanup/__init__.py index 5b6f2860..ce321f42 100644 --- a/kvmd/apps/cleanup/__init__.py +++ b/kvmd/apps/cleanup/__init__.py @@ -44,10 +44,6 @@ def _clear_gpio(config: Section) -> None: with gpio.bcm(): for (name, pin) in [ - *([ - ("hid_serial/reset", config.hid.reset_pin), - ] if config.hid.type == "serial" else []), - *([ ("atx_gpio/power_switch", config.atx.power_switch_pin), ("atx_gpio/reset_switch", config.atx.reset_switch_pin), diff --git a/kvmd/plugins/hid/serial.py b/kvmd/plugins/hid/serial.py index bb97aec4..23f6c136 100644 --- a/kvmd/plugins/hid/serial.py +++ b/kvmd/plugins/hid/serial.py @@ -35,7 +35,9 @@ from typing import List from typing import Dict from typing import Iterable from typing import AsyncGenerator +from typing import Optional +import gpiod import serial from ...logging import get_logger @@ -45,7 +47,6 @@ from ...keyboard.mappings import KEYMAP from ... import aiotools from ... import aiomulti from ... import aioproc -from ... import gpio from ...yamlconf import Option @@ -57,7 +58,7 @@ from ...validators.basic import valid_float_f01 from ...validators.os import valid_abs_path from ...validators.hw import valid_tty_speed -from ...validators.hw import valid_gpio_pin +from ...validators.hw import valid_gpio_pin_optional from . import BaseHid @@ -156,6 +157,47 @@ class _MouseWheelEvent(_BaseEvent): return struct.pack(">Bxbxx", 0x14, self.delta_y) +class _Gpio: + def __init__(self, reset_pin: int, reset_delay: float) -> None: + self.__reset_pin = reset_pin + self.__reset_delay = reset_delay + + self.__chip: Optional[gpiod.Chip] = None + self.__reset_line: Optional[gpiod.Line] = None + self.__reset_wip = False + + def open(self) -> None: + if self.__reset_pin >= 0: + assert self.__chip is None + assert self.__reset_line is None + self.__chip = gpiod.Chip("/dev/gpiochip0") + self.__reset_line = self.__chip.get_line(self.__reset_pin) + self.__reset_line.request("kvmd/hid-serial/reset", gpiod.LINE_REQ_DIR_OUT, default_val=0) + + def close(self) -> None: + if self.__chip: + self.__chip.close() + + @aiotools.atomic + async def reset(self) -> None: + if self.__reset_pin >= 0: + assert self.__reset_line + if not self.__reset_wip: + try: + self.__reset_wip = True + self.__reset_line.set_value(1) + await asyncio.sleep(self.__reset_delay) + finally: + try: + self.__reset_line.set_value(0) + await asyncio.sleep(1) + finally: + self.__reset_wip = False + get_logger(0).info("Reset HID performed") + else: + get_logger(0).info("Another reset HID in progress") + + # ===== class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-instance-attributes def __init__( # pylint: disable=too-many-arguments,super-init-not-called @@ -175,9 +217,6 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst multiprocessing.Process.__init__(self, daemon=True) - self.__reset_pin = gpio.set_output(reset_pin, False) - self.__reset_delay = reset_delay - self.__device_path = device_path self.__speed = speed self.__read_timeout = read_timeout @@ -187,7 +226,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst self.__errors_threshold = errors_threshold self.__noop = noop - self.__reset_wip = False + self.__gpio = _Gpio(reset_pin, reset_delay) self.__events_queue: multiprocessing.queues.Queue = multiprocessing.Queue() @@ -204,7 +243,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst @classmethod def get_plugin_options(cls) -> Dict: return { - "reset_pin": Option(-1, type=valid_gpio_pin), + "reset_pin": Option(-1, type=valid_gpio_pin_optional), "reset_delay": Option(0.1, type=valid_float_f01), "device": Option("", type=valid_abs_path, unpack_as="device_path"), @@ -218,6 +257,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst } def sysprep(self) -> None: + self.__gpio.open() get_logger(0).info("Starting HID daemon ...") self.start() @@ -247,20 +287,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst @aiotools.atomic async def reset(self) -> None: - if not self.__reset_wip: - try: - self.__reset_wip = True - gpio.write(self.__reset_pin, True) - await asyncio.sleep(self.__reset_delay) - finally: - try: - gpio.write(self.__reset_pin, False) - await asyncio.sleep(1) - finally: - self.__reset_wip = False - get_logger().info("Reset HID performed") - else: - get_logger().info("Another reset HID in progress") + await self.__gpio.reset() @aiotools.atomic async def cleanup(self) -> None: @@ -279,7 +306,7 @@ class Plugin(BaseHid, multiprocessing.Process): # pylint: disable=too-many-inst except Exception: logger.exception("Can't clear HID events") finally: - gpio.write(self.__reset_pin, False) + self.__gpio.close() # ===== From bddabc4742ebd130020efc14c53675bf5c96e134 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sat, 12 Sep 2020 22:16:14 +0300 Subject: [PATCH 03/19] using libgpiod for the relay msd --- kvmd/apps/cleanup/__init__.py | 5 --- kvmd/plugins/msd/relay.py | 84 +++++++++++++++++++++++++++-------- 2 files changed, 65 insertions(+), 24 deletions(-) diff --git a/kvmd/apps/cleanup/__init__.py b/kvmd/apps/cleanup/__init__.py index ce321f42..795841c5 100644 --- a/kvmd/apps/cleanup/__init__.py +++ b/kvmd/apps/cleanup/__init__.py @@ -48,11 +48,6 @@ def _clear_gpio(config: Section) -> None: ("atx_gpio/power_switch", config.atx.power_switch_pin), ("atx_gpio/reset_switch", config.atx.reset_switch_pin), ] if config.atx.type == "gpio" else []), - - *([ - ("msd_relay/target", config.msd.target_pin), - ("msd_relay/reset", config.msd.reset_pin), - ] if config.msd.type == "relay" else []), ]: if pin >= 0: logger.info("Writing 0 to GPIO pin=%d (%s)", pin, name) diff --git a/kvmd/plugins/msd/relay.py b/kvmd/plugins/msd/relay.py index 409d3d71..07e9f85e 100644 --- a/kvmd/plugins/msd/relay.py +++ b/kvmd/plugins/msd/relay.py @@ -35,12 +35,12 @@ from typing import Optional import aiofiles import aiofiles.base +import gpiod from ...logging import get_logger from ... import aiotools from ... import aiofs -from ... import gpio from ...yamlconf import Option @@ -152,6 +152,59 @@ def _explore_device(device_path: str) -> _DeviceInfo: ) +class _Gpio: + def __init__( + self, + target_pin: int, + reset_pin: int, + reset_delay: float, + ) -> None: + + self.__target_pin = target_pin + self.__reset_pin = reset_pin + self.__reset_delay = reset_delay + + self.__chip: Optional[gpiod.Chip] = None + self.__target_line: Optional[gpiod.Line] = None + self.__reset_line: Optional[gpiod.Line] = None + + def open(self) -> None: + assert self.__chip is None + assert self.__target_line is None + assert self.__reset_line is None + + self.__chip = gpiod.Chip("/dev/gpiochip0") + + self.__target_line = self.__chip.get_line(self.__target_pin) + self.__target_line.request("kvmd/msd-relay/target", gpiod.LINE_REQ_DIR_OUT, default_val=0) + + self.__reset_line = self.__chip.get_line(self.__reset_pin) + self.__reset_line.request("kvmd/msd-relay/reset", gpiod.LINE_REQ_DIR_OUT, default_val=0) + + def close(self) -> None: + if self.__chip: + self.__chip.close() + + def switch_to_local(self) -> None: + assert self.__target_line + self.__target_line.set_value(0) + + def switch_to_server(self) -> None: + assert self.__target_line + self.__target_line.set_value(1) + + @contextlib.asynccontextmanager + async def reset(self) -> AsyncGenerator[None, None]: + assert self.__reset_line + try: + self.__reset_line.set_value(1) + await asyncio.sleep(self.__reset_delay) + self.__reset_line.set_value(0) + yield + finally: + self.__reset_line.set_value(0) + + # ===== class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes def __init__( # pylint: disable=super-init-not-called @@ -165,13 +218,11 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes reset_delay: float, ) -> None: - self.__target_pin = gpio.set_output(target_pin, False) - self.__reset_pin = gpio.set_output(reset_pin, False) - self.__device_path = device_path self.__init_delay = init_delay self.__init_retries = init_retries - self.__reset_delay = reset_delay + + self.__gpio = _Gpio(target_pin, reset_pin, reset_delay) self.__device_info: Optional[_DeviceInfo] = None self.__connected = False @@ -202,6 +253,9 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes "reset_delay": Option(1.0, type=valid_float_f01), } + def sysprep(self) -> None: + self.__gpio.open() + async def get_state(self) -> Dict: storage: Optional[Dict] = None drive: Optional[Dict] = None @@ -245,26 +299,18 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes @aiotools.atomic async def __inner_reset(self) -> None: - try: - gpio.write(self.__reset_pin, True) - await asyncio.sleep(self.__reset_delay) - gpio.write(self.__reset_pin, False) - - gpio.write(self.__target_pin, False) + async with self.__gpio.reset(): + self.__gpio.switch_to_local() self.__connected = False - await self.__load_device_info() get_logger(0).info("MSD reset has been successful") - finally: - gpio.write(self.__reset_pin, False) @aiotools.atomic async def cleanup(self) -> None: try: await self.__close_device_file() finally: - gpio.write(self.__target_pin, False) - gpio.write(self.__reset_pin, False) + self.__gpio.close() # ===== @@ -283,7 +329,7 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes if self.__connected: raise MsdConnectedError() - gpio.write(self.__target_pin, True) + self.__gpio.switch_to_server() self.__connected = True get_logger(0).info("MSD switched to Server") @@ -294,12 +340,12 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes if not self.__connected: raise MsdDisconnectedError() - gpio.write(self.__target_pin, False) + self.__gpio.switch_to_local() try: await self.__load_device_info() except Exception: if self.__connected: - gpio.write(self.__target_pin, True) + self.__gpio.switch_to_server() raise self.__connected = False get_logger(0).info("MSD switched to KVM: %s", self.__device_info) From 002823b6e1ae6a261e77ee83b358307c682ce65a Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 10:47:53 +0300 Subject: [PATCH 04/19] using libgpiod for the gpio atx --- kvmd/aiogp.py | 101 ++++++++++++++++++++++++++++++++++ kvmd/aiotools.py | 3 + kvmd/apps/cleanup/__init__.py | 25 --------- kvmd/plugins/atx/gpio.py | 81 ++++++++++++++------------- 4 files changed, 148 insertions(+), 62 deletions(-) create mode 100644 kvmd/aiogp.py diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py new file mode 100644 index 00000000..dbc39e69 --- /dev/null +++ b/kvmd/aiogp.py @@ -0,0 +1,101 @@ +# ========================================================================== # +# # +# KVMD - The main Pi-KVM daemon. # +# # +# Copyright (C) 2018 Maxim Devaev # +# # +# This program is free software: you can redistribute it and/or modify # +# it under the terms of the GNU General Public License as published by # +# the Free Software Foundation, either version 3 of the License, or # +# (at your option) any later version. # +# # +# This program is distributed in the hope that it will be useful, # +# but WITHOUT ANY WARRANTY; without even the implied warranty of # +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # +# GNU General Public License for more details. # +# # +# You should have received a copy of the GNU General Public License # +# along with this program. If not, see . # +# # +# ========================================================================== # + + +import asyncio +import threading + +from typing import List +from typing import Optional + +import gpiod + +from . import aiotools + + +# ===== +class AioPinsReader(threading.Thread): + def __init__( + self, + path: str, + consumer: str, + pins: List[int], + inverted: List[bool], + notifier: aiotools.AioNotifier, + ) -> None: + + assert len(pins) == len(inverted) + super().__init__(daemon=True) + + self.__path = path + self.__consumer = consumer + self.__pins = pins + self.__inverted = dict(zip(pins, inverted)) + self.__notifier = notifier + + self.__state = dict.fromkeys(pins, False) + + self.__stop_event = threading.Event() + self.__loop: Optional[asyncio.AbstractEventLoop] = None + + def get(self, pin: int) -> bool: + return (self.__state[pin] ^ self.__inverted[pin]) + + async def poll(self) -> None: + if not self.__pins: + await aiotools.wait_infinite() + else: + assert self.__loop is None + self.__loop = asyncio.get_running_loop() + self.start() + try: + await aiotools.run_async(self.join) + finally: + self.__stop_event.set() + await aiotools.run_async(self.join) + + def run(self) -> None: + assert self.__loop + with gpiod.Chip(self.__path) as chip: + lines = chip.get_lines(self.__pins) + lines.request(self.__consumer, gpiod.LINE_REQ_EV_BOTH_EDGES) + + lines.event_wait(nsec=1) + self.__state = { + pin: bool(value) + for (pin, value) in zip(self.__pins, lines.get_values()) + } + self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) + + while not self.__stop_event.is_set(): + ev_lines = lines.event_wait(10) + if ev_lines: + for ev_lines in lines.event_wait(1): + for ev_line in ev_lines: + event = ev_line.event_read() + if event.type == gpiod.LineEvent.RISING_EDGE: + value = True + elif event.type == gpiod.LineEvent.FALLING_EDGE: + value = False + else: + raise RuntimeError(f"Invalid event {event} type: {event.type}") + self.__state[event.source.offset()] = value + self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) diff --git a/kvmd/aiotools.py b/kvmd/aiotools.py index 84c6f314..dfd67f44 100644 --- a/kvmd/aiotools.py +++ b/kvmd/aiotools.py @@ -97,6 +97,9 @@ class AioNotifier: async def notify(self) -> None: await self.__queue.put(None) + def notify_sync(self) -> None: + self.__queue.put_nowait(None) + async def wait(self) -> None: await self.__queue.get() while not self.__queue.empty(): diff --git a/kvmd/apps/cleanup/__init__.py b/kvmd/apps/cleanup/__init__.py index 795841c5..ec6a43c6 100644 --- a/kvmd/apps/cleanup/__init__.py +++ b/kvmd/apps/cleanup/__init__.py @@ -33,30 +33,10 @@ from ...logging import get_logger from ...yamlconf import Section -from ... import gpio - from .. import init # ===== -def _clear_gpio(config: Section) -> None: - logger = get_logger(0) - - with gpio.bcm(): - for (name, pin) in [ - *([ - ("atx_gpio/power_switch", config.atx.power_switch_pin), - ("atx_gpio/reset_switch", config.atx.reset_switch_pin), - ] if config.atx.type == "gpio" else []), - ]: - if pin >= 0: - logger.info("Writing 0 to GPIO pin=%d (%s)", pin, name) - try: - gpio.set_output(pin, False) - except Exception: - logger.exception("Can't clear GPIO pin=%d (%s)", pin, name) - - def _kill_streamer(config: Section) -> None: logger = get_logger(0) @@ -99,17 +79,12 @@ def main(argv: Optional[List[str]]=None) -> None: prog="kvmd-cleanup", description="Kill KVMD and clear resources", argv=argv, - load_hid=True, - load_atx=True, - load_msd=True, - load_gpio=True, )[2].kvmd logger = get_logger(0) logger.info("Cleaning up ...") for method in [ - _clear_gpio, _kill_streamer, _remove_sockets, ]: diff --git a/kvmd/plugins/atx/gpio.py b/kvmd/plugins/atx/gpio.py index e3225cf0..bd49513c 100644 --- a/kvmd/plugins/atx/gpio.py +++ b/kvmd/plugins/atx/gpio.py @@ -24,11 +24,14 @@ import asyncio from typing import Dict from typing import AsyncGenerator +from typing import Optional + +import gpiod from ...logging import get_logger from ... import aiotools -from ... import gpio +from ... import aiogp from ...yamlconf import Option @@ -37,7 +40,6 @@ from ...validators.basic import valid_float_f01 from ...validators.hw import valid_gpio_pin - from . import AtxIsBusyError from . import BaseAtx @@ -46,7 +48,6 @@ from . import BaseAtx class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes def __init__( # pylint: disable=too-many-arguments,super-init-not-called self, - power_led_pin: int, hdd_led_pin: int, power_led_inverted: bool, @@ -56,17 +57,12 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes reset_switch_pin: int, click_delay: float, long_click_delay: float, - - state_poll: float, ) -> None: - self.__power_led_pin = gpio.set_input(power_led_pin) - self.__hdd_led_pin = gpio.set_input(hdd_led_pin) - self.__power_switch_pin = gpio.set_output(power_switch_pin, False) - self.__reset_switch_pin = gpio.set_output(reset_switch_pin, False) - - self.__power_led_inverted = power_led_inverted - self.__hdd_led_inverted = hdd_led_inverted + self.__power_led_pin = power_led_pin + self.__hdd_led_pin = hdd_led_pin + self.__power_switch_pin = power_switch_pin + self.__reset_switch_pin = reset_switch_pin self.__click_delay = click_delay self.__long_click_delay = long_click_delay @@ -74,9 +70,15 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes self.__notifier = aiotools.AioNotifier() self.__region = aiotools.AioExclusiveRegion(AtxIsBusyError, self.__notifier) - self.__reader = gpio.BatchReader( - pins=set([self.__power_led_pin, self.__hdd_led_pin]), - interval=state_poll, + self.__chip: Optional[gpiod.Chip] = None + self.__power_switch_line: Optional[gpiod.Line] = None + self.__reset_switch_line: Optional[gpiod.Line] = None + + self.__reader = aiogp.AioPinsReader( + path="/dev/gpiochip0", + consumer="kvmd/atx-gpio/leds", + pins=[power_led_pin, hdd_led_pin], + inverted=[power_led_inverted, hdd_led_inverted], notifier=self.__notifier, ) @@ -92,17 +94,28 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes "reset_switch_pin": Option(-1, type=valid_gpio_pin), "click_delay": Option(0.1, type=valid_float_f01), "long_click_delay": Option(5.5, type=valid_float_f01), - - "state_poll": Option(0.1, type=valid_float_f01), } + def sysprep(self) -> None: + assert self.__chip is None + assert self.__power_switch_line is None + assert self.__reset_switch_line is None + + self.__chip = gpiod.Chip("/dev/gpiochip0") + + self.__power_switch_line = self.__chip.get_line(self.__power_switch_pin) + self.__power_switch_line.request("kvmd/atx-gpio/power_switch", gpiod.LINE_REQ_DIR_OUT, default_val=0) + + self.__reset_switch_line = self.__chip.get_line(self.__reset_switch_pin) + self.__reset_switch_line.request("kvmd/atx-gpio/reset_switch", gpiod.LINE_REQ_DIR_OUT, default_val=0) + async def get_state(self) -> Dict: return { "enabled": True, "busy": self.__region.is_busy(), "leds": { - "power": (self.__reader.get(self.__power_led_pin) ^ self.__power_led_inverted), - "hdd": (self.__reader.get(self.__hdd_led_pin) ^ self.__hdd_led_inverted), + "power": self.__reader.get(self.__power_led_pin), + "hdd": self.__reader.get(self.__hdd_led_pin), }, } @@ -119,14 +132,8 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes await self.__reader.poll() async def cleanup(self) -> None: - for (name, pin) in [ - ("power", self.__power_switch_pin), - ("reset", self.__reset_switch_pin), - ]: - try: - gpio.write(pin, False) - except Exception: - get_logger(0).exception("Can't cleanup %s pin %d", name, pin) + if self.__chip: + self.__chip.close() # ===== @@ -149,13 +156,13 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes # ===== async def click_power(self, wait: bool) -> None: - await self.__click("power", self.__power_switch_pin, self.__click_delay, wait) + await self.__click("power", self.__power_switch_line, self.__click_delay, wait) async def click_power_long(self, wait: bool) -> None: - await self.__click("power_long", self.__power_switch_pin, self.__long_click_delay, wait) + await self.__click("power_long", self.__power_switch_line, self.__long_click_delay, wait) async def click_reset(self, wait: bool) -> None: - await self.__click("reset", self.__reset_switch_pin, self.__click_delay, wait) + await self.__click("reset", self.__reset_switch_line, self.__click_delay, wait) # ===== @@ -163,22 +170,22 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes return (await self.get_state())["leds"]["power"] @aiotools.atomic - async def __click(self, name: str, pin: int, delay: float, wait: bool) -> None: + async def __click(self, name: str, line: gpiod.Line, delay: float, wait: bool) -> None: if wait: async with self.__region: - await self.__inner_click(name, pin, delay) + await self.__inner_click(name, line, delay) else: await aiotools.run_region_task( - "Can't perform ATX click or operation was not completed", - self.__region, self.__inner_click, name, pin, delay, + f"Can't perform ATX {name} click or operation was not completed", + self.__region, self.__inner_click, name, line, delay, ) @aiotools.atomic - async def __inner_click(self, name: str, pin: int, delay: float) -> None: + async def __inner_click(self, name: str, line: gpiod.Line, delay: float) -> None: try: - gpio.write(pin, True) + line.set_value(1) await asyncio.sleep(delay) finally: - gpio.write(pin, False) + line.set_value(0) await asyncio.sleep(1) get_logger(0).info("Clicked ATX button %r", name) From 41223fa8b24be7978f320781c4b0e3d7b2347c75 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 17:19:57 +0300 Subject: [PATCH 05/19] pass close() --- kvmd/plugins/atx/gpio.py | 5 ++++- kvmd/plugins/hid/serial.py | 5 ++++- kvmd/plugins/msd/relay.py | 5 ++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/kvmd/plugins/atx/gpio.py b/kvmd/plugins/atx/gpio.py index bd49513c..70354da4 100644 --- a/kvmd/plugins/atx/gpio.py +++ b/kvmd/plugins/atx/gpio.py @@ -133,7 +133,10 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes async def cleanup(self) -> None: if self.__chip: - self.__chip.close() + try: + self.__chip.close() + except Exception: + pass # ===== diff --git a/kvmd/plugins/hid/serial.py b/kvmd/plugins/hid/serial.py index 23f6c136..ff018826 100644 --- a/kvmd/plugins/hid/serial.py +++ b/kvmd/plugins/hid/serial.py @@ -176,7 +176,10 @@ class _Gpio: def close(self) -> None: if self.__chip: - self.__chip.close() + try: + self.__chip.close() + except Exception: + pass @aiotools.atomic async def reset(self) -> None: diff --git a/kvmd/plugins/msd/relay.py b/kvmd/plugins/msd/relay.py index 07e9f85e..64eab56e 100644 --- a/kvmd/plugins/msd/relay.py +++ b/kvmd/plugins/msd/relay.py @@ -183,7 +183,10 @@ class _Gpio: def close(self) -> None: if self.__chip: - self.__chip.close() + try: + self.__chip.close() + except Exception: + pass def switch_to_local(self) -> None: assert self.__target_line From 1e6ab4672f0980f073ab7e1c6f48fb9bf43b0856 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 18:23:28 +0300 Subject: [PATCH 06/19] refactoring and reuse gpio pulse code --- kvmd/aiogp.py | 23 +++++++++++++++-------- kvmd/plugins/atx/gpio.py | 15 +++++---------- kvmd/plugins/hid/serial.py | 13 ++++--------- kvmd/plugins/msd/relay.py | 22 ++++++++-------------- 4 files changed, 32 insertions(+), 41 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index dbc39e69..9b515d9a 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -23,7 +23,7 @@ import asyncio import threading -from typing import List +from typing import Dict from typing import Optional import gpiod @@ -32,23 +32,29 @@ from . import aiotools # ===== +async def pulse(line: gpiod.Line, delay: float, final: float) -> None: + try: + line.set_value(1) + await asyncio.sleep(delay) + finally: + line.set_value(0) + await asyncio.sleep(final) + + class AioPinsReader(threading.Thread): def __init__( self, path: str, consumer: str, - pins: List[int], - inverted: List[bool], + pins: Dict[int, bool], notifier: aiotools.AioNotifier, ) -> None: - assert len(pins) == len(inverted) super().__init__(daemon=True) self.__path = path self.__consumer = consumer self.__pins = pins - self.__inverted = dict(zip(pins, inverted)) self.__notifier = notifier self.__state = dict.fromkeys(pins, False) @@ -57,7 +63,7 @@ class AioPinsReader(threading.Thread): self.__loop: Optional[asyncio.AbstractEventLoop] = None def get(self, pin: int) -> bool: - return (self.__state[pin] ^ self.__inverted[pin]) + return (self.__state[pin] ^ self.__pins[pin]) async def poll(self) -> None: if not self.__pins: @@ -75,13 +81,14 @@ class AioPinsReader(threading.Thread): def run(self) -> None: assert self.__loop with gpiod.Chip(self.__path) as chip: - lines = chip.get_lines(self.__pins) + pins = sorted(self.__pins) + lines = chip.get_lines(pins) lines.request(self.__consumer, gpiod.LINE_REQ_EV_BOTH_EDGES) lines.event_wait(nsec=1) self.__state = { pin: bool(value) - for (pin, value) in zip(self.__pins, lines.get_values()) + for (pin, value) in zip(pins, lines.get_values()) } self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) diff --git a/kvmd/plugins/atx/gpio.py b/kvmd/plugins/atx/gpio.py index 70354da4..5ca611ef 100644 --- a/kvmd/plugins/atx/gpio.py +++ b/kvmd/plugins/atx/gpio.py @@ -20,8 +20,6 @@ # ========================================================================== # -import asyncio - from typing import Dict from typing import AsyncGenerator from typing import Optional @@ -77,8 +75,10 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes self.__reader = aiogp.AioPinsReader( path="/dev/gpiochip0", consumer="kvmd/atx-gpio/leds", - pins=[power_led_pin, hdd_led_pin], - inverted=[power_led_inverted, hdd_led_inverted], + pins={ + power_led_pin: power_led_inverted, + hdd_led_pin: hdd_led_inverted, + }, notifier=self.__notifier, ) @@ -185,10 +185,5 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes @aiotools.atomic async def __inner_click(self, name: str, line: gpiod.Line, delay: float) -> None: - try: - line.set_value(1) - await asyncio.sleep(delay) - finally: - line.set_value(0) - await asyncio.sleep(1) + await aiogp.pulse(line, delay, 1) get_logger(0).info("Clicked ATX button %r", name) diff --git a/kvmd/plugins/hid/serial.py b/kvmd/plugins/hid/serial.py index ff018826..27218323 100644 --- a/kvmd/plugins/hid/serial.py +++ b/kvmd/plugins/hid/serial.py @@ -21,7 +21,6 @@ import os -import asyncio import multiprocessing import multiprocessing.queues import dataclasses @@ -47,6 +46,7 @@ from ...keyboard.mappings import KEYMAP from ... import aiotools from ... import aiomulti from ... import aioproc +from ... import aiogp from ...yamlconf import Option @@ -186,16 +186,11 @@ class _Gpio: if self.__reset_pin >= 0: assert self.__reset_line if not self.__reset_wip: + self.__reset_wip = True try: - self.__reset_wip = True - self.__reset_line.set_value(1) - await asyncio.sleep(self.__reset_delay) + await aiogp.pulse(self.__reset_line, self.__reset_delay, 1) finally: - try: - self.__reset_line.set_value(0) - await asyncio.sleep(1) - finally: - self.__reset_wip = False + self.__reset_wip = False get_logger(0).info("Reset HID performed") else: get_logger(0).info("Another reset HID in progress") diff --git a/kvmd/plugins/msd/relay.py b/kvmd/plugins/msd/relay.py index 64eab56e..227dff46 100644 --- a/kvmd/plugins/msd/relay.py +++ b/kvmd/plugins/msd/relay.py @@ -41,6 +41,7 @@ from ...logging import get_logger from ... import aiotools from ... import aiofs +from ... import aiogp from ...yamlconf import Option @@ -196,16 +197,9 @@ class _Gpio: assert self.__target_line self.__target_line.set_value(1) - @contextlib.asynccontextmanager - async def reset(self) -> AsyncGenerator[None, None]: + async def reset(self) -> None: assert self.__reset_line - try: - self.__reset_line.set_value(1) - await asyncio.sleep(self.__reset_delay) - self.__reset_line.set_value(0) - yield - finally: - self.__reset_line.set_value(0) + await aiogp.pulse(self.__reset_line, self.__reset_delay, 0) # ===== @@ -302,11 +296,11 @@ class Plugin(BaseMsd): # pylint: disable=too-many-instance-attributes @aiotools.atomic async def __inner_reset(self) -> None: - async with self.__gpio.reset(): - self.__gpio.switch_to_local() - self.__connected = False - await self.__load_device_info() - get_logger(0).info("MSD reset has been successful") + await self.__gpio.reset() + self.__gpio.switch_to_local() + self.__connected = False + await self.__load_device_info() + get_logger(0).info("MSD reset has been successful") @aiotools.atomic async def cleanup(self) -> None: From 5464bc2297e69b493b37c6dffd7fec66d55d6ad9 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 19:18:12 +0300 Subject: [PATCH 07/19] fixed AioPinsReader's main loop --- kvmd/aiogp.py | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 9b515d9a..100bcd4c 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -93,16 +93,15 @@ class AioPinsReader(threading.Thread): self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) while not self.__stop_event.is_set(): - ev_lines = lines.event_wait(10) + ev_lines = lines.event_wait(1) if ev_lines: - for ev_lines in lines.event_wait(1): - for ev_line in ev_lines: - event = ev_line.event_read() - if event.type == gpiod.LineEvent.RISING_EDGE: - value = True - elif event.type == gpiod.LineEvent.FALLING_EDGE: - value = False - else: - raise RuntimeError(f"Invalid event {event} type: {event.type}") - self.__state[event.source.offset()] = value - self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) + for ev_line in ev_lines: + event = ev_line.event_read() + if event.type == gpiod.LineEvent.RISING_EDGE: + value = True + elif event.type == gpiod.LineEvent.FALLING_EDGE: + value = False + else: + raise RuntimeError(f"Invalid event {event} type: {event.type}") + self.__state[event.source.offset()] = value + self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) From 0ad0d17528eeb52ba0dee78d5be440f092fed7d7 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 20:04:17 +0300 Subject: [PATCH 08/19] using libgpiod for the ugpio driver --- kvmd/plugins/ugpio/gpio.py | 55 ++++++++++++++++++-------------------- 1 file changed, 26 insertions(+), 29 deletions(-) diff --git a/kvmd/plugins/ugpio/gpio.py b/kvmd/plugins/ugpio/gpio.py index 90426e13..aa43caf1 100644 --- a/kvmd/plugins/ugpio/gpio.py +++ b/kvmd/plugins/ugpio/gpio.py @@ -24,12 +24,10 @@ from typing import Dict from typing import Set from typing import Optional +import gpiod + from ... import aiotools -from ... import gpio - -from ...yamlconf import Option - -from ...validators.basic import valid_float_f01 +from ... import aiogp from . import BaseUserGpioDriver @@ -40,24 +38,17 @@ class Plugin(BaseUserGpioDriver): self, instance_name: str, notifier: aiotools.AioNotifier, - - state_poll: float, ) -> None: super().__init__(instance_name, notifier) - self.__state_poll = state_poll - self.__input_pins: Set[int] = set() self.__output_pins: Dict[int, Optional[bool]] = {} - self.__reader: Optional[gpio.BatchReader] = None + self.__reader: Optional[aiogp.AioPinsReader] = None - @classmethod - def get_plugin_options(cls) -> Dict: - return { - "state_poll": Option(0.1, type=valid_float_f01), - } + self.__chip: Optional[gpiod.Chip] = None + self.__output_lines: Dict[int, gpiod.Line] = {} def register_input(self, pin: int) -> None: self.__input_pins.add(pin) @@ -67,32 +58,38 @@ class Plugin(BaseUserGpioDriver): def prepare(self) -> None: assert self.__reader is None - self.__reader = gpio.BatchReader( - pins=set([ - *map(gpio.set_input, self.__input_pins), - *[ - gpio.set_output(pin, initial) - for (pin, initial) in self.__output_pins.items() - ], - ]), - interval=self.__state_poll, + self.__reader = aiogp.AioPinsReader( + path="/dev/gpiochip0", + consumer="kvmd/ugpio-gpio/inputs", + pins=dict.fromkeys(self.__input_pins, False), notifier=self._notifier, ) + self.__chip = gpiod.Chip("/dev/gpiochip0") + for (pin, initial) in self.__output_pins.items(): + line = self.__chip.get_line(pin) + line.request("kvmd/ugpio-gpio/outputs", gpiod.LINE_REQ_DIR_OUT, default_val=int(initial or False)) + self.__output_lines[pin] = line + async def run(self) -> None: assert self.__reader await self.__reader.poll() def cleanup(self) -> None: - for (pin, initial) in self.__output_pins.items(): - if initial is not None: - gpio.write(pin, initial) + if self.__chip: + try: + self.__chip.close() + except Exception: + pass def read(self, pin: int) -> bool: - return gpio.read(pin) + assert self.__reader + if pin in self.__input_pins: + return self.__reader.get(pin) + return bool(self.__output_lines[pin].get_value()) def write(self, pin: int, state: bool) -> None: - gpio.write(pin, state) + self.__output_lines[pin].set_value(int(state)) def __str__(self) -> str: return f"GPIO({self._instance_name})" From 5ed0c27f1f7201783d60e035ba26f35f62539a08 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 21:43:52 +0300 Subject: [PATCH 09/19] removed rpi.gpio --- PKGBUILD | 1 - kvmd/apps/kvmd/__init__.py | 69 +++++++++++------------ kvmd/gpio.py | 101 ---------------------------------- testenv/linters/vulture-wl.py | 2 - testenv/requirements.txt | 2 - testenv/tests/__init__.py | 39 ------------- testenv/tests/test_gpio.py | 58 ------------------- 7 files changed, 33 insertions(+), 239 deletions(-) delete mode 100644 kvmd/gpio.py delete mode 100644 testenv/tests/test_gpio.py diff --git a/PKGBUILD b/PKGBUILD index 062e16b1..c4de0621 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -39,7 +39,6 @@ depends=( python-aiohttp python-aiofiles python-passlib - python-raspberry-gpio python-pyserial python-setproctitle python-psutil diff --git a/kvmd/apps/kvmd/__init__.py b/kvmd/apps/kvmd/__init__.py index e257145d..bd08e157 100644 --- a/kvmd/apps/kvmd/__init__.py +++ b/kvmd/apps/kvmd/__init__.py @@ -25,8 +25,6 @@ from typing import Optional from ...logging import get_logger -from ... import gpio - from ...plugins.hid import get_hid_class from ...plugins.atx import get_atx_class from ...plugins.msd import get_msd_class @@ -45,6 +43,8 @@ from .server import KvmdServer # ===== def main(argv: Optional[List[str]]=None) -> None: + # pylint: disable=protected-access + config = init( prog="kvmd", description="The main Pi-KVM daemon", @@ -56,48 +56,45 @@ def main(argv: Optional[List[str]]=None) -> None: load_gpio=True, )[2] - with gpio.bcm(): - # pylint: disable=protected-access + msd_kwargs = config.kvmd.msd._unpack(ignore=["type"]) + if config.kvmd.msd.type == "otg": + msd_kwargs["gadget"] = config.otg.gadget # XXX: Small crutch to pass gadget name to plugin - msd_kwargs = config.kvmd.msd._unpack(ignore=["type"]) - if config.kvmd.msd.type == "otg": - msd_kwargs["gadget"] = config.otg.gadget # XXX: Small crutch to pass gadget name to plugin + global_config = config + config = config.kvmd - global_config = config - config = config.kvmd + hid = get_hid_class(config.hid.type)(**config.hid._unpack(ignore=["type", "keymap"])) + streamer = Streamer(**config.streamer._unpack()) - hid = get_hid_class(config.hid.type)(**config.hid._unpack(ignore=["type", "keymap"])) - streamer = Streamer(**config.streamer._unpack()) + KvmdServer( + auth_manager=AuthManager( + internal_type=config.auth.internal.type, + internal_kwargs=config.auth.internal._unpack(ignore=["type", "force_users"]), + external_type=config.auth.external.type, + external_kwargs=(config.auth.external._unpack(ignore=["type"]) if config.auth.external.type else {}), + force_internal_users=config.auth.internal.force_users, + enabled=config.auth.enabled, + ), + info_manager=InfoManager(global_config), + log_reader=LogReader(), + wol=WakeOnLan(**config.wol._unpack()), + user_gpio=UserGpio(config.gpio), - KvmdServer( - auth_manager=AuthManager( - internal_type=config.auth.internal.type, - internal_kwargs=config.auth.internal._unpack(ignore=["type", "force_users"]), - external_type=config.auth.external.type, - external_kwargs=(config.auth.external._unpack(ignore=["type"]) if config.auth.external.type else {}), - force_internal_users=config.auth.internal.force_users, - enabled=config.auth.enabled, - ), - info_manager=InfoManager(global_config), - log_reader=LogReader(), - wol=WakeOnLan(**config.wol._unpack()), - user_gpio=UserGpio(config.gpio), + hid=hid, + atx=get_atx_class(config.atx.type)(**config.atx._unpack(ignore=["type"])), + msd=get_msd_class(config.msd.type)(**msd_kwargs), + streamer=streamer, + snapshoter=Snapshoter( hid=hid, - atx=get_atx_class(config.atx.type)(**config.atx._unpack(ignore=["type"])), - msd=get_msd_class(config.msd.type)(**msd_kwargs), streamer=streamer, + **config.snapshot._unpack(), + ), - snapshoter=Snapshoter( - hid=hid, - streamer=streamer, - **config.snapshot._unpack(), - ), + heartbeat=config.server.heartbeat, + sync_chunk_size=config.server.sync_chunk_size, - heartbeat=config.server.heartbeat, - sync_chunk_size=config.server.sync_chunk_size, - - keymap_path=config.hid.keymap, - ).run(**config.server._unpack(ignore=["heartbeat", "sync_chunk_size"])) + keymap_path=config.hid.keymap, + ).run(**config.server._unpack(ignore=["heartbeat", "sync_chunk_size"])) get_logger(0).info("Bye-bye") diff --git a/kvmd/gpio.py b/kvmd/gpio.py deleted file mode 100644 index 8dce12f6..00000000 --- a/kvmd/gpio.py +++ /dev/null @@ -1,101 +0,0 @@ -# ========================================================================== # -# # -# KVMD - The main Pi-KVM daemon. # -# # -# Copyright (C) 2018 Maxim Devaev # -# # -# This program is free software: you can redistribute it and/or modify # -# it under the terms of the GNU General Public License as published by # -# the Free Software Foundation, either version 3 of the License, or # -# (at your option) any later version. # -# # -# This program is distributed in the hope that it will be useful, # -# but WITHOUT ANY WARRANTY; without even the implied warranty of # -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # -# GNU General Public License for more details. # -# # -# You should have received a copy of the GNU General Public License # -# along with this program. If not, see . # -# # -# ========================================================================== # - - -import asyncio -import contextlib - -from typing import Tuple -from typing import Set -from typing import Generator -from typing import Optional - -from RPi import GPIO - -from .logging import get_logger - -from . import aiotools - - -# ===== -@contextlib.contextmanager -def bcm() -> Generator[None, None, None]: - logger = get_logger(2) - GPIO.setmode(GPIO.BCM) - logger.info("Configured GPIO mode as BCM") - try: - yield - finally: - GPIO.cleanup() - logger.info("GPIO cleaned") - - -def set_output(pin: int, initial: Optional[bool]) -> int: - assert pin >= 0, pin - GPIO.setup(pin, GPIO.OUT, initial=initial) - return pin - - -def set_input(pin: int) -> int: - assert pin >= 0, pin - GPIO.setup(pin, GPIO.IN) - return pin - - -def read(pin: int) -> bool: - assert pin >= 0, pin - return bool(GPIO.input(pin)) - - -def write(pin: int, state: bool) -> None: - assert pin >= 0, pin - GPIO.output(pin, state) - - -class BatchReader: - def __init__( - self, - pins: Set[int], - interval: float, - notifier: aiotools.AioNotifier, - ) -> None: - - self.__pins = sorted(pins) - self.__interval = interval - self.__notifier = notifier - - self.__state = {pin: read(pin) for pin in self.__pins} - self.__flags: Tuple[Optional[bool], ...] = (None,) * len(self.__pins) - - def get(self, pin: int) -> bool: - return self.__state[pin] - - async def poll(self) -> None: - if not self.__pins: - await aiotools.wait_infinite() - else: - while True: - flags = tuple(map(read, self.__pins)) - if flags != self.__flags: - self.__flags = flags - self.__state = dict(zip(self.__pins, flags)) - await self.__notifier.notify() - await asyncio.sleep(self.__interval) diff --git a/testenv/linters/vulture-wl.py b/testenv/linters/vulture-wl.py index afb95bc2..62338131 100644 --- a/testenv/linters/vulture-wl.py +++ b/testenv/linters/vulture-wl.py @@ -20,8 +20,6 @@ IpmiServer.handle_raw_request _AtxApiPart.switch_power -fake_rpi.RPi.GPIO - _KeyMapping.web_name _KeyMapping.serial_code _KeyMapping.arduino_name diff --git a/testenv/requirements.txt b/testenv/requirements.txt index a88dd993..74cfcdb5 100644 --- a/testenv/requirements.txt +++ b/testenv/requirements.txt @@ -1,5 +1,3 @@ -git+git://github.com/willbuckner/rpi-gpio-development-mock@master#egg=rpi -fake_rpi aiohttp aiofiles passlib diff --git a/testenv/tests/__init__.py b/testenv/tests/__init__.py index d1faace6..1e91f7fa 100644 --- a/testenv/tests/__init__.py +++ b/testenv/tests/__init__.py @@ -18,42 +18,3 @@ # along with this program. If not, see . # # # # ========================================================================== # - - -import sys - -from typing import Dict -from typing import Optional - -import fake_rpi.RPi - - -# ===== -class _GPIO(fake_rpi.RPi._GPIO): # pylint: disable=protected-access - def __init__(self) -> None: - super().__init__() - self.__states: Dict[int, int] = {} - - @fake_rpi.RPi.printf - def setup(self, channel: int, state: int, initial: int=0, pull_up_down: Optional[int]=None) -> None: - _ = state # Makes linter happy - _ = pull_up_down # Makes linter happy - self.__states[int(channel)] = int(initial) - - @fake_rpi.RPi.printf - def output(self, channel: int, state: int) -> None: - self.__states[int(channel)] = int(state) - - @fake_rpi.RPi.printf - def input(self, channel: int) -> int: # pylint: disable=arguments-differ - return self.__states[int(channel)] - - @fake_rpi.RPi.printf - def cleanup(self, channel: Optional[int]=None) -> None: # pylint: disable=arguments-differ - _ = channel # Makes linter happy - self.__states = {} - - -# ===== -fake_rpi.RPi.GPIO = _GPIO() -sys.modules["RPi"] = fake_rpi.RPi diff --git a/testenv/tests/test_gpio.py b/testenv/tests/test_gpio.py deleted file mode 100644 index 3db61609..00000000 --- a/testenv/tests/test_gpio.py +++ /dev/null @@ -1,58 +0,0 @@ -# ========================================================================== # -# # -# KVMD - The main Pi-KVM daemon. # -# # -# Copyright (C) 2018 Maxim Devaev # -# # -# This program is free software: you can redistribute it and/or modify # -# it under the terms of the GNU General Public License as published by # -# the Free Software Foundation, either version 3 of the License, or # -# (at your option) any later version. # -# # -# This program is distributed in the hope that it will be useful, # -# but WITHOUT ANY WARRANTY; without even the implied warranty of # -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # -# GNU General Public License for more details. # -# # -# You should have received a copy of the GNU General Public License # -# along with this program. If not, see . # -# # -# ========================================================================== # - - -import pytest - -from kvmd import gpio - - -# ===== -@pytest.mark.parametrize("pin", [0, 1, 13]) -def test_ok__loopback_initial_false(pin: int) -> None: - with gpio.bcm(): - assert gpio.set_output(pin, False) == pin - assert gpio.read(pin) is False - gpio.write(pin, True) - assert gpio.read(pin) is True - - -@pytest.mark.parametrize("pin", [0, 1, 13]) -def test_ok__loopback_initial_true(pin: int) -> None: - with gpio.bcm(): - assert gpio.set_output(pin, True) == pin - assert gpio.read(pin) is True - gpio.write(pin, False) - assert gpio.read(pin) is False - - -@pytest.mark.parametrize("pin", [0, 1, 13]) -def test_ok__input(pin: int) -> None: - with gpio.bcm(): - assert gpio.set_input(pin) == pin - assert gpio.read(pin) is False - - -def test_fail__invalid_pin() -> None: - with pytest.raises(AssertionError): - gpio.set_output(-1, False) - with pytest.raises(AssertionError): - gpio.set_input(-1) From 91eb257f3df32487d00ca457f9d78eabd354ce54 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Sun, 13 Sep 2020 21:59:09 +0300 Subject: [PATCH 10/19] non-cas operation --- kvmd/apps/kvmd/ugpio.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/kvmd/apps/kvmd/ugpio.py b/kvmd/apps/kvmd/ugpio.py index f2ff2b1b..66fa5c70 100644 --- a/kvmd/apps/kvmd/ugpio.py +++ b/kvmd/apps/kvmd/ugpio.py @@ -201,10 +201,9 @@ class _GpioOutput: # pylint: disable=too-many-instance-attributes @aiotools.atomic async def __inner_switch(self, state: bool) -> None: - if state != self.__read(): - self.__write(state) - get_logger(0).info("Switched %s to state=%d", self, state) - await asyncio.sleep(self.__busy_delay) + self.__write(state) + get_logger(0).info("Ensured switch %s to state=%d", self, state) + await asyncio.sleep(self.__busy_delay) @aiotools.atomic async def __inner_pulse(self, delay: float) -> None: From ee10435b818e0bf8ebf749a209969166502d78d4 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 01:34:15 +0300 Subject: [PATCH 11/19] common gpio path variable --- Makefile | 1 + kvmd/aiogp.py | 7 +++++++ kvmd/plugins/atx/gpio.py | 4 ++-- kvmd/plugins/hid/serial.py | 2 +- kvmd/plugins/msd/relay.py | 2 +- kvmd/plugins/ugpio/gpio.py | 4 ++-- 6 files changed, 14 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index a134acac..e8467361 100644 --- a/Makefile +++ b/Makefile @@ -89,6 +89,7 @@ run: testenv $(TESTENV_GPIO) --volume `pwd`/contrib/keymaps:/usr/share/kvmd/keymaps:ro \ --device $(TESTENV_VIDEO):$(TESTENV_VIDEO) \ --device $(TESTENV_GPIO):$(TESTENV_GPIO) \ + --env KVMD_GPIO_DEVICE_PATH=$(TESTENV_GPIO) \ $(if $(TESTENV_RELAY),--device $(TESTENV_RELAY):$(TESTENV_RELAY),) \ --publish 8080:80/tcp \ -it $(TESTENV_IMAGE) /bin/bash -c " \ diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 100bcd4c..2f988e67 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -20,6 +20,7 @@ # ========================================================================== # +import os import asyncio import threading @@ -31,6 +32,12 @@ import gpiod from . import aiotools +# ===== +# XXX: Do not use this variable for any purpose other than testing. +# It can be removed at any time. +DEVICE_PATH = os.getenv("KVMD_GPIO_DEVICE_PATH", "/dev/gpiochip0") + + # ===== async def pulse(line: gpiod.Line, delay: float, final: float) -> None: try: diff --git a/kvmd/plugins/atx/gpio.py b/kvmd/plugins/atx/gpio.py index 5ca611ef..851e4ab4 100644 --- a/kvmd/plugins/atx/gpio.py +++ b/kvmd/plugins/atx/gpio.py @@ -73,7 +73,7 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes self.__reset_switch_line: Optional[gpiod.Line] = None self.__reader = aiogp.AioPinsReader( - path="/dev/gpiochip0", + path=aiogp.DEVICE_PATH, consumer="kvmd/atx-gpio/leds", pins={ power_led_pin: power_led_inverted, @@ -101,7 +101,7 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes assert self.__power_switch_line is None assert self.__reset_switch_line is None - self.__chip = gpiod.Chip("/dev/gpiochip0") + self.__chip = gpiod.Chip(aiogp.DEVICE_PATH) self.__power_switch_line = self.__chip.get_line(self.__power_switch_pin) self.__power_switch_line.request("kvmd/atx-gpio/power_switch", gpiod.LINE_REQ_DIR_OUT, default_val=0) diff --git a/kvmd/plugins/hid/serial.py b/kvmd/plugins/hid/serial.py index 27218323..c07ea45c 100644 --- a/kvmd/plugins/hid/serial.py +++ b/kvmd/plugins/hid/serial.py @@ -170,7 +170,7 @@ class _Gpio: if self.__reset_pin >= 0: assert self.__chip is None assert self.__reset_line is None - self.__chip = gpiod.Chip("/dev/gpiochip0") + self.__chip = gpiod.Chip(aiogp.DEVICE_PATH) self.__reset_line = self.__chip.get_line(self.__reset_pin) self.__reset_line.request("kvmd/hid-serial/reset", gpiod.LINE_REQ_DIR_OUT, default_val=0) diff --git a/kvmd/plugins/msd/relay.py b/kvmd/plugins/msd/relay.py index 227dff46..cec03377 100644 --- a/kvmd/plugins/msd/relay.py +++ b/kvmd/plugins/msd/relay.py @@ -174,7 +174,7 @@ class _Gpio: assert self.__target_line is None assert self.__reset_line is None - self.__chip = gpiod.Chip("/dev/gpiochip0") + self.__chip = gpiod.Chip(aiogp.DEVICE_PATH) self.__target_line = self.__chip.get_line(self.__target_pin) self.__target_line.request("kvmd/msd-relay/target", gpiod.LINE_REQ_DIR_OUT, default_val=0) diff --git a/kvmd/plugins/ugpio/gpio.py b/kvmd/plugins/ugpio/gpio.py index aa43caf1..16e0b516 100644 --- a/kvmd/plugins/ugpio/gpio.py +++ b/kvmd/plugins/ugpio/gpio.py @@ -59,13 +59,13 @@ class Plugin(BaseUserGpioDriver): def prepare(self) -> None: assert self.__reader is None self.__reader = aiogp.AioPinsReader( - path="/dev/gpiochip0", + path=aiogp.DEVICE_PATH, consumer="kvmd/ugpio-gpio/inputs", pins=dict.fromkeys(self.__input_pins, False), notifier=self._notifier, ) - self.__chip = gpiod.Chip("/dev/gpiochip0") + self.__chip = gpiod.Chip(aiogp.DEVICE_PATH) for (pin, initial) in self.__output_pins.items(): line = self.__chip.get_line(pin) line.request("kvmd/ugpio-gpio/outputs", gpiod.LINE_REQ_DIR_OUT, default_val=int(initial or False)) From 51ca4bc936e7005e466de7b12f9167287ae5cf88 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 01:40:39 +0300 Subject: [PATCH 12/19] raspberrypi-io-access >= 0.5 --- PKGBUILD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PKGBUILD b/PKGBUILD index c4de0621..c2ed6861 100644 --- a/PKGBUILD +++ b/PKGBUILD @@ -59,7 +59,7 @@ depends=( make patch sudo - raspberrypi-io-access + "raspberrypi-io-access>=0.5" "ustreamer>=1.19" ) makedepends=(python-setuptools) From ddb60e5a73c0860bf4187571e0e2458a6e9a6d77 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 14:23:14 +0300 Subject: [PATCH 13/19] read multiply events --- kvmd/aiogp.py | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 2f988e67..f23fc36b 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -103,12 +103,14 @@ class AioPinsReader(threading.Thread): ev_lines = lines.event_wait(1) if ev_lines: for ev_line in ev_lines: - event = ev_line.event_read() - if event.type == gpiod.LineEvent.RISING_EDGE: - value = True - elif event.type == gpiod.LineEvent.FALLING_EDGE: - value = False - else: - raise RuntimeError(f"Invalid event {event} type: {event.type}") - self.__state[event.source.offset()] = value + events = ev_line.event_read_multiply() + if events: + event = events[-1] + if event.type == gpiod.LineEvent.RISING_EDGE: + value = True + elif event.type == gpiod.LineEvent.FALLING_EDGE: + value = False + else: + raise RuntimeError(f"Invalid event {event} type: {event.type}") + self.__state[event.source.offset()] = value self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) From 50d0612f82ad03222518dd08cd2f1a11565de443 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 21:16:02 +0300 Subject: [PATCH 14/19] refactoring --- kvmd/aiogp.py | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index f23fc36b..7b0a2e74 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -24,6 +24,7 @@ import os import asyncio import threading +from typing import Tuple from typing import Dict from typing import Optional @@ -48,7 +49,7 @@ async def pulse(line: gpiod.Line, delay: float, final: float) -> None: await asyncio.sleep(final) -class AioPinsReader(threading.Thread): +class AioPinsReader: # pylint: disable=too-many-instance-attributes def __init__( self, path: str, @@ -57,8 +58,6 @@ class AioPinsReader(threading.Thread): notifier: aiotools.AioNotifier, ) -> None: - super().__init__(daemon=True) - self.__path = path self.__consumer = consumer self.__pins = pins @@ -69,6 +68,8 @@ class AioPinsReader(threading.Thread): self.__stop_event = threading.Event() self.__loop: Optional[asyncio.AbstractEventLoop] = None + self.__thread = threading.Thread(target=self.__run, daemon=True) + def get(self, pin: int) -> bool: return (self.__state[pin] ^ self.__pins[pin]) @@ -78,15 +79,14 @@ class AioPinsReader(threading.Thread): else: assert self.__loop is None self.__loop = asyncio.get_running_loop() - self.start() + self.__thread.start() try: - await aiotools.run_async(self.join) + await aiotools.run_async(self.__thread.join) finally: self.__stop_event.set() - await aiotools.run_async(self.join) + await aiotools.run_async(self.__thread.join) - def run(self) -> None: - assert self.__loop + def __run(self) -> None: with gpiod.Chip(self.__path) as chip: pins = sorted(self.__pins) lines = chip.get_lines(pins) @@ -97,7 +97,7 @@ class AioPinsReader(threading.Thread): pin: bool(value) for (pin, value) in zip(pins, lines.get_values()) } - self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) + self.__notify() while not self.__stop_event.is_set(): ev_lines = lines.event_wait(1) @@ -105,12 +105,18 @@ class AioPinsReader(threading.Thread): for ev_line in ev_lines: events = ev_line.event_read_multiply() if events: - event = events[-1] - if event.type == gpiod.LineEvent.RISING_EDGE: - value = True - elif event.type == gpiod.LineEvent.FALLING_EDGE: - value = False - else: - raise RuntimeError(f"Invalid event {event} type: {event.type}") - self.__state[event.source.offset()] = value - self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) + (pin, value) = self.__parse_event(events[-1]) + self.__state[pin] = value + self.__notify() + + def __parse_event(self, event: gpiod.LineEvent) -> Tuple[int, bool]: + pin = event.source.offset() + if event.type == gpiod.LineEvent.RISING_EDGE: + return (pin, True) + elif event.type == gpiod.LineEvent.FALLING_EDGE: + return (pin, False) + raise RuntimeError(f"Invalid event {event} type: {event.type}") + + def __notify(self) -> None: + assert self.__loop + self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) From 6ef53e48c56af680e6efbfd1002a2bb144d2043f Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 21:51:53 +0300 Subject: [PATCH 15/19] notify only on change --- kvmd/aiogp.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 7b0a2e74..7dfe4fa9 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -102,12 +102,16 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes while not self.__stop_event.is_set(): ev_lines = lines.event_wait(1) if ev_lines: + changed = False for ev_line in ev_lines: events = ev_line.event_read_multiply() if events: (pin, value) = self.__parse_event(events[-1]) - self.__state[pin] = value - self.__notify() + if self.__state[pin] != value: + self.__state[pin] = value + changed = True + if changed: + self.__notify() def __parse_event(self, event: gpiod.LineEvent) -> Tuple[int, bool]: pin = event.source.offset() From 123406b2b2012e84c7e30cfa999ee921d05a7c56 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 22:59:24 +0300 Subject: [PATCH 16/19] workaround for possible driver bug --- kvmd/aiogp.py | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 7dfe4fa9..3b50aaac 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -54,7 +54,7 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes self, path: str, consumer: str, - pins: Dict[int, bool], + pins: Dict[int, bool], # (pin, inverted) notifier: aiotools.AioNotifier, ) -> None: @@ -63,15 +63,15 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes self.__pins = pins self.__notifier = notifier - self.__state = dict.fromkeys(pins, False) + self.__state = dict.fromkeys(pins, 0) - self.__stop_event = threading.Event() self.__loop: Optional[asyncio.AbstractEventLoop] = None self.__thread = threading.Thread(target=self.__run, daemon=True) + self.__stop_event = threading.Event() def get(self, pin: int) -> bool: - return (self.__state[pin] ^ self.__pins[pin]) + return (bool(self.__state[pin]) ^ self.__pins[pin]) async def poll(self) -> None: if not self.__pins: @@ -92,17 +92,17 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes lines = chip.get_lines(pins) lines.request(self.__consumer, gpiod.LINE_REQ_EV_BOTH_EDGES) + def read_state() -> Dict[int, int]: + return dict(zip(pins, lines.get_values())) + lines.event_wait(nsec=1) - self.__state = { - pin: bool(value) - for (pin, value) in zip(pins, lines.get_values()) - } + self.__state = read_state() self.__notify() while not self.__stop_event.is_set(): + changed = False ev_lines = lines.event_wait(1) if ev_lines: - changed = False for ev_line in ev_lines: events = ev_line.event_read_multiply() if events: @@ -110,15 +110,21 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes if self.__state[pin] != value: self.__state[pin] = value changed = True - if changed: - self.__notify() + else: # Timeout + # Ensure state to avoid driver bugs + state = read_state() + if self.__state != state: + self.__state = state + changed = True + if changed: + self.__notify() - def __parse_event(self, event: gpiod.LineEvent) -> Tuple[int, bool]: + def __parse_event(self, event: gpiod.LineEvent) -> Tuple[int, int]: pin = event.source.offset() if event.type == gpiod.LineEvent.RISING_EDGE: - return (pin, True) + return (pin, 1) elif event.type == gpiod.LineEvent.FALLING_EDGE: - return (pin, False) + return (pin, 0) raise RuntimeError(f"Invalid event {event} type: {event.type}") def __notify(self) -> None: From 7cdf5976a8c0f0e020847413f4f8d64cb8e797f7 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Mon, 14 Sep 2020 23:37:19 +0300 Subject: [PATCH 17/19] fix --- kvmd/aiogp.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index 3b50aaac..fe092dcf 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -104,7 +104,7 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes ev_lines = lines.event_wait(1) if ev_lines: for ev_line in ev_lines: - events = ev_line.event_read_multiply() + events = ev_line.event_read_multiple() if events: (pin, value) = self.__parse_event(events[-1]) if self.__state[pin] != value: From 00069931c181a672c7f709d9a76892e575a964f7 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Wed, 16 Sep 2020 00:03:44 +0300 Subject: [PATCH 18/19] debounce for gpiod AioReader --- kvmd/aiogp.py | 98 +++++++++++++++++++++++++--------- kvmd/apps/__init__.py | 4 +- kvmd/apps/kvmd/ugpio.py | 2 +- kvmd/plugins/atx/gpio.py | 19 ++++--- kvmd/plugins/ugpio/__init__.py | 2 +- kvmd/plugins/ugpio/gpio.py | 13 +++-- kvmd/plugins/ugpio/hidrelay.py | 2 +- 7 files changed, 98 insertions(+), 42 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index fe092dcf..e696787c 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -22,7 +22,9 @@ import os import asyncio +import asyncio.queues import threading +import dataclasses from typing import Tuple from typing import Dict @@ -49,12 +51,19 @@ async def pulse(line: gpiod.Line, delay: float, final: float) -> None: await asyncio.sleep(final) -class AioPinsReader: # pylint: disable=too-many-instance-attributes +# ===== +@dataclasses.dataclass(frozen=True) +class AioReaderPinParams: + inverted: bool + debounce: float + + +class AioReader: # pylint: disable=too-many-instance-attributes def __init__( self, path: str, consumer: str, - pins: Dict[int, bool], # (pin, inverted) + pins: Dict[int, AioReaderPinParams], notifier: aiotools.AioNotifier, ) -> None: @@ -63,15 +72,16 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes self.__pins = pins self.__notifier = notifier - self.__state = dict.fromkeys(pins, 0) - - self.__loop: Optional[asyncio.AbstractEventLoop] = None + self.__values: Optional[Dict[int, _DebouncedValue]] = None self.__thread = threading.Thread(target=self.__run, daemon=True) self.__stop_event = threading.Event() + self.__loop: Optional[asyncio.AbstractEventLoop] = None + def get(self, pin: int) -> bool: - return (bool(self.__state[pin]) ^ self.__pins[pin]) + value = (self.__values[pin].get() if self.__values is not None else False) + return (value ^ self.__pins[pin].inverted) async def poll(self) -> None: if not self.__pins: @@ -87,37 +97,39 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes await aiotools.run_async(self.__thread.join) def __run(self) -> None: + assert self.__values is None + assert self.__loop with gpiod.Chip(self.__path) as chip: pins = sorted(self.__pins) lines = chip.get_lines(pins) lines.request(self.__consumer, gpiod.LINE_REQ_EV_BOTH_EDGES) - def read_state() -> Dict[int, int]: - return dict(zip(pins, lines.get_values())) - lines.event_wait(nsec=1) - self.__state = read_state() - self.__notify() + self.__values = { + pin: _DebouncedValue( + initial=bool(value), + debounce=self.__pins[pin].debounce, + notifier=self.__notifier, + loop=self.__loop, + ) + for (pin, value) in zip(pins, lines.get_values()) + } + self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) while not self.__stop_event.is_set(): - changed = False ev_lines = lines.event_wait(1) if ev_lines: for ev_line in ev_lines: events = ev_line.event_read_multiple() if events: (pin, value) = self.__parse_event(events[-1]) - if self.__state[pin] != value: - self.__state[pin] = value - changed = True + self.__values[pin].set(bool(value)) else: # Timeout - # Ensure state to avoid driver bugs - state = read_state() - if self.__state != state: - self.__state = state - changed = True - if changed: - self.__notify() + # Размер буфера ядра - 16 эвентов на линии. При превышении этого числа, + # новые эвенты потеряются. Это не баг, это фича, как мне объяснили в LKML. + # Штош. Будем с этим жить и синхронизировать состояния при таймауте. + for (pin, value) in zip(pins, lines.get_values()): + self.__values[pin].set(bool(value)) def __parse_event(self, event: gpiod.LineEvent) -> Tuple[int, int]: pin = event.source.offset() @@ -127,6 +139,42 @@ class AioPinsReader: # pylint: disable=too-many-instance-attributes return (pin, 0) raise RuntimeError(f"Invalid event {event} type: {event.type}") - def __notify(self) -> None: - assert self.__loop - self.__loop.call_soon_threadsafe(self.__notifier.notify_sync) + +class _DebouncedValue: + def __init__( + self, + initial: bool, + debounce: float, + notifier: aiotools.AioNotifier, + loop: asyncio.AbstractEventLoop, + ) -> None: + + self.__value = initial + self.__debounce = debounce + self.__notifier = notifier + self.__loop = loop + + self.__queue: asyncio.queues.Queue = asyncio.Queue(loop=loop) + self.__task = loop.create_task(self.__consumer()) + + def set(self, value: bool) -> None: + if self.__loop.is_running(): + self.__check_alive() + self.__loop.call_soon_threadsafe(self.__queue.put_nowait, value) + + def get(self) -> bool: + return self.__value + + def __check_alive(self) -> None: + if self.__task.done() and not self.__task.cancelled(): + raise RuntimeError("Dead debounce consumer") + + async def __consumer(self) -> None: + while True: + value = await self.__queue.get() + while not self.__queue.empty(): + value = await self.__queue.get() + if self.__value != value: + self.__value = value + await self.__notifier.notify() + await asyncio.sleep(self.__debounce) diff --git a/kvmd/apps/__init__.py b/kvmd/apps/__init__.py index ac140466..ccede372 100644 --- a/kvmd/apps/__init__.py +++ b/kvmd/apps/__init__.py @@ -227,7 +227,9 @@ def _patch_dynamic( # pylint: disable=too-many-locals "min_delay": Option(0.1, type=valid_float_f01), "max_delay": Option(0.1, type=valid_float_f01), }, - } if mode == UserGpioModes.OUTPUT else {}) + } if mode == UserGpioModes.OUTPUT else { # input + "debounce": Option(0.1, type=valid_float_f0), + }) } rebuild = True diff --git a/kvmd/apps/kvmd/ugpio.py b/kvmd/apps/kvmd/ugpio.py index 66fa5c70..cb328115 100644 --- a/kvmd/apps/kvmd/ugpio.py +++ b/kvmd/apps/kvmd/ugpio.py @@ -81,7 +81,7 @@ class _GpioInput: self.__inverted: bool = config.inverted self.__driver = driver - self.__driver.register_input(self.__pin) + self.__driver.register_input(self.__pin, config.debounce) def get_scheme(self) -> Dict: return { diff --git a/kvmd/plugins/atx/gpio.py b/kvmd/plugins/atx/gpio.py index 851e4ab4..b49dd689 100644 --- a/kvmd/plugins/atx/gpio.py +++ b/kvmd/plugins/atx/gpio.py @@ -34,6 +34,7 @@ from ... import aiogp from ...yamlconf import Option from ...validators.basic import valid_bool +from ...validators.basic import valid_float_f0 from ...validators.basic import valid_float_f01 from ...validators.hw import valid_gpio_pin @@ -47,9 +48,12 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes def __init__( # pylint: disable=too-many-arguments,super-init-not-called self, power_led_pin: int, - hdd_led_pin: int, power_led_inverted: bool, + power_led_debounce: float, + + hdd_led_pin: int, hdd_led_inverted: bool, + hdd_led_debounce: float, power_switch_pin: int, reset_switch_pin: int, @@ -72,12 +76,12 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes self.__power_switch_line: Optional[gpiod.Line] = None self.__reset_switch_line: Optional[gpiod.Line] = None - self.__reader = aiogp.AioPinsReader( + self.__reader = aiogp.AioReader( path=aiogp.DEVICE_PATH, consumer="kvmd/atx-gpio/leds", pins={ - power_led_pin: power_led_inverted, - hdd_led_pin: hdd_led_inverted, + power_led_pin: aiogp.AioReaderPinParams(power_led_inverted, power_led_debounce), + hdd_led_pin: aiogp.AioReaderPinParams(hdd_led_inverted, hdd_led_debounce), }, notifier=self.__notifier, ) @@ -86,9 +90,12 @@ class Plugin(BaseAtx): # pylint: disable=too-many-instance-attributes def get_plugin_options(cls) -> Dict: return { "power_led_pin": Option(-1, type=valid_gpio_pin), - "hdd_led_pin": Option(-1, type=valid_gpio_pin), "power_led_inverted": Option(False, type=valid_bool), - "hdd_led_inverted": Option(False, type=valid_bool), + "power_led_debounce": Option(0.1, type=valid_float_f0), + + "hdd_led_pin": Option(-1, type=valid_gpio_pin), + "hdd_led_inverted": Option(False, type=valid_bool), + "hdd_led_debounce": Option(0.1, type=valid_float_f0), "power_switch_pin": Option(-1, type=valid_gpio_pin), "reset_switch_pin": Option(-1, type=valid_gpio_pin), diff --git a/kvmd/plugins/ugpio/__init__.py b/kvmd/plugins/ugpio/__init__.py index 9ed48a5f..c280b2a8 100644 --- a/kvmd/plugins/ugpio/__init__.py +++ b/kvmd/plugins/ugpio/__init__.py @@ -74,7 +74,7 @@ class BaseUserGpioDriver(BasePlugin): def get_modes(cls) -> Set[str]: return set(UserGpioModes.ALL) - def register_input(self, pin: int) -> None: + def register_input(self, pin: int, debounce: float) -> None: raise NotImplementedError def register_output(self, pin: int, initial: Optional[bool]) -> None: diff --git a/kvmd/plugins/ugpio/gpio.py b/kvmd/plugins/ugpio/gpio.py index 16e0b516..4b951057 100644 --- a/kvmd/plugins/ugpio/gpio.py +++ b/kvmd/plugins/ugpio/gpio.py @@ -21,7 +21,6 @@ from typing import Dict -from typing import Set from typing import Optional import gpiod @@ -42,26 +41,26 @@ class Plugin(BaseUserGpioDriver): super().__init__(instance_name, notifier) - self.__input_pins: Set[int] = set() + self.__input_pins: Dict[int, aiogp.AioReaderPinParams] = {} self.__output_pins: Dict[int, Optional[bool]] = {} - self.__reader: Optional[aiogp.AioPinsReader] = None + self.__reader: Optional[aiogp.AioReader] = None self.__chip: Optional[gpiod.Chip] = None self.__output_lines: Dict[int, gpiod.Line] = {} - def register_input(self, pin: int) -> None: - self.__input_pins.add(pin) + def register_input(self, pin: int, debounce: float) -> None: + self.__input_pins[pin] = aiogp.AioReaderPinParams(False, debounce) def register_output(self, pin: int, initial: Optional[bool]) -> None: self.__output_pins[pin] = initial def prepare(self) -> None: assert self.__reader is None - self.__reader = aiogp.AioPinsReader( + self.__reader = aiogp.AioReader( path=aiogp.DEVICE_PATH, consumer="kvmd/ugpio-gpio/inputs", - pins=dict.fromkeys(self.__input_pins, False), + pins=self.__input_pins, notifier=self._notifier, ) diff --git a/kvmd/plugins/ugpio/hidrelay.py b/kvmd/plugins/ugpio/hidrelay.py index b7f88cb8..32c4a3eb 100644 --- a/kvmd/plugins/ugpio/hidrelay.py +++ b/kvmd/plugins/ugpio/hidrelay.py @@ -79,7 +79,7 @@ class Plugin(BaseUserGpioDriver): def get_modes(cls) -> Set[str]: return set([UserGpioModes.OUTPUT]) - def register_input(self, pin: int) -> None: + def register_input(self, pin: int, debounce: float) -> None: raise RuntimeError(f"Unsupported mode 'input' for pin={pin} on {self}") def register_output(self, pin: int, initial: Optional[bool]) -> None: From 3f79f55a9ef6368b0bd2c76bf55c7e139ecfb9c7 Mon Sep 17 00:00:00 2001 From: Devaev Maxim Date: Wed, 16 Sep 2020 01:33:15 +0300 Subject: [PATCH 19/19] refactoring --- kvmd/aiogp.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/kvmd/aiogp.py b/kvmd/aiogp.py index e696787c..aa7c2778 100644 --- a/kvmd/aiogp.py +++ b/kvmd/aiogp.py @@ -155,7 +155,7 @@ class _DebouncedValue: self.__loop = loop self.__queue: asyncio.queues.Queue = asyncio.Queue(loop=loop) - self.__task = loop.create_task(self.__consumer()) + self.__task = loop.create_task(self.__consumer_task_loop()) def set(self, value: bool) -> None: if self.__loop.is_running(): @@ -169,7 +169,7 @@ class _DebouncedValue: if self.__task.done() and not self.__task.cancelled(): raise RuntimeError("Dead debounce consumer") - async def __consumer(self) -> None: + async def __consumer_task_loop(self) -> None: while True: value = await self.__queue.get() while not self.__queue.empty():