platform: Support zephyr

Add an implementation for platform/zephyr along with appropriate build
rules and Kconfig. This was tested against zephyrproject-rtos/zephyr#41735

Signed-off-by: Yuval Peress <[email protected]>
Change-Id: I34cd7b100db1d1c2411b9151d537ce6594d2cd89

Author: yperess

platform/zephyr/CMakeLists.txt

@@ -0,0 +1,128 @@
+# Copyright (C) 2022 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.
+
+if(CONFIG_CHRE)
+  get_filename_component(CHRE_DIR "${ZEPHYR_CURRENT_MODULE_DIR}" ABSOLUTE)
+
+  zephyr_library()
+
+  set(CHRE_INCLUDE_DIRS
+      "${CHRE_DIR}/chpp/include"
+      "${CHRE_DIR}/chre_api/include"
+      "${CHRE_DIR}/chre_api/include/chre_api"
+      "${CHRE_DIR}/core/include"
+      "${CHRE_DIR}/pal/include"
+      "${CHRE_DIR}/platform/include"
+      "${CHRE_DIR}/platform/shared/include"
+      "${CHRE_DIR}/util/include"
+      "${CMAKE_CURRENT_SOURCE_DIR}/include")
+  zephyr_include_directories("${CHRE_INCLUDE_DIRS}")
+  zephyr_library_include_directories("${CHRE_INCLUDE_DIRS}")
+
+  zephyr_library_sources(
+      "context.cc"
+      "host_link.cc"
+      "init.cc"
+      "log_module.c"
+      "memory.cc"
+      "platform_nanoapp.cc"
+      "power_control_manager.cc"
+      "system_time.cc"
+      "system_timer.cc"
+      "${CHRE_DIR}/core/debug_dump_manager.cc"
+      "${CHRE_DIR}/core/event.cc"
+      "${CHRE_DIR}/core/event_loop.cc"
+      "${CHRE_DIR}/core/event_loop_manager.cc"
+      "${CHRE_DIR}/core/event_ref_queue.cc"
+      "${CHRE_DIR}/core/host_comms_manager.cc"
+      "${CHRE_DIR}/core/init.cc"
+      "${CHRE_DIR}/core/nanoapp.cc"
+      "${CHRE_DIR}/core/settings.cc"
+      "${CHRE_DIR}/core/static_nanoapps.cc"
+      "${CHRE_DIR}/core/timer_pool.cc"
+      "${CHRE_DIR}/platform/shared/version.cc"
+      "${CHRE_DIR}/platform/shared/system_time.cc"
+      "${CHRE_DIR}/util/dynamic_vector_base.cc"
+  )
+
+  # Optional audio support
+  if(CONFIG_CHRE_AUDIO_SUPPORT_ENABLED)
+    zephyr_compile_definitions(CHRE_AUDIO_SUPPORT_ENABLED)
+    zephyr_library_sources("${CHRE_DIR}/core/audio_request_manager.cc")
+  endif()
+
+  # Optional GNSS support
+  if(CONFIG_CHRE_GNSS_SUPPORT_ENABLED)
+    zephyr_compile_definitions(CHRE_GNSS_SUPPORT_ENABLED)
+    zephyr_library_sources("${CHRE_DIR}/core/gnss_manager.cc")
+  endif()
+
+  # Optional sensor support
+  if(CONFIG_CHRE_SENSORS_SUPPORT_ENABLED)
+    zephyr_compile_definitions(CHRE_SENSORS_SUPPORT_ENABLED)
+    zephyr_library_sources(
+        "${CHRE_DIR}/core/sensor.cc"
+        "${CHRE_DIR}/core/sensor_request.cc"
+        "${CHRE_DIR}/core/sensor_request_manager.cc"
+        "${CHRE_DIR}/core/sensor_request_multiplexer.cc"
+        "${CHRE_DIR}/core/sensor_type.cc"
+        "${CHRE_DIR}/core/sensor_type_helpers.cc"
+    )
+  endif()
+
+  # Optional WiFi support
+  if(CONFIG_CHRE_WIFI_SUPPORT_ENABLED)
+    zephyr_compile_definitions(CHRE_WIFI_SUPPORT_ENABLED)
+    zephyr_library_sources(
+        "${CHRE_DIR}/core/wifi_request_manager.cc"
+        "${CHRE_DIR}/core/wifi_scan_request.cc"
+    )
+  endif()
+
+  # Optional WWAN support
+  if(CONFIG_CHRE_WWAN_SUPPORT_ENABLED)
+    zephyr_compile_definitions(CHRE_WWAN_SUPPORT_ENABLED)
+    zephyr_library_sources("${CHRE_DIR}/core/wwan_request_manager.cc")
+  endif()
+
+  zephyr_compile_definitions(
+      CHRE_MESSAGE_TO_HOST_MAX_SIZE=${CONFIG_CHRE_MESSAGE_TO_HOST_MAX_SIZE})
+
+  zephyr_compile_definitions(CHRE_FILENAME=__FILE__)
+
+  # Add logging definitions
+  if((NOT DEFINED CONFIG_CHRE_LOG_LEVEL) OR
+     "${CONFIG_CHRE_LOG_LEVEL}" EQUAL "0")
+    zephyr_compile_definitions(CHRE_MINIMUM_LOG_LEVEL=CHRE_LOG_LEVEL_MUTE)
+  elseif("${CONFIG_CHRE_LOG_LEVEL}" EQUAL "1")
+    zephyr_compile_definitions(CHRE_MINIMUM_LOG_LEVEL=CHRE_LOG_LEVEL_ERROR)
+  elseif("${CONFIG_CHRE_LOG_LEVEL}" EQUAL "2")
+    zephyr_compile_definitions(CHRE_MINIMUM_LOG_LEVEL=CHRE_LOG_LEVEL_WARN)
+  elseif("${CONFIG_CHRE_LOG_LEVEL}" EQUAL "3")
+    zephyr_compile_definitions(CHRE_MINIMUM_LOG_LEVEL=CHRE_LOG_LEVEL_INFO)
+  elseif(("${CONFIG_CHRE_LOG_LEVEL}" EQUAL "4") OR
+         ("${CONFIG_CHRE_LOG_LEVEL}" EQUAL "5"))
+    # Debug and verbose are collapsed into one since Zephyr doesn't
+    # differentiate the two levels
+    zephyr_compile_definitions(CHRE_MINIMUM_LOG_LEVEL=CHRE_LOG_LEVEL_VERBOSE)
+  endif()
+
+  if(DEFINED CONFIG_CHRE_ASSERTIONS)
+    zephyr_compile_definitions(CHRE_ASSERTIONS_ENABLED)
+  else()
+    zephyr_compile_definitions(CHRE_ASSERTIONS_DISABLED)
+  endif()
+
+  zephyr_compile_definitions(CHRE_FIRST_SUPPORTED_API_VERSION=CHRE_API_VERSION_1_5)
+endif()

