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