1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
|
import platform
import ctypes
import fcntl
import os
import select
from .gpio import GPIO, GPIOError, EdgeEvent
try:
KERNEL_VERSION = tuple([int(s) for s in platform.release().split(".")[:2]])
except ValueError:
KERNEL_VERSION = (0, 0)
_GPIO_NAME_MAX_SIZE = 32
_GPIOHANDLES_MAX = 64
class _CGpiochipInfo(ctypes.Structure):
_fields_ = [
('name', ctypes.c_char * _GPIO_NAME_MAX_SIZE),
('label', ctypes.c_char * _GPIO_NAME_MAX_SIZE),
('lines', ctypes.c_uint32),
]
class _CGpiolineInfo(ctypes.Structure):
_fields_ = [
('line_offset', ctypes.c_uint32),
('flags', ctypes.c_uint32),
('name', ctypes.c_char * _GPIO_NAME_MAX_SIZE),
('consumer', ctypes.c_char * _GPIO_NAME_MAX_SIZE),
]
class _CGpiohandleRequest(ctypes.Structure):
_fields_ = [
('lineoffsets', ctypes.c_uint32 * _GPIOHANDLES_MAX),
('flags', ctypes.c_uint32),
('default_values', ctypes.c_uint8 * _GPIOHANDLES_MAX),
('consumer_label', ctypes.c_char * _GPIO_NAME_MAX_SIZE),
('lines', ctypes.c_uint32),
('fd', ctypes.c_int),
]
class _CGpiohandleData(ctypes.Structure):
_fields_ = [
('values', ctypes.c_uint8 * _GPIOHANDLES_MAX),
]
class _CGpioeventRequest(ctypes.Structure):
_fields_ = [
('lineoffset', ctypes.c_uint32),
('handleflags', ctypes.c_uint32),
('eventflags', ctypes.c_uint32),
('consumer_label', ctypes.c_char * _GPIO_NAME_MAX_SIZE),
('fd', ctypes.c_int),
]
class _CGpioeventData(ctypes.Structure):
_fields_ = [
('timestamp', ctypes.c_uint64),
('id', ctypes.c_uint32),
]
class Cdev1GPIO(GPIO):
# Constants scraped from <linux/gpio.h>
_GPIOHANDLE_GET_LINE_VALUES_IOCTL = 0xc040b408
_GPIOHANDLE_SET_LINE_VALUES_IOCTL = 0xc040b409
_GPIO_GET_CHIPINFO_IOCTL = 0x8044b401
_GPIO_GET_LINEINFO_IOCTL = 0xc048b402
_GPIO_GET_LINEHANDLE_IOCTL = 0xc16cb403
_GPIO_GET_LINEEVENT_IOCTL = 0xc030b404
_GPIOHANDLE_REQUEST_INPUT = 0x1
_GPIOHANDLE_REQUEST_OUTPUT = 0x2
_GPIOHANDLE_REQUEST_ACTIVE_LOW = 0x4
_GPIOHANDLE_REQUEST_OPEN_DRAIN = 0x8
_GPIOHANDLE_REQUEST_OPEN_SOURCE = 0x10
_GPIOHANDLE_REQUEST_BIAS_PULL_UP = 0x20
_GPIOHANDLE_REQUEST_BIAS_PULL_DOWN = 0x40
_GPIOHANDLE_REQUEST_BIAS_DISABLE = 0x80
_GPIOEVENT_REQUEST_RISING_EDGE = 0x1
_GPIOEVENT_REQUEST_FALLING_EDGE = 0x2
_GPIOEVENT_REQUEST_BOTH_EDGES = 0x3
_GPIOEVENT_EVENT_RISING_EDGE = 0x1
_GPIOEVENT_EVENT_FALLING_EDGE = 0x2
_SUPPORTS_LINE_BIAS = KERNEL_VERSION >= (5, 5)
def __init__(self, path, line, direction, edge="none", bias="default", drive="default", inverted=False, label=None):
"""**Character device GPIO (ABI version 1)**
Instantiate a GPIO object and open the character device GPIO with the
specified line and direction at the specified GPIO chip path (e.g.
"/dev/gpiochip0"). Defaults properties can be overridden with keyword
arguments.
Args:
path (str): GPIO chip character device path.
line (int, str): GPIO line number or name.
direction (str): GPIO direction, can be "in", "out", "high", or
"low".
edge (str): GPIO interrupt edge, can be "none", "rising",
"falling", or "both".
bias (str): GPIO line bias, can be "default", "pull_up",
"pull_down", or "disable".
drive (str): GPIO line drive, can be "default", "open_drain", or
"open_source".
inverted (bool): GPIO is inverted (active low).
label (str, None): GPIO line consumer label.
Returns:
Cdev1GPIO: GPIO object.
Raises:
GPIOError: if an I/O or OS error occurs.
TypeError: if `path`, `line`, `direction`, `edge`, `bias`, `drive`,
`inverted`, or `label` types are invalid.
ValueError: if `direction`, `edge`, `bias`, or `drive` value is
invalid.
LookupError: if the GPIO line was not found by the provided name.
"""
self._devpath = None
self._line = None
self._line_fd = None
self._chip_fd = None
self._direction = None
self._edge = None
self._bias = None
self._drive = None
self._inverted = None
self._label = None
self._open(path, line, direction, edge, bias, drive, inverted, label)
def __new__(self, path, line, direction, **kwargs):
return object.__new__(Cdev1GPIO)
def _open(self, path, line, direction, edge, bias, drive, inverted, label):
if not isinstance(path, str):
raise TypeError("Invalid path type, should be string.")
if not isinstance(line, (int, str)):
raise TypeError("Invalid line type, should be integer or string.")
if not isinstance(direction, str):
raise TypeError("Invalid direction type, should be string.")
elif direction not in ["in", "out", "high", "low"]:
raise ValueError("Invalid direction, can be: \"in\", \"out\", \"high\", \"low\".")
if not isinstance(edge, str):
raise TypeError("Invalid edge type, should be string.")
elif edge not in ["none", "rising", "falling", "both"]:
raise ValueError("Invalid edge, can be: \"none\", \"rising\", \"falling\", \"both\".")
if not isinstance(bias, str):
raise TypeError("Invalid bias type, should be string.")
elif bias not in ["default", "pull_up", "pull_down", "disable"]:
raise ValueError("Invalid bias, can be: \"default\", \"pull_up\", \"pull_down\", \"disable\".")
if not isinstance(drive, str):
raise TypeError("Invalid drive type, should be string.")
elif drive not in ["default", "open_drain", "open_source"]:
raise ValueError("Invalid drive, can be: \"default\", \"open_drain\", \"open_source\".")
if not isinstance(inverted, bool):
raise TypeError("Invalid drive type, should be bool.")
if not isinstance(label, (type(None), str)):
raise TypeError("Invalid label type, should be None or str.")
if isinstance(line, str):
line = self._find_line_by_name(path, line)
# Open GPIO chip
try:
self._chip_fd = os.open(path, 0)
except OSError as e:
raise GPIOError(e.errno, "Opening GPIO chip: " + e.strerror)
self._devpath = path
self._line = line
self._label = label.encode() if label is not None else b"periphery"
self._reopen(direction, edge, bias, drive, inverted)
def _reopen(self, direction, edge, bias, drive, inverted):
flags = 0
if bias != "default" and not Cdev1GPIO._SUPPORTS_LINE_BIAS:
raise GPIOError(None, "Line bias configuration not supported by kernel version {}.{}.".format(*KERNEL_VERSION))
elif bias == "pull_up":
flags |= Cdev1GPIO._GPIOHANDLE_REQUEST_BIAS_PULL_UP
elif bias == "pull_down":
flags |= Cdev1GPIO._GPIOHANDLE_REQUEST_BIAS_PULL_DOWN
elif bias == "disable":
flags |= Cdev1GPIO._GPIOHANDLE_REQUEST_BIAS_DISABLE
if drive == "open_drain":
flags |= Cdev1GPIO._GPIOHANDLE_REQUEST_OPEN_DRAIN
elif drive == "open_source":
flags |= Cdev1GPIO._GPIOHANDLE_REQUEST_OPEN_SOURCE
if inverted:
flags |= Cdev1GPIO._GPIOHANDLE_REQUEST_ACTIVE_LOW
# FIXME this should really use GPIOHANDLE_SET_CONFIG_IOCTL instead of
# closing and reopening, especially to preserve output value on
# configuration changes
# Close existing line
if self._line_fd is not None:
try:
os.close(self._line_fd)
except OSError as e:
raise GPIOError(e.errno, "Closing existing GPIO line: " + e.strerror)
self._line_fd = None
if direction == "in":
if edge == "none":
request = _CGpiohandleRequest()
request.lineoffsets[0] = self._line
request.flags = flags | Cdev1GPIO._GPIOHANDLE_REQUEST_INPUT
request.consumer_label = self._label
request.lines = 1
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_LINEHANDLE_IOCTL, request)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Opening input line handle: " + e.strerror)
self._line_fd = request.fd
else:
request = _CGpioeventRequest()
request.lineoffset = self._line
request.handleflags = flags | Cdev1GPIO._GPIOHANDLE_REQUEST_INPUT
request.eventflags = Cdev1GPIO._GPIOEVENT_REQUEST_RISING_EDGE if edge == "rising" else Cdev1GPIO._GPIOEVENT_REQUEST_FALLING_EDGE if edge == "falling" else Cdev1GPIO._GPIOEVENT_REQUEST_BOTH_EDGES
request.consumer_label = self._label
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_LINEEVENT_IOCTL, request)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Opening input line event handle: " + e.strerror)
self._line_fd = request.fd
else:
request = _CGpiohandleRequest()
initial_value = True if direction == "high" else False
initial_value ^= inverted
request.lineoffsets[0] = self._line
request.flags = flags | Cdev1GPIO._GPIOHANDLE_REQUEST_OUTPUT
request.default_values[0] = initial_value
request.consumer_label = self._label
request.lines = 1
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_LINEHANDLE_IOCTL, request)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Opening output line handle: " + e.strerror)
self._line_fd = request.fd
self._direction = "in" if direction == "in" else "out"
self._edge = edge
self._bias = bias
self._drive = drive
self._inverted = inverted
def _find_line_by_name(self, path, line):
# Open GPIO chip
try:
fd = os.open(path, 0)
except OSError as e:
raise GPIOError(e.errno, "Opening GPIO chip: " + e.strerror)
# Get chip info for number of lines
chip_info = _CGpiochipInfo()
try:
fcntl.ioctl(fd, Cdev1GPIO._GPIO_GET_CHIPINFO_IOCTL, chip_info)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Querying GPIO chip info: " + e.strerror)
# Get each line info
line_info = _CGpiolineInfo()
found = False
for i in range(chip_info.lines):
line_info.line_offset = i
try:
fcntl.ioctl(fd, Cdev1GPIO._GPIO_GET_LINEINFO_IOCTL, line_info)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Querying GPIO line info: " + e.strerror)
if line_info.name.decode() == line:
found = True
break
try:
os.close(fd)
except OSError as e:
raise GPIOError(e.errno, "Closing GPIO chip: " + e.strerror)
if found:
return i
raise LookupError("Opening GPIO line: GPIO line \"{:s}\" not found by name.".format(line))
# Methods
def read(self):
data = _CGpiohandleData()
try:
fcntl.ioctl(self._line_fd, Cdev1GPIO._GPIOHANDLE_GET_LINE_VALUES_IOCTL, data)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Getting line value: " + e.strerror)
return bool(data.values[0])
def write(self, value):
if not isinstance(value, bool):
raise TypeError("Invalid value type, should be bool.")
elif self._direction != "out":
raise GPIOError(None, "Invalid operation: cannot write to input GPIO")
data = _CGpiohandleData()
data.values[0] = value
try:
fcntl.ioctl(self._line_fd, Cdev1GPIO._GPIOHANDLE_SET_LINE_VALUES_IOCTL, data)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Setting line value: " + e.strerror)
def poll(self, timeout=None):
if not isinstance(timeout, (int, float, type(None))):
raise TypeError("Invalid timeout type, should be integer, float, or None.")
elif self._direction != "in":
raise GPIOError(None, "Invalid operation: cannot poll output GPIO")
# Setup poll
p = select.poll()
p.register(self._line_fd, select.POLLIN | select.POLLPRI | select.POLLERR)
# Scale timeout to milliseconds
if isinstance(timeout, (int, float)) and timeout > 0:
timeout *= 1000
# Poll
events = p.poll(timeout)
return len(events) > 0
def read_event(self):
if self._direction != "in":
raise GPIOError(None, "Invalid operation: cannot read event of output GPIO")
elif self._edge == "none":
raise GPIOError(None, "Invalid operation: GPIO edge not set")
try:
buf = os.read(self._line_fd, ctypes.sizeof(_CGpioeventData))
except OSError as e:
raise GPIOError(e.errno, "Reading GPIO event: " + e.strerror)
event_data = _CGpioeventData.from_buffer_copy(buf)
if event_data.id == Cdev1GPIO._GPIOEVENT_EVENT_RISING_EDGE:
edge = "rising"
elif event_data.id == Cdev1GPIO._GPIOEVENT_EVENT_FALLING_EDGE:
edge = "falling"
else:
edge = "none"
timestamp = event_data.timestamp
return EdgeEvent(edge, timestamp)
def close(self):
try:
if self._line_fd is not None:
os.close(self._line_fd)
except OSError as e:
raise GPIOError(e.errno, "Closing GPIO line: " + e.strerror)
try:
if self._chip_fd is not None:
os.close(self._chip_fd)
except OSError as e:
raise GPIOError(e.errno, "Closing GPIO chip: " + e.strerror)
self._line_fd = None
self._chip_fd = None
self._edge = "none"
self._direction = "in"
self._line = None
# Immutable properties
@property
def devpath(self):
return self._devpath
@property
def fd(self):
return self._line_fd
@property
def line(self):
return self._line
@property
def name(self):
line_info = _CGpiolineInfo()
line_info.line_offset = self._line
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_LINEINFO_IOCTL, line_info)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Querying GPIO line info: " + e.strerror)
return line_info.name.decode()
@property
def label(self):
line_info = _CGpiolineInfo()
line_info.line_offset = self._line
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_LINEINFO_IOCTL, line_info)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Querying GPIO line info: " + e.strerror)
return line_info.consumer.decode()
@property
def chip_fd(self):
return self._chip_fd
@property
def chip_name(self):
chip_info = _CGpiochipInfo()
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_CHIPINFO_IOCTL, chip_info)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Querying GPIO chip info: " + e.strerror)
return chip_info.name.decode()
@property
def chip_label(self):
chip_info = _CGpiochipInfo()
try:
fcntl.ioctl(self._chip_fd, Cdev1GPIO._GPIO_GET_CHIPINFO_IOCTL, chip_info)
except (OSError, IOError) as e:
raise GPIOError(e.errno, "Querying GPIO chip info: " + e.strerror)
return chip_info.label.decode()
# Mutable properties
def _get_direction(self):
return self._direction
def _set_direction(self, direction):
if not isinstance(direction, str):
raise TypeError("Invalid direction type, should be string.")
if direction not in ["in", "out", "high", "low"]:
raise ValueError("Invalid direction, can be: \"in\", \"out\", \"high\", \"low\".")
if self._direction == direction:
return
self._reopen(direction, "none", self._bias, self._drive, self._inverted)
direction = property(_get_direction, _set_direction)
def _get_edge(self):
return self._edge
def _set_edge(self, edge):
if not isinstance(edge, str):
raise TypeError("Invalid edge type, should be string.")
if edge not in ["none", "rising", "falling", "both"]:
raise ValueError("Invalid edge, can be: \"none\", \"rising\", \"falling\", \"both\".")
if self._direction != "in":
raise GPIOError(None, "Invalid operation: cannot set edge on output GPIO")
if self._edge == edge:
return
self._reopen(self._direction, edge, self._bias, self._drive, self._inverted)
edge = property(_get_edge, _set_edge)
def _get_bias(self):
return self._bias
def _set_bias(self, bias):
if not isinstance(bias, str):
raise TypeError("Invalid bias type, should be string.")
if bias not in ["default", "pull_up", "pull_down", "disable"]:
raise ValueError("Invalid bias, can be: \"default\", \"pull_up\", \"pull_down\", \"disable\".")
if self._bias == bias:
return
self._reopen(self._direction, self._edge, bias, self._drive, self._inverted)
bias = property(_get_bias, _set_bias)
def _get_drive(self):
return self._drive
def _set_drive(self, drive):
if not isinstance(drive, str):
raise TypeError("Invalid drive type, should be string.")
if drive not in ["default", "open_drain", "open_source"]:
raise ValueError("Invalid drive, can be: \"default\", \"open_drain\", \"open_source\".")
if self._direction != "out" and drive != "default":
raise GPIOError(None, "Invalid operation: cannot set line drive on input GPIO")
if self._drive == drive:
return
self._reopen(self._direction, self._edge, self._bias, drive, self._inverted)
drive = property(_get_drive, _set_drive)
def _get_inverted(self):
return self._inverted
def _set_inverted(self, inverted):
if not isinstance(inverted, bool):
raise TypeError("Invalid drive type, should be bool.")
if self._inverted == inverted:
return
self._reopen(self._direction, self._edge, self._bias, self._drive, inverted)
inverted = property(_get_inverted, _set_inverted)
# String representation
def __str__(self):
try:
str_name = self.name
except GPIOError:
str_name = "<error>"
try:
str_label = self.label
except GPIOError:
str_label = "<error>"
try:
str_direction = self.direction
except GPIOError:
str_direction = "<error>"
try:
str_edge = self.edge
except GPIOError:
str_edge = "<error>"
try:
str_bias = self.bias
except GPIOError:
str_bias = "<error>"
try:
str_drive = self.drive
except GPIOError:
str_drive = "<error>"
try:
str_inverted = str(self.inverted)
except GPIOError:
str_inverted = "<error>"
try:
str_chip_name = self.chip_name
except GPIOError:
str_chip_name = "<error>"
try:
str_chip_label = self.chip_label
except GPIOError:
str_chip_label = "<error>"
return "GPIO {:d} (name=\"{:s}\", label=\"{:s}\", device={:s}, line_fd={:d}, chip_fd={:d}, direction={:s}, edge={:s}, bias={:s}, drive={:s}, inverted={:s}, chip_name=\"{:s}\", chip_label=\"{:s}\", type=cdev)" \
.format(self._line, str_name, str_label, self._devpath, self._line_fd, self._chip_fd, str_direction, str_edge, str_bias, str_drive, str_inverted, str_chip_name, str_chip_label)
|