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