platform/zephyr/Kconfig

@@ -0,0 +1,70 @@
+# Copyright (c) 2021 Google LLC
+# SPDX-License-Identifier: Apache-2.0
+
+config ZEPHYR_CHRE_MODULE
+	bool
+
+menuconfig CHRE
+	bool "CHRE Support"
+	help
+	  This option enables the CHRE library.
+
+if CHRE
+
+module = CHRE
+module-str = chre
+source "subsys/logging/Kconfig.template.log_config"
+
+config CHRE_MESSAGE_TO_HOST_MAX_SIZE
+	int "Maximum message size to send to the host (bytes)"
+	default 4000
+	help
+	  Defines the maximum message size that can be sent to the host.
+
+config CHRE_ASSERTIONS
+	bool "Enable CHRE assertions"
+	help
+	  When enabled, CHRE will include various assertions which will trigger
+	  calls to chreAbort if resolve to false.
+
+config CHRE_AUDIO_SUPPORT_ENABLED
+	bool "Enable audio support"
+	help
+	  When enabled, CHRE will include the code needed to support the audio
+	  framework. The framework should be provided via chrePalAudioGetApi()
+
+config CHRE_GNSS_SUPPORT_ENABLED
+	bool "Enable GNSS support"
+	help
+	  When enabled, CHRE will include the code needed to support the GNSS
+	  framework. The framework should be provided via chrePalGnssGetApi()
+
+config CHRE_SENSORS_SUPPORT_ENABLED
+	bool "Enable sensor support"
+	help
+	  When enabled, CHRE will include the code needed to support the sensor
+	  framework. The framework should be provided via chrePalSensorGetApi()
+
+config CHRE_WIFI_SUPPORT_ENABLED
+	bool "Enable WiFi support"
+	help
+	  When enabled, CHRE will include the code needed to support the WiFi
+	  framework. The framework should be provided via chrePalWifiGetApi()
+
+config CHRE_DYNAMIC_MEMORY_SIZE
+	int "The size of the CHRE memory pool"
+	default 4096
+
+config CHRE_TASK_NAME
+	string "The name of the CHRE task"
+	default "CHRE"
+
+config CHRE_TASK_STACK_SIZE
+	int "The size of the CHRE task stack"
+	default 2048
+
+config CHRE_TASK_PRIORITY
+	int "The priority of the CHRE task"
+	default 5
+
+endif # CHRE

