Fix copyrights, add comments, update README, avoid custom .swift files

kubamracek · kubamracek · commit 40cf9d2264f7 · 2025-05-23T14:49:00.000-07:00
diff --git a/.swiftformatignore b/.swiftformatignore
@@ -1,4 +1,5 @@
 ./harmony/*
+./stm32-lvgl/*
 ./stm32-lcd-logo/Sources/Application/Registers/*
 ./stm32-lvgl/Sources/Registers/*
 ./stm32-neopixel/Sources/Application/Registers/*
diff --git a/stm32-lvgl/.swift-format b/stm32-lvgl/.swift-format
diff --git a/stm32-lvgl/.swift-version b/stm32-lvgl/.swift-version
diff --git a/stm32-lvgl/Makefile b/stm32-lvgl/Makefile
@@ -2,7 +2,7 @@
 ##
 ## This source file is part of the Swift open source project
 ##
-## Copyright (c) 2023 Apple Inc. and the Swift project authors.
+## Copyright (c) 2025 Apple Inc. and the Swift project authors.
 ## Licensed under Apache License v2.0 with Runtime Library Exception
 ##
 ## See https://swift.org/LICENSE.txt for license information
@@ -32,8 +32,6 @@ BUILDROOT        := $(shell $(SWIFT_BUILD) $(SWIFT_BUILD_ARGS) --show-bin-path)
 build:
 	@echo "checking dependencies..."
 
-	# TODO: Check that we have swiftly and recent Swift main toolchain
-
 	if [[ ! -d $(PWD)/lvgl ]]; then echo "\n  *** LVGL checkout not found, please run ./fetch-dependencies.sh\n" ; exit 1 ; fi
 	if [[ ! -d $(PWD)/llvm-toolchain ]]; then echo "\n  *** LLVM toolchain checkout not found, please run ./fetch-dependencies.sh\n" ; exit 1 ; fi
 
diff --git a/stm32-lvgl/README.md b/stm32-lvgl/README.md
@@ -19,10 +19,9 @@ Additionally, this sample code:
 ## How to build and run this example:
 
 1. Connect the STM32F746G-DISCO board via the ST-LINK USB port to your Mac.
-2. Install a recent nightly "main" Swift toolchain. This is best done using `swiftly`, for example with:
+2. Install the right Swift toolchain specified in this repo's `.swift-version` file. This is best done using `swiftly`:
 ```console
-$ swiftly install main-snapshot-2025-04-12
-$ swiftly use main-snapshot-2025-04-12 -g
+$ swiftly install  # Run in the project's directory
 ```
 3. Install the `stlink` (https://github.com/stlink-org/stlink) command line tools, e.g. via `brew install stlink`.
 4. Run a provided shell script that fetches the LVGL and LLVM dependencies:
diff --git a/stm32-lvgl/Sources/Application/Clocks.swift b/stm32-lvgl/Sources/Application/Clocks.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/Debug.swift b/stm32-lvgl/Sources/Application/Debug.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/I2C.swift b/stm32-lvgl/Sources/Application/I2C.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/Interrupts.swift b/stm32-lvgl/Sources/Application/Interrupts.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/Lcd.swift b/stm32-lvgl/Sources/Application/Lcd.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/Main.swift b/stm32-lvgl/Sources/Application/Main.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/Pins.swift b/stm32-lvgl/Sources/Application/Pins.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/Sdram.swift b/stm32-lvgl/Sources/Application/Sdram.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/TouchPanel.swift b/stm32-lvgl/Sources/Application/TouchPanel.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Application/UIAppLogic.swift b/stm32-lvgl/Sources/Application/UIAppLogic.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/CLVGL/include/CLVGL.h b/stm32-lvgl/Sources/CLVGL/include/CLVGL.h
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/CLVGL/include/module.modulemap b/stm32-lvgl/Sources/CLVGL/include/module.modulemap
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/HostSDLApp/Main.swift b/stm32-lvgl/Sources/HostSDLApp/Main.swift
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Support/Startup.c b/stm32-lvgl/Sources/Support/Startup.c
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
diff --git a/stm32-lvgl/Sources/Support/Stubs.c b/stm32-lvgl/Sources/Support/Stubs.c
@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift open source project
 //
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -12,6 +12,9 @@
 #include <string.h>
 #include <stdint.h>
 
+// This is NOT real entropy. This implementation is a stub that generates
+// predictable, sequential values for testing purposes only. Do not use this
+// in production code where actual cryptographic randomness is required.
 int getentropy(char *buffer, size_t length) {
     for (size_t i = 0; i < length; i++) {
         buffer[i] = i % 256;
diff --git a/stm32-lvgl/Sources/Support/include/Support.h b/stm32-lvgl/Sources/Support/include/Support.h
@@ -1,52 +1,52 @@
-//===----------------------------------------------------------------------===//
-//
-// This source file is part of the Swift open source project
-//
-// Copyright (c) 2023 Apple Inc. and the Swift project authors.
-// Licensed under Apache License v2.0 with Runtime Library Exception
-//
-// See https://swift.org/LICENSE.txt for license information
-//
-//===----------------------------------------------------------------------===//
-
-#pragma once
-
-#include <stdint.h>
-
-static inline void nop() {
-    asm volatile("nop");
-}
-
-static inline uint32_t primask_get(void) {
-    uint32_t r;
-    asm volatile("mrs %0, primask" : "=r" (r));
-    return r;
-}
-
-static inline void primask_set(uint32_t m) {
-    asm volatile("msr primask, %0" : : "r" (m));
-}
-
-static inline void cpsid_i(void) {
-    asm volatile("cpsid i");
-}
-
-static inline void delay(uint32_t i) {
-    __asm__ volatile(
-        "   .align 2 \n"
-        "1:     subs    %0, #1\n"
-        "       bhi     1b\n"
-        : "=r"(i)
-        : "0" (i)
-    : "cc"
-        );
-}
-
-void panic(const char *);
-
-static uint32_t log2_exact(uint32_t value) {
-    if ((value == 0) || (__builtin_popcount(value) != 1)) {
-        panic("log2_exact");
-    }
-    return 31U - __builtin_clz(value);
-}
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift open source project
+//
+// Copyright (c) 2025 Apple Inc. and the Swift project authors.
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+//
+//===----------------------------------------------------------------------===//
+
+#pragma once
+
+#include <stdint.h>
+
+static inline void nop() {
+    asm volatile("nop");
+}
+
+static inline uint32_t primask_get(void) {
+    uint32_t r;
+    asm volatile("mrs %0, primask" : "=r" (r));
+    return r;
+}
+
+static inline void primask_set(uint32_t m) {
+    asm volatile("msr primask, %0" : : "r" (m));
+}
+
+static inline void cpsid_i(void) {
+    asm volatile("cpsid i");
+}
+
+static inline void delay(uint32_t i) {
+    __asm__ volatile(
+        "   .align 2 \n"
+        "1:     subs    %0, #1\n"
+        "       bhi     1b\n"
+        : "=r"(i)
+        : "0" (i)
+    : "cc"
+        );
+}
+
+void panic(const char *);
+
+static uint32_t log2_exact(uint32_t value) {
+    if ((value == 0) || (__builtin_popcount(value) != 1)) {
+        panic("log2_exact");
+    }
+    return 31U - __builtin_clz(value);
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`./harmony/*`
	`2`	`+./stm32-lvgl/*`
`2`	`3`	`./stm32-lcd-logo/Sources/Application/Registers/*`
`3`	`4`	`./stm32-lvgl/Sources/Registers/*`
`4`	`5`	`./stm32-neopixel/Sources/Application/Registers/*`