Macros | Typedefs | Functions

le_kernelModule_interface.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros

#define LE_KERNELMODULE_NAME_LEN   60
 
#define LE_KERNELMODULE_NAME_LEN_BYTES   61
 

Typedefs

typedef void(* le_kernelModule_DisconnectHandler_t) (void *)
 

Functions

void le_kernelModule_ConnectService (void)
 
le_result_t le_kernelModule_TryConnectService (void)
 
void le_kernelModule_SetServerDisconnectHandler (le_kernelModule_DisconnectHandler_t disconnectHandler, void *contextPtr)
 
void le_kernelModule_DisconnectService (void)
 
le_result_t le_kernelModule_Load (const char *LE_NONNULL moduleName)
 
le_result_t le_kernelModule_Unload (const char *LE_NONNULL moduleName)
 

Detailed Description

Legato Linux Kernel Module API include file.

Copyright (C) Sierra Wireless Inc.

Typedef Documentation

◆ le_kernelModule_DisconnectHandler_t

typedef void(* le_kernelModule_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_kernelModule_ConnectService()

void le_kernelModule_ConnectService ( void  )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

◆ le_kernelModule_DisconnectService()

void le_kernelModule_DisconnectService ( void  )

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

◆ le_kernelModule_Load()

le_result_t le_kernelModule_Load ( 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.

◆ le_kernelModule_SetServerDisconnectHandler()

void le_kernelModule_SetServerDisconnectHandler ( le_kernelModule_DisconnectHandler_t  disconnectHandler,
void *  contextPtr 
)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ le_kernelModule_TryConnectService()

le_result_t le_kernelModule_TryConnectService ( void  )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

Returns
  • LE_OK if the client connected successfully to the service.
  • LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
  • LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
  • LE_COMM_ERROR if the Service Directory cannot be reached.

◆ le_kernelModule_Unload()

le_result_t le_kernelModule_Unload ( 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.