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