platform/zephyr/context.cc

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2022 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.
+ */
+
+#include "chre/platform/context.h"
+
+#include <zephyr.h>
+#include "chre/target_platform/init.h"
+
+namespace chre {
+
+bool inEventLoopThread() {
+  k_tid_t evtLoopTaskId = zephyr::getChreTaskId();
+  k_tid_t currentTaskId = k_current_get();
+
+  return (evtLoopTaskId == currentTaskId);
+}
+
+}  // namespace chre

platform/zephyr/host_link.cc

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2022 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.
+ */
+
+#include "chre/platform/host_link.h"
+
+namespace chre {
+
+void HostLink::flushMessagesSentByNanoapp(uint64_t appId) {
+  // TODO: implement
+}
+
+bool HostLink::sendMessage(const MessageToHost *message) {
+  // TODO: implement
+  return false;
+}
+
+}  // namespace chre

platform/zephyr/include/chre/target_platform/atomic_base.h

@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2022 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_PLATFORM_ZEPHYR_ATOMIC_BASE_H_
+#define CHRE_PLATFORM_ZEPHYR_ATOMIC_BASE_H_
+
+#include <sys/atomic.h>
+
+namespace chre {
+
+class AtomicBase {
+ protected:
+  atomic_t value;
+};
+
+typedef AtomicBase AtomicBoolBase;
+typedef AtomicBase AtomicUint32Base;
+
+}  // namespace chre
+
+#endif  // CHRE_PLATFORM_ZEPHYR_ATOMIC_BASE_H_

platform/zephyr/include/chre/target_platform/atomic_base_impl.h

@@ -0,0 +1,84 @@
+/*
+ * Copyright (C) 2022 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_PLATFORM_ZEPHYR_ATOMIC_BASE_IMPL_H_
+#define CHRE_PLATFORM_ZEPHYR_ATOMIC_BASE_IMPL_H_
+
+#include <sys/atomic.h>
+
+#include "chre/platform/atomic.h"
+
+namespace chre {
+
+inline AtomicBool::AtomicBool(bool starting_value) {
+  value = ATOMIC_INIT(starting_value);
+}
+
+inline bool AtomicBool::operator=(bool desired) {
+  return atomic_set(&value, desired);
+}
+
+inline bool AtomicBool::load() const {
+  return atomic_get(&value);
+}
+
+inline void AtomicBool::store(bool desired) {
+  atomic_set(&value, desired);
+}
+
+inline bool AtomicBool::exchange(bool desired) {
+  return atomic_set(&value, desired);
+}
+
+inline AtomicUint32::AtomicUint32(uint32_t starting_value) {
+  value = ATOMIC_INIT(starting_value);
+}
+
+inline uint32_t AtomicUint32::operator=(uint32_t desired) {
+  return atomic_set(&value, desired);
+}
+
+inline uint32_t AtomicUint32::load() const {
+  return atomic_get(&value);
+}
+
+inline void AtomicUint32::store(uint32_t desired) {
+  atomic_set(&value, desired);
+}
+
+inline uint32_t AtomicUint32::exchange(uint32_t desired) {
+  return atomic_set(&value, desired);
+}
+
+inline uint32_t AtomicUint32::fetch_add(uint32_t arg) {
+  return atomic_add(&value, arg);
+}
+
+inline uint32_t AtomicUint32::fetch_increment() {
+  return atomic_inc(&value);
+}
+
+inline uint32_t AtomicUint32::fetch_sub(uint32_t arg) {
+  return atomic_sub(&value, arg);
+}
+
+inline uint32_t AtomicUint32::fetch_decrement() {
+  return atomic_dec(&value);
+}
+
+}  // namespace chre
+
+#endif  // CHRE_PLATFORM_ZEPHYR_ATOMIC_BASE_IMPL_H_