fwk: Add EC_CMD_READ_BOARDID

Add a host command to read board ID.

BUG=https://app.clickup.com/t/86ev8c9qb
BUG=https://app.clickup.com/t/86ev63cvg
BUG=So that BIOS and OS can detect different touchpads and audio boards
TEST=Send host command with channel 0 (mainboard) and make sure it
reports something between 0 and 14 (inclusive)
BRANCH=fwk-main

Signed-off-by: Daniel Schaefer <dhs@frame.work>
(cherry picked from commit 290e7f609cdc8a619d93b41bb9fadfe15069dd18)

Author: JohnAZoidberg

zephyr/program/framework/include/board_host_command.h

@@ -563,4 +563,53 @@ enum battery_extender_cmd {
 	BATT_EXTENDER_READ_CMD,
 };
 
+/*****************************************************************************/
+/*
+ * Measure a Board ID to see what's currently populated
+ *
+ * Similar to EC_CMD_GET_CROS_BOARD_INFO. But that is only measured once,
+ * not for hotpluggable components.
+ * We use the board ID for hotpluggable components like the inputmodules,
+ * touchpad, powerbutton board and audio board.
+ * To detect whether these are plugged in and which version of the is plugged in,
+ * the board ID needs to be measured at run-time.
+ *
+ * For the Framework 16 inputmodules there is a dedicated command, which abstracts the logic,
+ * because there is also a mux involed: EC_CMD_CHECK_DECK_STATE
+ *
+ * For Framework 13 we have multiple versions of the touchpad and speakers (audio board)
+ * that BIOS/OS need to distinguish through this host command.
+ *
+ * Compared to EC_CMD_ADC_READ this host command adds the board specific logic
+ * to convert the voltage level into the board ID index.
+ */
+#define EC_CMD_READ_BOARDID	0x3E26
+
+enum ec_board_id_type {
+	/* Mainboard - any system */
+	HC_BOARD_ID_MAINBOARD = 0,
+	/* Power button board - Framework 12 */
+	HC_BOARD_ID_POWERBUTTON_BOARD = 1,
+	/* Power button board - Framework 12, 13, 16 */
+	HC_BOARD_ID_TOUCHPAD = 2,
+	/* Power button board - Framework 12, 13 */
+	HC_BOARD_ID_AUDIO_BOARD = 3,
+	/* dGPU board - Framework 16 */
+	HC_BOARD_ID_DGPU0 = 4,
+	/* dGPU board - Framework 16 */
+	HC_BOARD_ID_DGPU1 = 5,
+};
+
+struct ec_params_read_boardid {
+  /* See enum ec_board_id_type */
+	uint8_t board_id_type;
+} __ec_align1;
+
+struct ec_response_read_boardid {
+	/* -1 if unknown (some issue reading it)
+	 * Otherwise 0-15
+	 */
+	int8_t board_id;
+} __ec_align1;
+
 #endif /* __BOARD_HOST_COMMAND_H */

zephyr/program/framework/src/adc.c

@@ -7,7 +7,9 @@
 
 #include "adc.h"
 #include "board_adc.h"
+#include "board_host_command.h"
 #include "console.h"
+#include "ec_commands.h"
 #include "system.h"
 #include "hooks.h"
 
@@ -96,3 +98,45 @@ __override int board_get_version(void)
 	return version;
 }
 
+/* Host command */
+static enum ec_status hc_read_boardid(struct host_cmd_handler_args *args)
+{
+	const struct ec_params_read_boardid *p = args->params;
+	struct ec_response_read_boardid *r = args->response;
+
+	switch (p->board_id_type) {
+	case HC_BOARD_ID_MAINBOARD:
+		r->board_id = get_hardware_id(ADC_MAIN_BOARD_ID);
+		break;
+#ifdef ADC_POWER_BUTTON_BOARD_ID
+	case HC_BOARD_ID_POWERBUTTON_BOARD:
+		r->board_id = get_hardware_id(ADC_POWER_BUTTON_BOARD_ID);
+		break;
+#endif
+#ifdef ADC_TOUCHPAD_ID
+	case HC_BOARD_ID_TOUCHPAD:
+		r->board_id = get_hardware_id(ADC_TOUCHPAD_ID);
+		break;
+#endif
+#ifdef ADC_AUDIO_ID
+	case HC_BOARD_ID_AUDIO_BOARD:
+		r->board_id = get_hardware_id(ADC_AUDIO_ID);
+		break;
+#endif
+#ifdef CONFIG_PLATFORM_EC_FRAMEWORK_LAPTOP_16
+	case HC_BOARD_ID_DGPU0:
+		r->board_id = get_hardware_id(ADC_GPU_BOARD_ID_0);
+		break;
+	case HC_BOARD_ID_DGPU1:
+		r->board_id = get_hardware_id(ADC_GPU_BOARD_ID_1);
+		break;
+#endif
+	default:
+		return EC_ERROR_INVAL;
+	}
+
+	args->response_size = sizeof(*r);
+
+	return EC_RES_SUCCESS;
+}
+DECLARE_HOST_COMMAND(EC_CMD_READ_BOARDID, hc_read_boardid, EC_VER_MASK(0));