Firmware updates to allow fine-grained control of biast from command …

…line (#1314) * Initial commit of hackrf_biast * Cleaned up hackrf_biast * Cleaned up usage info * Include getopt.h for non-GNU systems * Add support for overriding HackRF's default antenna power behavior in firmware. Add support for specifying antenna power behavior in libhackrf. * Moved bias tee config routines into user_config.c, cleaned up operation of hackrf_biast * hackrf_biast now calls usage() and exits when invoked with no arguments * Fixed minor documentation error in usage() * minor syntax cleanup * Add some documentation to the host API call * Add proper declaration magic in hackrf.h to hackrf_set_user_bias_t_opts() to appease Visual Studio * Documentation changes suggested by @martinling * Moved bias t setting above switch statement, removed line that explicit turned bias t off when entering OFF mode * Change hackrf_set_user_bias_t_opts() to use a friendly struct() instead of a bitmask. User friendliness fixes to hackrf_biast options. More clang-format appeasement. * Removed support for integer mode args from hackrf_biast * clang-format error fixes * Tweaked position of comment for clang-format v14 * Reformat files with clang-format v14 instead of 16 * Remove internal numeric modes for bias T settings Co-authored-by: Martin Ling <[email protected]> * Fix documentation error in hackrf_biast.c --------- Co-authored-by: Martin Ling <[email protected]>
greatscottgadgets · Sep 13, 2023 · dab548b · dab548b
1 parent 13dacd8
commit dab548b
Show file tree

Hide file tree

Showing 12 changed files with 495 additions and 8 deletions.
diff --git a/firmware/common/rf_path.c b/firmware/common/rf_path.c
@@ -34,6 +34,7 @@
 #include "max283x.h"
 #include "max5864.h"
 #include "sgpio.h"
+#include "user_config.h"
 
 #if (defined JAWBREAKER || defined HACKRF_ONE || defined RAD1O)
 	/*
@@ -386,6 +387,10 @@ void rf_path_set_direction(rf_path_t* const rf_path, const rf_path_direction_t d
 {
 	/* Turn off TX and RX amplifiers, then enable based on direction and bypass state. */
 	rf_path->switchctrl |= SWITCHCTRL_NO_TX_AMP_PWR | SWITCHCTRL_NO_RX_AMP_PWR;
+
+	// Perform any user-requested actions for mode switch
+	user_config_on_rf_path_direction_change(rf_path, direction);
+
 	switch (direction) {
 	case RF_PATH_DIRECTION_TX:
 		rf_path->switchctrl |= SWITCHCTRL_TX;
@@ -427,9 +432,6 @@ void rf_path_set_direction(rf_path_t* const rf_path, const rf_path_direction_t d
 
 	case RF_PATH_DIRECTION_OFF:
 	default:
-#ifdef HACKRF_ONE
-		rf_path_set_antenna(rf_path, 0);
-#endif
 		rf_path_set_lna(rf_path, 0);
 		/* Set RF path to receive direction when "off" */
 		rf_path->switchctrl &= ~SWITCHCTRL_TX;
@@ -510,4 +512,4 @@ void rf_path_set_antenna(rf_path_t* const rf_path, const uint_fast8_t enable)
 	switchctrl_set(rf_path, rf_path->switchctrl);
 
 	hackrf_ui()->set_antenna_bias(enable);
-}
+}
diff --git a/firmware/common/user_config.c b/firmware/common/user_config.c
@@ -0,0 +1,112 @@
+/*
+ * Copyright 2023 Jonathan Suite (GitHub: @ai6aj)
+ *
+ * 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 "user_config.h"
+
+static user_config_user_opt_t user_direction_rx_bias_t_opts = RF_DIRECTION_USER_OPT_NOP;
+static user_config_user_opt_t user_direction_tx_bias_t_opts = RF_DIRECTION_USER_OPT_NOP;
+static user_config_user_opt_t user_direction_off_bias_t_opts =
+	RF_DIRECTION_USER_OPT_CLEAR;
+
+//	Perform user-specified actions to Bias T power when transitioning modes
+static void _rf_path_handle_user_bias_t_action(rf_path_t* const rf_path, int action)
+{
+	switch (action) {
+	case RF_DIRECTION_USER_OPT_SET:
+		rf_path_set_antenna(rf_path, 1);
+		break;
+
+	case RF_DIRECTION_USER_OPT_CLEAR:
+		rf_path_set_antenna(rf_path, 0);
+		break;
+
+	case RF_DIRECTION_USER_OPT_NOP:
+	default:
+		break;
+	}
+}
+
+void user_config_on_rf_path_direction_change(
+	rf_path_t* const rf_path,
+	const rf_path_direction_t direction)
+{
+	switch (direction) {
+	case RF_PATH_DIRECTION_RX:
+		_rf_path_handle_user_bias_t_action(rf_path, user_direction_rx_bias_t_opts);
+		break;
+
+	case RF_PATH_DIRECTION_TX:
+		_rf_path_handle_user_bias_t_action(rf_path, user_direction_tx_bias_t_opts);
+		break;
+
+	case RF_PATH_DIRECTION_OFF:
+	default:
+		_rf_path_handle_user_bias_t_action(
+			rf_path,
+			user_direction_off_bias_t_opts);
+		break;
+	}
+}
+
+void user_config_set_bias_t_opt(
+	const rf_path_direction_t direction,
+	const user_config_user_opt_t option)
+{
+	switch (direction) {
+	case RF_PATH_DIRECTION_RX:
+		user_direction_rx_bias_t_opts = option;
+		break;
+
+	case RF_PATH_DIRECTION_TX:
+		user_direction_tx_bias_t_opts = option;
+		break;
+
+	case RF_PATH_DIRECTION_OFF:
+		user_direction_off_bias_t_opts = option;
+		break;
+
+	default:
+		break;
+	}
+}
+
+/*
+ Bias T options are set as follows:
+	Bits 0,1:	One of NOP (0), CLEAR (0b10), or SET (0b11)
+	Bit 2:		1=Set OFF behavior according to bits 0,1  0=Don't change
+	Bits 3,4:	One of NOP (0), CLEAR (0b10), or SET (0b11)
+	Bit 5:		1=Set RX behavior according to bits 0,1  0=Don't change
+	Bits 6,7:	One of NOP (0), CLEAR (0b10), or SET (0b11)
+	Bit 8:		1=Set TX behavior according to bits 0,1  0=Don't change
+	Bits 9-15:	Ignored; set to 0
+*/
+void user_config_set_bias_t_opts(uint16_t value)
+{
+	if (value & 0x4) {
+		user_config_set_bias_t_opt(RF_PATH_DIRECTION_OFF, value & 0x3);
+	}
+	if (value & 0x20) {
+		user_config_set_bias_t_opt(RF_PATH_DIRECTION_RX, (value & 0x18) >> 3);
+	}
+	if (value & 0x100) {
+		user_config_set_bias_t_opt(RF_PATH_DIRECTION_TX, (value & 0xC0) >> 6);
+	}
+}
diff --git a/firmware/common/user_config.h b/firmware/common/user_config.h
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2023 Jonathan Suite (GitHub: @ai6aj)
+ *
+ * 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.
+ */
+
+#ifndef __USER_CONFIG_H__
+#define __USER_CONFIG_H__
+
+#include "rf_path.h"
+
+typedef enum {
+	RF_DIRECTION_USER_OPT_NOP,      // No OPeration / Ignore the thing
+	RF_DIRECTION_USER_OPT_RESERVED, // Currently a NOP
+	RF_DIRECTION_USER_OPT_CLEAR,    // Clear/Disable the thing
+	RF_DIRECTION_USER_OPT_SET,      // Set/Enable the thing
+} user_config_user_opt_t;
+
+void user_config_set_bias_t_opt(
+	const rf_path_direction_t direction,
+	const user_config_user_opt_t action);
+void user_config_set_bias_t_opts(uint16_t value);
+
+void user_config_on_rf_path_direction_change(
+	rf_path_t* const rf_path,
+	const rf_path_direction_t direction);
+
+#endif
diff --git a/firmware/hackrf-common.cmake b/firmware/hackrf-common.cmake
@@ -190,7 +190,8 @@ macro(DeclareTargets)
 		${PATH_HACKRF_FIRMWARE_COMMON}/firmware_info.c
 		${PATH_HACKRF_FIRMWARE_COMMON}/clkin.c
 		${PATH_HACKRF_FIRMWARE_COMMON}/gpdma.c
-	)
+		${PATH_HACKRF_FIRMWARE_COMMON}/user_config.c
+		)
 
 	if(BOARD STREQUAL "RAD1O")
 		SET(SRC_M4

diff --git a/firmware/hackrf_usb/hackrf_usb.c b/firmware/hackrf_usb/hackrf_usb.c
@@ -125,6 +125,7 @@ static usb_request_handler_fn vendor_request_handler[] = {
 	usb_vendor_request_read_board_rev,
 	usb_vendor_request_read_supported_platform,
 	usb_vendor_request_set_leds,
+	usb_vendor_request_user_config_set_bias_t_opts,
 };
 
 static const uint32_t vendor_request_handler_count =

diff --git a/firmware/hackrf_usb/usb_api_register.c b/firmware/hackrf_usb/usb_api_register.c
@@ -22,7 +22,7 @@
  */
 
 #include "usb_api_register.h"
-
+#include <user_config.h>
 #include <hackrf_core.h>
 #include <usb_queue.h>
 #include <max283x.h>
@@ -208,3 +208,14 @@ usb_request_status_t usb_vendor_request_set_leds(
 	}
 	return USB_REQUEST_STATUS_OK;
 }
