include/mraa_internal.h

   1 /*
   2  * Author: Thomas Ingleby <thomas.c.ingleby@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
  33 #include "common.h"
  34 #include "mraa_internal_types.h"
  35 #include "mraa_adv_func.h"
  36
  37 extern mraa_board_t* plat;
  38 extern mraa_iio_info_t* plat_iio;
  39
  40 /**
  41  * Takes in pin information and sets up the multiplexors.
  42  *
  43  * @param meta
  44  * @return mraa result type indicating success of actions.
  45  */
  46 mraa_result_t mraa_setup_mux_mapped(mraa_pin_t meta);
  47
  48 /**
  49  * runtime detect running x86 platform
  50  *
  51  * @return mraa_platform_t of the init'ed platform
  52  */
  53 mraa_platform_t mraa_x86_platform();
  54
  55 /**
  56  * runtime detect running arm platforms
  57  *
  58  * @return mraa_platform_t of the init'ed platform
  59  */
  60 mraa_platform_t mraa_arm_platform();
  61
  62 /**
  63  * runtime detect running usb platform extender
  64  *
  65  * @return mraa_platform_t of the detected platform extender
  66  */
  67 mraa_platform_t mraa_usb_platform_extender(mraa_board_t* board);
  68
  69 /**
  70  * helper function to check if file exists
  71  *
  72  * @param filename to check
  73  * @return mraa_boolean_t boolean result.
  74  */
  75 mraa_boolean_t mraa_file_exist(const char* filename);
  76
  77 /**
  78  * helper function to unglob filenames
  79  *
  80  * @param filename to unglob
  81  * @return char * with the existing filename matching the pattern of input. NULL if there is no
  82  *match. Caller must free result
  83  */
  84 char* mraa_file_unglob(const char* filename);
  85
  86 /**
  87  * helper function to check if file contains a given text
  88  *
  89  * @param filename to check
  90  * @param content to check in file
  91  * @return mraa_boolean_t boolean result.
  92  */
  93 mraa_boolean_t mraa_file_contains(const char* filename, const char* content);
  94
  95 /**
  96  * helper function to check if file contains a given text
  97  *
  98  * @param filename to check
  99  * @param content to check in file
 100  * @param content2 to check in same line of file
 101  * @return mraa_boolean_t boolean result.
 102  */
 103 mraa_boolean_t mraa_file_contains_both(const char* filename, const char* content, const char* content2);
 104
 105 /**
 106  * helper function to find out if file that is targeted by a softlink
 107  * (partially) matches the given name
 108  *
 109  * @param filename of the softlink
 110  * @param (partial) filename that is matched with the filename of the link-targeted file
 111  * @return mraa_boolean_t true when targetname (partially) matches
 112  */
 113 mraa_boolean_t mraa_link_targets(const char* filename, const char* targetname);
 114
 115 /**
 116  * helper function to find the first i2c bus containing devname starting from
 117  * i2c-n where n is startfrom
 118  *
 119  * @param device name to match
 120  * @param i2c-dev number to start search from
 121  * @return the matching i2c-dev bus id or -1
 122  */
 123 int mraa_find_i2c_bus(const char* devname, int startfrom);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif