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 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 mraa_spi_bus_t*
 169 mraa_setup_spi(int bus)
 170 {
 171     if (plat == NULL)
 172         return NULL;
 173
 174     if (plat->spi_bus_count >! 0) {
 175         syslog(LOG_ERR, "No spi buses defined in platform");
 176         return NULL;
 177     }
 178     if (plat->spi_bus_count == 1) {
 179         bus = plat->def_spi_bus;
 180     }
 181     if (bus >= plat->spi_bus_count) {
 182         syslog(LOG_ERR, "Above spi bus count");
 183         return NULL;
 184     }
 185
 186     int pos = plat->spi_bus[bus].sclk;
 187     if (plat->pins[pos].spi.mux_total > 0)
 188         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 189              return NULL;
 190
 191     pos = plat->spi_bus[bus].mosi;
 192     if (plat->pins[pos].spi.mux_total > 0)
 193         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 194              return NULL;
 195
 196     pos = plat->spi_bus[bus].miso;
 197     if (plat->pins[pos].spi.mux_total > 0)
 198         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 199              return NULL;
 200
 201     pos = plat->spi_bus[bus].cs;
 202     if (plat->pins[pos].spi.mux_total > 0)
 203         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 204              return NULL;
 205
 206     pos = plat->spi_bus[bus].cs;
 207     if (plat->pins[pos].spi.mux_total > 0)
 208         if (mraa_setup_mux_mapped(plat->pins[pos].spi) != MRAA_SUCCESS)
 209              return NULL;
 210
 211     mraa_spi_bus_t *spi = &(plat->spi_bus[bus]);
 212     return spi;
 213 }
 214
 215 mraa_pin_t*
 216 mraa_setup_pwm(int pin)
 217 {
 218     if (plat == NULL)
 219         return NULL;
 220
 221     if (plat->pins[pin].capabilites.pwm != 1)
 222         return NULL;
 223
 224     if (plat->pins[pin].capabilites.gpio == 1) {
 225         mraa_gpio_context mux_i;
 226         mux_i = mraa_gpio_init_raw(plat->pins[pin].gpio.pinmap);
 227         if (mux_i == NULL)
 228             return NULL;
 229         if (mraa_gpio_dir(mux_i, MRAA_GPIO_OUT) != MRAA_SUCCESS)
 230             return NULL;
 231         // Current REV D quirk. //TODO GEN 2
 232         if (mraa_gpio_write(mux_i, 1) != MRAA_SUCCESS)
 233             return NULL;
 234         if (mraa_gpio_close(mux_i) != MRAA_SUCCESS)
 235             return NULL;
 236     }
 237
 238     if (plat->pins[pin].pwm.mux_total > 0)
 239        if (mraa_setup_mux_mapped(plat->pins[pin].pwm) != MRAA_SUCCESS)
 240             return NULL;
 241
 242     mraa_pin_t *ret;
 243     ret = (mraa_pin_t*) malloc(sizeof(mraa_pin_t));
 244     ret->pinmap = plat->pins[pin].pwm.pinmap;
 245     ret->parent_id = plat->pins[pin].pwm.parent_id;
 246     return ret;
 247 }
 248
 249 void
 250 mraa_result_print(mraa_result_t result)
 251 {
 252     switch (result) {
 253         case MRAA_SUCCESS:
 254             fprintf(stdout, "MRAA: SUCCESS\n");
 255             break;
 256         case MRAA_ERROR_FEATURE_NOT_IMPLEMENTED:
 257             fprintf(stdout, "MRAA: Feature not implemented.\n");
 258             break;
 259         case MRAA_ERROR_FEATURE_NOT_SUPPORTED:
 260             fprintf(stdout, "MRAA: Feature not supported by Hardware.\n");
 261             break;
 262         case MRAA_ERROR_INVALID_VERBOSITY_LEVEL:
 263             fprintf(stdout, "MRAA: Invalid verbosity level.\n");
 264             break;
 265         case MRAA_ERROR_INVALID_PARAMETER:
 266             fprintf(stdout, "MRAA: Invalid parameter.\n");
 267             break;
 268         case MRAA_ERROR_INVALID_HANDLE:
 269             fprintf(stdout, "MRAA: Invalid Handle.\n");
 270             break;
 271         case MRAA_ERROR_NO_RESOURCES:
 272             fprintf(stdout, "MRAA: No resources.\n");
 273             break;
 274         case MRAA_ERROR_INVALID_RESOURCE:
 275             fprintf(stdout, "MRAA: Invalid resource.\n");
 276             break;
 277         case MRAA_ERROR_INVALID_QUEUE_TYPE:
 278             fprintf(stdout, "MRAA: Invalid Queue Type.\n");
 279             break;
 280         case MRAA_ERROR_NO_DATA_AVAILABLE:
 281             fprintf(stdout, "MRAA: No Data available.\n");
 282             break;
 283         case MRAA_ERROR_INVALID_PLATFORM:
 284             fprintf(stdout, "MRAA: Platform not recognised.\n");
 285             break;
 286         case MRAA_ERROR_PLATFORM_NOT_INITIALISED:
 287             fprintf(stdout, "MRAA: Platform not initialised.\n");
 288             break;
 289         case MRAA_ERROR_PLATFORM_ALREADY_INITIALISED:
 290             fprintf(stdout, "MRAA: Platform already initialised.\n");
 291             break;
 292         case MRAA_ERROR_UNSPECIFIED:
 293             fprintf(stdout, "MRAA: Unspecified Error.\n");
 294             break;
 295         default:
 296             fprintf(stdout, "MRAA: Unrecognised error.\n");
 297             break;
 298     }
 299 }
 300
 301 mraa_boolean_t
 302 mraa_pin_mode_test(int pin, mraa_pinmodes_t mode)
 303 {
 304     if (plat == NULL) {
 305         mraa_init();
 306         if (plat == NULL)
 307             return 0;
 308     }
 309     if (pin > plat->phy_pin_count || pin < 0)
 310         return 0;
 311
 312     switch(mode) {
 313         case MRAA_PIN_VALID:
 314             if (plat->pins[pin].capabilites.valid == 1)
 315                 return 1;
 316             break;
 317         case MRAA_PIN_GPIO:
 318             if (plat->pins[pin].capabilites.gpio ==1)
 319                 return 1;
 320             break;
 321         case MRAA_PIN_PWM:
 322             if (plat->pins[pin].capabilites.pwm ==1)
 323                 return 1;
 324             break;
 325         case MRAA_PIN_FAST_GPIO:
 326             if (plat->pins[pin].capabilites.fast_gpio ==1)
 327                 return 1;
 328             break;
 329         case MRAA_PIN_SPI:
 330             if (plat->pins[pin].capabilites.spi ==1)
 331                 return 1;
 332             break;
 333         case MRAA_PIN_I2C:
 334             if (plat->pins[pin].capabilites.i2c ==1)
 335                 return 1;
 336             break;
 337         case MRAA_PIN_AIO:
 338             if (pin < plat->aio_count)
 339                 pin = pin + plat->gpio_count;
 340             if (plat->pins[pin].capabilites.aio ==1)
 341                 return 1;
 342             break;
 343         default: break;
 344     }
 345     return 0;
 346 }
 347
 348 mraa_mmap_pin_t*
 349 mraa_setup_mmap_gpio(int pin)
 350 {
 351     if (plat == NULL)
 352         return NULL;
 353
 354     if (plat->pins[pin].capabilites.fast_gpio != 1)
 355         return NULL;
 356
 357     if (plat->pins[pin].mmap.gpio.mux_total > 0)
 358        if (mraa_setup_mux_mapped(plat->pins[pin].mmap.gpio) != MRAA_SUCCESS)
 359             return NULL;
 360
 361     if (mraa_setup_mux_mapped(plat->pins[pin].mmap.gpio) != MRAA_SUCCESS)
 362             return NULL;
 363     mraa_mmap_pin_t *ret = &(plat->pins[pin].mmap);
 364     return ret;
 365 }
 366
 367 mraa_platform_t mraa_get_platform_type()
 368 {
 369     return platform_type;
 370 }
 371
 372 unsigned int
 373 mraa_adc_raw_bits()
 374 {
 375     if (plat == NULL)
 376         return 0;
 377
 378     if (plat->aio_count == 0)
 379         return 0;
 380
 381     return plat->adc_raw;
 382 }
 383
 384 unsigned int
 385 mraa_adc_supported_bits()
 386 {
 387     if (plat == NULL)
 388         return 0;
 389
 390     if (plat->aio_count == 0)
 391         return 0;
 392
 393     return plat->adc_supported;
 394 }
 395
 396 mraa_result_t
 397 mraa_setup_uart(int index)
 398 {
 399     if (plat == NULL)
 400         return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
 401
 402     if (plat->uart_dev_count == 0)
 403         return MRAA_ERROR_FEATURE_NOT_SUPPORTED;
 404
 405     if (plat->uart_dev_count <= index)
 406         return MRAA_ERROR_NO_RESOURCES;
 407
 408     int pos = plat->uart_dev[index].rx;
 409     if (pos >= 0) {
 410         if (plat->pins[pos].uart.mux_total > 0)
 411             if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS)
 412                 return MRAA_ERROR_INVALID_RESOURCE;
 413     }
 414
 415     if (pos >= 0) {
 416         pos = plat->uart_dev[index].tx;
 417         if (plat->pins[pos].uart.mux_total > 0)
 418             if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS)
 419                 return MRAA_ERROR_INVALID_RESOURCE;
 420     }
 421
 422     return MRAA_SUCCESS;
 423 }