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 void
 169 mraa_result_print(mraa_result_t result)
 170 {
 171     switch (result) {
 172         case MRAA_SUCCESS:
 173             fprintf(stdout, "MRAA: SUCCESS\n");
 174             break;
 175         case MRAA_ERROR_FEATURE_NOT_IMPLEMENTED:
 176             fprintf(stdout, "MRAA: Feature not implemented.\n");
 177             break;
 178         case MRAA_ERROR_FEATURE_NOT_SUPPORTED:
 179             fprintf(stdout, "MRAA: Feature not supported by Hardware.\n");
 180             break;
 181         case MRAA_ERROR_INVALID_VERBOSITY_LEVEL:
 182             fprintf(stdout, "MRAA: Invalid verbosity level.\n");
 183             break;
 184         case MRAA_ERROR_INVALID_PARAMETER:
 185             fprintf(stdout, "MRAA: Invalid parameter.\n");
 186             break;
 187         case MRAA_ERROR_INVALID_HANDLE:
 188             fprintf(stdout, "MRAA: Invalid Handle.\n");
 189             break;
 190         case MRAA_ERROR_NO_RESOURCES:
 191             fprintf(stdout, "MRAA: No resources.\n");
 192             break;
 193         case MRAA_ERROR_INVALID_RESOURCE:
 194             fprintf(stdout, "MRAA: Invalid resource.\n");
 195             break;
 196         case MRAA_ERROR_INVALID_QUEUE_TYPE:
 197             fprintf(stdout, "MRAA: Invalid Queue Type.\n");
 198             break;
 199         case MRAA_ERROR_NO_DATA_AVAILABLE:
 200             fprintf(stdout, "MRAA: No Data available.\n");
 201             break;
 202         case MRAA_ERROR_INVALID_PLATFORM:
 203             fprintf(stdout, "MRAA: Platform not recognised.\n");
 204             break;
 205         case MRAA_ERROR_PLATFORM_NOT_INITIALISED:
 206             fprintf(stdout, "MRAA: Platform not initialised.\n");
 207             break;
 208         case MRAA_ERROR_PLATFORM_ALREADY_INITIALISED:
 209             fprintf(stdout, "MRAA: Platform already initialised.\n");
 210             break;
 211         case MRAA_ERROR_UNSPECIFIED:
 212             fprintf(stdout, "MRAA: Unspecified Error.\n");
 213             break;
 214         default:
 215             fprintf(stdout, "MRAA: Unrecognised error.\n");
 216             break;
 217     }
 218 }
 219
 220 mraa_boolean_t
 221 mraa_pin_mode_test(int pin, mraa_pinmodes_t mode)
 222 {
 223     if (plat == NULL) {
 224         mraa_init();
 225         if (plat == NULL)
 226             return 0;
 227     }
 228     if (pin > plat->phy_pin_count || pin < 0)
 229         return 0;
 230
 231     switch(mode) {
 232         case MRAA_PIN_VALID:
 233             if (plat->pins[pin].capabilites.valid == 1)
 234                 return 1;
 235             break;
 236         case MRAA_PIN_GPIO:
 237             if (plat->pins[pin].capabilites.gpio ==1)
 238                 return 1;
 239             break;
 240         case MRAA_PIN_PWM:
 241             if (plat->pins[pin].capabilites.pwm ==1)
 242                 return 1;
 243             break;
 244         case MRAA_PIN_FAST_GPIO:
 245             if (plat->pins[pin].capabilites.fast_gpio ==1)
 246                 return 1;
 247             break;
 248         case MRAA_PIN_SPI:
 249             if (plat->pins[pin].capabilites.spi ==1)
 250                 return 1;
 251             break;
 252         case MRAA_PIN_I2C:
 253             if (plat->pins[pin].capabilites.i2c ==1)
 254                 return 1;
 255             break;
 256         case MRAA_PIN_AIO:
 257             if (pin < plat->aio_count)
 258                 pin = pin + plat->gpio_count;
 259             if (plat->pins[pin].capabilites.aio ==1)
 260                 return 1;
 261             break;
 262         default: break;
 263     }
 264     return 0;
 265 }
 266
 267 mraa_mmap_pin_t*
 268 mraa_setup_mmap_gpio(int pin)
 269 {
 270     if (plat == NULL)
 271         return NULL;
 272
 273     if (plat->pins[pin].capabilites.fast_gpio != 1)
 274         return NULL;
 275
 276     if (plat->pins[pin].mmap.gpio.mux_total > 0)
 277        if (mraa_setup_mux_mapped(plat->pins[pin].mmap.gpio) != MRAA_SUCCESS)
 278             return NULL;
 279
 280     if (mraa_setup_mux_mapped(plat->pins[pin].mmap.gpio) != MRAA_SUCCESS)
 281             return NULL;
 282     mraa_mmap_pin_t *ret = &(plat->pins[pin].mmap);
 283     return ret;
 284 }
 285
 286 mraa_platform_t mraa_get_platform_type()
 287 {
 288     return platform_type;
 289 }
 290
 291 unsigned int
 292 mraa_adc_raw_bits()
 293 {
 294     if (plat == NULL)
 295         return 0;
 296
 297     if (plat->aio_count == 0)
 298         return 0;
 299
 300     return plat->adc_raw;
 301 }
 302
 303 unsigned int
 304 mraa_adc_supported_bits()
 305 {
 306     if (plat == NULL)
 307         return 0;
 308
 309     if (plat->aio_count == 0)
 310         return 0;
 311
 312     return plat->adc_supported;
 313 }
 314
 315 mraa_result_t
 316 mraa_setup_uart(int index)
 317 {
 318     if (plat == NULL)
 319         return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
 320
 321     if (plat->uart_dev_count == 0)
 322         return MRAA_ERROR_FEATURE_NOT_SUPPORTED;
 323
 324     if (plat->uart_dev_count <= index)
 325         return MRAA_ERROR_NO_RESOURCES;
 326
 327     int pos = plat->uart_dev[index].rx;
 328     if (pos >= 0) {
 329         if (plat->pins[pos].uart.mux_total > 0)
 330             if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS)
 331                 return MRAA_ERROR_INVALID_RESOURCE;
 332     }
 333
 334     if (pos >= 0) {
 335         pos = plat->uart_dev[index].tx;
 336         if (plat->pins[pos].uart.mux_total > 0)
 337             if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS)
 338                 return MRAA_ERROR_INVALID_RESOURCE;
 339     }
 340
 341     return MRAA_SUCCESS;
 342 }