Add 'hackrf_radio_set_mode()'

Author: antoinevg

firmware/common/fpga.h

@@ -26,6 +26,14 @@
 
 #include "ice40_spi.h"
 
+/* Supported Bitstreams. */
+typedef enum {
+	FPGA_BITSTREAM_STANDARD = 0,
+	FPGA_BITSTREAM_HALFPREC = 1,
+	FPGA_BITSTREAM_EXTPREC_RX = 2,
+	FPGA_BITSTREAM_EXTPREC_TX = 3,
+} fpga_bitstream_index_t;
+
 /* Up to 7 registers, each containing up to 8 bits of data */
 #define FPGA_NUM_REGS            7
 #define FPGA_DATA_REGS_MAX_VALUE 255

firmware/common/radio.c

@@ -952,3 +952,66 @@ void radio_switch_opmode(radio_t* const radio, const transceiver_mode_t mode)
 	nvic_enable_irq(NVIC_USB0_IRQ);
 	radio_update(radio);
 }
+
+bool radio_set_config_mode(radio_t* const radio, const radio_config_mode_t mode)
+{
+	// Check if the requested mode is supported.
+	switch (mode) {
+	case RADIO_CONFIG_LEGACY:
+	case RADIO_CONFIG_STANDARD:
+		// supported on all boards
+		break;
+#ifdef IS_PRALINE
+	case RADIO_CONFIG_HALF_PRECISION:
+	case RADIO_CONFIG_EXT_PRECISION_RX:
+	case RADIO_CONFIG_EXT_PRECISION_TX:
+		// only supported on praline
+		if (!IS_PRALINE) {
+			return false;
+		}
+		break;
+#endif
+	default:
+		return false;
+	}
+
+	// If we're on praline, load the appropriate bitstream.
+#if defined(IS_PRALINE) && !(defined(DFU_MODE) || defined(RAM_MODE))
+	if (IS_PRALINE) {
+		fpga_bitstream_index_t bitstream_index;
+		switch (mode) {
+		case RADIO_CONFIG_LEGACY:
+		case RADIO_CONFIG_STANDARD:
+			bitstream_index = FPGA_BITSTREAM_STANDARD;
+			break;
+		case RADIO_CONFIG_HALF_PRECISION:
+			bitstream_index = FPGA_BITSTREAM_HALFPREC;
+			break;
+		case RADIO_CONFIG_EXT_PRECISION_RX:
+			bitstream_index = FPGA_BITSTREAM_EXTPREC_RX;
+			break;
+		case RADIO_CONFIG_EXT_PRECISION_TX:
+			bitstream_index = FPGA_BITSTREAM_EXTPREC_TX;
+			break;
+		default:
+			return false;
+		}
+
+		// Load bitstream if needed.
+		if (mode != radio->config_mode) {
+			extern struct fpga_loader_t fpga_loader;
+			if (!fpga_image_load(&fpga_loader, bitstream_index)) {
+				return false;
+			}
+		}
+	}
+#endif
+
+	// Update radio config mode.
+	radio->config_mode = mode;
+
+	// Clear radio registers - TODO temporary workaround for zero-valued samples when switching bitstreams.
+	radio_init(radio);
+
+	return true;
+}

firmware/common/radio.h

@@ -41,12 +41,15 @@ typedef enum {
 } radio_error_t;
 
 /* radio configuration modes */
