/* * Hamlib Yaesu backend - FTX-1 shared definitions * Copyright (c) 2025 by Terrell Deppe (KJ5HST) * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * */ #ifndef _FTX1_H #define _FTX1_H #include /* * FTX-1 rig ID constants * * The Radio ID command (ID;) always returns 0840 for ALL FTX-1 configurations. * Head type detection uses a two-stage process: * * Stage 1: PC Command Format * PC1xxx = Field Head (battery or 12V) * PC2xxx = Optima/SPA-1 (5-100W) * * Stage 2: Power Probe (Field Head Only) * Attempt to set 8W power: * - If radio accepts 8W → 12V power (0.5-10W range) * - If radio rejects 8W (stays ≤6W) → Battery power (0.5-6W range) * The probe saves and restores original power setting. */ #define NC_RIGID_FTX1 0x840 /* Default rig model ID */ #define FTX1_RADIO_ID "0840" /* Radio ID (same for all configs) */ /* * FTX-1 head type constants * * Power ranges by head type: * FIELD_BATTERY: 0.5W - 6W (0.5W steps) * FIELD_12V: 0.5W - 10W (0.5W steps) * SPA1: 5W - 100W (1W steps) - "Optima" when attached to Field */ #define FTX1_HEAD_UNKNOWN 0 #define FTX1_HEAD_FIELD_BATTERY 1 /* Field Head on battery (0.5-6W) */ #define FTX1_HEAD_FIELD_12V 2 /* Field Head on 12V (0.5-10W) */ #define FTX1_HEAD_SPA1 3 /* Optima/SPA-1 amplifier (5-100W) */ /* Legacy alias for backwards compatibility */ #define FTX1_HEAD_FIELD FTX1_HEAD_FIELD_12V /* * FTX1_VFO_TO_P1 - Convert Hamlib VFO to FTX-1 P1 parameter * * FTX-1 CAT commands use P1=0 for MAIN VFO and P1=1 for SUB VFO. * This macro maps Hamlib VFO types to the appropriate P1 value. * * NOTE: This macro does NOT resolve RIG_VFO_CURR - it treats it as MAIN. * For functions that need to respect the current VFO, use ftx1_vfo_to_p1() * instead, which properly resolves currVFO. * * Returns: 0 for MAIN/VFO-A/CURR, 1 for SUB/VFO-B */ #define FTX1_VFO_TO_P1(vfo) \ ((vfo == RIG_VFO_CURR || vfo == RIG_VFO_MAIN || vfo == RIG_VFO_A) ? 0 : 1) /* * ftx1_vfo_to_p1 - Convert Hamlib VFO to FTX-1 P1 parameter with currVFO resolution * * Unlike the FTX1_VFO_TO_P1 macro, this function properly resolves RIG_VFO_CURR * to the actual current VFO before determining P1. * * Returns: 0 for MAIN/VFO-A, 1 for SUB/VFO-B */ static inline int ftx1_vfo_to_p1(RIG *rig, vfo_t vfo) { /* Resolve currVFO to actual VFO */ if (vfo == RIG_VFO_CURR || vfo == RIG_VFO_NONE) { vfo = STATE(rig)->current_vfo; } return (vfo == RIG_VFO_SUB || vfo == RIG_VFO_B) ? 1 : 0; } /* * FTX-1 CTCSS mode values for CT command */ #define FTX1_CTCSS_MODE_OFF 0 /* CT0: CTCSS/DCS off */ #define FTX1_CTCSS_MODE_ENC 1 /* CT1: CTCSS encode only (TX tone) */ #define FTX1_CTCSS_MODE_TSQ 2 /* CT2: Tone squelch (TX+RX tone) */ #define FTX1_CTCSS_MODE_DCS 3 /* CT3: DCS mode */ /* * FTX-1 S-Meter Calibration Table * Maps raw SM command values (0-255) to dB relative to S9 */ #define FTX1_STR_CAL { 16, \ { \ { 0, -54 }, /* S0 */ \ { 12, -48 }, /* S1 */ \ { 27, -42 }, /* S2 */ \ { 40, -36 }, /* S3 */ \ { 55, -30 }, /* S4 */ \ { 65, -24 }, /* S5 */ \ { 80, -18 }, /* S6 */ \ { 95, -12 }, /* S7 */ \ { 112, -6 }, /* S8 */ \ { 130, 0 }, /* S9 */ \ { 150, 10 }, /* +10 */ \ { 172, 20 }, /* +20 */ \ { 190, 30 }, /* +30 */ \ { 220, 40 }, /* +40 */ \ { 240, 50 }, /* +50 */ \ { 255, 60 }, /* +60 */ \ } \ } /* * FTX-1 RF Power Meter Calibration * Maps raw RM5 (PO) values to watts (approximate) */ #define FTX1_RFPOWER_METER_CAL { \ 7, \ { \ {0, 0.0f}, \ {10, 0.8f}, \ {50, 8.0f}, \ {100, 26.0f}, \ {150, 54.0f}, \ {200, 92.0f}, \ {250, 140.0f}, \ } \ } /* * FTX-1 SWR Meter Calibration * Using Yaesu default values — verify with hardware */ #define FTX1_SWR_CAL { \ 5, \ { \ {12, 1.0f}, \ {39, 1.35f}, \ {65, 1.5f}, \ {89, 2.0f}, \ {242, 5.0f}, \ } \ } /* * FTX-1 ALC Meter Calibration * Using Yaesu default values — verify with hardware */ #define FTX1_ALC_CAL { \ 2, \ { \ {0, 0.0f}, \ {64, 1.0f}, \ } \ } /* * FTX-1 Compressor Meter Calibration * Using Yaesu default values — verify with hardware */ #define FTX1_COMP_METER_CAL { \ 9, \ { \ {0, 0.0f}, \ {40, 2.5f}, \ {60, 5.0f}, \ {85, 7.5f}, \ {135, 10.0f}, \ {150, 12.5f}, \ {175, 15.0f}, \ {195, 17.5f}, \ {220, 20.0f}, \ } \ } /* * FTX-1 VD (Voltage) Meter Calibration * Using Yaesu default values — verify with hardware */ #define FTX1_VD_METER_CAL { \ 3, \ { \ {0, 0.0f}, \ {196, 13.8f}, \ {255, 17.95f}, \ } \ } /* * FTX-1 ID (Current) Meter Calibration * Using Yaesu default values — verify with hardware */ #define FTX1_ID_METER_CAL { \ 3, \ { \ {0, 0.0f}, \ {100, 10.0f}, \ {255, 25.5f}, \ } \ } /* * FTX-1 head detection functions (defined in ftx1.c) * These functions take a RIG* parameter to access per-rig instance storage. */ extern int ftx1_has_spa1(RIG *rig); extern int ftx1_get_head_type(RIG *rig); /* * ftx1_ensure_vfo_mode - force the radio out of Memory mode if the driver * knows it entered via a prior set_mem. Call at the top of any VFO-state * setter that would otherwise fail or behave transiently in Memory mode. * See ftx1.c for full rationale. */ extern void ftx1_ensure_vfo_mode(RIG *rig); /* * FTX-1 band select functions (defined in ftx1_scan.c) */ extern int ftx1_set_band_select(RIG *rig, vfo_t vfo, int band); extern int ftx1_get_band_select(RIG *rig, vfo_t vfo, int *band); /* * FTX-1 CTCSS helpers (defined in ftx1_ctcss.c) */ extern int ftx1_freq_to_tone_num(unsigned int freq); extern unsigned int ftx1_tone_num_to_freq(int num); #endif /* _FTX1_H */