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     // then check to make sure the pin is exported.
 121     char directory[MAX_SIZE];
 122     snprintf(directory, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/", dev->pin);
 123     struct stat dir;
 124     if (stat(directory, &dir) == 0 && S_ISDIR(dir.st_mode)) {
 125         dev->owner = 0; // Not Owner
 126     } else {
 127         int export = open(SYSFS_CLASS_GPIO "/export", O_WRONLY);
 128         if (export == -1) {
 129             syslog(LOG_ERR, "gpio: Failed to open export for writing");
 130             free(dev);
 131             return NULL;
 132         }
 133         length = snprintf(bu, sizeof(bu), "%d", dev->pin);
 134         if (write(export, bu, length*sizeof(char)) == -1) {
 135             syslog(LOG_ERR, "gpio: Failed to write to export");
 136             close(export);
 137             free(dev);
 138             return NULL;
 139         }
 140         dev->owner = 1;
 141         close(export);
 142     }
 143
 144     return dev;
 145 }
 146
 147
 148 static mraa_result_t
 149 mraa_gpio_wait_interrupt(int fd)
 150 {
 151     unsigned char c;
 152     struct pollfd pfd;
 153
 154     // setup poll on POLLPRI
 155     pfd.fd = fd;
 156     pfd.events = POLLPRI;
 157
 158     // do an initial read to clear interupt
 159     read (fd, &c, 1);
 160
 161     if (fd <= 0) {
 162         return MRAA_ERROR_INVALID_RESOURCE;
 163     }
 164
 165     // Wait for it forever or until pthread_cancel
 166     // poll is a cancelable point like sleep()
 167     int x = poll (&pfd, 1, -1);
 168
 169     // do a final read to clear interupt
 170     read (fd, &c, 1);
 171
 172     return MRAA_SUCCESS;
 173 }
 174
 175 static void*
 176 mraa_gpio_interrupt_handler(void* arg)
 177 {
 178     mraa_gpio_context dev = (mraa_gpio_context) arg;
 179     mraa_result_t ret;
 180
 181     // open gpio value with open(3)
 182     char bu[MAX_SIZE];
 183     sprintf(bu, SYSFS_CLASS_GPIO "/gpio%d/value", dev->pin);
 184     int fp = open(bu, O_RDONLY);
 185     if (fp < 0) {
 186         syslog(LOG_ERR, "gpio: failed to open gpio%d/value", dev->pin);
 187         return NULL;
 188     }
 189     dev->isr_value_fp = fp;
 190
 191     for (;;) {
 192         ret = mraa_gpio_wait_interrupt(dev->isr_value_fp);
 193         if (ret == MRAA_SUCCESS) {
 194             pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
 195 #ifdef SWIGPYTHON
 196             // In order to call a python object (all python functions are objects) we
 197             // need to aquire the GIL (Global Interpreter Lock). This may not always be
 198             // nessecary but especially if doing IO (like print()) python will segfault
 199             // if we do not hold a lock on the GIL
 200             PyGILState_STATE gilstate = PyGILState_Ensure();
 201             PyObject *arglist;
 202             PyObject *ret;
 203             arglist = Py_BuildValue("(i)", dev->isr_args);
 204             if (arglist == NULL) {
 205                 syslog(LOG_ERR, "gpio: Py_BuildValue NULL");
 206             } else {
 207                 ret = PyEval_CallObject((PyObject*)dev->isr, arglist);
 208                 if (ret == NULL) {
 209                     syslog(LOG_ERR, "gpio: PyEval_CallObject failed");
 210                 } else {
 211                     Py_DECREF(ret);
 212                 }
 213                 Py_DECREF(arglist);
 214             }
 215
 216             PyGILState_Release (gilstate);
 217 #else
 218             dev->isr(dev->isr_args);
 219 #endif
 220             pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
 221         } else {
 222         // we must have got an error code so die nicely
 223             pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
 224             close(dev->isr_value_fp);
 225             dev->isr_value_fp = -1;
 226             return NULL;
 227         }
 228     }
 229 }
 230
 231 mraa_result_t
 232 mraa_gpio_edge_mode(mraa_gpio_context dev, gpio_edge_t mode)
 233 {
 234     if (dev->value_fp != -1) {
 235          close(dev->value_fp);
 236          dev->value_fp = -1;
 237     }
 238
 239     char filepath[MAX_SIZE];
 240     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/edge", dev->pin);
 241
 242     int edge = open(filepath, O_RDWR);
 243     if (edge == -1) {
 244         syslog(LOG_ERR, "gpio: Failed to open edge for writing");
 245         return MRAA_ERROR_INVALID_RESOURCE;
 246     }
 247
 248     char bu[MAX_SIZE];
 249     int length;
 250     switch(mode) {
 251         case MRAA_GPIO_EDGE_NONE:
 252             length = snprintf(bu, sizeof(bu), "none");
 253             break;
 254         case MRAA_GPIO_EDGE_BOTH:
 255             length = snprintf(bu, sizeof(bu), "both");
 256             break;
 257         case MRAA_GPIO_EDGE_RISING:
 258             length = snprintf(bu, sizeof(bu), "rising");
 259             break;
 260         case MRAA_GPIO_EDGE_FALLING:
 261             length = snprintf(bu, sizeof(bu), "falling");
 262             break;
 263         default:
 264             close(edge);
 265             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 266     }
 267     if (write(edge, bu, length*sizeof(char)) == -1) {
 268         syslog(LOG_ERR, "gpio: Failed to write to edge");
 269         close(edge);
 270         return MRAA_ERROR_INVALID_RESOURCE;
 271     }
 272
 273     close(edge);
 274     return MRAA_SUCCESS;
 275 }
 276
 277 mraa_result_t
 278 mraa_gpio_isr(mraa_gpio_context dev, gpio_edge_t mode, void (*fptr)(void *), void * args)
 279 {
 280     // we only allow one isr per mraa_gpio_context
 281     if (dev->thread_id != 0) {
 282         return MRAA_ERROR_NO_RESOURCES;
 283     }
 284
 285     if (MRAA_SUCCESS != mraa_gpio_edge_mode(dev, mode)) {
 286         return MRAA_ERROR_UNSPECIFIED;
 287     }
 288
 289     dev->isr = fptr;
 290     dev->isr_args = args;
 291     pthread_create (&dev->thread_id, NULL, mraa_gpio_interrupt_handler, (void *) dev);
 292
 293     return MRAA_SUCCESS;
 294 }
 295
 296 mraa_result_t
 297 mraa_gpio_isr_exit(mraa_gpio_context dev)
 298 {
 299     mraa_result_t ret = MRAA_SUCCESS;
 300
 301     // wasting our time, there is no isr to exit from
 302     if (dev->thread_id == 0 && dev->isr_value_fp == -1) {
 303         return ret;
 304     }
 305
 306     // stop isr being useful
 307     ret = mraa_gpio_edge_mode(dev, MRAA_GPIO_EDGE_NONE);
 308
 309     if ((dev->thread_id != 0)) {
 310         if ((pthread_cancel(dev->thread_id) != 0) || (pthread_join(dev->thread_id, NULL) != 0)) {
 311             ret = MRAA_ERROR_INVALID_HANDLE;
 312         }
 313     }
 314
 315     // close the filehandle in case it's still open
 316     if (dev->isr_value_fp != -1) {
 317           if (close(dev->isr_value_fp) != 0) {
 318               ret = MRAA_ERROR_INVALID_PARAMETER;
 319           }
 320     }
 321
 322 #ifdef SWIGPYTHON
 323     // Dereference our Python call back function
 324     Py_DECREF(dev->isr);
 325 #endif
 326
 327     // assume our thread will exit either way we just lost it's handle
 328     dev->thread_id = 0;
 329     dev->isr_value_fp = -1;
 330     return ret;
 331 }
 332
 333 mraa_result_t
 334 mraa_gpio_mode(mraa_gpio_context dev, gpio_mode_t mode)
 335 {
 336     if (advance_func->gpio_mode_replace != NULL)
 337         return advance_func->gpio_mode_replace(dev,mode);
 338
 339     if (advance_func->gpio_mode_pre != NULL) {
 340         mraa_result_t pre_ret = (advance_func->gpio_mode_pre(dev,mode));
 341         if(pre_ret != MRAA_SUCCESS)
 342             return pre_ret;
 343     }
 344
 345     if (dev->value_fp != -1) {
 346          close(dev->value_fp);
 347          dev->value_fp = -1;
 348     }
 349
 350     char filepath[MAX_SIZE];
 351     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/drive", dev->pin);
 352
 353     int drive = open(filepath, O_WRONLY);
 354     if (drive == -1) {
 355         syslog(LOG_ERR, "gpio: Failed to open drive for writing");
 356         return MRAA_ERROR_INVALID_RESOURCE;
 357     }
 358
 359     char bu[MAX_SIZE];
 360     int length;
 361     switch(mode) {
 362         case MRAA_GPIO_STRONG:
 363             length = snprintf(bu, sizeof(bu), "strong");
 364             break;
 365         case MRAA_GPIO_PULLUP:
 366             length = snprintf(bu, sizeof(bu), "pullup");
 367             break;
 368         case MRAA_GPIO_PULLDOWN:
 369             length = snprintf(bu, sizeof(bu), "pulldown");
 370             break;
 371         case MRAA_GPIO_HIZ:
 372             length = snprintf(bu, sizeof(bu), "hiz");
 373             break;
 374         default:
 375             close(drive);
 376             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 377     }
 378     if (write(drive, bu, length*sizeof(char)) == -1) {
 379         syslog(LOG_ERR, "gpio: Failed to write to drive mode");
 380         close(drive);
 381         return MRAA_ERROR_INVALID_RESOURCE;
 382
 383     }
 384
 385     close(drive);
 386     if (advance_func->gpio_mode_post != NULL)
 387         return advance_func->gpio_mode_post(dev,mode);
 388     return MRAA_SUCCESS;
 389 }
 390
 391 mraa_result_t
 392 mraa_gpio_dir(mraa_gpio_context dev, gpio_dir_t dir)
 393 {
 394     if (advance_func->gpio_dir_replace != NULL) {
 395         return advance_func->gpio_dir_replace(dev,dir);
 396     }
 397     if (advance_func->gpio_dir_pre != NULL) {
 398         mraa_result_t pre_ret = (advance_func->gpio_dir_pre(dev,dir));
 399         if (pre_ret != MRAA_SUCCESS) {
 400             return pre_ret;
 401         }
 402     }
 403
 404     if (dev == NULL) {
 405         return MRAA_ERROR_INVALID_HANDLE;
 406     }
 407     if (dev->value_fp != -1) {
 408          close(dev->value_fp);
 409          dev->value_fp = -1;
 410     }
 411     char filepath[MAX_SIZE];
 412     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/direction", dev->pin);
 413
 414     int direction = open(filepath, O_RDWR);
 415
 416     if (direction == -1) {
 417         // Direction Failed to Open. If HIGH or LOW was passed will try and set
 418         // If not fail as usual.
 419         switch (dir) {
 420             case MRAA_GPIO_OUT_HIGH:
 421                 return mraa_gpio_write(dev, 1);
 422             case MRAA_GPIO_OUT_LOW:
 423                 return mraa_gpio_write(dev, 0);
 424             default:
 425                 return MRAA_ERROR_INVALID_RESOURCE;
 426         }
 427     }
 428
 429     char bu[MAX_SIZE];
 430     int length;
 431     switch(dir) {
 432         case MRAA_GPIO_OUT:
 433             length = snprintf(bu, sizeof(bu), "out");
 434             break;
 435         case MRAA_GPIO_IN:
 436             length = snprintf(bu, sizeof(bu), "in");
 437             break;
 438         case MRAA_GPIO_OUT_HIGH:
 439             length = snprintf(bu, sizeof(bu), "high");
 440             break;
 441         case MRAA_GPIO_OUT_LOW:
 442             length = snprintf(bu, sizeof(bu), "low");
 443             break;
 444         default:
 445             close(direction);
 446             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 447     }
 448
 449     if (write(direction, bu, length*sizeof(char)) == -1) {
 450         close(direction);
 451         return MRAA_ERROR_INVALID_RESOURCE;
 452     }
 453
 454     close(direction);
 455     if (advance_func->gpio_dir_post != NULL)
 456         return advance_func->gpio_dir_post(dev,dir);
 457     return MRAA_SUCCESS;
 458 }
 459
 460 int
 461 mraa_gpio_read(mraa_gpio_context dev)
 462 {
 463     if (dev == NULL)
 464         return -1;
 465
 466     if (dev->mmap_read != NULL)
 467         return dev->mmap_read(dev);
 468
 469     if (dev->value_fp == -1) {
 470         if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
 471             syslog(LOG_ERR, "gpio: Failed to get value file pointer");
 472             return -1;
 473         }
 474     }
 475     else {
 476         // if value_fp is new this is pointless
 477         lseek(dev->value_fp, 0, SEEK_SET);
 478     }
 479     char bu[2];
 480     if (read(dev->value_fp, bu, 2*sizeof(char)) != 2) {
 481         syslog(LOG_ERR, "gpio: Failed to read a sensible value from sysfs");
 482         return -1;
 483     }
 484     lseek(dev->value_fp, 0, SEEK_SET);
 485
 486     return (int) strtol(bu, NULL, 10);
 487 }
 488
 489 mraa_result_t
 490 mraa_gpio_write(mraa_gpio_context dev, int value)
 491 {
 492     if (dev == NULL)
 493         return MRAA_ERROR_INVALID_HANDLE;
 494
 495     if (dev->mmap_write != NULL)
 496         return dev->mmap_write(dev,value);
 497
 498     if (advance_func->gpio_write_pre != NULL) {
 499         mraa_result_t pre_ret = (advance_func->gpio_write_pre(dev,value));
 500         if(pre_ret != MRAA_SUCCESS)
 501             return pre_ret;
 502     }
 503
 504     if (dev->value_fp == -1) {
 505         if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
 506             return MRAA_ERROR_INVALID_RESOURCE;
 507         }
 508     }
 509
 510     if (lseek(dev->value_fp, 0, SEEK_SET) == -1) {
 511         return MRAA_ERROR_INVALID_RESOURCE;
 512     }
 513
 514     char bu[MAX_SIZE];
 515     int length = snprintf(bu, sizeof(bu), "%d", value);
 516     if (write(dev->value_fp, bu, length*sizeof(char)) == -1) {
 517         return MRAA_ERROR_INVALID_HANDLE;
 518     }
 519
 520     if (advance_func->gpio_write_post != NULL)
 521         return advance_func->gpio_write_post(dev,value);
 522     return MRAA_SUCCESS;
 523 }
 524
 525 static mraa_result_t
 526 mraa_gpio_unexport_force(mraa_gpio_context dev)
 527 {
 528     int unexport = open(SYSFS_CLASS_GPIO "/unexport", O_WRONLY);
 529     if (unexport == -1) {
 530         syslog(LOG_ERR, "gpio: Failed to open unexport for writing");
 531         return MRAA_ERROR_INVALID_RESOURCE;
 532     }
 533
 534     char bu[MAX_SIZE];
 535     int length = snprintf(bu, sizeof(bu), "%d", dev->pin);
 536     if (write(unexport, bu, length*sizeof(char)) == -1) {
 537         syslog(LOG_ERR, "gpio: Failed to write to unexport");
 538         close(unexport);
 539         return MRAA_ERROR_INVALID_RESOURCE;
 540     }
 541
 542     close(unexport);
 543     mraa_gpio_isr_exit(dev);
 544     return MRAA_SUCCESS;
 545 }
 546 static mraa_result_t
 547 mraa_gpio_unexport(mraa_gpio_context dev)
 548 {
 549     if(dev->owner) {
 550         return mraa_gpio_unexport_force(dev);
 551     }
 552     return MRAA_ERROR_INVALID_RESOURCE;
 553 }
 554
 555 mraa_result_t
 556 mraa_gpio_close(mraa_gpio_context dev)
 557 {
 558     mraa_result_t result = MRAA_SUCCESS;
 559
 560     if (advance_func->gpio_close_pre != NULL) {
 561         result = advance_func->gpio_close_pre(dev);
 562     }
 563
 564     if (dev->value_fp != -1) {
 565         close(dev->value_fp);
 566     }
 567     mraa_gpio_unexport(dev);
 568     free(dev);
 569     return result;
 570 }
 571
 572 mraa_result_t
 573 mraa_gpio_owner(mraa_gpio_context dev, mraa_boolean_t own)
 574 {
 575     if (dev == NULL)
 576         return MRAA_ERROR_INVALID_RESOURCE;
 577     dev->owner = own;
 578     return MRAA_SUCCESS;
 579 }
 580
 581 mraa_result_t
 582 mraa_gpio_use_mmaped(mraa_gpio_context dev, mraa_boolean_t mmap_en)
 583 {
 584     if (advance_func->gpio_mmap_setup != NULL) {
 585         return advance_func->gpio_mmap_setup(dev,mmap_en);
 586     }
 587
 588     syslog(LOG_ERR, "gpio: mmap not implemented on this platform");
 589     return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 590 }
 591
 592 int
 593 mraa_gpio_get_pin(mraa_gpio_context dev)
 594 {
 595     if (dev == NULL) {
 596         syslog(LOG_ERR, "gpio: context is invalid");
 597     }
 598     return dev->phy_pin;
 599 }
 600
 601 int
 602 mraa_gpio_get_pin_raw(mraa_gpio_context dev)
 603 {
 604     if (dev == NULL) {
 605         syslog(LOG_ERR, "gpio: context is invalid");
 606     }
 607     return dev->pin;
 608 }