2 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
3 * Author: Brendan Le Foll <brendan.le.foll@intel.com>
4 * Copyright (c) 2014, 2015 Intel Corporation.
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 #include "mraa_internal.h"
38 #define SYSFS_CLASS_GPIO "/sys/class/gpio"
43 mraa_gpio_get_valfp(mraa_gpio_context dev)
46 sprintf(bu, SYSFS_CLASS_GPIO "/gpio%d/value", dev->pin);
47 dev->value_fp = open(bu, O_RDWR);
48 if (dev->value_fp == -1) {
49 return MRAA_ERROR_INVALID_RESOURCE;
55 static mraa_gpio_context
56 mraa_gpio_init_internal(mraa_adv_func_t* func_table, int pin)
61 mraa_result_t status = MRAA_SUCCESS;
65 mraa_gpio_context dev = (mraa_gpio_context) calloc(1, sizeof(struct _gpio));
67 syslog(LOG_CRIT, "gpio: Failed to allocate memory for context");
71 dev->advance_func = func_table;
74 if (IS_FUNC_DEFINED(dev, gpio_init_internal_replace)) {
75 status = dev->advance_func->gpio_init_internal_replace(pin);
76 if (status == MRAA_SUCCESS)
79 goto init_internal_cleanup;
82 if (IS_FUNC_DEFINED(dev, gpio_init_pre)) {
83 status = dev->advance_func->gpio_init_pre(pin);
84 if (status != MRAA_SUCCESS)
85 goto init_internal_cleanup;
89 dev->isr_value_fp = -1;
90 dev->isr_thread_terminating = 0;
93 // then check to make sure the pin is exported.
94 char directory[MAX_SIZE];
95 snprintf(directory, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/", dev->pin);
97 if (stat(directory, &dir) == 0 && S_ISDIR(dir.st_mode)) {
98 dev->owner = 0; // Not Owner
100 int export = open(SYSFS_CLASS_GPIO "/export", O_WRONLY);
102 syslog(LOG_ERR, "gpio: Failed to open export for writing");
103 status = MRAA_ERROR_NO_RESOURCES;
104 goto init_internal_cleanup;
106 length = snprintf(bu, sizeof(bu), "%d", dev->pin);
107 if (write(export, bu, length * sizeof(char)) == -1) {
108 syslog(LOG_ERR, "gpio: Failed to write %d to export", dev->pin);
110 status = MRAA_ERROR_NO_RESOURCES;
111 goto init_internal_cleanup;
117 init_internal_cleanup:
118 if (status != MRAA_SUCCESS) {
127 mraa_gpio_init(int pin)
129 mraa_board_t* board = plat;
131 syslog(LOG_ERR, "gpio: platform not initialised");
135 if (mraa_is_sub_platform_id(pin)) {
136 syslog(LOG_NOTICE, "gpio: Using sub platform");
137 board = board->sub_platform;
139 syslog(LOG_ERR, "gpio: Sub platform Not Initialised");
142 pin = mraa_get_sub_platform_index(pin);
145 if (pin < 0 || pin > board->phy_pin_count) {
146 syslog(LOG_ERR, "gpio: pin %i beyond platform definition", pin);
149 if (board->pins[pin].capabilites.gpio != 1) {
150 syslog(LOG_ERR, "gpio: pin %i not capable of gpio", pin);
153 if (board->pins[pin].gpio.mux_total > 0) {
154 if (mraa_setup_mux_mapped(board->pins[pin].gpio) != MRAA_SUCCESS) {
155 syslog(LOG_ERR, "gpio: unable to setup muxes");
160 mraa_gpio_context r = mraa_gpio_init_internal(board->adv_func, board->pins[pin].gpio.pinmap);
162 syslog(LOG_CRIT, "gpio: mraa_gpio_init_raw(%d) returned error", pin);
167 if (IS_FUNC_DEFINED(r, gpio_init_post)) {
168 mraa_result_t ret = r->advance_func->gpio_init_post(r);
169 if (ret != MRAA_SUCCESS) {
178 mraa_gpio_init_raw(int pin)
180 return mraa_gpio_init_internal(plat == NULL ? NULL : plat->adv_func , pin);
185 mraa_gpio_wait_interrupt(int fd)
191 return MRAA_ERROR_INVALID_RESOURCE;
194 // setup poll on POLLPRI
196 pfd.events = POLLPRI;
198 // do an initial read to clear interrupt
199 lseek(fd, 0, SEEK_SET);
202 // Wait for it forever or until pthread_cancel
203 // poll is a cancelable point like sleep()
204 int x = poll(&pfd, 1, -1);
206 // do a final read to clear interrupt
213 mraa_gpio_interrupt_handler(void* arg)
215 mraa_gpio_context dev = (mraa_gpio_context) arg;
216 if (IS_FUNC_DEFINED(dev, gpio_interrupt_handler_replace))
217 return dev->advance_func->gpio_interrupt_handler_replace(dev);
221 // open gpio value with open(3)
223 sprintf(bu, SYSFS_CLASS_GPIO "/gpio%d/value", dev->pin);
224 int fp = open(bu, O_RDONLY);
226 syslog(LOG_ERR, "gpio: failed to open gpio%d/value", dev->pin);
229 dev->isr_value_fp = fp;
232 ret = mraa_gpio_wait_interrupt(dev->isr_value_fp);
233 if (ret == MRAA_SUCCESS && !dev->isr_thread_terminating) {
234 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
236 // In order to call a python object (all python functions are objects) we
237 // need to aquire the GIL (Global Interpreter Lock). This may not always be
238 // necessary but especially if doing IO (like print()) python will segfault
239 // if we do not hold a lock on the GIL
240 PyGILState_STATE gilstate = PyGILState_Ensure();
243 arglist = Py_BuildValue("(O)", dev->isr_args);
244 if (arglist == NULL) {
245 syslog(LOG_ERR, "gpio: Py_BuildValue NULL");
247 ret = PyEval_CallObject((PyObject*) dev->isr, arglist);
249 syslog(LOG_ERR, "gpio: PyEval_CallObject failed");
250 PyObject *pvalue, *ptype, *ptraceback;
251 PyObject *pvalue_pystr, *ptype_pystr, *ptraceback_pystr;
252 char *pvalue_cstr, *ptype_cstr, *ptraceback_cstr;
253 PyErr_Fetch(&pvalue, &ptype, &ptraceback);
254 pvalue_pystr = PyObject_Str(pvalue);
255 ptype_pystr = PyObject_Str(ptype);
256 ptraceback_pystr = PyObject_Str(ptraceback);
258 #if PY_VERSION_HEX < 0x03000000
259 pvalue_cstr = PyString_AsString(pvalue_pystr);
260 ptype_cstr = PyString_AsString(ptype_pystr);
261 ptraceback_cstr = PyString_AsString(ptraceback_pystr);
263 #elif PY_VERSION_HEX >= 0x03000000
264 // In Python 3 we need one extra conversion
265 PyObject *pvalue_ustr, *ptype_ustr, *ptraceback_ustr;
266 pvalue_ustr = PyUnicode_AsUTF8String(pvalue_pystr);
267 pvalue_cstr = PyBytes_AsString(pvalue_ustr);
268 ptype_ustr = PyUnicode_AsUTF8String(ptype_pystr);
269 ptype_cstr = PyBytes_AsString(ptype_ustr);
270 ptraceback_ustr = PyUnicode_AsUTF8String(ptraceback_pystr);
271 ptraceback_cstr = PyBytes_AsString(ptraceback_ustr);
272 #endif // PY_VERSION_HEX
273 syslog(LOG_ERR, "gpio: the error was %s:%s:%s",
280 Py_XDECREF(ptraceback);
281 Py_XDECREF(pvalue_pystr);
282 Py_XDECREF(ptype_pystr);
283 Py_XDECREF(ptraceback_pystr);
285 #if PY_VERSION_HEX >= 0x03000000
286 Py_XDECREF(pvalue_ustr);
287 Py_XDECREF(ptype_ustr);
288 Py_XDECREF(ptraceback_ustr);
289 #endif // PY_VERSION_HEX
296 PyGILState_Release(gilstate);
298 dev->isr(dev->isr_args);
300 pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
302 // we must have got an error code or exit request so die nicely
303 pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
304 close(dev->isr_value_fp);
305 dev->isr_value_fp = -1;
312 mraa_gpio_edge_mode(mraa_gpio_context dev, mraa_gpio_edge_t mode)
314 if (IS_FUNC_DEFINED(dev, gpio_edge_mode_replace))
315 return dev->advance_func->gpio_edge_mode_replace(dev, mode);
317 if (dev->value_fp != -1) {
318 close(dev->value_fp);
322 char filepath[MAX_SIZE];
323 snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/edge", dev->pin);
325 int edge = open(filepath, O_RDWR);
327 syslog(LOG_ERR, "gpio: Failed to open edge for writing");
328 return MRAA_ERROR_INVALID_RESOURCE;
334 case MRAA_GPIO_EDGE_NONE:
335 length = snprintf(bu, sizeof(bu), "none");
337 case MRAA_GPIO_EDGE_BOTH:
338 length = snprintf(bu, sizeof(bu), "both");
340 case MRAA_GPIO_EDGE_RISING:
341 length = snprintf(bu, sizeof(bu), "rising");
343 case MRAA_GPIO_EDGE_FALLING:
344 length = snprintf(bu, sizeof(bu), "falling");
348 return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
350 if (write(edge, bu, length * sizeof(char)) == -1) {
351 syslog(LOG_ERR, "gpio: Failed to write to edge");
353 return MRAA_ERROR_INVALID_RESOURCE;
361 mraa_gpio_isr(mraa_gpio_context dev, mraa_gpio_edge_t mode, void (*fptr)(void*), void* args)
363 // we only allow one isr per mraa_gpio_context
364 if (dev->thread_id != 0) {
365 return MRAA_ERROR_NO_RESOURCES;
368 if (MRAA_SUCCESS != mraa_gpio_edge_mode(dev, mode)) {
369 return MRAA_ERROR_UNSPECIFIED;
373 dev->isr_args = args;
374 pthread_create(&dev->thread_id, NULL, mraa_gpio_interrupt_handler, (void*) dev);
380 mraa_gpio_isr_exit(mraa_gpio_context dev)
382 mraa_result_t ret = MRAA_SUCCESS;
384 // wasting our time, there is no isr to exit from
385 if (dev->thread_id == 0 && dev->isr_value_fp == -1) {
388 // mark the beginning of the thread termination process for interested parties
389 dev->isr_thread_terminating = 1;
391 // stop isr being useful
392 ret = mraa_gpio_edge_mode(dev, MRAA_GPIO_EDGE_NONE);
394 if ((dev->thread_id != 0)) {
395 if ((pthread_cancel(dev->thread_id) != 0) || (pthread_join(dev->thread_id, NULL) != 0)) {
396 ret = MRAA_ERROR_INVALID_HANDLE;
400 // close the filehandle in case it's still open
401 if (dev->isr_value_fp != -1) {
402 if (close(dev->isr_value_fp) != 0) {
403 ret = MRAA_ERROR_INVALID_PARAMETER;
407 // assume our thread will exit either way we just lost it's handle
409 dev->isr_value_fp = -1;
410 dev->isr_thread_terminating = 0;
415 mraa_gpio_mode(mraa_gpio_context dev, mraa_gpio_mode_t mode)
417 if (IS_FUNC_DEFINED(dev, gpio_mode_replace))
418 return dev->advance_func->gpio_mode_replace(dev, mode);
420 if (IS_FUNC_DEFINED(dev, gpio_mode_pre)) {
421 mraa_result_t pre_ret = (dev->advance_func->gpio_mode_pre(dev, mode));
422 if (pre_ret != MRAA_SUCCESS)
426 if (dev->value_fp != -1) {
427 close(dev->value_fp);
431 char filepath[MAX_SIZE];
432 snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/drive", dev->pin);
434 int drive = open(filepath, O_WRONLY);
436 syslog(LOG_ERR, "gpio: Failed to open drive for writing");
437 return MRAA_ERROR_INVALID_RESOURCE;
443 case MRAA_GPIO_STRONG:
444 length = snprintf(bu, sizeof(bu), "strong");
446 case MRAA_GPIO_PULLUP:
447 length = snprintf(bu, sizeof(bu), "pullup");
449 case MRAA_GPIO_PULLDOWN:
450 length = snprintf(bu, sizeof(bu), "pulldown");
453 length = snprintf(bu, sizeof(bu), "hiz");
457 return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
459 if (write(drive, bu, length * sizeof(char)) == -1) {
460 syslog(LOG_ERR, "gpio: Failed to write to drive mode");
462 return MRAA_ERROR_INVALID_RESOURCE;
466 if (IS_FUNC_DEFINED(dev, gpio_mode_post))
467 return dev->advance_func->gpio_mode_post(dev, mode);
472 mraa_gpio_dir(mraa_gpio_context dev, mraa_gpio_dir_t dir)
474 if (IS_FUNC_DEFINED(dev, gpio_dir_replace)) {
475 return dev->advance_func->gpio_dir_replace(dev, dir);
478 if (IS_FUNC_DEFINED(dev, gpio_dir_pre)) {
479 mraa_result_t pre_ret = (dev->advance_func->gpio_dir_pre(dev, dir));
480 if (pre_ret != MRAA_SUCCESS) {
486 return MRAA_ERROR_INVALID_HANDLE;
488 if (dev->value_fp != -1) {
489 close(dev->value_fp);
492 char filepath[MAX_SIZE];
493 snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/direction", dev->pin);
495 int direction = open(filepath, O_RDWR);
497 if (direction == -1) {
498 // Direction Failed to Open. If HIGH or LOW was passed will try and set
499 // If not fail as usual.
501 case MRAA_GPIO_OUT_HIGH:
502 return mraa_gpio_write(dev, 1);
503 case MRAA_GPIO_OUT_LOW:
504 return mraa_gpio_write(dev, 0);
506 return MRAA_ERROR_INVALID_RESOURCE;
514 length = snprintf(bu, sizeof(bu), "out");
517 length = snprintf(bu, sizeof(bu), "in");
519 case MRAA_GPIO_OUT_HIGH:
520 length = snprintf(bu, sizeof(bu), "high");
522 case MRAA_GPIO_OUT_LOW:
523 length = snprintf(bu, sizeof(bu), "low");
527 return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
530 if (write(direction, bu, length * sizeof(char)) == -1) {
532 return MRAA_ERROR_INVALID_RESOURCE;
536 if (IS_FUNC_DEFINED(dev, gpio_dir_post))
537 return dev->advance_func->gpio_dir_post(dev, dir);
542 mraa_gpio_read(mraa_gpio_context dev)
547 if (IS_FUNC_DEFINED(dev, gpio_read_replace))
548 return dev->advance_func->gpio_read_replace(dev);
550 if (dev->mmap_read != NULL)
551 return dev->mmap_read(dev);
553 if (dev->value_fp == -1) {
554 if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
555 syslog(LOG_ERR, "gpio: Failed to get value file pointer");
559 // if value_fp is new this is pointless
560 lseek(dev->value_fp, 0, SEEK_SET);
563 if (read(dev->value_fp, bu, 2 * sizeof(char)) != 2) {
564 syslog(LOG_ERR, "gpio: Failed to read a sensible value from sysfs");
567 lseek(dev->value_fp, 0, SEEK_SET);
569 return (int) strtol(bu, NULL, 10);
573 mraa_gpio_write(mraa_gpio_context dev, int value)
576 return MRAA_ERROR_INVALID_HANDLE;
578 if (dev->mmap_write != NULL)
579 return dev->mmap_write(dev, value);
581 if (IS_FUNC_DEFINED(dev, gpio_write_pre)) {
582 mraa_result_t pre_ret = (dev->advance_func->gpio_write_pre(dev, value));
583 if (pre_ret != MRAA_SUCCESS)
587 if (IS_FUNC_DEFINED(dev, gpio_write_replace)) {
588 return dev->advance_func->gpio_write_replace(dev, value);
591 if (dev->value_fp == -1) {
592 if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
593 return MRAA_ERROR_INVALID_RESOURCE;
597 if (lseek(dev->value_fp, 0, SEEK_SET) == -1) {
598 return MRAA_ERROR_INVALID_RESOURCE;
602 int length = snprintf(bu, sizeof(bu), "%d", value);
603 if (write(dev->value_fp, bu, length * sizeof(char)) == -1) {
604 return MRAA_ERROR_INVALID_HANDLE;
607 if (IS_FUNC_DEFINED(dev, gpio_write_post))
608 return dev->advance_func->gpio_write_post(dev, value);
613 mraa_gpio_unexport_force(mraa_gpio_context dev)
615 int unexport = open(SYSFS_CLASS_GPIO "/unexport", O_WRONLY);
616 if (unexport == -1) {
617 syslog(LOG_ERR, "gpio: Failed to open unexport for writing");
618 return MRAA_ERROR_INVALID_RESOURCE;
622 int length = snprintf(bu, sizeof(bu), "%d", dev->pin);
623 if (write(unexport, bu, length * sizeof(char)) == -1) {
624 syslog(LOG_ERR, "gpio: Failed to write to unexport");
626 return MRAA_ERROR_INVALID_RESOURCE;
630 mraa_gpio_isr_exit(dev);
634 mraa_gpio_unexport(mraa_gpio_context dev)
637 return mraa_gpio_unexport_force(dev);
639 return MRAA_ERROR_INVALID_RESOURCE;
643 mraa_gpio_close(mraa_gpio_context dev)
645 mraa_result_t result = MRAA_SUCCESS;
647 if (IS_FUNC_DEFINED(dev, gpio_close_pre)) {
648 result = dev->advance_func->gpio_close_pre(dev);
651 if (dev->value_fp != -1) {
652 close(dev->value_fp);
654 mraa_gpio_unexport(dev);
660 mraa_gpio_owner(mraa_gpio_context dev, mraa_boolean_t own)
663 return MRAA_ERROR_INVALID_RESOURCE;
665 syslog(LOG_DEBUG, "gpio: Set owner to %d", (int) own);
671 mraa_gpio_use_mmaped(mraa_gpio_context dev, mraa_boolean_t mmap_en)
673 if (IS_FUNC_DEFINED(dev, gpio_mmap_setup)) {
674 return dev->advance_func->gpio_mmap_setup(dev, mmap_en);
677 syslog(LOG_ERR, "gpio: mmap not implemented on this platform");
678 return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
682 mraa_gpio_get_pin(mraa_gpio_context dev)
685 syslog(LOG_ERR, "gpio: context is invalid");
692 mraa_gpio_get_pin_raw(mraa_gpio_context dev)
695 syslog(LOG_ERR, "gpio: context is invalid");