src/mraa.c

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   3  * Author: Thomas Ingleby <thomas.c.ingleby@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
  26 #include <stddef.h>
  27 #include <stdlib.h>
  28 #include <sched.h>
  29 #include <string.h>
  30
  31 #include "mraa_internal.h"
  32 #include "intel_galileo_rev_d.h"
  33 #include "intel_galileo_rev_g.h"
  34 #include "intel_edison_fab_c.h"
  35 #include "intel_de3815.h"
  36 #include "gpio.h"
  37 #include "version.h"
  38
  39 mraa_board_t* plat = NULL;
  40 static mraa_platform_t platform_type = MRAA_UNKNOWN_PLATFORM;
  41 mraa_adv_func_t* advance_func;
  42
  43 const char *
  44 mraa_get_version()
  45 {
  46     return gVERSION;
  47 }
  48
  49 mraa_result_t
  50 mraa_set_log_level(int level)
  51 {
  52     if (level <= 7 && level >= 0) {
  53         setlogmask(LOG_UPTO(level));
  54         return MRAA_SUCCESS;
  55     }
  56     return MRAA_ERROR_INVALID_PARAMETER;
  57 }
  58
  59 mraa_result_t __attribute__((constructor))
  60 mraa_init()
  61 {
  62 #ifdef DEBUG
  63     setlogmask(LOG_UPTO(LOG_DEBUG));
  64 #else
  65     setlogmask(LOG_UPTO(LOG_NOTICE));
  66 #endif
  67
  68     openlog("libmraa", LOG_CONS | LOG_PID | LOG_NDELAY, LOG_LOCAL1);
  69     syslog(LOG_DEBUG, "libmraa initialised by user %d", getuid());
  70
  71     if (plat != NULL) {
  72         return MRAA_ERROR_PLATFORM_ALREADY_INITIALISED;
  73     }
  74 #ifdef SWIGPYTHON
  75     // Initialise python threads, this allows use to grab the GIL when we are
  76     // required to do so
  77     Py_InitializeEx(0);
  78     PyEval_InitThreads();
  79 #endif
  80     // detect a galileo gen2 board
  81     char *line = NULL;
  82     // let getline allocate memory for *line
  83     size_t len = 0;
  84     FILE *fh = fopen("/sys/devices/virtual/dmi/id/board_name", "r");
  85     if (fh != NULL) {
  86         if (getline(&line, &len, fh) != -1) {
  87             if (strncmp(line, "GalileoGen2", 10) == 0) {
  88                 platform_type = MRAA_INTEL_GALILEO_GEN2;
  89             } else if (strncmp(line, "BODEGA BAY", 10) == 0) {
  90                 platform_type = MRAA_INTEL_EDISON_FAB_C;
  91             } else if (strncmp(line, "SALT BAY", 7) == 0) {
  92                 platform_type = MRAA_INTEL_EDISON_FAB_C;
  93             } else if (strncmp(line, "DE3815", 6) == 0) {
  94                 platform_type = MRAA_INTEL_DE3815;
  95             } else {
  96                 platform_type = MRAA_INTEL_GALILEO_GEN1;
  97             }
  98             free(line);
  99         }
 100         fclose(fh);
 101     }
 102
 103     advance_func = (mraa_adv_func_t*) malloc(sizeof(mraa_adv_func_t));
 104     memset(advance_func, 0, sizeof(mraa_adv_func_t));
 105
 106     switch(platform_type) {
 107         case MRAA_INTEL_GALILEO_GEN2:
 108             plat = mraa_intel_galileo_gen2();
 109             break;
 110         case MRAA_INTEL_GALILEO_GEN1:
 111             plat = mraa_intel_galileo_rev_d();
 112             break;
 113         case MRAA_INTEL_EDISON_FAB_C:
 114             plat = mraa_intel_edison_fab_c();
 115             break;
 116         case MRAA_INTEL_DE3815:
 117             plat = mraa_intel_de3815();
 118             break;
 119         default:
 120             plat = mraa_intel_galileo_rev_d();
 121             syslog(LOG_ERR, "Platform not found, initialising MRAA_INTEL_GALILEO_GEN1");
 122     }
 123
 124     syslog(LOG_NOTICE, "libmraa initialised for platform %d", platform_type);
 125     return MRAA_SUCCESS;
 126 }
 127
 128 void
 129 mraa_deinit()
 130 {
 131     free(plat->pins);
 132     free(plat);
 133     closelog();
 134 }
 135
 136 int
 137 mraa_set_priority(const unsigned int priority)
 138 {
 139     struct sched_param sched_s;
 140
 141     memset(&sched_s, 0, sizeof(struct sched_param));
 142     if (priority > sched_get_priority_max(SCHED_RR)) {
 143         sched_s.sched_priority = sched_get_priority_max(SCHED_RR);
 144     }
 145     else {
 146         sched_s.sched_priority = priority;
 147     }
 148
 149     return sched_setscheduler(0, SCHED_RR, &sched_s);
 150 }
 151
 152 static mraa_result_t
 153 mraa_setup_mux_mapped(mraa_pin_t meta)
 154 {
 155     int mi;
 156     for (mi = 0; mi < meta.mux_total; mi++) {
 157         mraa_gpio_context mux_i;
 158         mux_i = mraa_gpio_init_raw(meta.mux[mi].pin);
 159         if (mux_i == NULL)
 160             return MRAA_ERROR_INVALID_HANDLE;
 161         mraa_gpio_dir(mux_i, MRAA_GPIO_OUT);
 162         if (mraa_gpio_write(mux_i, meta.mux[mi].value) != MRAA_SUCCESS)
 163             return MRAA_ERROR_INVALID_RESOURCE;
 164     }
 165     return MRAA_SUCCESS;
 166 }
 167
 168 unsigned int
 169 mraa_setup_gpio(int pin)
 170 {
 171     if (plat == NULL)
 172         return MRAA_PLATFORM_NO_INIT;
 173
 174     if (pin < 0 || pin > plat->phy_pin_count)
 175         return MRAA_NO_SUCH_IO;
 176
 177     if(plat->pins[pin].capabilites.gpio != 1)
 178       return MRAA_NO_SUCH_IO;
 179
 180     if (plat->pins[pin].gpio.mux_total > 0)
 181        if (mraa_setup_mux_mapped(plat->pins[pin].gpio) != MRAA_SUCCESS)
 182             return MRAA_NO_SUCH_IO;
 183     return plat->pins[pin].gpio.pinmap;
 184 }
 185
 186 unsigned int
 187 mraa_setup_aio(int aio)
 188 {
 189     if (plat == NULL)
 190         return MRAA_PLATFORM_NO_INIT;
 191
 192     if (aio < 0 || aio > plat->aio_count)
 193         return MRAA_NO_SUCH_IO;
 194
 195     int pin = aio + plat->gpio_count;
 196
 197     if (plat->pins[pin].capabilites.aio != 1)
 198       return MRAA_NO_SUCH_IO;
 199
 200     if (plat->pins[pin].aio.mux_total > 0)
 201        if (mraa_setup_mux_mapped(plat->pins[pin].aio) != MRAA_SUCCESS)
 202             return MRAA_NO_SUCH_IO;
 203     return plat->pins[pin].aio.pinmap;
 204 }
 205
 206 unsigned int
 207 mraa_setup_i2c(int* bus)
 208 {
 209     if (plat == NULL)
 210         return MRAA_PLATFORM_NO_INIT;
 211
 212     if (plat->i2c_bus_count == 0) {
 213         syslog(LOG_ERR, "No i2c buses defined in platform");
 214         return MRAA_NO_SUCH_IO;
 215     }
 216     if (*bus >= plat->i2c_bus_count) {
 217         syslog(LOG_ERR, "Above i2c bus count");
 218         return MRAA_NO_SUCH_IO;
 219     }
 220
 221     if (plat->i2c_bus[*bus].bus_id == -1) {
 222         syslog(LOG_ERR, "Invalid i2c bus, moving to default i2c bus");
 223         *bus = plat->def_i2c_bus;
 224     }
 225
 226     int pos = plat->i2c_bus[*bus].sda;
 227     if (plat->pins[pos].i2c.mux_total > 0)
 228         if (mraa_setup_mux_mapped(plat->pins[pos].i2c) != MRAA_SUCCESS)
 229              return MRAA_IO_SETUP_FAILURE;
 230
 231     pos = plat->i2c_bus[*bus].scl;
 232     if (plat->pins[pos].i2c.mux_total > 0)
 233         if (mraa_setup_mux_mapped(plat->pins[pos].i2c) != MRAA_SUCCESS)
 234              return MRAA_IO_SETUP_FAILURE;
 235
 236     return plat->i2c_bus[*bus].bus_id;
 237 }
 238
 239 mraa_spi_bus_t*
 240 mraa_setup_spi(int bus)
 241 {
 242     if (plat == NULL)
 243         return NULL;
 244
 245     if (plat->spi_bus_count >! 0) {
 246         syslog(LOG_ERR, "No spi buses defined in platform");
 247         return NULL;
 248     }
 249     if (plat->spi_bus_count == 1) {
 250         bus = plat->def_spi_bus;
 251     }
 252     if (bus >= plat->spi_bus_count) {
 253         syslog(LOG_ERR, "Above spi bus count");
 254         return NULL;
 255     }
 256
 257     int pos = plat->spi_bus[bus].sclk;
 258     if (plat->pins[pos].spi.mux_total > 0)
 259         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 260              return NULL;
 261
 262     pos = plat->spi_bus[bus].mosi;
 263     if (plat->pins[pos].spi.mux_total > 0)
 264         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 265              return NULL;
 266
 267     pos = plat->spi_bus[bus].miso;
 268     if (plat->pins[pos].spi.mux_total > 0)
 269         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 270              return NULL;
 271
 272     mraa_spi_bus_t *spi = &(plat->spi_bus[bus]);
 273     return spi;
 274 }
 275
 276 mraa_pin_t*
 277 mraa_setup_pwm(int pin)
 278 {
 279     if (plat == NULL)
 280         return NULL;
 281
 282     if (plat->pins[pin].capabilites.pwm != 1)
 283         return NULL;
 284
 285     if (plat->pins[pin].capabilites.gpio == 1) {
 286         mraa_gpio_context mux_i;
 287         mux_i = mraa_gpio_init_raw(plat->pins[pin].gpio.pinmap);
 288         if (mux_i == NULL)
 289             return NULL;
 290         if (mraa_gpio_dir(mux_i, MRAA_GPIO_OUT) != MRAA_SUCCESS)
 291             return NULL;
 292         // Current REV D quirk. //TODO GEN 2
 293         if (mraa_gpio_write(mux_i, 1) != MRAA_SUCCESS)
 294             return NULL;
 295         if (mraa_gpio_close(mux_i) != MRAA_SUCCESS)
 296             return NULL;
 297     }
 298
 299     if (plat->pins[pin].pwm.mux_total > 0)
 300        if (mraa_setup_mux_mapped(plat->pins[pin].pwm) != MRAA_SUCCESS)
 301             return NULL;
 302
 303     mraa_pin_t *ret;
 304     ret = (mraa_pin_t*) malloc(sizeof(mraa_pin_t));
 305     ret->pinmap = plat->pins[pin].pwm.pinmap;
 306     ret->parent_id = plat->pins[pin].pwm.parent_id;
 307     return ret;
 308 }
 309
 310 void
 311 mraa_result_print(mraa_result_t result)
 312 {
 313     switch (result) {
 314         case MRAA_SUCCESS:
 315             fprintf(stdout, "MRAA: SUCCESS\n");
 316             break;
 317         case MRAA_ERROR_FEATURE_NOT_IMPLEMENTED:
 318             fprintf(stdout, "MRAA: Feature not implemented.\n");
 319             break;
 320         case MRAA_ERROR_FEATURE_NOT_SUPPORTED:
 321             fprintf(stdout, "MRAA: Feature not supported by Hardware.\n");
 322             break;
 323         case MRAA_ERROR_INVALID_VERBOSITY_LEVEL:
 324             fprintf(stdout, "MRAA: Invalid verbosity level.\n");
 325             break;
 326         case MRAA_ERROR_INVALID_PARAMETER:
 327             fprintf(stdout, "MRAA: Invalid parameter.\n");
 328             break;
 329         case MRAA_ERROR_INVALID_HANDLE:
 330             fprintf(stdout, "MRAA: Invalid Handle.\n");
 331             break;
 332         case MRAA_ERROR_NO_RESOURCES:
 333             fprintf(stdout, "MRAA: No resources.\n");
 334             break;
 335         case MRAA_ERROR_INVALID_RESOURCE:
 336             fprintf(stdout, "MRAA: Invalid resource.\n");
 337             break;
 338         case MRAA_ERROR_INVALID_QUEUE_TYPE:
 339             fprintf(stdout, "MRAA: Invalid Queue Type.\n");
 340             break;
 341         case MRAA_ERROR_NO_DATA_AVAILABLE:
 342             fprintf(stdout, "MRAA: No Data available.\n");
 343             break;
 344         case MRAA_ERROR_INVALID_PLATFORM:
 345             fprintf(stdout, "MRAA: Platform not recognised.\n");
 346             break;
 347         case MRAA_ERROR_PLATFORM_NOT_INITIALISED:
 348             fprintf(stdout, "MRAA: Platform not initialised.\n");
 349             break;
 350         case MRAA_ERROR_PLATFORM_ALREADY_INITIALISED:
 351             fprintf(stdout, "MRAA: Platform already initialised.\n");
 352             break;
 353         case MRAA_ERROR_UNSPECIFIED:
 354             fprintf(stdout, "MRAA: Unspecified Error.\n");
 355             break;
 356         default:
 357             fprintf(stdout, "MRAA: Unrecognised error.\n");
 358             break;
 359     }
 360 }
 361
 362 mraa_boolean_t
 363 mraa_pin_mode_test(int pin, mraa_pinmodes_t mode)
 364 {
 365     if (plat == NULL) {
 366         mraa_init();
 367         if (plat == NULL)
 368             return 0;
 369     }
 370     if (pin > plat->phy_pin_count || pin < 0)
 371         return 0;
 372
 373     switch(mode) {
 374         case MRAA_PIN_VALID:
 375             if (plat->pins[pin].capabilites.valid == 1)
 376                 return 1;
 377             break;
 378         case MRAA_PIN_GPIO:
 379             if (plat->pins[pin].capabilites.gpio ==1)
 380                 return 1;
 381             break;
 382         case MRAA_PIN_PWM:
 383             if (plat->pins[pin].capabilites.pwm ==1)
 384                 return 1;
 385             break;
 386         case MRAA_PIN_FAST_GPIO:
 387             if (plat->pins[pin].capabilites.fast_gpio ==1)
 388                 return 1;
 389             break;
 390         case MRAA_PIN_SPI:
 391             if (plat->pins[pin].capabilites.spi ==1)
 392                 return 1;
 393             break;
 394         case MRAA_PIN_I2C:
 395             if (plat->pins[pin].capabilites.i2c ==1)
 396                 return 1;
 397             break;
 398         case MRAA_PIN_AIO:
 399             if (pin < plat->aio_count)
 400                 pin = pin + plat->gpio_count;
 401             if (plat->pins[pin].capabilites.aio ==1)
 402                 return 1;
 403             break;
 404         default: break;
 405     }
 406     return 0;
 407 }
 408
 409 mraa_mmap_pin_t*
 410 mraa_setup_mmap_gpio(int pin)
 411 {
 412     if (plat == NULL)
 413         return NULL;
 414
 415     if (plat->pins[pin].capabilites.fast_gpio != 1)
 416         return NULL;
 417
 418     if (plat->pins[pin].mmap.gpio.mux_total > 0)
 419        if (mraa_setup_mux_mapped(plat->pins[pin].mmap.gpio) != MRAA_SUCCESS)
 420             return NULL;
 421
 422     if (mraa_setup_mux_mapped(plat->pins[pin].mmap.gpio) != MRAA_SUCCESS)
 423             return NULL;
 424     mraa_mmap_pin_t *ret = &(plat->pins[pin].mmap);
 425     return ret;
 426 }
 427
 428 mraa_platform_t mraa_get_platform_type()
 429 {
 430     return platform_type;
 431 }
 432
 433 unsigned int
 434 mraa_adc_raw_bits()
 435 {
 436     if (plat == NULL)
 437         return 0;
 438
 439     if (plat->aio_count == 0)
 440         return 0;
 441
 442     return plat->adc_raw;
 443 }
 444
 445 unsigned int
 446 mraa_adc_supported_bits()
 447 {
 448     if (plat == NULL)
 449         return 0;
 450
 451     if (plat->aio_count == 0)
 452         return 0;
 453
 454     return plat->adc_supported;
 455 }
 456
 457 mraa_result_t
 458 mraa_setup_uart(int index)
 459 {
 460     if (plat == NULL)
 461         return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
 462
 463     if (plat->uart_dev_count == 0)
 464         return MRAA_ERROR_FEATURE_NOT_SUPPORTED;
 465
 466     if (plat->uart_dev_count <= index)
 467         return MRAA_ERROR_NO_RESOURCES;
 468
 469     int pos = plat->uart_dev[index].rx;
 470     if (pos >= 0) {
 471         if (plat->pins[pos].uart.mux_total > 0)
 472             if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS)
 473                 return MRAA_ERROR_INVALID_RESOURCE;
 474     }
 475
 476     if (pos >= 0) {
 477         pos = plat->uart_dev[index].tx;
 478         if (plat->pins[pos].uart.mux_total > 0)
 479             if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS)
 480                 return MRAA_ERROR_INVALID_RESOURCE;
 481     }
 482
 483     return MRAA_SUCCESS;
 484 }