firmware: refactor si5351c for runtime platform detection

Author: antoinevg

firmware/common/hackrf_core.c

@@ -23,35 +23,21 @@
 
 #include "hackrf_core.h"
 #include "hackrf_ui.h"
-//#include "sgpio.h"
-//#include "si5351c.h"
-//#include "spi_ssp.h"
 #include "max283x.h"
-//#include "max5864.h"
 #include "max5864_target.h"
-//#include "w25q80bv.h"
 #include "w25q80bv_target.h"
-//#include "i2c_bus.h"
 #include "i2c_lpc.h"
-//#include "cpld_jtag.h"
 #include "ice40_spi.h"
 #include "platform_detect.h"
 #include "platform_gpio.h"
 #include "platform_scu.h"
 #include "clkin.h"
+#include "portapack.h"
 #include <libopencm3/lpc43xx/cgu.h>
 #include <libopencm3/lpc43xx/ccu.h>
 #include <libopencm3/lpc43xx/scu.h>
 #include <libopencm3/lpc43xx/ssp.h>
 
-//#if (defined HACKRF_ONE || defined PRALINE)
-#include "portapack.h"
-//#endif
-
-#include "gpio_lpc.h"
-
-#include "platform_gpio.h"
-
 i2c_bus_t i2c0 = {
 	.obj = (void*) I2C0_BASE,
 	.start = i2c_lpc_start,

firmware/common/platform_gpio.c

@@ -229,11 +229,20 @@ const platform_gpio_t* platform_gpio()
 		break;
 	}
 
+	/* HackRF One r9 clock control */
+	switch (board_id) {
+	case BOARD_ID_HACKRF1_R9:
+		gpio.h1r9_clkin_en   = &GPIO5_15;
+		gpio.h1r9_clkout_en  = &GPIO0_9;
+		gpio.h1r9_mcu_clk_en = &GPIO0_8;
+		break;
+	default:
+		break;
+	}
+
 	/* HackRF One r9 */
 	switch (board_id) {
-	case BOARD_ID_HACKRF1_OG:
 	case BOARD_ID_HACKRF1_R9:
-		//gpio.h1r9_rx             = &GPIO0_7;
 		gpio.h1r9_1v8_enable     = &GPIO2_9;
 		gpio.h1r9_vaa_disable    = &GPIO3_6;
 		gpio.h1r9_trigger_enable = &GPIO5_5;

firmware/common/platform_gpio.h

@@ -124,6 +124,11 @@ typedef struct {
 	const struct gpio_t* vco_mux;       // RAD1O
 	const struct gpio_t* synt_rfout_en; // RAD1O
 
+	/* HackRF One r9 clock control */
+	const struct gpio_t* h1r9_clkin_en;
+	const struct gpio_t* h1r9_clkout_en;
+	const struct gpio_t* h1r9_mcu_clk_en;
+
 	/* HackRF One r9 */
 	//const struct gpio_t* h1r9_rx;
 	const struct gpio_t* h1r9_1v8_enable;

firmware/common/si5351c.c

@@ -23,18 +23,11 @@
 #include "si5351c.h"
 #include "clkin.h"
 #include "platform_detect.h"
+#include "platform_gpio.h"
 #include "platform_scu.h"
-#include "gpio_lpc.h"
 #include "hackrf_core.h"
 #include "selftest.h"
 
-/* HackRF One r9 clock control */
-// clang-format off
-static struct gpio_t gpio_h1r9_clkin_en   = GPIO(5, 15);
-static struct gpio_t gpio_h1r9_clkout_en  = GPIO(0,  9);
-static struct gpio_t gpio_h1r9_mcu_clk_en = GPIO(0,  8);
-// clang-format on
-
 #include <stdbool.h>
 
 static enum pll_sources active_clock_source = PLL_SOURCE_UNINITIALIZED;
@@ -195,6 +188,7 @@ void si5351c_configure_clock_control(
 	uint8_t clkout_ctrl;
 
 	board_id_t board_id = detected_platform();
+	const platform_gpio_t* gpio = platform_gpio();
 
 	if (board_id == BOARD_ID_RAD1O) {
 		/* PLLA on XTAL */
@@ -215,13 +209,13 @@ void si5351c_configure_clock_control(
 				 * but externally switches that input to CLKIN.
 				 */
 				pll = SI5351C_CLK_PLL_SRC_A;
-				gpio_set(&gpio_h1r9_clkin_en);
+				gpio_set(gpio->h1r9_clkin_en);
 			}
 		} else {
 			/* PLLA on XTAL */
 			pll = SI5351C_CLK_PLL_SRC_A;
 			if (board_id == BOARD_ID_HACKRF1_R9) {
-				gpio_clear(&gpio_h1r9_clkin_en);
+				gpio_clear(gpio->h1r9_clkin_en);
 			}
 		}
 		break;
@@ -298,6 +292,7 @@ void si5351c_enable_clock_outputs(si5351c_driver_t* const drv)
 	/* 3: External clock output is deactivated by default */
 
 	board_id_t board_id = detected_platform();
+	const platform_gpio_t* gpio = platform_gpio();
 
 	uint8_t value;
 	if (board_id != BOARD_ID_PRALINE) {
@@ -327,10 +322,12 @@ void si5351c_enable_clock_outputs(si5351c_driver_t* const drv)
 	uint8_t data[] = {SI5351C_REG_OUTPUT_EN, value};
 	si5351c_write(drv, data, sizeof(data));
 
-	if ((clkout_enabled) && (detected_platform() == BOARD_ID_HACKRF1_R9)) {
-		gpio_set(&gpio_h1r9_clkout_en);
-	} else {
-		gpio_clear(&gpio_h1r9_clkout_en);
+	if (detected_platform() == BOARD_ID_HACKRF1_R9) {
+		if (clkout_enabled) {
+			gpio_set(gpio->h1r9_clkout_en);
+		} else {
+			gpio_clear(gpio->h1r9_clkout_en);
+		}
 	}
 }
 
@@ -424,22 +421,23 @@ void si5351c_init(si5351c_driver_t* const drv)
 	}
 
 	if (detected_platform() == BOARD_ID_HACKRF1_R9) {
+		const platform_gpio_t* gpio = platform_gpio();
 		const platform_scu_t* scu = platform_scu();
 
 		/* CLKIN_EN */
 		scu_pinmux(scu->H1R9_CLKIN_EN, SCU_GPIO_FAST | SCU_CONF_FUNCTION4);
-		gpio_clear(&gpio_h1r9_clkin_en);
-		gpio_output(&gpio_h1r9_clkin_en);
+		gpio_clear(gpio->h1r9_clkin_en);
+		gpio_output(gpio->h1r9_clkin_en);
 
 		/* CLKOUT_EN */
 		scu_pinmux(scu->H1R9_CLKOUT_EN, SCU_GPIO_FAST | SCU_CONF_FUNCTION0);
-		gpio_clear(&gpio_h1r9_clkout_en);
-		gpio_output(&gpio_h1r9_clkout_en);
+		gpio_clear(gpio->h1r9_clkout_en);
+		gpio_output(gpio->h1r9_clkout_en);
 
 		/* MCU_CLK_EN */
 		scu_pinmux(scu->H1R9_MCU_CLK_EN, SCU_GPIO_FAST | SCU_CONF_FUNCTION0);
-		gpio_clear(&gpio_h1r9_mcu_clk_en);
-		gpio_output(&gpio_h1r9_mcu_clk_en);
+		gpio_clear(gpio->h1r9_mcu_clk_en);
+		gpio_output(gpio->h1r9_mcu_clk_en);
 	}
 	(void) drv;
 }