+// TODO are we sure we need a legacy mode?
 typedef enum {
 	RADIO_CONFIG_LEGACY = 0,
 	RADIO_CONFIG_STANDARD = 1,
+#ifdef IS_PRALINE
 	RADIO_CONFIG_EXT_PRECISION_RX = 2,
 	RADIO_CONFIG_EXT_PRECISION_TX = 3,
 	RADIO_CONFIG_HALF_PRECISION = 4,
+#endif
 } radio_config_mode_t;
 
 typedef struct {
@@ -271,6 +274,12 @@ bool radio_update(radio_t* const radio);
  */
 void radio_switch_opmode(radio_t* const radio, const transceiver_mode_t mode);
 
+/**
+ * Switch to a new configuration mode.
+ * Return true if the mode was successfully switched.
+ */
+bool radio_set_config_mode(radio_t* const radio, const radio_config_mode_t mode);
+
 /**
  * Driver instance.
  */

firmware/hackrf_usb/CMakeLists.txt

@@ -60,6 +60,7 @@ set(SRC_M4
 	usb_api_spiflash.c
 	usb_api_transceiver.c
 	usb_api_operacake.c
+	usb_api_radio.c
 	usb_api_sweep.c
 	usb_api_selftest.c
 	usb_api_ui.c

firmware/hackrf_usb/hackrf_usb.c

@@ -75,6 +75,7 @@
 #include "usb_api_board_info.h"
 #include "usb_api_m0_state.h"
 #include "usb_api_operacake.h"
+#include "usb_api_radio.h"
 #include "usb_api_register.h"
 #include "usb_api_selftest.h"
 #include "usb_api_spiflash.h"
@@ -185,6 +186,7 @@ static usb_request_handler_fn vendor_request_handler[] = {
 	usb_vendor_request_lock_radio_reg,
 	usb_vendor_request_open,
 	usb_vendor_request_close,
+	usb_vendor_request_set_radio_mode,
 };
 
 static const uint32_t vendor_request_handler_count =

firmware/hackrf_usb/usb_api_radio.c

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2026 Great Scott Gadgets <info@greatscottgadgets.com>
+ *
+ * This file is part of HackRF.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <radio.h>
+#include <usb_request.h>
+#include <usb_type.h>
+
+#include "usb_queue.h"
+
+usb_request_status_t usb_vendor_request_set_radio_mode(
+	usb_endpoint_t* const endpoint,
+	const usb_transfer_stage_t stage)
+{
+	if (stage == USB_TRANSFER_STAGE_SETUP) {
+		radio_config_mode_t mode = endpoint->setup.value;
+		if (!radio_set_config_mode(&radio, mode)) {
+			return USB_REQUEST_STATUS_STALL;
+		}
+		usb_transfer_schedule_ack(endpoint->in);
+	}
+
+	return USB_REQUEST_STATUS_OK;
+}

firmware/hackrf_usb/usb_api_radio.h

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2026 Great Scott Gadgets <info@greatscottgadgets.com>
+ *
+ * This file is part of HackRF.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#pragma once
+
+#include <usb_request.h>
+#include <usb_type.h>
+
+usb_request_status_t usb_vendor_request_set_radio_mode(
+	usb_endpoint_t* const endpoint,
+	const usb_transfer_stage_t stage);

host/libhackrf/src/hackrf.c

@@ -123,6 +123,7 @@ typedef enum {
 	HACKRF_VENDOR_REQUEST_RADIO_LOCK_REG = 62,
 	HACKRF_VENDOR_REQUEST_OPEN = 63,
 	HACKRF_VENDOR_REQUEST_CLOSE = 64,
+	HACKRF_VENDOR_REQUEST_RADIO_SET_MODE = 65,
 } hackrf_vendor_request;
 
 #define USB_CONFIG_STANDARD 0x1
@@ -3748,6 +3749,32 @@ int ADDCALL hackrf_radio_lock_register(
 	return HACKRF_SUCCESS;
 }
 
+int ADDCALL hackrf_radio_set_config_mode(
+	hackrf_device* device,
+	const enum radio_config_mode mode)
+{
+	USB_API_REQUIRED(device, 0x0113);
+	int result;
+
+	result = libusb_control_transfer(
+		device->usb_device,
+		LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR |
+			LIBUSB_RECIPIENT_DEVICE,
+		HACKRF_VENDOR_REQUEST_RADIO_SET_MODE,
+		mode,
+		0,
+		NULL,
+		0,
+		DEFAULT_REQUEST_TIMEOUT);
+
+	if (result != 0) {
+		last_libusb_error = result;
+		return HACKRF_ERROR_LIBUSB;
+	}
+
+	return HACKRF_SUCCESS;
+}
+
 #ifdef __cplusplus
 } // __cplusplus defined.
 #endif

host/libhackrf/src/hackrf.h

@@ -946,6 +946,19 @@ enum clkin_ctrl_signal {
 	CLKIN_SIGNAL_P22 = 1,
 };
 
+/**
+ * HackRF Pro Radio Configuration Mode.
+ *
+ * Used by @ref hackrf_radio_set_config_mode, to set the active configuration mode.
+ */
+enum radio_config_mode {
+	RADIO_CONFIG_LEGACY = 0,
+	RADIO_CONFIG_STANDARD = 1,
+	RADIO_CONFIG_EXT_PRECISION_RX = 2,
+	RADIO_CONFIG_EXT_PRECISION_TX = 3,
+	RADIO_CONFIG_HALF_PRECISION = 4,
+};
+
 /**
  * Opaque struct for hackrf device info. Object can be created via @ref hackrf_open, @ref hackrf_device_list_open or @ref hackrf_open_by_serial and be destroyed via @ref hackrf_close
  * @ingroup device
@@ -2477,6 +2490,18 @@ extern ADDAPI int ADDCALL hackrf_radio_lock_register(
 	const uint8_t register_number,
 	const bool register_locked);
 
+/**
+ * Switches the radio configuration mode.
+ *
+ * @param[in] device device to configure
+ * @param[in] mode configuration mode. Defaults to RADIO_CONFIG_LEGACY. Available modes are defined in @ref radio_config_mode.
+ * @return @ref HACKRF_SUCCESS on success or @ref hackrf_error variant
+ * @ingroup configuration
+ */
+extern ADDAPI int ADDCALL hackrf_radio_set_config_mode(
+	hackrf_device* device,
+	const enum radio_config_mode mode);
+
 #ifdef __cplusplus
 } // __cplusplus defined.
 #endif