hackrf/firmware/common/user_config.h
Jonathan Suite dab548bf29 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 <martin-github@earth.li>

* Fix documentation error in hackrf_biast.c

---------

Co-authored-by: Martin Ling <martin-github@earth.li>
2023-09-13 11:15:30 -04:00

43 lines
1.4 KiB
C

/*
* 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