hackrf_ui.h

/*
 * Copyright 2018-2022 Great Scott Gadgets <info@greatscottgadgets.com>
 * Copyright (C) 2018 Jared Boone, ShareBrained Technology, Inc.
 *
 * 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 <stdbool.h>
#include <stdint.h>

#include "radio.h"
#include "rf_path.h"

typedef void (*hackrf_ui_init_fn)(void);
typedef void (*hackrf_ui_deinit_fn)(void);
typedef void (*hackrf_ui_set_frequency_fn)(uint64_t frequency);
typedef void (*hackrf_ui_set_sample_rate_fn)(uint32_t sample_rate);
typedef void (*hackrf_ui_set_direction_fn)(const rf_path_direction_t direction);
typedef void (*hackrf_ui_set_filter_bw_fn)(uint32_t bandwidth);
typedef void (*hackrf_ui_set_lna_power_fn)(bool lna_on);
typedef void (*hackrf_ui_set_bb_lna_gain_fn)(const uint32_t gain_db);
typedef void (*hackrf_ui_set_bb_vga_gain_fn)(const uint32_t gain_db);
typedef void (*hackrf_ui_set_bb_tx_vga_gain_fn)(const uint32_t gain_db);
typedef void (*hackrf_ui_set_first_if_frequency_fn)(const uint64_t frequency);
typedef void (*hackrf_ui_set_filter_fn)(const rf_path_filter_t filter);
typedef void (*hackrf_ui_set_antenna_bias_fn)(bool antenna_bias);
typedef void (*hackrf_ui_set_clock_source_fn)(clock_source_t source);
typedef void (*hackrf_ui_set_transceiver_mode_fn)(transceiver_mode_t mode);
typedef bool (*hackrf_ui_operacake_gpio_compatible_fn)(void);

typedef struct {
	hackrf_ui_init_fn init;
	hackrf_ui_deinit_fn deinit;
	hackrf_ui_set_frequency_fn set_frequency;
	hackrf_ui_set_sample_rate_fn set_sample_rate;
	hackrf_ui_set_direction_fn set_direction;
	hackrf_ui_set_filter_bw_fn set_filter_bw;
	hackrf_ui_set_lna_power_fn set_lna_power;
	hackrf_ui_set_bb_lna_gain_fn set_bb_lna_gain;
	hackrf_ui_set_bb_vga_gain_fn set_bb_vga_gain;
	hackrf_ui_set_bb_tx_vga_gain_fn set_bb_tx_vga_gain;
	hackrf_ui_set_first_if_frequency_fn set_first_if_frequency;
	hackrf_ui_set_filter_fn set_filter;
	hackrf_ui_set_antenna_bias_fn set_antenna_bias;
	hackrf_ui_set_clock_source_fn set_clock_source;
	hackrf_ui_set_transceiver_mode_fn set_transceiver_mode;
	hackrf_ui_operacake_gpio_compatible_fn operacake_gpio_compatible;
} hackrf_ui_t;

/* TODO: Lame hack to know that PortaPack was detected.
 * In the future, whatever UI was detected will be returned here,
 * or NULL if no UI was detected.
 */
const hackrf_ui_t* hackrf_ui(void);
void hackrf_ui_set_enable(bool);