1 /* 2 * Copyright (C) 2016 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef CHRE_PLATFORM_SHARED_NANOAPP_SUPPORT_LIB_DSO_H_ 18 #define CHRE_PLATFORM_SHARED_NANOAPP_SUPPORT_LIB_DSO_H_ 19 20 /** 21 * @file 22 * This provides the interface that the dynamic shared object (DSO) nanoapp 23 * nanoapp support library (NSL) uses to interface with the underlying CHRE 24 * implementation in a compatible manner. 25 * 26 * This header file must retain compatibility with C, and have minimal or no 27 * dependencies on other CHRE system header files, as it will be used when 28 * compiling external/dynamic nanoapps. 29 */ 30 31 #include "chre/util/entry_points.h" 32 33 #include <stdint.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 //! Special magic value to uniquely identify the nanoapp info structure 40 #define CHRE_NSL_NANOAPP_INFO_MAGIC UINT32_C(0x50e69977) 41 42 //! The minor version in the nanoapp info structure to determine which fields 43 //! are available to support backwards compatibility. 44 #define CHRE_NSL_NANOAPP_INFO_STRUCT_MINOR_VERSION UINT8_C(3) 45 46 //! The symbol name expected from the nanoapp's definition of its info struct 47 #define CHRE_NSL_DSO_NANOAPP_INFO_SYMBOL_NAME "_chreNslDsoNanoappInfo" 48 49 //! The symbol name expected from the nanoapp's definition of its unstable ID 50 //! char array 51 #define CHRE_NSL_DSO_NANOAPP_UNSTABLE_ID_SYMBOL_NAME "_chreNanoappUnstableId" 52 53 //! Maximum length of vendor and name strings 54 #define CHRE_NSL_DSO_NANOAPP_STRING_MAX_LEN (32) 55 56 /** 57 * DSO-based nanoapps must expose this struct under a symbol whose name is given 58 * by CHRE_NSL_DSO_NANOAPP_INFO_SYMBOL_NAME. When the nanoapp is loaded, dlsym() 59 * will be used to locate this symbol to register the nanoapp with the system. 60 */ 61 struct chreNslNanoappInfo { 62 //! @see CHRE_NSL_NANOAPP_INFO_MAGIC 63 uint32_t magic; 64 65 //! @see CHRE_NSL_NANOAPP_INFO_STRUCT_MINOR_VERSION 66 uint8_t structMinorVersion; 67 68 //! Set to 1 if this nanoapp is a "system nanoapp" that should not show up in 69 //! the context hub HAL, likely because it implements some device 70 //! functionality beneath the HAL. 71 uint8_t isSystemNanoapp : 1; 72 73 //! Set to 1 if this nanoapp runs in tightly coupled memory. This flag is only 74 //! relevant to platforms that have the ability to run nanoapps within tightly 75 //! coupled memory. 76 //! 77 //! @since minor version 1 78 uint8_t isTcmNanoapp : 1; 79 80 //! Reserved for future use, set to 0. Assignment of this field to some use 81 //! must be accompanied by an increase of the struct minor version. 82 uint8_t reservedFlags : 6; 83 uint8_t reserved; 84 85 //! The CHRE API version that the nanoapp was compiled against 86 uint32_t targetApiVersion; 87 88 //! A human-friendly name of the nanoapp vendor (null-terminated string, 89 //! maximum length CHRE_NSL_DSO_NANOAPP_STRING_MAX_LEN) 90 const char *vendor; 91 92 //! A human-friendly name for the nanoapp (null-terminated string, maximum 93 //! length CHRE_NSL_DSO_NANOAPP_STRING_MAX_LEN) 94 const char *name; 95 96 //! Identifies the vendor (most significant 5 bytes) and application 97 uint64_t appId; 98 99 //! Application-specific version number 100 uint32_t appVersion; 101 102 struct { 103 chreNanoappStartFunction *start; 104 chreNanoappHandleEventFunction *handleEvent; 105 chreNanoappEndFunction *end; 106 } entryPoints; 107 108 //! Application-specific verison string. This might contain a commit hash at 109 //! which the app was built, but is up to the app itself. 110 //! 111 //! @since minor version 2 112 const char *appVersionString; 113 114 //! Set of permissions that determines what APIs the application is allowed to 115 //! use. See chre/util/system/napp_permissions.h for more details on what 116 //! permissions can be declared here and what their values are. 117 //! 118 //! @since minor version 3 119 uint32_t appPermissions; 120 }; 121 122 /** 123 * Defined as a placeholder to enable future functionality extension. 124 * 125 * @param apiId 126 * @param apiHandle If this function returns true, this will be set to a pointer 127 * to the associated structure containing the API 128 * 129 * @return true if the requested API is supported, false otherwise 130 */ 131 bool chreNslDsoGetApi(uint32_t apiId, void **apiHandle); 132 133 #ifdef __cplusplus 134 } 135 #endif 136 137 #endif // CHRE_PLATFORM_SHARED_NANOAPP_SUPPORT_LIB_DSO_H_ 138
