le_kernelModule_common.h

Go to the documentation of this file.
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_kernelModule_common.h
12  *
13  * Type definitions for le_kernelModule.
14  *
15  */
16 #ifndef LE_KERNELMODULE_COMMON_H_INCLUDE_GUARD
17 #define LE_KERNELMODULE_COMMON_H_INCLUDE_GUARD
18 
19 
20 #include "legato.h"
21 
22 #define IFGEN_LE_KERNELMODULE_PROTOCOL_ID "b9a021649e1b6d35ccdd0293014c964b"
23 #define IFGEN_LE_KERNELMODULE_MSG_SIZE 72
24 /** @addtogroup le_kernelModule
25  * @{ **/
26 
27 
28 //--------------------------------------------------------------------------------------------------
29 /**
30  * @file le_kernelModule_interface.h
31  *
32  * Legato @ref c_kernelModule include file.
33  *
34  * Copyright (C) Sierra Wireless Inc.
35  */
36 //--------------------------------------------------------------------------------------------------
37 #define LE_KERNELMODULE_NAME_LEN 60
38 
39 //--------------------------------------------------------------------------------------------------
40 /**
41  */
42 //--------------------------------------------------------------------------------------------------
43 #define LE_KERNELMODULE_NAME_LEN_BYTES 61
44 
45 
46 //--------------------------------------------------------------------------------------------------
47 /**
48  * Get if this client bound locally.
49  */
50 //--------------------------------------------------------------------------------------------------
51 LE_SHARED bool ifgen_le_kernelModule_HasLocalBinding
52 (
53  void
54 );
55 
56 
57 //--------------------------------------------------------------------------------------------------
58 /**
59  * Init data that is common across all threads
60  */
61 //--------------------------------------------------------------------------------------------------
62 LE_SHARED void ifgen_le_kernelModule_InitCommonData
63 (
64  void
65 );
66 
67 
68 //--------------------------------------------------------------------------------------------------
69 /**
70  * Perform common initialization and open a session
71  */
72 //--------------------------------------------------------------------------------------------------
73 LE_SHARED le_result_t ifgen_le_kernelModule_OpenSession
74 (
75  le_msg_SessionRef_t _ifgen_sessionRef,
76  bool isBlocking
77 );
78 
79 //--------------------------------------------------------------------------------------------------
80 /**
81  * Load the specified kernel module that was bundled with a Legato system.
82  *
83  * @return
84  * - LE_OK if the module has been successfully loaded into the kernel.
85  * - LE_NOT_FOUND if the named module was not found in the system.
86  * - LE_FAULT if errors were encountered when loading the module, or one of the module's
87  * dependencies.
88  * - LE_DUPLICATE if the module has been already loaded into the kernel.
89  */
90 //--------------------------------------------------------------------------------------------------
91 LE_SHARED le_result_t ifgen_le_kernelModule_Load
92 (
93  le_msg_SessionRef_t _ifgen_sessionRef,
94  const char* LE_NONNULL moduleName
95  ///< [IN] Name of the module to load.
96 );
97 
98 //--------------------------------------------------------------------------------------------------
99 /**
100  * Unload the specified module. The module to be unloaded must be one that was bundled with the
101  * system.
102  *
103  * @return
104  * - LE_OK if the module has been successfully unloaded from the kernel.
105  * - LE_NOT_FOUND if the named module was not found in the system.
106  * - LE_FAULT if errors were encountered during the module, or one of the module's dependencies
107  * unloading.
108  * - LE_DUPLICATE if the module has been already unloaded from the kernel.
109  */
110 //--------------------------------------------------------------------------------------------------
111 LE_SHARED le_result_t ifgen_le_kernelModule_Unload
112 (
113  le_msg_SessionRef_t _ifgen_sessionRef,
114  const char* LE_NONNULL moduleName
115  ///< [IN] Name of the module to unload.
116 );
117 /** @} **/
118 #endif // LE_KERNELMODULE_COMMON_H_INCLUDE_GUARD
#define LE_SHARED
Definition: le_basics.h:300
le_result_t
Definition: le_basics.h:46
struct le_msg_Session * le_msg_SessionRef_t
Definition: le_messaging.h:860