Snapdragon® Telematics Application Framework (TelAF) Interface Specification
le_kernelModule_common.h File Reference
#include "legato.h"

Go to the source code of this file.

Macros

#define IFGEN_LE_KERNELMODULE_PROTOCOL_ID   "b9a021649e1b6d35ccdd0293014c964b"
 
#define IFGEN_LE_KERNELMODULE_MSG_SIZE   72
 
#define LE_KERNELMODULE_NAME_LEN   60
 
#define LE_KERNELMODULE_NAME_LEN_BYTES   61
 

Functions

LE_SHARED bool ifgen_le_kernelModule_HasLocalBinding (void)
 
LE_SHARED void ifgen_le_kernelModule_InitCommonData (void)
 
LE_SHARED void ifgen_le_kernelModule_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_le_kernelModule_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED le_result_t ifgen_le_kernelModule_Load (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL moduleName)
 
LE_SHARED le_result_t ifgen_le_kernelModule_Unload (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL moduleName)
 

Macro Definition Documentation

◆ IFGEN_LE_KERNELMODULE_PROTOCOL_ID

#define IFGEN_LE_KERNELMODULE_PROTOCOL_ID   "b9a021649e1b6d35ccdd0293014c964b"

◆ IFGEN_LE_KERNELMODULE_MSG_SIZE

#define IFGEN_LE_KERNELMODULE_MSG_SIZE   72

◆ LE_KERNELMODULE_NAME_LEN

#define LE_KERNELMODULE_NAME_LEN   60

◆ LE_KERNELMODULE_NAME_LEN_BYTES

#define LE_KERNELMODULE_NAME_LEN_BYTES   61

Function Documentation

◆ ifgen_le_kernelModule_HasLocalBinding()

LE_SHARED bool ifgen_le_kernelModule_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_le_kernelModule_InitCommonData()

LE_SHARED void ifgen_le_kernelModule_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_le_kernelModule_CleanupCommonData()

LE_SHARED void ifgen_le_kernelModule_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_le_kernelModule_OpenSession()

LE_SHARED le_result_t ifgen_le_kernelModule_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_le_kernelModule_Load()

LE_SHARED le_result_t ifgen_le_kernelModule_Load ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  moduleName 
)

Load the specified kernel module that was bundled with a Legato system.

Returns
  • LE_OK if the module has been successfully loaded into the kernel.
  • LE_NOT_FOUND if the named module was not found in the system.
  • LE_FAULT if errors were encountered when loading the module, or one of the module's dependencies.
  • LE_DUPLICATE if the module has been already loaded into the kernel.
Parameters
[in]moduleNameName of the module to load.

◆ ifgen_le_kernelModule_Unload()

LE_SHARED le_result_t ifgen_le_kernelModule_Unload ( le_msg_SessionRef_t  _ifgen_sessionRef,
const char *LE_NONNULL  moduleName 
)

Unload the specified module. The module to be unloaded must be one that was bundled with the system.

Returns
  • LE_OK if the module has been successfully unloaded from the kernel.
  • LE_NOT_FOUND if the named module was not found in the system.
  • LE_FAULT if errors were encountered during the module, or one of the module's dependencies unloading.
  • LE_DUPLICATE if the module has been already unloaded from the kernel.
Parameters
[in]moduleNameName of the module to unload.