Add lvgl-module (empty for now)

CMakeLists.txt

@@ -85,7 +85,8 @@ if (NOT DEFINED ENV{ESP_IDF_VERSION})
     add_subdirectory(Libraries/QRCode)
     add_subdirectory(Libraries/minitar)
     add_subdirectory(Libraries/minmea)
-    add_subdirectory(Modules/hal-device)
+    add_subdirectory(Modules/hal-device-module)
+    add_subdirectory(Modules/lvgl-module)
 
     # FreeRTOS
     set(FREERTOS_CONFIG_FILE_DIRECTORY ${PROJECT_SOURCE_DIR}/Devices/simulator/Source CACHE STRING "")

Firmware/CMakeLists.txt

@@ -36,7 +36,8 @@ else ()
         TactilityCore
         TactilityFreeRtos
         TactilityKernel
-        hal-device
+        hal-device-module
+        lvgl-module
         Simulator
         PlatformPosix
         SDL2::SDL2-static SDL2-static

Modules/hal-device-module/CMakeLists.txt

@@ -1,7 +1,8 @@
 cmake_minimum_required(VERSION 3.20)
 
+file(GLOB_RECURSE SOURCE_FILES "Source/*.c*")
+
 if (DEFINED ENV{ESP_IDF_VERSION})
-    file(GLOB_RECURSE SOURCE_FILES Source/*.c*)
 
     list(APPEND REQUIRES_LIST
         TactilityKernel
@@ -21,21 +22,18 @@ if (DEFINED ENV{ESP_IDF_VERSION})
 
 else ()
 
-    file(GLOB_RECURSE SOURCES "Source/*.c*")
+    add_library(hal-device-module OBJECT)
 
-    add_library(hal-device OBJECT)
+    target_sources(hal-device-module PRIVATE ${SOURCE_FILES})
 
-    target_sources(hal-device PRIVATE ${SOURCES})
+    target_include_directories(hal-device-module
-
-    target_include_directories(hal-device
-        PRIVATE Private/
         PUBLIC Include/
     )
 
     add_definitions(-D_Nullable=)
     add_definitions(-D_Nonnull=)
 
-    target_link_libraries(hal-device PUBLIC
+    target_link_libraries(hal-device-module PUBLIC
         TactilityFreeRtos
         TactilityCore
         TactilityKernel

Modules/lvgl-module/CMakeLists.txt

@@ -0,0 +1,40 @@
+cmake_minimum_required(VERSION 3.20)
+
+file(GLOB_RECURSE SOURCE_FILES Source/*.c*)
+
+if (DEFINED ENV{ESP_IDF_VERSION})
+
+    list(APPEND REQUIRES_LIST
+        TactilityKernel
+        lvgl
+        esp_lvgl_port
+    )
+
+    idf_component_register(
+        SRCS ${SOURCE_FILES}
+        INCLUDE_DIRS "Include/"
+        REQUIRES ${REQUIRES_LIST}
+    )
+
+    if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+        target_compile_options(${COMPONENT_LIB} PUBLIC -Wno-unused-variable)
+    endif ()
+
+else ()
+
+    add_library(lvgl-module OBJECT)
+
+    target_sources(lvgl-module PRIVATE ${SOURCE_FILES})
+
+    target_include_directories(lvgl-module
+        PUBLIC Include/
+    )
+
+    target_link_libraries(lvgl-module PUBLIC
+        TactilityKernel
+        freertos_kernel
+        lvgl
+    )
+    
+endif ()
+

Modules/lvgl-module/Include/tactility/lvgl_module.h

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern struct Module lvgl_module;
+
+#ifdef __cplusplus
+}
+#endif

Modules/lvgl-module/LICENSE-Apache-2.0.md

@@ -0,0 +1,195 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+* **(b)** You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_
+
+### APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets `[]` replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same “printed page” as the copyright notice for easier identification within
+third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+    
+    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.
+

Modules/lvgl-module/README.md

@@ -0,0 +1,8 @@
+**WARNING: This module contains deprecated code**
+
+This module is the basis for the old Tactility HAL.
+This HAL existed before TactilityKernel.
+
+The C++ `tt::hal::Device` class is replaced by `struct Device` from TactilityKernel.
+
+License: Apache v2.0

Modules/lvgl-module/Source/lvgl_module.cpp

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: Apache-2.0
+#include <tactility/module.h>
+
+extern "C" {
+
+static error_t start() {
+    return ERROR_NONE;
+}
+
+static error_t stop() {
+    return ERROR_NONE;
+}
+
+struct Module lvgl_module = {
+    .name = "lvgl",
+    .start = start,
+    .stop = stop
+};
+
+}

Tactility/CMakeLists.txt

@@ -8,8 +8,8 @@ if (DEFINED ENV{ESP_IDF_VERSION})
         PlatformEsp32
         TactilityCore
         TactilityFreeRtos
-        hal-device
+        hal-device-module
-        lvgl
+        lvgl-module
         driver
         elf_loader
         lv_screenshot
@@ -17,7 +17,6 @@ if (DEFINED ENV{ESP_IDF_VERSION})
         esp_http_server
         esp_http_client
         esp-tls
-        esp_lvgl_port
         esp_wifi
         json
         minitar
@@ -72,7 +71,8 @@ else()
         TactilityCore
         TactilityKernel
         PlatformPosix
-        hal-device
+        hal-device-module
+        lvgl-module
         freertos_kernel
         lvgl
         lv_screenshot

Tactility/Source/Tactility.cpp

@@ -24,6 +24,7 @@
 
 #include <tactility/kernel_init.h>
 #include <tactility/hal_device_module.h>
+#include <tactility/lvgl_module.h>
 
 #include <map>
 #include <format>
@@ -336,10 +337,14 @@ void run(const Configuration& config, Module* platformModule, Module* deviceModu
         return;
     }
 
-    // HAL compatibility module: it creates kernel driver wrappers for tt::hal::Device
+    // Module parent
     check(module_parent_construct(&tactility_module_parent) == ERROR_NONE);
+    // hal-device-module
     check(module_set_parent(&hal_device_module, &tactility_module_parent) == ERROR_NONE);
     check(module_start(&hal_device_module) == ERROR_NONE);
+    //lvgl-module
+    check(module_set_parent(&lvgl_module, &tactility_module_parent) == ERROR_NONE);
+    check(module_start(&lvgl_module) == ERROR_NONE);
 
     const hal::Configuration& hardware = *config.hardware;
 

Tests/Tactility/CMakeLists.txt

@@ -23,7 +23,9 @@ target_link_libraries(TactilityTests PRIVATE
     TactilityCore
     TactilityKernel
     PlatformPosix
-    hal-device
+    hal-device-module
+    lvgl-module
+    lvgl
     Simulator
     SDL2::SDL2-static SDL2-static
 )