src/gpio/gpio.c

   1 /*
   2  * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
   3  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   4  * Copyright (c) 2014 Intel Corporation.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  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.
  24  */
  25 #include "gpio.h"
  26 #include "mraa_internal.h"
  27
  28 #include <stdlib.h>
  29 #include <fcntl.h>
  30 #include <string.h>
  31 #include <unistd.h>
  32 #include <poll.h>
  33 #include <pthread.h>
  34 #include <signal.h>
  35 #include <sys/stat.h>
  36 #include <sys/mman.h>
  37
  38 #define SYSFS_CLASS_GPIO "/sys/class/gpio"
  39 #define MAX_SIZE 64
  40 #define POLL_TIMEOUT
  41
  42 static mraa_result_t
  43 mraa_gpio_get_valfp(mraa_gpio_context dev)
  44 {
  45     char bu[MAX_SIZE];
  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;
  50     }
  51
  52     return MRAA_SUCCESS;
  53 }
  54
  55 mraa_gpio_context
  56 mraa_gpio_init(int pin)
  57 {
  58     if (plat == NULL) {
  59         syslog(LOG_ERR, "gpio: platform not initialised");
  60         return NULL;
  61     }
  62     if (pin < 0 || pin > plat->phy_pin_count) {
  63         syslog(LOG_ERR, "gpio: pin %i beyond platform definition", pin);
  64         return NULL;
  65     }
  66     if (plat->pins[pin].capabilites.gpio != 1) {
  67         syslog(LOG_ERR, "gpio: pin %i not capable of gpio", pin);
  68         return NULL;
  69     }
  70     if (plat->pins[pin].gpio.mux_total > 0) {
  71         if (mraa_setup_mux_mapped(plat->pins[pin].gpio) != MRAA_SUCCESS) {
  72             syslog(LOG_ERR, "gpio: unable to setup muxes");
  73             return NULL;
  74         }
  75     }
  76
  77     mraa_gpio_context r = mraa_gpio_init_raw(plat->pins[pin].gpio.pinmap);
  78     if (r == NULL) {
  79         syslog(LOG_CRIT, "gpio: mraa_gpio_init_raw(%d) returned error", pin);
  80         return NULL;
  81     }
  82     r->phy_pin = pin;
  83
  84     if (advance_func->gpio_init_post != NULL) {
  85         mraa_result_t ret = advance_func->gpio_init_post(r);
  86         if (ret != MRAA_SUCCESS) {
  87             free(r);
  88             return NULL;
  89         }
  90     }
  91     return r;
  92 }
  93
  94 mraa_gpio_context
  95 mraa_gpio_init_raw(int pin)
  96 {
  97     if (advance_func->gpio_init_pre != NULL) {
  98         if (advance_func->gpio_init_pre(pin) != MRAA_SUCCESS)
  99             return NULL;
 100     }
 101
 102     if (pin < 0)
 103         return NULL;
 104
 105     char bu[MAX_SIZE];
 106     int length;
 107
 108     mraa_gpio_context dev = (mraa_gpio_context) malloc(sizeof(struct _gpio));
 109     if (dev == NULL) {
 110         syslog(LOG_CRIT, "gpio: Failed to allocate memory for context");
 111         return NULL;
 112     }
 113
 114     memset(dev, 0, sizeof(struct _gpio));
 115     dev->value_fp = -1;
 116     dev->isr_value_fp = -1;
 117     dev->pin = pin;
 118     dev->phy_pin = -1;
 119
 120     char directory[MAX_SIZE];
 121     snprintf(directory, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/", dev->pin);
 122     struct stat dir;
 123     if (stat(directory, &dir) == 0 && S_ISDIR(dir.st_mode)) {
 124         dev->owner = 0; // Not Owner
 125     } else {
 126         int export = open(SYSFS_CLASS_GPIO "/export", O_WRONLY);
 127         if (export == -1) {
 128             syslog(LOG_ERR, "gpio: Failed to open export for writing");
 129             free(dev);
 130             return NULL;
 131         }
 132         length = snprintf(bu, sizeof(bu), "%d", dev->pin);
 133         if (write(export, bu, length*sizeof(char)) == -1) {
 134             syslog(LOG_ERR, "gpio: Failed to write to export");
 135             close(export);
 136             free(dev);
 137             return NULL;
 138         }
 139         dev->owner = 1;
 140         close(export);
 141     }
 142
 143     return dev;
 144 }
 145
 146
 147 static mraa_result_t
 148 mraa_gpio_wait_interrupt(int fd)
 149 {
 150     unsigned char c;
 151     struct pollfd pfd;
 152
 153     // setup poll on POLLPRI
 154     pfd.fd = fd;
 155     pfd.events = POLLPRI;
 156
 157     // do an initial read to clear interupt
 158     read (fd, &c, 1);
 159
 160     if (fd <= 0) {
 161         return MRAA_ERROR_INVALID_RESOURCE;
 162     }
 163
 164     // Wait for it forever or until pthread_cancel
 165     // poll is a cancelable point like sleep()
 166     int x = poll (&pfd, 1, -1);
 167
 168     // do a final read to clear interupt
 169     read (fd, &c, 1);
 170
 171     return MRAA_SUCCESS;
 172 }
 173
 174 static void*
 175 mraa_gpio_interrupt_handler(void* arg)
 176 {
 177     mraa_gpio_context dev = (mraa_gpio_context) arg;
 178     mraa_result_t ret;
 179
 180     // open gpio value with open(3)
 181     char bu[MAX_SIZE];
 182     sprintf(bu, SYSFS_CLASS_GPIO "/gpio%d/value", dev->pin);
 183     int fp = open(bu, O_RDONLY);
 184     if (fp < 0) {
 185         syslog(LOG_ERR, "gpio: failed to open gpio%d/value", dev->pin);
 186         return NULL;
 187     }
 188     dev->isr_value_fp = fp;
 189
 190     for (;;) {
 191         ret = mraa_gpio_wait_interrupt(dev->isr_value_fp);
 192         if (ret == MRAA_SUCCESS) {
 193             pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
 194 #ifdef SWIGPYTHON
 195             // In order to call a python object (all python functions are objects) we
 196             // need to aquire the GIL (Global Interpreter Lock). This may not always be
 197             // nessecary but especially if doing IO (like print()) python will segfault
 198             // if we do not hold a lock on the GIL
 199             PyGILState_STATE gilstate = PyGILState_Ensure();
 200             PyObject *arglist;
 201             PyObject *ret;
 202             arglist = Py_BuildValue("(i)", dev->isr_args);
 203             if (arglist == NULL) {
 204                 syslog(LOG_ERR, "gpio: Py_BuildValue NULL");
 205             } else {
 206                 ret = PyEval_CallObject((PyObject*)dev->isr, arglist);
 207                 if (ret == NULL) {
 208                     syslog(LOG_ERR, "gpio: PyEval_CallObject failed");
 209                 } else {
 210                     Py_DECREF(ret);
 211                 }
 212                 Py_DECREF(arglist);
 213             }
 214
 215             PyGILState_Release (gilstate);
 216 #else
 217             dev->isr(dev->isr_args);
 218 #endif
 219             pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
 220         } else {
 221         // we must have got an error code so die nicely
 222             pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
 223             close(dev->isr_value_fp);
 224             dev->isr_value_fp = -1;
 225             return NULL;
 226         }
 227     }
 228 }
 229
 230 mraa_result_t
 231 mraa_gpio_edge_mode(mraa_gpio_context dev, gpio_edge_t mode)
 232 {
 233     if (dev->value_fp != -1) {
 234          close(dev->value_fp);
 235          dev->value_fp = -1;
 236     }
 237
 238     char filepath[MAX_SIZE];
 239     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/edge", dev->pin);
 240
 241     int edge = open(filepath, O_RDWR);
 242     if (edge == -1) {
 243         syslog(LOG_ERR, "gpio: Failed to open edge for writing");
 244         return MRAA_ERROR_INVALID_RESOURCE;
 245     }
 246
 247     char bu[MAX_SIZE];
 248     int length;
 249     switch(mode) {
 250         case MRAA_GPIO_EDGE_NONE:
 251             length = snprintf(bu, sizeof(bu), "none");
 252             break;
 253         case MRAA_GPIO_EDGE_BOTH:
 254             length = snprintf(bu, sizeof(bu), "both");
 255             break;
 256         case MRAA_GPIO_EDGE_RISING:
 257             length = snprintf(bu, sizeof(bu), "rising");
 258             break;
 259         case MRAA_GPIO_EDGE_FALLING:
 260             length = snprintf(bu, sizeof(bu), "falling");
 261             break;
 262         default:
 263             close(edge);
 264             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 265     }
 266     if (write(edge, bu, length*sizeof(char)) == -1) {
 267         syslog(LOG_ERR, "gpio: Failed to write to edge");
 268         close(edge);
 269         return MRAA_ERROR_INVALID_RESOURCE;
 270     }
 271
 272     close(edge);
 273     return MRAA_SUCCESS;
 274 }
 275
 276 mraa_result_t
 277 mraa_gpio_isr(mraa_gpio_context dev, gpio_edge_t mode, void (*fptr)(void *), void * args)
 278 {
 279     // we only allow one isr per mraa_gpio_context
 280     if (dev->thread_id != 0) {
 281         return MRAA_ERROR_NO_RESOURCES;
 282     }
 283
 284     if (MRAA_SUCCESS != mraa_gpio_edge_mode(dev, mode)) {
 285         return MRAA_ERROR_UNSPECIFIED;
 286     }
 287
 288     dev->isr = fptr;
 289     dev->isr_args = args;
 290     pthread_create (&dev->thread_id, NULL, mraa_gpio_interrupt_handler, (void *) dev);
 291
 292     return MRAA_SUCCESS;
 293 }
 294
 295 mraa_result_t
 296 mraa_gpio_isr_exit(mraa_gpio_context dev)
 297 {
 298     mraa_result_t ret = MRAA_SUCCESS;
 299
 300     // wasting our time, there is no isr to exit from
 301     if (dev->thread_id == 0 && dev->isr_value_fp == -1) {
 302         return ret;
 303     }
 304
 305     // stop isr being useful
 306     ret = mraa_gpio_edge_mode(dev, MRAA_GPIO_EDGE_NONE);
 307
 308     if ((dev->thread_id != 0)) {
 309         if ((pthread_cancel(dev->thread_id) != 0) || (pthread_join(dev->thread_id, NULL) != 0)) {
 310             ret = MRAA_ERROR_INVALID_HANDLE;
 311         }
 312     }
 313
 314     // close the filehandle in case it's still open
 315     if (dev->isr_value_fp != -1) {
 316           if (close(dev->isr_value_fp) != 0) {
 317               ret = MRAA_ERROR_INVALID_PARAMETER;
 318           }
 319     }
 320
 321 #ifdef SWIGPYTHON
 322     // Dereference our Python call back function
 323     Py_DECREF(dev->isr);
 324 #endif
 325
 326     // assume our thread will exit either way we just lost it's handle
 327     dev->thread_id = 0;
 328     dev->isr_value_fp = -1;
 329     return ret;
 330 }
 331
 332 mraa_result_t
 333 mraa_gpio_mode(mraa_gpio_context dev, gpio_mode_t mode)
 334 {
 335     if (advance_func->gpio_mode_replace != NULL)
 336         return advance_func->gpio_mode_replace(dev,mode);
 337
 338     if (advance_func->gpio_mode_pre != NULL) {
 339         mraa_result_t pre_ret = (advance_func->gpio_mode_pre(dev,mode));
 340         if(pre_ret != MRAA_SUCCESS)
 341             return pre_ret;
 342     }
 343
 344     if (dev->value_fp != -1) {
 345          close(dev->value_fp);
 346          dev->value_fp = -1;
 347     }
 348
 349     char filepath[MAX_SIZE];
 350     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/drive", dev->pin);
 351
 352     int drive = open(filepath, O_WRONLY);
 353     if (drive == -1) {
 354         syslog(LOG_ERR, "gpio: Failed to open drive for writing");
 355         return MRAA_ERROR_INVALID_RESOURCE;
 356     }
 357
 358     char bu[MAX_SIZE];
 359     int length;
 360     switch(mode) {
 361         case MRAA_GPIO_STRONG:
 362             length = snprintf(bu, sizeof(bu), "strong");
 363             break;
 364         case MRAA_GPIO_PULLUP:
 365             length = snprintf(bu, sizeof(bu), "pullup");
 366             break;
 367         case MRAA_GPIO_PULLDOWN:
 368             length = snprintf(bu, sizeof(bu), "pulldown");
 369             break;
 370         case MRAA_GPIO_HIZ:
 371             length = snprintf(bu, sizeof(bu), "hiz");
 372             break;
 373         default:
 374             close(drive);
 375             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 376     }
 377     if (write(drive, bu, length*sizeof(char)) == -1) {
 378         syslog(LOG_ERR, "gpio: Failed to write to drive mode");
 379         close(drive);
 380         return MRAA_ERROR_INVALID_RESOURCE;
 381
 382     }
 383
 384     close(drive);
 385     if (advance_func->gpio_mode_post != NULL)
 386         return advance_func->gpio_mode_post(dev,mode);
 387     return MRAA_SUCCESS;
 388 }
 389
 390 mraa_result_t
 391 mraa_gpio_dir(mraa_gpio_context dev, gpio_dir_t dir)
 392 {
 393     if (advance_func->gpio_dir_replace != NULL) {
 394         return advance_func->gpio_dir_replace(dev,dir);
 395     }
 396     if (advance_func->gpio_dir_pre != NULL) {
 397         mraa_result_t pre_ret = (advance_func->gpio_dir_pre(dev,dir));
 398         if (pre_ret != MRAA_SUCCESS) {
 399             return pre_ret;
 400         }
 401     }
 402
 403     if (dev == NULL) {
 404         return MRAA_ERROR_INVALID_HANDLE;
 405     }
 406     if (dev->value_fp != -1) {
 407          close(dev->value_fp);
 408          dev->value_fp = -1;
 409     }
 410     char filepath[MAX_SIZE];
 411     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/direction", dev->pin);
 412
 413     int direction = open(filepath, O_RDWR);
 414
 415     if (direction == -1) {
 416         return MRAA_ERROR_INVALID_RESOURCE;
 417     }
 418
 419     char bu[MAX_SIZE];
 420     int length;
 421     switch(dir) {
 422         case MRAA_GPIO_OUT:
 423             length = snprintf(bu, sizeof(bu), "out");
 424             break;
 425         case MRAA_GPIO_IN:
 426             length = snprintf(bu, sizeof(bu), "in");
 427             break;
 428         default:
 429             close(direction);
 430             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 431     }
 432
 433     if (write(direction, bu, length*sizeof(char)) == -1) {
 434         close(direction);
 435         return MRAA_ERROR_INVALID_RESOURCE;
 436     }
 437
 438     close(direction);
 439     if (advance_func->gpio_dir_post != NULL)
 440         return advance_func->gpio_dir_post(dev,dir);
 441     return MRAA_SUCCESS;
 442 }
 443
 444 int
 445 mraa_gpio_read(mraa_gpio_context dev)
 446 {
 447     if (dev == NULL)
 448         return -1;
 449
 450     if (dev->mmap_read != NULL)
 451         return dev->mmap_read(dev);
 452
 453     if (dev->value_fp == -1) {
 454         if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
 455             syslog(LOG_ERR, "gpio: Failed to get value file pointer");
 456             return -1;
 457         }
 458     }
 459     else {
 460         // if value_fp is new this is pointless
 461         lseek(dev->value_fp, 0, SEEK_SET);
 462     }
 463     char bu[2];
 464     if (read(dev->value_fp, bu, 2*sizeof(char)) != 2) {
 465         syslog(LOG_ERR, "gpio: Failed to read a sensible value from sysfs");
 466         return -1;
 467     }
 468     lseek(dev->value_fp, 0, SEEK_SET);
 469
 470     return (int) strtol(bu, NULL, 10);
 471 }
 472
 473 mraa_result_t
 474 mraa_gpio_write(mraa_gpio_context dev, int value)
 475 {
 476     if (dev == NULL)
 477         return MRAA_ERROR_INVALID_HANDLE;
 478
 479     if (dev->mmap_write != NULL)
 480         return dev->mmap_write(dev,value);
 481
 482     if (advance_func->gpio_write_pre != NULL) {
 483         mraa_result_t pre_ret = (advance_func->gpio_write_pre(dev,value));
 484         if(pre_ret != MRAA_SUCCESS)
 485             return pre_ret;
 486     }
 487
 488     if (dev->value_fp == -1) {
 489         if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
 490             return MRAA_ERROR_INVALID_RESOURCE;
 491         }
 492     }
 493
 494     if (lseek(dev->value_fp, 0, SEEK_SET) == -1) {
 495         return MRAA_ERROR_INVALID_RESOURCE;
 496     }
 497
 498     char bu[MAX_SIZE];
 499     int length = snprintf(bu, sizeof(bu), "%d", value);
 500     if (write(dev->value_fp, bu, length*sizeof(char)) == -1) {
 501         return MRAA_ERROR_INVALID_HANDLE;
 502     }
 503
 504     if (advance_func->gpio_write_post != NULL)
 505         return advance_func->gpio_write_post(dev,value);
 506     return MRAA_SUCCESS;
 507 }
 508
 509 static mraa_result_t
 510 mraa_gpio_unexport_force(mraa_gpio_context dev)
 511 {
 512     int unexport = open(SYSFS_CLASS_GPIO "/unexport", O_WRONLY);
 513     if (unexport == -1) {
 514         syslog(LOG_ERR, "gpio: Failed to open unexport for writing");
 515         return MRAA_ERROR_INVALID_RESOURCE;
 516     }
 517
 518     char bu[MAX_SIZE];
 519     int length = snprintf(bu, sizeof(bu), "%d", dev->pin);
 520     if (write(unexport, bu, length*sizeof(char)) == -1) {
 521         syslog(LOG_ERR, "gpio: Failed to write to unexport");
 522         close(unexport);
 523         return MRAA_ERROR_INVALID_RESOURCE;
 524     }
 525
 526     close(unexport);
 527     mraa_gpio_isr_exit(dev);
 528     return MRAA_SUCCESS;
 529 }
 530 static mraa_result_t
 531 mraa_gpio_unexport(mraa_gpio_context dev)
 532 {
 533     if(dev->owner) {
 534         return mraa_gpio_unexport_force(dev);
 535     }
 536     return MRAA_ERROR_INVALID_RESOURCE;
 537 }
 538
 539 mraa_result_t
 540 mraa_gpio_close(mraa_gpio_context dev)
 541 {
 542     if (dev->value_fp != -1) {
 543         close(dev->value_fp);
 544     }
 545     mraa_gpio_unexport(dev);
 546     free(dev);
 547     return MRAA_SUCCESS;
 548 }
 549
 550 mraa_result_t
 551 mraa_gpio_owner(mraa_gpio_context dev, mraa_boolean_t own)
 552 {
 553     if (dev == NULL)
 554         return MRAA_ERROR_INVALID_RESOURCE;
 555     dev->owner = own;
 556     return MRAA_SUCCESS;
 557 }
 558
 559 mraa_result_t
 560 mraa_gpio_use_mmaped(mraa_gpio_context dev, mraa_boolean_t mmap_en)
 561 {
 562     if (advance_func->gpio_mmap_setup != NULL) {
 563         return advance_func->gpio_mmap_setup(dev,mmap_en);
 564     }
 565
 566     syslog(LOG_ERR, "gpio: mmap not implemented on this platform");
 567     return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 568 }