+
+usb_request_status_t usb_vendor_request_user_config_set_bias_t_opts(
+	usb_endpoint_t* const endpoint,
+	const usb_transfer_stage_t stage)
+{
+	if (stage == USB_TRANSFER_STAGE_SETUP) {
+		user_config_set_bias_t_opts(endpoint->setup.value);
+		usb_transfer_schedule_ack(endpoint->in);
+	}
+	return USB_REQUEST_STATUS_OK;
+}
diff --git a/firmware/hackrf_usb/usb_api_register.h b/firmware/hackrf_usb/usb_api_register.h
@@ -54,5 +54,8 @@ usb_request_status_t usb_vendor_request_get_clkin_status(
 usb_request_status_t usb_vendor_request_set_leds(
 	usb_endpoint_t* const endpoint,
 	const usb_transfer_stage_t stage);
+usb_request_status_t usb_vendor_request_user_config_set_bias_t_opts(
+	usb_endpoint_t* const endpoint,
+	const usb_transfer_stage_t stage);
 
 #endif /* end of include guard: __USB_API_REGISTER_H__ */
diff --git a/firmware/hackrf_usb/usb_descriptor.c b/firmware/hackrf_usb/usb_descriptor.c
@@ -37,7 +37,7 @@
 	#define USB_PRODUCT_ID (0xFFFF)
 #endif
 
-#define USB_API_VERSION (0x0107)
+#define USB_API_VERSION (0x0108)
 
 #define USB_WORD(x) (x & 0xFF), ((x >> 8) & 0xFF)
 

diff --git a/host/hackrf-tools/src/CMakeLists.txt b/host/hackrf-tools/src/CMakeLists.txt
@@ -37,6 +37,7 @@ SET(TOOLS
 	hackrf_clock
 	hackrf_sweep
 	hackrf_operacake
+	hackrf_biast
 )
 
 if(MSVC)