From f65d7327ca3d2f318048bdcce70e7097d97d03a0 Mon Sep 17 00:00:00 2001
From: Mark Brown <broonie@kernel.org>
Date: Sun, 8 Jan 2023 18:44:43 +0000
Subject: [PATCH] bin: Add a tool to generate a template bootrr board
 description

bootrr requires a description of each board it runs on to provide
detection of the actual devices and system support that is
present.  Currently these descriptions must be written by hand
but we can ease the process of creating them by providing a tool
which examines the running system and outputs a set of bootrr
assertions which would pass on the system.

The script will require post processing by users, the generate
rule names won't be good, hotplugged devices will be included and
any spaces in device or driver names will cause confusion, but it
can provide a usefuls starting point.

Signed-off-by: Mark Brown <broonie@kernel.org>
---
 Makefile                     |  2 +-
 bin/bootrr-generate-template | 51 ++++++++++++++++++++++++++++++++++++
 2 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100755 bin/bootrr-generate-template

diff --git a/Makefile b/Makefile
index d45abce..3951bab 100644
--- a/Makefile
+++ b/Makefile
@@ -11,7 +11,7 @@ HELPERS := $(wildcard helpers/*)
 
 BOARDS := $(wildcard boards/*)
 
-BINS := bin/bootrr
+BINS := bin/bootrr bin/bootrr-generate-template
 
 LIBEXEC_DIR ?= $(prefix)/libexec
 BOOTRR_DIR = $(LIBEXEC_DIR)/bootrr
diff --git a/bin/bootrr-generate-template b/bin/bootrr-generate-template
new file mode 100755
index 0000000..67c337a
--- /dev/null
+++ b/bin/bootrr-generate-template
@@ -0,0 +1,51 @@
+#!/bin/sh
+
+# This will output a list of template bootrr rules for the
+# current system based on what is currently found in sysfs.  Some
+# editing will be required for usability and maintainability,
+# this is just a helper to get started.
+
+ncpus=$(cat /proc/cpuinfo | grep ^processor | wc -l)
+max_cpu=$(expr ${ncpus} - 1)
+
+if [ -f /sys/devices/system/cpu/cpu0/cpufreq/scaling_driver ]; then
+	echo assert_cpufreq_enabled cpufreq-enabled ${max_cpu}
+fi
+if [ -f /sys/devices/system/cpu/cpuidle/current_driver ]; then
+	echo assert_cpuidle_enabled cpuidle-enabled ${max_cpu}
+fi
+
+# Find drivers with bound devices
+for bus in $(ls /sys/bus) ; do
+	for driver in $(ls /sys/bus/${bus}/drivers) ; do
+		devs=$(find /sys/bus/${bus}/drivers/${driver} -type l |
+			grep -v module$)
+		if [ "${devs}" = "" ]; then
+			continue
+		fi
+
+		# Check for the driver
+		echo assert_driver_present ${driver}-driver-present ${driver}
+
+		# Check for each instance of the driver
+		for dev in ${devs} ; do
+			d=$(cd ${dev} ; pwd -P | sed s,.*/,,)
+			echo assert_device_present ${d}-probed ${driver} ${d}
+		done
+
+		echo
+	done
+done
+
+# Sound card display names are symbolic links to their numbered
+# directories
+for card in $(find /proc/asound -type l | sed s,/proc/asound/,,g) ; do
+	# Check for the first playback and capture PCM only for
+	# now
+	if [ -d /proc/asound/${card}/pcm0p ]; then
+		echo assert_soundcard_present ${card}-playback ${card} pcm0p
+	fi
+	if [ -d /proc/asound/${card}/pcm0c ]; then
+		echo assert_soundcard_present ${card}-capture ${card} pcm0c
+	fi
+done