Merge branch 'lukeshu/tidy'

9 files changed, 66 insertions, 42 deletions

diff --git a/GNUmakefile b/GNUmakefile
index f6ff6c3..5a2ff93 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -109,15 +109,25 @@ build-aux/venv: build-aux/requirements.txt
 	$@/bin/pip install -r $<
 	touch --no-create $@
 
-# `lint` ###########
+# `lint` ###############################
+# generic ##########
 lint:
 	$(MAKE) -k INNER=t $(patsubst sources_%,lint/%,$(filter sources_%,$(.VARIABLES)))
 # Only lint binaries if the build scripts pass lint.
 	$(MAKE) INNER=t lint/bin
 lint/bin: build build-aux/lint-bin
 	./build-aux/lint-bin $(foreach t,$(build_types),build/rp2040-$t/cmd/sbc_harness/sbc_harness.elf)
+lint/all: lint/%: build-aux/lint-generic build-aux/get-dscname
+	./build-aux/lint-generic '%s\n' $(sources_$*)
+lint/unknown: lint/%: build-aux/lint-unknown
+	./build-aux/lint-unknown $(sources_$*)
+.PHONY: lint lint/%
+# specific #########
+lint/c: lint/%: build-aux/lint-h build-aux/get-dscname
+	./build-aux/lint-h $(filter %.h,$(sources_$*))
 lint/sh lint/bash: lint/%:
 	shellcheck $(sources_$*)
+	shfmt --diff --case-indent --simplify $(sources_$*)
 lint/python3: lint/%: build-aux/venv
 	./build-aux/venv/bin/mypy --strict --scripts-are-modules $(sources_$*)
 	./build-aux/venv/bin/black --check $(sources_$*)
