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     int pinm = mraa_setup_gpio(pin);
  59     if (pinm < 0)
  60         return NULL;
  61
  62     mraa_gpio_context r = mraa_gpio_init_raw(pinm);
  63     r->phy_pin = pin;
  64     return r;
  65 }
  66
  67 mraa_gpio_context
  68 mraa_gpio_init_raw(int pin)
  69 {
  70     if (advance_func->gpio_init_pre != NULL) {
  71         printf("Actually entering\n");
  72         if (advance_func->gpio_init_pre(pin) != MRAA_SUCCESS)
  73             return NULL;
  74     }
  75
  76     if (pin < 0)
  77         return NULL;
  78
  79     char bu[MAX_SIZE];
  80     int length;
  81
  82     mraa_gpio_context dev = (mraa_gpio_context) malloc(sizeof(struct _gpio));
  83     memset(dev, 0, sizeof(struct _gpio));
  84     dev->value_fp = -1;
  85     dev->isr_value_fp = -1;
  86     dev->pin = pin;
  87     dev->phy_pin = -1;
  88
  89     char directory[MAX_SIZE];
  90     snprintf(directory, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/", dev->pin);
  91     struct stat dir;
  92     if (stat(directory, &dir) == 0 && S_ISDIR(dir.st_mode)) {
  93         //fprintf(stderr, "GPIO Pin already exporting, continuing.\n");
  94         dev->owner = 0; // Not Owner
  95     } else {
  96         int export = open(SYSFS_CLASS_GPIO "/export", O_WRONLY);
  97         if (export == -1) {
  98             fprintf(stderr, "Failed to open export for writing!\n");
  99             return NULL;
 100         }
 101         length = snprintf(bu, sizeof(bu), "%d", dev->pin);
 102         if (write(export, bu, length*sizeof(char)) == -1) {
 103             fprintf(stderr, "Failed to write to export\n");
 104             close(export);
 105             return NULL;
 106         }
 107         dev->owner = 1;
 108         close(export);
 109     }
 110
 111     if (advance_func->gpio_init_post != NULL) {
 112         free(dev);
 113         return NULL;
 114     }
 115     return dev;
 116 }
 117
 118 static mraa_result_t
 119 mraa_gpio_write_register(mraa_gpio_context dev,int value)
 120 {
 121     if (advance_func->gpio_mmaped_write_replace != NULL)
 122         return advance_func->gpio_mmaped_write_replace(dev,value);
 123     if (advance_func->gpio_mmaped_write_pre != NULL) {
 124         mraa_result_t pre_ret = (advance_func->gpio_mmaped_write_pre(dev,value));
 125         if(pre_ret != MRAA_SUCCESS)
 126             return pre_ret;
 127     }
 128     if (value == 1) {
 129         *((unsigned *)dev->reg) |= (1<<dev->reg_bit_pos);
 130         return MRAA_SUCCESS;
 131     }
 132     *((unsigned *)dev->reg) &= ~(1<<dev->reg_bit_pos);
 133
 134     if (advance_func->gpio_mmaped_write_post != NULL)
 135         return advance_func->gpio_mmaped_write_post(dev,value);
 136     return MRAA_SUCCESS;
 137 }
 138
 139 static mraa_result_t
 140 mraa_gpio_wait_interrupt(int fd)
 141 {
 142     unsigned char c;
 143     struct pollfd pfd;
 144
 145     // setup poll on POLLPRI
 146     pfd.fd = fd;
 147     pfd.events = POLLPRI;
 148
 149     // do an initial read to clear interupt
 150     read (fd, &c, 1);
 151
 152     if (fd <= 0) {
 153         return MRAA_ERROR_INVALID_RESOURCE;
 154     }
 155
 156     // Wait for it forever or until pthread_cancel
 157     // poll is a cancelable point like sleep()
 158     int x = poll (&pfd, 1, -1);
 159
 160     // do a final read to clear interupt
 161     read (fd, &c, 1);
 162
 163     return MRAA_SUCCESS;
 164 }
 165
 166 static void*
 167 mraa_gpio_interrupt_handler(void* arg)
 168 {
 169     mraa_gpio_context dev = (mraa_gpio_context) arg;
 170     mraa_result_t ret;
 171
 172     // open gpio value with open(3)
 173     char bu[MAX_SIZE];
 174     sprintf(bu, SYSFS_CLASS_GPIO "/gpio%d/value", dev->pin);
 175     dev->isr_value_fp = open(bu, O_RDONLY);
 176
 177     for (;;) {
 178         ret = mraa_gpio_wait_interrupt(dev->isr_value_fp);
 179         if (ret == MRAA_SUCCESS) {
 180             pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
 181 #ifdef SWIGPYTHON
 182             // In order to call a python object (all python functions are objects) we
 183             // need to aquire the GIL (Global Interpreter Lock). This may not always be
 184             // nessecary but especially if doing IO (like print()) python will segfault
 185             // if we do not hold a lock on the GIL
 186             PyGILState_STATE gilstate = PyGILState_Ensure();
 187             PyObject *arglist;
 188             PyObject *ret;
 189             arglist = Py_BuildValue("(i)", dev->isr_args);
 190                         if (arglist == NULL) {
 191                                 fprintf(stdout, "Py_BuildValue NULL\n");
 192                         } else {
 193                 ret = PyEval_CallObject((PyObject*)dev->isr, arglist);
 194                 if (ret == NULL) {
 195                     fprintf(stdout, "PyEval_CallObject failed\n");
 196                 } else {
 197                     Py_DECREF(ret);
 198                 }
 199                 Py_DECREF(arglist);
 200             }
 201
 202             PyGILState_Release (gilstate);
 203 #else
 204             dev->isr(dev->isr_args);
 205 #endif
 206             pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL);
 207         } else {
 208         // we must have got an error code so die nicely
 209             pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, NULL);
 210             close(dev->isr_value_fp);
 211             dev->isr_value_fp = -1;
 212             return NULL;
 213         }
 214     }
 215 }
 216
 217 mraa_result_t
 218 mraa_gpio_edge_mode(mraa_gpio_context dev, gpio_edge_t mode)
 219 {
 220     if (dev->value_fp != -1) {
 221          close(dev->value_fp);
 222          dev->value_fp = -1;
 223     }
 224
 225     char filepath[MAX_SIZE];
 226     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/edge", dev->pin);
 227
 228     int edge = open(filepath, O_RDWR);
 229     if (edge == -1) {
 230         fprintf(stderr, "Failed to open edge for writing!\n");
 231         return MRAA_ERROR_INVALID_RESOURCE;
 232     }
 233
 234     char bu[MAX_SIZE];
 235     int length;
 236     switch(mode) {
 237         case MRAA_GPIO_EDGE_NONE:
 238             length = snprintf(bu, sizeof(bu), "none");
 239             break;
 240         case MRAA_GPIO_EDGE_BOTH:
 241             length = snprintf(bu, sizeof(bu), "both");
 242             break;
 243         case MRAA_GPIO_EDGE_RISING:
 244             length = snprintf(bu, sizeof(bu), "rising");
 245             break;
 246         case MRAA_GPIO_EDGE_FALLING:
 247             length = snprintf(bu, sizeof(bu), "falling");
 248             break;
 249         default:
 250             close(edge);
 251             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 252     }
 253     if (write(edge, bu, length*sizeof(char)) == -1) {
 254         fprintf(stderr, "Failed to write to edge\n");
 255         close(edge);
 256         return MRAA_ERROR_INVALID_RESOURCE;
 257     }
 258
 259     close(edge);
 260     return MRAA_SUCCESS;
 261 }
 262
 263 mraa_result_t
 264 mraa_gpio_isr(mraa_gpio_context dev, gpio_edge_t mode, void (*fptr)(void *), void * args)
 265 {
 266     // we only allow one isr per mraa_gpio_context
 267     if (dev->thread_id != 0) {
 268         return MRAA_ERROR_NO_RESOURCES;
 269     }
 270
 271     if (MRAA_SUCCESS != mraa_gpio_edge_mode(dev, mode)) {
 272         return MRAA_ERROR_UNSPECIFIED;
 273     }
 274
 275     dev->isr = fptr;
 276     dev->isr_args = args;
 277     pthread_create (&dev->thread_id, NULL, mraa_gpio_interrupt_handler, (void *) dev);
 278
 279     return MRAA_SUCCESS;
 280 }
 281
 282 mraa_result_t
 283 mraa_gpio_isr_exit(mraa_gpio_context dev)
 284 {
 285     mraa_result_t ret = MRAA_SUCCESS;
 286
 287     // wasting our time, there is no isr to exit from
 288     if (dev->thread_id == 0 && dev->isr_value_fp == -1) {
 289         return ret;
 290     }
 291
 292     // stop isr being useful
 293     ret = mraa_gpio_edge_mode(dev, MRAA_GPIO_EDGE_NONE);
 294
 295     if ((dev->thread_id != 0) &&
 296         (pthread_cancel(dev->thread_id) != 0)) {
 297         ret = MRAA_ERROR_INVALID_HANDLE;
 298     }
 299
 300     // close the filehandle in case it's still open
 301     if (dev->isr_value_fp != -1) {
 302           if (close(dev->isr_value_fp) != 0) {
 303               ret = MRAA_ERROR_INVALID_PARAMETER;
 304           }
 305     }
 306
 307 #ifdef SWIGPYTHON
 308     // Dereference our Python call back function
 309     Py_DECREF(dev->isr);
 310 #endif
 311
 312     // assume our thread will exit either way we just lost it's handle
 313     dev->thread_id = 0;
 314     dev->isr_value_fp = -1;
 315     return ret;
 316 }
 317
 318 mraa_result_t
 319 mraa_gpio_mode(mraa_gpio_context dev, gpio_mode_t mode)
 320 {
 321     if (advance_func->gpio_mode_replace != NULL)
 322         return advance_func->gpio_mode_replace(dev,mode);
 323
 324     if (advance_func->gpio_mode_pre != NULL) {
 325         mraa_result_t pre_ret = (advance_func->gpio_mode_pre(dev,mode));
 326         if(pre_ret != MRAA_SUCCESS)
 327             return pre_ret;
 328     }
 329
 330     if (dev->value_fp != -1) {
 331          close(dev->value_fp);
 332          dev->value_fp = -1;
 333     }
 334
 335     char filepath[MAX_SIZE];
 336     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/drive", dev->pin);
 337
 338     int drive = open(filepath, O_WRONLY);
 339     if (drive == -1) {
 340         fprintf(stderr, "Failed to open drive for writing!\n");
 341         return MRAA_ERROR_INVALID_RESOURCE;
 342     }
 343
 344     char bu[MAX_SIZE];
 345     int length;
 346     switch(mode) {
 347         case MRAA_GPIO_STRONG:
 348             length = snprintf(bu, sizeof(bu), "strong");
 349             break;
 350         case MRAA_GPIO_PULLUP:
 351             length = snprintf(bu, sizeof(bu), "pullup");
 352             break;
 353         case MRAA_GPIO_PULLDOWN:
 354             length = snprintf(bu, sizeof(bu), "pulldown");
 355             break;
 356         case MRAA_GPIO_HIZ:
 357             length = snprintf(bu, sizeof(bu), "hiz");
 358             break;
 359         default:
 360             close(drive);
 361             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 362     }
 363     if (write(drive, bu, length*sizeof(char)) == -1) {
 364         fprintf(stderr, "Failed to write to drive mode!\n");
 365         close(drive);
 366         return MRAA_ERROR_INVALID_RESOURCE;
 367
 368     }
 369
 370     close(drive);
 371     if (advance_func->gpio_mode_post != NULL)
 372         return advance_func->gpio_mode_post(dev,mode);
 373     return MRAA_SUCCESS;
 374 }
 375
 376 mraa_result_t
 377 mraa_gpio_dir(mraa_gpio_context dev, gpio_dir_t dir)
 378 {
 379     if (advance_func->gpio_dir_replace != NULL)
 380         return advance_func->gpio_dir_replace(dev,dir);
 381     if (advance_func->gpio_dir_pre != NULL) {
 382         mraa_result_t pre_ret = (advance_func->gpio_dir_pre(dev,dir));
 383         if(pre_ret != MRAA_SUCCESS)
 384             return pre_ret;
 385     }
 386
 387     if (dev == NULL) {
 388         return MRAA_ERROR_INVALID_HANDLE;
 389     }
 390     if (dev->value_fp != -1) {
 391          close(dev->value_fp);
 392          dev->value_fp = -1;
 393     }
 394     char filepath[MAX_SIZE];
 395     snprintf(filepath, MAX_SIZE, SYSFS_CLASS_GPIO "/gpio%d/direction", dev->pin);
 396
 397     int direction = open(filepath, O_RDWR);
 398
 399     if (direction == -1) {
 400         return MRAA_ERROR_INVALID_RESOURCE;
 401     }
 402
 403     char bu[MAX_SIZE];
 404     int length;
 405     int out_switch = 0;
 406     switch(dir) {
 407         case MRAA_GPIO_OUT:
 408             length = snprintf(bu, sizeof(bu), "out");
 409             out_switch = 1;
 410             break;
 411         case MRAA_GPIO_IN:
 412             length = snprintf(bu, sizeof(bu), "in");
 413             break;
 414         default:
 415             close(direction);
 416             return MRAA_ERROR_FEATURE_NOT_IMPLEMENTED;
 417     }
 418
 419     if (dev->phy_pin >= 0) {
 420         mraa_result_t swap_res = mraa_swap_complex_gpio(dev->phy_pin, out_switch);
 421         if (swap_res != MRAA_SUCCESS)
 422             return swap_res;
 423     }
 424
 425     if (write(direction, bu, length*sizeof(char)) == -1) {
 426         close(direction);
 427         return MRAA_ERROR_INVALID_RESOURCE;
 428     }
 429
 430     close(direction);
 431     if (advance_func->gpio_dir_post != NULL)
 432         return advance_func->gpio_dir_post(dev,dir);
 433     return MRAA_SUCCESS;
 434 }
 435
 436 int
 437 mraa_gpio_read(mraa_gpio_context dev)
 438 {
 439     if (dev->value_fp == -1) {
 440         if (mraa_gpio_get_valfp(dev) != MRAA_SUCCESS) {
 441              fprintf(stderr, "Failed to get value file pointer\n");
 442         }
 443     }
 444     else {
 445         // if value_fp is new this is pointless
 446         lseek(dev->value_fp, 0, SEEK_SET);
 447     }
 448     char bu[2];
 449     if (read(dev->value_fp, bu, 2*sizeof(char)) != 2) {
 450         fprintf(stderr, "Failed to read a sensible value from sysfs");
 451     }
 452     lseek(dev->value_fp, 0, SEEK_SET);
 453     int ret = strtol(bu, NULL, 10);
 454
 455     return ret;
 456     return 0;
 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_func->gpio_write_pre != NULL) {
 466         mraa_result_t pre_ret = (advance_func->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_func->gpio_write_post != NULL)
 485         return advance_func->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 }