Merge pull request #1730 from pmelange/25.0.1-sysfsgpio_active_low

Sysfsgpio invert (active_low)

Author: Bastian-Krause

doc/configuration.rst

@@ -644,9 +644,11 @@ A :any:`SysfsGPIO` resource describes a GPIO line.
 
    SysfsGPIO:
      index: 12
+     invert: False
 
 Arguments:
   - index (int): index of the GPIO line
+  - invert (bool, default=False): optional, whether the logic level is inverted (active-low)
 
 Used by:
   - `GpioDigitalOutputDriver`_
@@ -670,6 +672,7 @@ USB based gpiochips.
        '@SUBSYSTEM': 'usb'
        '@ID_SERIAL_SHORT': 'D38EJ8LF'
      pin: 0
+     invert: False
 
 The example would search for a USB gpiochip with the key ``ID_SERIAL_SHORT``
 and the value ``D38EJ8LF`` and use the pin 0 of this device.
@@ -678,6 +681,7 @@ The ``ID_SERIAL_SHORT`` property is set by the usb_id builtin helper program.
 Arguments:
   - match (dict): key and value pairs for a udev match, see `udev Matching`_
   - pin (int): gpio pin number within the matched gpiochip.
+  - invert (bool, default=False): optional, whether the logic level is inverted (active-low)
 
 Used by:
   - `GpioDigitalOutputDriver`_

examples/sysfsgpio/export-gpio.yaml

@@ -1,3 +1,4 @@
 desk:
-    GpioDigitalOutputDriver:
+    SysfsGPIO:
         index: 60
+        invert: False

examples/sysfsgpio/import-gpio.yaml

@@ -5,5 +5,3 @@ targets:
         name: gpio
     drivers:
       GpioDigitalOutputDriver: {}
-options:
-  coordinator_address: 'labgrid:20408'

examples/sysfsgpio/sysfsgpio.py

@@ -13,11 +13,12 @@
 StepLogger.start()
 
 t = Target("main")
-r = SysfsGPIO(t, name=None, index=60)
+r = SysfsGPIO(t, name=None, index=60, invert=True)
 d = GpioDigitalOutputDriver(t, name=None)
 
 p = t.get_driver("DigitalOutputProtocol")
 print(t.resources)
+print("Testing IO")
 p.set(True)
 print(p.get())
 time.sleep(2)

examples/sysfsgpio/sysfsgpio_remote.py

@@ -15,6 +15,7 @@
 
 p = t.get_driver("DigitalOutputProtocol")
 print(t.resources)
+print("Testing IO")
 p.set(True)
 print(p.get())
 time.sleep(2)

labgrid/driver/gpiodriver.py

@@ -37,9 +37,9 @@ def on_deactivate(self):
     @Driver.check_active
     @step(args=['status'])
     def set(self, status):
-        self.proxy.set(self.gpio.index, status)
+        self.proxy.set(self.gpio.index, self.gpio.invert, status)
 
     @Driver.check_active
     @step(result=True)
     def get(self):
-        return self.proxy.get(self.gpio.index)
+        return self.proxy.get(self.gpio.index, self.gpio.invert)

labgrid/remote/exporter.py

@@ -666,16 +666,19 @@ def _get_params(self):
         return {
             "host": self.host,
             "index": self.local.index,
+            "invert": self.local.invert,
         }
 
     def _get_start_params(self):
         return {
             "index": self.local.index,
+            "invert": self.local.invert,
         }
 
     def _start(self, start_params):
         """Start a GPIO export to userspace"""
         index = start_params["index"]
+        invert = start_params["invert"]  # pylint: disable=unused-variable
 
         if self.export_path.exists():
             self.system_exported = True

labgrid/resource/base.py

@@ -42,5 +42,7 @@ class SysfsGPIO(Resource):
     """The basic SysfsGPIO contains an index
 
     Args:
-        index (int): index of target gpio line."""
+        index (int): index of target gpio line.
+        invert (bool) : optional, whether the logic level is inverted (active-low)"""
     index = attr.ib(default=None, validator=attr.validators.instance_of(int))
+    invert = attr.ib(default=False,  validator=attr.validators.instance_of(bool))

labgrid/resource/remote.py

@@ -352,6 +352,7 @@ class NetworkSysfsGPIO(NetworkResource, ManagedResource):
 
     """The NetworkSysfsGPIO describes a remotely accessible gpio line"""
     index = attr.ib(validator=attr.validators.optional(attr.validators.instance_of(int)))
+    invert = attr.ib(default=False, validator=attr.validators.instance_of(bool))
     def __attrs_post_init__(self):
         self.timeout = 10.0
         super().__attrs_post_init__()

labgrid/resource/udev.py

@@ -929,8 +929,10 @@ class MatchedSysfsGPIO(USBResource):
     """The MatchedSysfsGPIO described a SysfsGPIO matched by Udev
 
     Args:
-        pin (int): gpio pin number within the matched gpiochip."""
+        pin (int): gpio pin number within the matched gpiochip.
+        invert (bool): optional, whether the logic level is inverted (active-low)"""
     pin = attr.ib(default=None, validator=attr.validators.instance_of(int))
+    invert = attr.ib(default=False, validator=attr.validators.instance_of(bool))
     index = None
 
     def __attrs_post_init__(self):