@@ -125,28 +135,21 @@ lint/python3: lint/%: build-aux/venv
 	./build-aux/venv/bin/pylint $(sources_$*)
 	! grep -nh 'SPECIAL$$' -- lib9p/proto.gen lib9p/protogen/*.py
 	./build-aux/venv/bin/pytest $(foreach f,$(sources_python3),$(if $(filter test_%.py,$(notdir $f)),$f))
-lint/c: lint/%: build-aux/lint-h build-aux/get-dscname
-	./build-aux/lint-h $(filter %.h,$(sources_$*))
 lint/make lint/cmake lint/gitignore lint/ini lint/9p lint/markdown lint/pip lint/man-cat: lint/%:
-	@:
-lint/unknown: lint/%: build-aux/lint-unknown
-	./build-aux/lint-unknown $(sources_$*)
-lint/all: lint/%: build-aux/lint-generic build-aux/get-dscname
-	./build-aux/lint-generic '%s\n' $(sources_$*)
-.PHONY: lint lint/%
+	@: TODO: Write/adopt linters for these file types
 
-# `format` #########
+# `format` #############################
+# generic ##########
 format:
-	$(MAKE) -k INNER=t $(patsubst sources_%,format/%,$(filter-out sources_all,$(filter sources_%,$(.VARIABLES))))
+	$(MAKE) -k INNER=t $(patsubst sources_%,format/%,$(filter-out sources_all sources_unknown,$(filter sources_%,$(.VARIABLES))))
+.PHONY: format format/%
+# specific #########
+format/c: format/%:
+	@: TODO: Adopt a C code-formatter
+format/sh format/bash: format/%:
+	shfmt --write --case-indent --simplify $(sources_$*)
 format/python3: format/%: ./build-aux/venv
 	./build-aux/venv/bin/black $(sources_$*)
 	./build-aux/venv/bin/isort $(sources_$*)
-format/sh format/bash: format/%
-	@:
-format/c: format/%:
-	@: TODO: Adopt a C code-formatter
 format/make format/cmake format/gitignore format/ini format/9p format/markdown format/pip format/man-cat: format/%:
-	@:
-format/unknown: format/%:
-	@:
-.PHONY: format format/%
+	@: TODO: Write/adopt formatters for these file types
diff --git a/PLAN.md b/PLAN.md
index 2bae3fd..3201122 100644
--- a/PLAN.md
+++ b/PLAN.md
@@ -1,10 +1,20 @@
 <!--
   PLAN.md - Misc planning notes
 
-  Copyright (C) 2024  Luke T. Shumaker <lukeshu@lukeshu.com>
+  Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
   SPDX-License-Identifier: AGPL-3.0-or-later
 -->
 
+- [ ] syslog on 9p
+- [ ] better 9p-shutdown
+- [ ] PIO-based USB
+- [ ] wire the USB keyboard to 9P
+- [ ] wire uart to 9p
+
+- SDcard to 9p
+- PicoDVI
+- solder up the bus switch
+
 - with hardware I have:
   1. [X] type "hello world" as a USB keyboard
   2. [ ] get networking up (ping)
@@ -19,5 +29,3 @@
     1. [ ] PicoDVI hello-world
     2. [ ] "PiciDVI" to network
     3. [ ] reverse the flow of PicoDVI
-
-https://hackaday.com/2022/08/26/bit-banged-ethernet-on-the-raspberry-pi-pico/
diff --git a/build-aux/embed-sources.h.gen b/build-aux/embed-sources.h.gen
index 0329496..ee9eb42 100755
--- a/build-aux/embed-sources.h.gen
+++ b/build-aux/embed-sources.h.gen
@@ -6,5 +6,5 @@
 
 nm --format=posix "$@" |
 	sed -n -E \
-	    -e 's/(.*_(end|start)) [DR] .*/extern char \1[];/p' \
-	    -e 's/(.*_size) A .*/extern size_t \1;/p'
+		-e 's/(.*_(end|start)) [DR] .*/extern char \1[];/p' \
+		-e 's/(.*_size) A .*/extern size_t \1;/p'
diff --git a/build-aux/lint-bin b/build-aux/lint-bin
index 78ed19f..91f1612 100755
--- a/build-aux/lint-bin
+++ b/build-aux/lint-bin
@@ -62,7 +62,7 @@ lint_globals() {
 				cd "$rel_base"
 				total=0
 				while read -r symbol addr size source; do
-					if (( addr == 0 )); then
+					if ((addr == 0)); then
 						continue
 					fi
 					case "$source" in
@@ -103,8 +103,9 @@ lint_stack() {
 		fi
 	done < <(
 		comm -3 \
-		     <(sed -En 's/^included: (.*:)?//p' "${in_elffile%.elf}_stack.c" | sort -u) \
-		     <(readelf_funcs "$in_elffile" | sed -E -e 's/\.part\.[0-9]*$//' -e 's/^__(.*)_veneer$/\1/' | sort -u))
+			<(sed -En 's/^included: (.*:)?//p' "${in_elffile%.elf}_stack.c" | sort -u) \
+			<(readelf_funcs "$in_elffile" | sed -E -e 's/\.part\.[0-9]*$//' -e 's/^__(.*)_veneer$/\1/' | sort -u)
+	)
 }
 
 lint_func_blocklist() {
@@ -118,8 +119,8 @@ lint_func_blocklist() {
 	while read -r func; do
 		err "$in_elffile" "Contains blocklisted function: ${func}"
 	done < <(readelf --syms --wide -- "$in_elffile" |
-			 awk '$4 == "FUNC" { print $8 }' |
-			 grep -Fx "${blocklist[@]/#/-e}")
+		awk '$4 == "FUNC" { print $8 }' |
+		grep -Fx "${blocklist[@]/#/-e}")
 }
 
 main() {
@@ -130,8 +131,8 @@ main() {
 		{
 			echo 'Global variables:'
 			lint_globals "${elf}.map" | sed 's/^/  /'
-		} > "${elf%.elf}.lint.globals"
-		(lint_stack "$elf") &> "${elf%.elf}.lint.stack"
+		} >"${elf%.elf}.lint.globals"
+		(lint_stack "$elf") &>"${elf%.elf}.lint.stack"
 		lint_func_blocklist "$elf"
 	done
 
diff --git a/build-aux/lint-h b/build-aux/lint-h
index 26ac13d..7459032 100755
--- a/build-aux/lint-h
+++ b/build-aux/lint-h
@@ -18,9 +18,9 @@ for filename in "$@"; do
 	guard=${dscname//'/'/'_'}
 	guard=${guard//'.'/'_'}
 	guard="_${guard^^}_"
-	if ! { grep -Fxq "#ifndef ${guard}"      "$filename" &&
-	       grep -Fxq "#define ${guard}"      "$filename" &&
-	       grep -Fxq "#endif /* ${guard} */" "$filename"; }; then
+	if ! { grep -Fxq "#ifndef ${guard}" "$filename" &&
+		grep -Fxq "#define ${guard}" "$filename" &&
+		grep -Fxq "#endif /* ${guard} */" "$filename"; }; then
 		err "$filename" "does not have ${guard} guard"
 	fi
 done
diff --git a/cmd/sbc_harness/main.c b/cmd/sbc_harness/main.c
index 25b122c..7765ca8 100644
--- a/cmd/sbc_harness/main.c
+++ b/cmd/sbc_harness/main.c
@@ -234,4 +234,5 @@ int main() {
 	infof("===================================================================");
 	coroutine_add("init", init_cr, NULL);
 	coroutine_main();
+	assert_notreached("all coroutines exited");
 }
diff --git a/libusb/include/libusb/tusb_helpers.h b/libusb/include/libusb/tusb_helpers.h
index 1b4e48e..0c35f62 100644
--- a/libusb/include/libusb/tusb_helpers.h
+++ b/libusb/include/libusb/tusb_helpers.h
@@ -1,7 +1,7 @@
 /* Generated by `libusb/include/libusb/tusb_helpers.h.gen `.  DO NOT EDIT!  */
 /* libusb/tusb_helpers.h - Preprocessor macros that I think should be included in TinyUSB
  *
- * Copyright (C) 2024  Luke T. Shumaker <lukeshu@lukeshu.com>
+ * Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
  *
  * SPDX-License-Identifier: MIT
  *
diff --git a/libusb/include/libusb/tusb_helpers.h.gen b/libusb/include/libusb/tusb_helpers.h.gen
index 5a5d1ac..1de1d09 100755
--- a/libusb/include/libusb/tusb_helpers.h.gen
+++ b/libusb/include/libusb/tusb_helpers.h.gen
@@ -7,7 +7,7 @@ echo "/* Generated by \`$0 $*\`.  DO NOT EDIT!  */"
 cat <<'EOT'
 /* libusb/tusb_helpers.h - Preprocessor macros that I think should be included in TinyUSB
  *
- * Copyright (C) 2024  Luke T. Shumaker <lukeshu@lukeshu.com>
+ * Copyright (C) 2024-2025  Luke T. Shumaker <lukeshu@lukeshu.com>
  *
  * SPDX-License-Identifier: MIT
  *
@@ -70,12 +70,19 @@ fi
 if [[ ! -f 3rd-party/MS-LCID.txt || 3rd-party/MS-LCID.txt -ot 3rd-party/MS-LCID.pdf ]]; then
 	pdftotext -layout 3rd-party/MS-LCID.pdf
 fi
-<3rd-party/MS-LCID.txt \
-	grep -E '^\s*0x[0-9A-F]{4}\s+[a-z]' | sed 's/,.*//' | grep -v reserved | # find the lines we're interested in
-	sed -E 's/^\s*0x(..)(..)\s+(\S.*)/\2 \1 \3/p' | tr '[:lower:]-' '[:upper:]_' | # format them as 'PRIhex SUBhex UPPER_STR'
-	sort |
-	sed -E 's/(..) (..) (.*)/#define LANGID_\3 0x\2\1/' | # format them as '#define LANGID_UPPER_STR 0xSUBPRI'
-	column --table --output-separator=' '
+{
+	{
+		# find the lines we're interested in
+		grep -E '^\s*0x[0-9A-F]{4}\s+[a-z]' | sed 's/,.*//' | grep -v reserved
+	} | {
+		# format them as 'PRIhex SUBhex UPPER_STR'
+		sed -E 's/^\s*0x(..)(..)\s+(\S.*)/\2 \1 \3/p' | tr '[:lower:]-' '[:upper:]_'
+	} | sort | {
+		# format them as '#define LANGID_UPPER_STR 0xSUBPRI'
+		sed -E 's/(..) (..) (.*)/#define LANGID_\3 0x\2\1/' |
+			column --table --output-separator=' '
+	}
+} <3rd-party/MS-LCID.txt
 cat <<'EOT'
 
 /** USB 2.0 §9.6.6 "Endpoint", field bEndpointAddress, bit 7 */
diff --git a/notes.md b/notes.md
index 8f2f44c..84c2e72 100644
--- a/notes.md
+++ b/notes.md
@@ -187,3 +187,7 @@ OpenBMC
  - Sipeed NanoKVM
  - https://github.com/stefanklug/picoKVM (~$20 Arduino, ~$5 HDMI
    capture), non-IP
+
+----
+
+https://hackaday.com/2022/08/26/bit-banged-ethernet-on-the-raspberry-pi-pico/