/* * Copyright (C) 2017 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef CHRE_HOST_HOST_PROTOCOL_HOST_H_ #define CHRE_HOST_HOST_PROTOCOL_HOST_H_ #include #include "chre/platform/shared/host_protocol_common.h" #include "chre_host/fragmented_load_transaction.h" #include "chre_host/generated/host_messages_generated.h" #include "flatbuffers/flatbuffers.h" #include namespace android { namespace chre { /** * Checks that a string encapsulated as a byte vector is null-terminated, and * if it is, returns a pointer to the vector's data. Otherwise returns null. * * This is similar to getStringFromByteVector in host_protocol_chre.h. Ensure * that method's implementation is kept in sync with this. * * @param vec Target vector, can be null * * @return Pointer to the vector's data, or null */ const char *getStringFromByteVector(const std::vector &vec); /** * Calling code should provide an implementation of this interface to handle * parsed results from decodeMessageFromChre(). */ class IChreMessageHandlers { public: virtual ~IChreMessageHandlers() = default; virtual void handleNanoappMessage( const ::chre::fbs::NanoappMessageT & /*message*/){}; virtual void handleHubInfoResponse( const ::chre::fbs::HubInfoResponseT & /*response*/){}; virtual void handleNanoappListResponse( const ::chre::fbs::NanoappListResponseT & /*response*/){}; virtual void handleLoadNanoappResponse( const ::chre::fbs::LoadNanoappResponseT & /*response*/){}; virtual void handleUnloadNanoappResponse( const ::chre::fbs::UnloadNanoappResponseT & /*response*/){}; virtual void handleDebugDumpData( const ::chre::fbs::DebugDumpDataT & /*data*/){}; virtual void handleDebugDumpResponse( const ::chre::fbs::DebugDumpResponseT & /*response*/){}; virtual void handleSelfTestResponse( const ::chre::fbs::SelfTestResponseT & /*response*/){}; }; /** * A set of helper methods that simplify the encode/decode of FlatBuffers * messages used in communication with CHRE from the host. */ class HostProtocolHost : public ::chre::HostProtocolCommon { public: /** * Decodes a message sent from CHRE and invokes the appropriate handler * function in the provided interface implementation to handle the parsed * result. * * @param message Buffer containing a complete FlatBuffers CHRE message * @param messageLen Size of the message, in bytes * @param handlers Set of callbacks to handle the parsed message. If this * function returns success, then exactly one of these functions was * called. * * @return true if the message was parsed successfully and passed to a handler */ static bool decodeMessageFromChre(const void *message, size_t messageLen, IChreMessageHandlers &handlers); /** * Encodes a message requesting pulse from CHRE * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodePulseRequest(flatbuffers::FlatBufferBuilder &builder); /** * Encodes a message requesting hub information from CHRE * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodeHubInfoRequest(flatbuffers::FlatBufferBuilder &builder); /** * Encodes a message sending boot debug configuration to CHRE * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodeDebugConfiguration(flatbuffers::FlatBufferBuilder &builder); /** * Encodes a message requesting to load a nanoapp specified by the included * (possibly fragmented) binary payload and metadata. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message * @param request The FragmentedLoadRequest object with the binary and the * metadata * @param respondBeforeStart See LoadNanoappRequest.respond_before_start in * flatbuffers message. */ static void encodeFragmentedLoadNanoappRequest( flatbuffers::FlatBufferBuilder &builder, const FragmentedLoadRequest &request, bool respondBeforeStart = false); /** * Encodes a message requesting the list of loaded nanoapps from CHRE * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodeNanoappListRequest(flatbuffers::FlatBufferBuilder &builder); /** * Encodes a message requesting to unload a nanoapp specified by app ID. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message * @param transactionId A transaction identifier to tie the subsequent * response to this request * @param appId Identifier for the app to unload * @param allowSystemNanoappUnload Whether this request should be allowed to * result in unloading a system nanoapp (e.g. requests from the context * hub HAL should have set this to false, as system nanoapps are not * expected to be managed through that HAL) */ static void encodeUnloadNanoappRequest( flatbuffers::FlatBufferBuilder &builder, uint32_t transactionId, uint64_t appId, bool allowSystemNanoappUnload); /** * Encodes a message to send the AP timestamp to CHRE * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message * @param offset The AP to SLPI offset in nanoseconds */ static void encodeTimeSyncMessage(flatbuffers::FlatBufferBuilder &builder, int64_t offset); /** * Encodes a message requesting debugging information from CHRE * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodeDebugDumpRequest(flatbuffers::FlatBufferBuilder &builder); /** * Decodes the host client ID included in the message container * * @param message Buffer containing a complete FlatBuffers CHRE message * @param messageLen Size of the message, in bytes * @param hostClientId Output parameter that will be populated with the client * ID included in the message on success * * @return true if the host client ID was successfully decoded from the * message */ static bool extractHostClientIdAndType(const void *message, size_t messageLen, uint16_t *hostClientId, ::chre::fbs::ChreMessage *messageType); /** * Update the host client ID field in the MessageContainer. * * @param message Buffer containing a complete FlatBuffers CHRE message * @param messageLen Size of the message, in bytes * @param hostClientId The value to set the host client ID to * * @return true if the message was verified successfully, and we were able to * modify the host client ID field */ static bool mutateHostClientId(void *message, size_t messageLen, uint16_t hostClientId); /** * Encodes a message requesting to load a nanoapp specified by the included * binary payload and metadata. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodeLoadNanoappRequestForBinary( flatbuffers::FlatBufferBuilder &builder, uint32_t transactionId, uint64_t appId, uint32_t appVersion, uint32_t appFlags, uint32_t targetApiVersion, const std::vector &nanoappBinary, uint32_t fragmentId, size_t appTotalSizeBytes, bool respondBeforeStart); /** * Encodes a message requesting to load a nanoapp specified by the included * binary filename and metadata. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message */ static void encodeLoadNanoappRequestForFile( flatbuffers::FlatBufferBuilder &builder, uint32_t transactionId, uint64_t appId, uint32_t appVersion, uint32_t targetApiVersion, const char *nanoappBinaryName); /** * Encodes a message notifying CHRE of a user setting change. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message * @param setting The setting value that the user changed * @param newState The state that the user change the setting to. */ static void encodeSettingChangeNotification( flatbuffers::FlatBufferBuilder &builder, ::chre::fbs::Setting setting, ::chre::fbs::SettingState newState); /** * Encodes a message to request CHRE to perform a self test. */ static void encodeSelfTestRequest(flatbuffers::FlatBufferBuilder &builder); /** * Encodes a message notifying CHRE of a host endpoint that connected. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message * @param hostEndpointId The ID of the host endpoint that connected. * @param type The CHRE_HOST_ENDPOINT_TYPE_* value that describes the * endpoint. * @param packageName The (optional) package name of the endpoint. * @param attributionTag The (optional) attribution tag of the endpoint. */ static void encodeHostEndpointConnected( flatbuffers::FlatBufferBuilder &builder, uint16_t hostEndpointId, uint8_t type, const std::string &packageName, const std::string &attributionTag); /** * Encodes a message notifying CHRE of a host endpoint that disconnected. * * @param builder A newly constructed FlatBufferBuilder that will be used to * construct the message * @param hostEndpointId The ID of the host endpoint that disconnected. */ static void encodeHostEndpointDisconnected( flatbuffers::FlatBufferBuilder &builder, uint16_t hostEndpointId); static void encodeNanconfigurationUpdate( flatbuffers::FlatBufferBuilder &builder, bool nanEnabled); }; } // namespace chre } // namespace android #endif // CHRE_HOST_HOST_PROTOCOL_HOST_H_