le_gpioCfg_common.h

    1 
    2 /*
    3  * ====================== WARNING ======================
    4  *
    5  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    6  * DO NOT MODIFY IN ANY WAY.
    7  *
    8  * ====================== WARNING ======================
    9  */
   10 /**
   11  * @file le_gpioCfg_common.h
   12  *
   13  * Type definitions for le_gpioCfg.
   14  *
   15  */
   16 #ifndef LE_GPIOCFG_COMMON_H_INCLUDE_GUARD
   17 #define LE_GPIOCFG_COMMON_H_INCLUDE_GUARD
   18 
   19 
   20 #include "legato.h"
   21 
   22 #define IFGEN_LE_GPIOCFG_PROTOCOL_ID "0b0f9e49a9882653d7b5d948d4ca5d05"
   23 #define IFGEN_LE_GPIOCFG_MSG_SIZE 272
   24 /** @addtogroup le_gpioCfg
   25  *  @{ **/
   26 
   27 
   28 //--------------------------------------------------------------------------------------------------
   29 /**
   30  * @file le_gpioCfg_interface.h
   31  *
   32  * Legato @ref c_gpioCfg include file.
   33  *
   34  * Copyright (C) Sierra Wireless Inc.
   35  */
   36 //--------------------------------------------------------------------------------------------------
   37 #define LE_GPIOCFG_MAX_GPIO_LIST_SIZE 64
   38 
   39 
   40 //--------------------------------------------------------------------------------------------------
   41 /**
   42  * Get if this client bound locally.
   43  */
   44 //--------------------------------------------------------------------------------------------------
   45 LE_SHARED bool ifgen_le_gpioCfg_HasLocalBinding
   46 (
   47     void
   48 );
   49 
   50 
   51 //--------------------------------------------------------------------------------------------------
   52 /**
   53  * Init data that is common across all threads
   54  */
   55 //--------------------------------------------------------------------------------------------------
   56 LE_SHARED void ifgen_le_gpioCfg_InitCommonData
   57 (
   58     void
   59 );
   60 
   61 
   62 //--------------------------------------------------------------------------------------------------
   63 /**
   64  * Perform common initialization and open a session
   65  */
   66 //--------------------------------------------------------------------------------------------------
   67 LE_SHARED le_result_t ifgen_le_gpioCfg_OpenSession
   68 (
   69     le_msg_SessionRef_t _ifgen_sessionRef,
   70     bool isBlocking
   71 );
   72 
   73 //--------------------------------------------------------------------------------------------------
   74 /**
   75  * Get the current number of GPIO pins in the system
   76  *
   77  * @return The current configured value
   78  */
   79 //--------------------------------------------------------------------------------------------------
   80 LE_SHARED uint32_t ifgen_le_gpioCfg_GetTotalPinNumber
   81 (
   82     le_msg_SessionRef_t _ifgen_sessionRef
   83 );
   84 
   85 //--------------------------------------------------------------------------------------------------
   86 /**
   87  * Get the current number of GPIO pins in the system
   88  *
   89  * @return The current configured value
   90  */
   91 //--------------------------------------------------------------------------------------------------
   92 LE_SHARED bool ifgen_le_gpioCfg_IsAvailable
   93 (
   94     le_msg_SessionRef_t _ifgen_sessionRef,
   95         uint32_t gpioId
   96         ///< [IN] GPIO ID being examined
   97 );
   98 
   99 //--------------------------------------------------------------------------------------------------
  100 /**
  101  * Get list of supported GPIOs. If GPIO01, GPIO03 and GPIO05 are supported,
  102  * the returned list will look like {1, 5, 7}
  103  *
  104  * @return
  105  *    - LE_OK on success
  106  *    - LE_FAULT on failure
  107  */
  108 //--------------------------------------------------------------------------------------------------
  109 LE_SHARED le_result_t ifgen_le_gpioCfg_GetSupportedGpioList
  110 (
  111     le_msg_SessionRef_t _ifgen_sessionRef,
  112         uint32_t* retListPtr,
  113         ///< [OUT] User allocated buffer where results will be stored
  114         size_t* retListSizePtr
  115         ///< [INOUT]
  116 );
  117 /** @} **/
  118 #endif // LE_GPIOCFG_COMMON_H_INCLUDE_GUARD
LE_SHARED
#define LE_SHARED
Definition: le_basics.h:300
le_result_t
le_result_t
Definition: le_basics.h:46
le_msg_SessionRef_t
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860
legato.h