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.
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:
14 * The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
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.
27 #if !defined(_XOPEN_SOURCE) || _XOPEN_SOURCE < 600
28 #define _XOPEN_SOURCE 600 /* Get nftw() and S_IFSOCK declarations */
44 #include "mraa_internal.h"
48 #define MAX_PLATFORM_NAME_LENGTH 128
49 #define IIO_DEVICE_WILDCARD "iio:device*"
50 mraa_board_t* plat = NULL;
51 mraa_iio_info_t* plat_iio = NULL;
53 static char platform_name[MAX_PLATFORM_NAME_LENGTH];
55 static int num_i2c_devices = 0;
56 static int num_iio_devices = 0;
65 mraa_set_log_level(int level)
67 if (level <= 7 && level >= 0) {
68 setlogmask(LOG_UPTO(level));
69 syslog(LOG_DEBUG, "Loglevel %d is set", level);
72 syslog(LOG_NOTICE, "Invalid loglevel %d requested", level);
73 return MRAA_ERROR_INVALID_PARAMETER;
77 #if (defined SWIGPYTHON) || (defined SWIG)
80 mraa_result_t __attribute__((constructor))
85 return MRAA_ERROR_PLATFORM_ALREADY_INITIALISED;
88 uid_t proc_euid = geteuid();
89 struct passwd* proc_user = getpwuid(proc_euid);
92 setlogmask(LOG_UPTO(LOG_DEBUG));
94 setlogmask(LOG_UPTO(LOG_NOTICE));
97 openlog("libmraa", LOG_CONS | LOG_PID | LOG_NDELAY, LOG_LOCAL1);
98 syslog(LOG_NOTICE, "libmraa version %s initialised by user '%s' with EUID %d",
99 mraa_get_version(), (proc_user != NULL) ? proc_user->pw_name : "<unknown>", proc_euid);
102 // Initialise python threads, this allows use to grab the GIL when we are
105 PyEval_InitThreads();
108 mraa_platform_t platform_type;
110 // Use runtime x86 platform detection
111 platform_type = mraa_x86_platform();
112 #elif defined(ARMPLAT)
113 // Use runtime ARM platform detection
114 platform_type = mraa_arm_platform();
116 #error mraa_ARCH NOTHING
120 plat->platform_type = platform_type;
123 // This is a platform extender so create null base platform if one doesn't already exist
125 plat = (mraa_board_t*) calloc(1, sizeof(mraa_board_t));
127 plat->platform_type = MRAA_NULL_PLATFORM;
128 plat->platform_name = "Unknown platform";
131 // Now detect sub platform
133 mraa_platform_t usb_platform_type = mraa_usb_platform_extender(plat);
134 if (plat->platform_type == MRAA_UNKNOWN_PLATFORM && usb_platform_type != MRAA_UNKNOWN_PLATFORM) {
135 plat->platform_type = usb_platform_type;
137 return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
141 printf("mraa: FATAL error, failed to initialise platform\n");
142 return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
146 // Look for IIO devices
149 syslog(LOG_NOTICE, "libmraa initialised for platform '%s' of type %d", mraa_get_platform_name(), mraa_get_platform_type());
157 if (plat->pins != NULL) {
160 mraa_board_t* sub_plat = plat->sub_platform;
161 if (sub_plat != NULL) {
162 if (sub_plat->pins != NULL) {
163 free(sub_plat->pins);
170 if (plat_iio != NULL) {
177 mraa_set_priority(const unsigned int priority)
179 struct sched_param sched_s;
181 memset(&sched_s, 0, sizeof(struct sched_param));
182 if (priority > sched_get_priority_max(SCHED_RR)) {
183 sched_s.sched_priority = sched_get_priority_max(SCHED_RR);
185 sched_s.sched_priority = priority;
188 return sched_setscheduler(0, SCHED_RR, &sched_s);
192 mraa_count_iio_devices(const char* path, const struct stat* sb, int flag, struct FTW* ftwb)
194 // we are only interested in files with specific names
195 if (fnmatch(IIO_DEVICE_WILDCARD, basename(path), 0) == 0) {
204 plat_iio = (mraa_iio_info_t*) calloc(1, sizeof(mraa_iio_info_t));
205 plat_iio->iio_device_count = num_iio_devices;
206 // Now detect IIO devices, linux only
207 // find how many iio devices we have if we haven't already
208 if (num_iio_devices == 0) {
209 if (nftw("/sys/bus/iio/devices", &mraa_count_iio_devices, 20, FTW_PHYS) == -1) {
210 return MRAA_ERROR_UNSPECIFIED;
213 char name[64], filepath[64];
215 plat_iio->iio_device_count = num_iio_devices;
216 plat_iio->iio_devices = calloc(num_iio_devices, sizeof(struct _iio));
218 for (i=0; i < num_iio_devices; i++) {
219 device = &plat_iio->iio_devices[i];
221 snprintf(filepath, 64, "/sys/bus/iio/devices/iio:device%d/name", i);
222 fd = open(filepath, O_RDONLY);
224 len = read(fd, &name, 64);
226 // remove any trailing CR/LF symbols
227 name[strcspn(name, "\r\n")] = '\0';
230 device->name = malloc((sizeof(char) * len) + sizeof(char));
231 strncpy(device->name, name, len+1);
241 mraa_setup_mux_mapped(mraa_pin_t meta)
245 for (mi = 0; mi < meta.mux_total; mi++) {
246 mraa_gpio_context mux_i;
247 mux_i = mraa_gpio_init_raw(meta.mux[mi].pin);
249 return MRAA_ERROR_INVALID_HANDLE;
251 // this function will sometimes fail, however this is not critical as
252 // long as the write succeeds - Test case galileo gen2 pin2
253 mraa_gpio_dir(mux_i, MRAA_GPIO_OUT);
254 mraa_gpio_owner(mux_i, 0);
256 if (mraa_gpio_write(mux_i, meta.mux[mi].value) != MRAA_SUCCESS) {
257 mraa_gpio_close(mux_i);
258 return MRAA_ERROR_INVALID_RESOURCE;
260 mraa_gpio_close(mux_i);
267 mraa_result_print(mraa_result_t result)
271 fprintf(stdout, "MRAA: SUCCESS\n");
273 case MRAA_ERROR_FEATURE_NOT_IMPLEMENTED:
274 fprintf(stdout, "MRAA: Feature not implemented.\n");
276 case MRAA_ERROR_FEATURE_NOT_SUPPORTED:
277 fprintf(stdout, "MRAA: Feature not supported by Hardware.\n");
279 case MRAA_ERROR_INVALID_VERBOSITY_LEVEL:
280 fprintf(stdout, "MRAA: Invalid verbosity level.\n");
282 case MRAA_ERROR_INVALID_PARAMETER:
283 fprintf(stdout, "MRAA: Invalid parameter.\n");
285 case MRAA_ERROR_INVALID_HANDLE:
286 fprintf(stdout, "MRAA: Invalid Handle.\n");
288 case MRAA_ERROR_NO_RESOURCES:
289 fprintf(stdout, "MRAA: No resources.\n");
291 case MRAA_ERROR_INVALID_RESOURCE:
292 fprintf(stdout, "MRAA: Invalid resource.\n");
294 case MRAA_ERROR_INVALID_QUEUE_TYPE:
295 fprintf(stdout, "MRAA: Invalid Queue Type.\n");
297 case MRAA_ERROR_NO_DATA_AVAILABLE:
298 fprintf(stdout, "MRAA: No Data available.\n");
300 case MRAA_ERROR_INVALID_PLATFORM:
301 fprintf(stdout, "MRAA: Platform not recognised.\n");
303 case MRAA_ERROR_PLATFORM_NOT_INITIALISED:
304 fprintf(stdout, "MRAA: Platform not initialised.\n");
306 case MRAA_ERROR_PLATFORM_ALREADY_INITIALISED:
307 fprintf(stdout, "MRAA: Platform already initialised.\n");
309 case MRAA_ERROR_UNSPECIFIED:
310 fprintf(stdout, "MRAA: Unspecified Error.\n");
313 fprintf(stdout, "MRAA: Unrecognised error.\n");
320 mraa_has_sub_platform()
322 return (plat != NULL) && (plat->sub_platform != NULL);
326 mraa_pin_mode_test(int pin, mraa_pinmodes_t mode)
331 mraa_board_t* current_plat = plat;
332 if (mraa_is_sub_platform_id(pin)) {
333 current_plat = plat->sub_platform;
334 if (current_plat == NULL) {
335 syslog(LOG_ERR, "mraa_pin_mode_test: Sub platform Not Initialised");
338 pin = mraa_get_sub_platform_index(pin);
341 if (current_plat == NULL || current_plat->platform_type == MRAA_UNKNOWN_PLATFORM) {
344 if (pin > (current_plat->phy_pin_count - 1) || pin < 0)
349 if (current_plat->pins[pin].capabilites.valid == 1)
353 if (current_plat->pins[pin].capabilites.gpio == 1)
357 if (current_plat->pins[pin].capabilites.pwm == 1)
360 case MRAA_PIN_FAST_GPIO:
361 if (current_plat->pins[pin].capabilites.fast_gpio == 1)
365 if (current_plat->pins[pin].capabilites.spi == 1)
369 if (current_plat->pins[pin].capabilites.i2c == 1)
373 if (current_plat->pins[pin].capabilites.aio == 1)
377 if (current_plat->pins[pin].capabilites.uart == 1)
381 syslog(LOG_NOTICE, "requested pinmode invalid");
388 mraa_get_platform_type()
391 return MRAA_UNKNOWN_PLATFORM;
392 return plat->platform_type;
396 mraa_get_platform_combined_type()
398 int type = mraa_get_platform_type();
399 int sub_type = mraa_has_sub_platform() ? plat->sub_platform->platform_type : MRAA_UNKNOWN_PLATFORM;
400 return type | (sub_type << 8);
409 if (plat->aio_count == 0)
412 return plat->adc_raw;
416 mraa_get_platform_adc_raw_bits(uint8_t platform_offset)
418 if (platform_offset == MRAA_MAIN_PLATFORM_OFFSET)
419 return mraa_adc_raw_bits();
421 if (!mraa_has_sub_platform())
424 if (plat->sub_platform->aio_count == 0)
427 return plat->sub_platform->adc_raw;
433 mraa_adc_supported_bits()
438 if (plat->aio_count == 0)
441 return plat->adc_supported;
445 mraa_get_platform_adc_supported_bits(int platform_offset)
447 if (platform_offset == MRAA_MAIN_PLATFORM_OFFSET)
448 return mraa_adc_supported_bits();
450 if (!mraa_has_sub_platform())
453 if (plat->sub_platform->aio_count == 0)
456 return plat->sub_platform->adc_supported;
462 mraa_get_platform_name()
467 if (mraa_has_sub_platform()) {
468 snprintf(platform_name, MAX_PLATFORM_NAME_LENGTH, "%s + %s", plat->platform_name, plat->sub_platform->platform_name);
470 strncpy(platform_name, plat->platform_name, MAX_PLATFORM_NAME_LENGTH-1);
473 return platform_name;
477 mraa_get_i2c_bus_count()
482 return plat->i2c_bus_count;
486 mraa_get_i2c_bus_id(unsigned i2c_bus)
492 if (i2c_bus >= plat->i2c_bus_count) {
496 return plat->i2c_bus[i2c_bus].bus_id;
505 return plat->phy_pin_count;
509 mraa_get_platform_pin_count(uint8_t platform_offset)
511 if (platform_offset == MRAA_MAIN_PLATFORM_OFFSET)
512 return mraa_get_pin_count();
514 if (mraa_has_sub_platform())
515 return plat->sub_platform->phy_pin_count;
523 mraa_get_pin_name(int pin)
528 mraa_board_t* current_plat = plat;
529 if (mraa_is_sub_platform_id(pin)) {
530 current_plat = plat->sub_platform;
531 if (current_plat == NULL) {
532 syslog(LOG_ERR, "mraa_get_pin_name: Sub platform Not Initialised");
535 pin = mraa_get_sub_platform_index(pin);
538 if (pin > (current_plat->phy_pin_count - 1) || pin < 0)
540 return (char*) current_plat->pins[pin].name;
544 mraa_get_default_i2c_bus(uint8_t platform_offset)
548 if (platform_offset == MRAA_MAIN_PLATFORM_OFFSET) {
549 return plat->def_i2c_bus;
551 if (mraa_has_sub_platform())
552 return plat->sub_platform->def_i2c_bus;
560 mraa_file_exist(const char* filename)
563 results.gl_pathc = 0;
564 glob(filename, 0, NULL, &results);
565 int file_found = results.gl_pathc == 1;
571 mraa_file_contains(const char* filename, const char* content)
573 mraa_boolean_t found = 0;
574 if ((filename == NULL) || (content == NULL)) {
578 char* file = mraa_file_unglob(filename);
581 char* line = malloc(len);
586 FILE* fh = fopen(file, "r");
592 while ((getline(&line, &len, fh) != -1) && (found == 0)) {
593 if (strstr(line, content)) {
606 mraa_file_contains_both(const char* filename, const char* content, const char* content2)
608 mraa_boolean_t found = 0;
609 if ((filename == NULL) || (content == NULL)) {
613 char* file = mraa_file_unglob(filename);
616 char* line = malloc(len);
621 FILE* fh = fopen(file, "r");
627 while ((getline(&line, &len, fh) != -1) && (found == 0)) {
628 if (strstr(line, content) && strstr(line, content2)) {
641 mraa_file_unglob(const char* filename)
645 results.gl_pathc = 0;
646 glob(filename, 0, NULL, &results);
647 if (results.gl_pathc == 1)
648 res = strdup(results.gl_pathv[0]);
654 mraa_link_targets(const char* filename, const char* targetname)
659 while (nchars == 0) {
660 buffer = (char*) realloc(buffer, size);
663 nchars = readlink(filename, buffer, size);
668 buffer[nchars] = '\0';
670 if (nchars >= size) {
675 if (strstr(buffer, targetname)) {
685 mraa_count_i2c_files(const char* path, const struct stat* sb, int flag, struct FTW* ftwb)
687 switch (sb->st_mode & S_IFMT) {
696 mraa_find_i2c_bus(const char* devname, int startfrom)
703 // because feeding mraa_find_i2c_bus result back into the function is
704 // useful treat -1 as 0
709 // find how many i2c buses we have if we haven't already
710 if (num_i2c_devices == 0) {
711 if (nftw("/sys/class/i2c-dev/", &mraa_count_i2c_files, 20, FTW_PHYS) == -1) {
716 // i2c devices are numbered numerically so 0 must exist otherwise there is
718 if (mraa_file_exist("/sys/class/i2c-dev/i2c-0")) {
719 for (i; i < num_i2c_devices; i++) {
721 snprintf(path, 64, "/sys/class/i2c-dev/i2c-%u/name", i);
722 fd = open(path, O_RDONLY);
726 size = lseek(fd, 0, SEEK_END);
728 syslog(LOG_WARNING, "mraa: failed to seek i2c filename file");
732 err = lseek(fd, 0, SEEK_SET);
734 syslog(LOG_WARNING, "mraa: failed to seek i2c filename file");
738 char* value = malloc(size);
740 syslog(LOG_ERR, "mraa: failed to allocate memory for i2c file");
744 ssize_t r = read(fd, value, size);
746 if (strcasestr(value, devname) != NULL) {
752 syslog(LOG_ERR, "mraa: sysfs i2cdev failed");
758 syslog(LOG_WARNING, "mraa: no i2c-dev detected, load i2c-dev");
765 mraa_is_sub_platform_id(int pin_or_bus)
767 return (pin_or_bus & MRAA_SUB_PLATFORM_MASK) != 0;
771 mraa_get_sub_platform_id(int pin_or_bus)
773 return pin_or_bus | MRAA_SUB_PLATFORM_MASK;
777 mraa_get_sub_platform_index(int pin_or_bus)
779 return pin_or_bus & (~MRAA_SUB_PLATFORM_MASK);
783 mraa_get_iio_device_count()
785 return plat_iio->iio_device_count;
789 mraa_find_iio_device(const char* devicename)
792 for (i; i < plat_iio->iio_device_count; i++) {
794 // compare with devices array