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 #include <pwd.h>
  31
  32 #include "mraa_internal.h"
  33 #include "gpio.h"
  34 #include "version.h"
  35
  36 mraa_board_t* plat = NULL;
  37 static mraa_platform_t platform_type = MRAA_UNKNOWN_PLATFORM;
  38 mraa_adv_func_t* advance_func;
  39
  40 const char *
  41 mraa_get_version()
  42 {
  43     return gVERSION;
  44 }
  45
  46 mraa_result_t
  47 mraa_set_log_level(int level)
  48 {
  49     if (level <= 7 && level >= 0) {
  50         setlogmask(LOG_UPTO(level));
  51         return MRAA_SUCCESS;
  52     }
  53     return MRAA_ERROR_INVALID_PARAMETER;
  54 }
  55
  56 mraa_result_t __attribute__((constructor))
  57 mraa_init()
  58 {
  59     if (plat != NULL) {
  60         return MRAA_ERROR_PLATFORM_ALREADY_INITIALISED;
  61     }
  62
  63     uid_t proc_euid = geteuid();
  64     struct passwd *proc_user = getpwuid(proc_euid);
  65
  66 #ifdef DEBUG
  67     setlogmask(LOG_UPTO(LOG_DEBUG));
  68 #else
  69     setlogmask(LOG_UPTO(LOG_NOTICE));
  70 #endif
  71
  72     openlog("libmraa", LOG_CONS | LOG_PID | LOG_NDELAY, LOG_LOCAL1);
  73     syslog(LOG_NOTICE,
  74            "libmraa version %s initialised by user '%s' with EUID %d",
  75            mraa_get_version(),
  76            (proc_user != NULL) ? proc_user->pw_name : "<unknown>",
  77            proc_euid);
  78
  79 #ifdef SWIGPYTHON
  80     // Initialise python threads, this allows use to grab the GIL when we are
  81     // required to do so
  82     Py_InitializeEx(0);
  83     PyEval_InitThreads();
  84 #endif
  85     advance_func = (mraa_adv_func_t*) malloc(sizeof(mraa_adv_func_t));
  86     memset(advance_func, 0, sizeof(mraa_adv_func_t));
  87
  88 #ifdef X86PLAT
  89     // Use runtime x86 platform detection
  90     platform_type = mraa_x86_platform();
  91 #elif ARMPLAT
  92     // Use runtime ARM platform detection
  93     platform_type = mraa_arm_platform();
  94 #else
  95     #error mraa_ARCH NOTHING
  96 #endif
  97
  98     if (plat == NULL) {
  99         printf("mraa: FATAL error, failed to initialise platform\n");
 100         return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
 101     }
 102
 103     syslog(LOG_INFO,
 104            "libmraa initialised for platform '%s' of type %d",
 105            mraa_get_platform_name(),
 106            platform_type);
 107     return MRAA_SUCCESS;
 108 }
 109
 110 void
 111 mraa_deinit()
 112 {
 113     if (plat != NULL) {
 114         if (plat->pins != NULL) {
 115             free(plat->pins);
 116         }
 117         free(plat);
 118     }
 119     closelog();
 120 }
 121
 122 int
 123 mraa_set_priority(const unsigned int priority)
 124 {
 125     struct sched_param sched_s;
 126
 127     memset(&sched_s, 0, sizeof(struct sched_param));
 128     if (priority > sched_get_priority_max(SCHED_RR)) {
 129         sched_s.sched_priority = sched_get_priority_max(SCHED_RR);
 130     }
 131     else {
 132         sched_s.sched_priority = priority;
 133     }
 134
 135     return sched_setscheduler(0, SCHED_RR, &sched_s);
 136 }
 137
 138 mraa_result_t
 139 mraa_setup_mux_mapped(mraa_pin_t meta)
 140 {
 141     int mi;
 142
 143     for (mi = 0; mi < meta.mux_total; mi++) {
 144         mraa_gpio_context mux_i;
 145         mux_i = mraa_gpio_init_raw(meta.mux[mi].pin);
 146         if (mux_i == NULL) {
 147             return MRAA_ERROR_INVALID_HANDLE;
 148         }
 149         // this function will sometimes fail, however this is not critical as
 150         // long as the write succeeds - Test case galileo gen2 pin2
 151         mraa_gpio_dir(mux_i, MRAA_GPIO_OUT);
 152
 153         if (mraa_gpio_write(mux_i, meta.mux[mi].value) != MRAA_SUCCESS) {
 154             mraa_gpio_close(mux_i);
 155             return MRAA_ERROR_INVALID_RESOURCE;
 156         }
 157         mraa_gpio_close(mux_i);
 158     }
 159
 160     return MRAA_SUCCESS;
 161 }
 162
 163 void
 164 mraa_result_print(mraa_result_t result)
 165 {
 166     switch (result) {
 167         case MRAA_SUCCESS:
 168             fprintf(stdout, "MRAA: SUCCESS\n");
 169             break;
 170         case MRAA_ERROR_FEATURE_NOT_IMPLEMENTED:
 171             fprintf(stdout, "MRAA: Feature not implemented.\n");
 172             break;
 173         case MRAA_ERROR_FEATURE_NOT_SUPPORTED:
 174             fprintf(stdout, "MRAA: Feature not supported by Hardware.\n");
 175             break;
 176         case MRAA_ERROR_INVALID_VERBOSITY_LEVEL:
 177             fprintf(stdout, "MRAA: Invalid verbosity level.\n");
 178             break;
 179         case MRAA_ERROR_INVALID_PARAMETER:
 180             fprintf(stdout, "MRAA: Invalid parameter.\n");
 181             break;
 182         case MRAA_ERROR_INVALID_HANDLE:
 183             fprintf(stdout, "MRAA: Invalid Handle.\n");
 184             break;
 185         case MRAA_ERROR_NO_RESOURCES:
 186             fprintf(stdout, "MRAA: No resources.\n");
 187             break;
 188         case MRAA_ERROR_INVALID_RESOURCE:
 189             fprintf(stdout, "MRAA: Invalid resource.\n");
 190             break;
 191         case MRAA_ERROR_INVALID_QUEUE_TYPE:
 192             fprintf(stdout, "MRAA: Invalid Queue Type.\n");
 193             break;
 194         case MRAA_ERROR_NO_DATA_AVAILABLE:
 195             fprintf(stdout, "MRAA: No Data available.\n");
 196             break;
 197         case MRAA_ERROR_INVALID_PLATFORM:
 198             fprintf(stdout, "MRAA: Platform not recognised.\n");
 199             break;
 200         case MRAA_ERROR_PLATFORM_NOT_INITIALISED:
 201             fprintf(stdout, "MRAA: Platform not initialised.\n");
 202             break;
 203         case MRAA_ERROR_PLATFORM_ALREADY_INITIALISED:
 204             fprintf(stdout, "MRAA: Platform already initialised.\n");
 205             break;
 206         case MRAA_ERROR_UNSPECIFIED:
 207             fprintf(stdout, "MRAA: Unspecified Error.\n");
 208             break;
 209         default:
 210             fprintf(stdout, "MRAA: Unrecognised error.\n");
 211             break;
 212     }
 213 }
 214
 215 mraa_boolean_t
 216 mraa_pin_mode_test(int pin, mraa_pinmodes_t mode)
 217 {
 218     if (plat == NULL) {
 219         mraa_init();
 220         if (plat == NULL)
 221             return 0;
 222     }
 223     if (pin > (plat->phy_pin_count -1) || pin < 0)
 224         return 0;
 225
 226     switch(mode) {
 227         case MRAA_PIN_VALID:
 228             if (plat->pins[pin].capabilites.valid == 1)
 229                 return 1;
 230             break;
 231         case MRAA_PIN_GPIO:
 232             if (plat->pins[pin].capabilites.gpio ==1)
 233                 return 1;
 234             break;
 235         case MRAA_PIN_PWM:
 236             if (plat->pins[pin].capabilites.pwm ==1)
 237                 return 1;
 238             break;
 239         case MRAA_PIN_FAST_GPIO:
 240             if (plat->pins[pin].capabilites.fast_gpio ==1)
 241                 return 1;
 242             break;
 243         case MRAA_PIN_SPI:
 244             if (plat->pins[pin].capabilites.spi ==1)
 245                 return 1;
 246             break;
 247         case MRAA_PIN_I2C:
 248             if (plat->pins[pin].capabilites.i2c ==1)
 249                 return 1;
 250             break;
 251         case MRAA_PIN_AIO:
 252             if (plat->pins[pin].capabilites.aio ==1)
 253                 return 1;
 254             break;
 255         case MRAA_PIN_UART:
 256             if (plat->pins[pin].capabilites.uart == 1)
 257                 return 1;
 258             break;
 259         default:
 260             syslog(LOG_NOTICE, "requested pinmode invalid");
 261             break;
 262     }
 263     return 0;
 264 }
 265
 266 mraa_platform_t mraa_get_platform_type()
 267 {
 268     return platform_type;
 269 }
 270
 271 unsigned int
 272 mraa_adc_raw_bits()
 273 {
 274     if (plat == NULL)
 275         return 0;
 276
 277     if (plat->aio_count == 0)
 278         return 0;
 279
 280     return plat->adc_raw;
 281 }
 282
 283 unsigned int
 284 mraa_adc_supported_bits()
 285 {
 286     if (plat == NULL)
 287         return 0;
 288
 289     if (plat->aio_count == 0)
 290         return 0;
 291
 292     return plat->adc_supported;
 293 }
 294
 295 char*
 296 mraa_get_platform_name()
 297 {
 298     if (plat == NULL) {
 299         return NULL;
 300     }
 301     return (char*) plat->platform_name;
 302 }
 303
 304 unsigned int
 305 mraa_get_pin_count()
 306 {
 307     if (plat == NULL) {
 308         return 0;
 309     }
 310     return plat->phy_pin_count;
 311 }