Home | History | Annotate | Download | only in include 
      1 /*
      2  * Author: Thomas Ingleby <thomas.c.ingleby (at) intel.com>
      3  * Copyright (c) 2014 Intel Corporation.
      4  *
      5  * Permission is hereby granted, free of charge, to any person obtaining
      6  * a copy of this software and associated documentation files (the
      7  * "Software"), to deal in the Software without restriction, including
      8  * without limitation the rights to use, copy, modify, merge, publish,
      9  * distribute, sublicense, and/or sell copies of the Software, and to
     10  * permit persons to whom the Software is furnished to do so, subject to
     11  * the following conditions:
     12  *
     13  * The above copyright notice and this permission notice shall be
     14  * included in all copies or substantial portions of the Software.
     15  *
     16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     23  */
     24 
     25 #pragma once
     26 
     27 #ifdef __cplusplus
     28 extern "C" {
     29 #endif
     30 
     31 #include <syslog.h>
     32 #include <fnmatch.h>
     33 
     34 #include "common.h"
     35 #include "mraa_internal_types.h"
     36 #include "mraa_adv_func.h"
     37 
     38 extern mraa_board_t* plat;
     39 extern mraa_iio_info_t* plat_iio;
     40 
     41 /**
     42  * Takes in pin information and sets up the multiplexors.
     43  *
     44  * @param meta
     45  * @return mraa result type indicating success of actions.
     46  */
     47 mraa_result_t mraa_setup_mux_mapped(mraa_pin_t meta);
     48 
     49 /**
     50  * runtime detect running x86 platform
     51  *
     52  * @return mraa_platform_t of the init'ed platform
     53  */
     54 mraa_platform_t mraa_x86_platform();
     55 
     56 /**
     57  * runtime detect running arm platforms
     58  *
     59  * @return mraa_platform_t of the init'ed platform
     60  */
     61 mraa_platform_t mraa_arm_platform();
     62 
     63 /**
     64  * runtime detect running usb platform extender
     65  *
     66  * @return mraa_platform_t of the detected platform extender
     67  */
     68 mraa_platform_t mraa_usb_platform_extender(mraa_board_t* board);
     69 
     70 /**
     71  * runtime detect iio subsystem
     72  *
     73  * @return mraa_result_t indicating success of iio detection
     74  */
     75 mraa_result_t mraa_iio_detect();
     76 
     77 /**
     78  * helper function to check if file exists
     79  *
     80  * @param filename to check
     81  * @return mraa_boolean_t boolean result.
     82  */
     83 mraa_boolean_t mraa_file_exist(const char* filename);
     84 
     85 /**
     86  * helper function to unglob filenames
     87  *
     88  * @param filename to unglob
     89  * @return char * with the existing filename matching the pattern of input. NULL if there is no
     90  *match. Caller must free result
     91  */
     92 char* mraa_file_unglob(const char* filename);
     93 
     94 /**
     95  * helper function to check if file contains a given text
     96  *
     97  * @param filename to check
     98  * @param content to check in file
     99  * @return mraa_boolean_t boolean result.
    100  */
    101 mraa_boolean_t mraa_file_contains(const char* filename, const char* content);
    102 
    103 /**
    104  * helper function to check if file contains a given text
    105  *
    106  * @param filename to check
    107  * @param content to check in file
    108  * @param content2 to check in same line of file
    109  * @return mraa_boolean_t boolean result.
    110  */
    111 mraa_boolean_t mraa_file_contains_both(const char* filename, const char* content, const char* content2);
    112 
    113 /**
    114  * helper function to find out if file that is targeted by a softlink
    115  * (partially) matches the given name
    116  *
    117  * @param filename of the softlink
    118  * @param (partial) filename that is matched with the filename of the link-targeted file
    119  * @return mraa_boolean_t true when targetname (partially) matches
    120  */
    121 mraa_boolean_t mraa_link_targets(const char* filename, const char* targetname);
    122 
    123 /**
    124  * helper function to find the first i2c bus containing devname starting from
    125  * i2c-n where n is startfrom
    126  *
    127  * @param device name to match
    128  * @param i2c-dev number to start search from
    129  * @return the matching i2c-dev bus id or -1
    130  */
    131 int mraa_find_i2c_bus(const char* devname, int startfrom);
    132 
    133 #ifdef __cplusplus
    134 }
    135 #endif
    136