Hamlib/rigs/icom/id5100.c

359 wiersze
10 KiB
C

/*
* Hamlib CI-V backend - description of ID-5100 and variations
* Copyright (c) 2015 by Stephane Fillod
* Copyright (c) 2019 by Malcolm Herring
*
*
* 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
*
*/
#include "hamlib/rig.h"
#include "idx_builtin.h"
#include "icom.h"
#include "icom_defs.h"
#include "frame.h"
#include "misc.h"
/*
* Specs and protocol details comes from the chapter 13 of ID-5100_Full-Inst_Manual.pdf
*
* NB: while the port labeled "Data" is used for firmware upgrades,
* you have to use the port labeled "SP2" for rig control.
*
* TODO:
* - DV mode
* - GPS support
* - Single/dual watch (RIG_LEVEL_BALANCE)
*/
#define ID5100_MODES (RIG_MODE_AM|RIG_MODE_AMN|RIG_MODE_FM|RIG_MODE_FMN|RIG_MODE_DSTAR)
#define ID5100_ALL_RX_MODES (RIG_MODE_AM|ID5100_MODES)
#define ID5100_VFO_ALL (RIG_VFO_A|RIG_VFO_B|RIG_VFO_MAIN|RIG_VFO_SUB)
#define ID5100_SCAN_OPS RIG_SCAN_NONE
#define ID5100_VFO_OPS RIG_OP_NONE
#define ID5100_FUNC_ALL ( \
RIG_FUNC_TONE| \
RIG_FUNC_TSQL| \
RIG_FUNC_CSQL| \
RIG_FUNC_DSQL| \
RIG_FUNC_DUAL_WATCH| \
RIG_FUNC_VOX)
#define ID5100_LEVEL_ALL (RIG_LEVEL_AF| \
RIG_LEVEL_SQL| \
RIG_LEVEL_RAWSTR| \
RIG_LEVEL_RFPOWER| \
RIG_LEVEL_MICGAIN| \
RIG_LEVEL_VOXGAIN)
#define ID5100_PARM_ALL RIG_PARM_NONE
/*
* FIXME: real measurement
*/
#define ID5100_STR_CAL UNKNOWN_IC_STR_CAL
int id5100_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
{
int retval;
unsigned char modebuf;
unsigned char ackbuf[MAXFRAMELEN];
int icmode = 2;
int ack_len = sizeof(ackbuf);
switch (mode)
{
case RIG_MODE_AM: icmode = 2; modebuf = 1; break;
case RIG_MODE_AMN: icmode = 2; modebuf = 2; break;
case RIG_MODE_FM: icmode = 5; modebuf = 1; break;
case RIG_MODE_FMN: icmode = 5; modebuf = 2; break;
case RIG_MODE_DSTAR: icmode = 0x17; modebuf = 1; break;
default:
rig_debug(RIG_DEBUG_ERR, "%s: Unknown mode=%s\n", __func__, rig_strrmode(mode));
return -RIG_EINVAL;
}
rig_debug(RIG_DEBUG_VERBOSE, "%s: mode=%d, modebuf=%c\n", __func__, icmode,
modebuf);
retval = icom_transaction(rig, C_SET_MODE, icmode, &modebuf, 1, ackbuf,
&ack_len);
return retval;
}
int id5100_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
{
int retval;
int mode_len;
unsigned char modebuf[4];
retval = icom_transaction(rig, C_RD_MODE, -1, NULL, 0, modebuf, &mode_len);
if (retval != RIG_OK)
{
return retval;
}
switch (modebuf[1])
{
case 2:
*mode = modebuf[2] == 1 ? RIG_MODE_AM : RIG_MODE_AMN;
*width = modebuf[2] == 1 ? 12000 : 6000; break;
case 5:
*mode = modebuf[2] == 1 ? RIG_MODE_FM : RIG_MODE_FMN;
*width = modebuf[2] == 1 ? 10000 : 5000; break;
case 0x17:
*mode = RIG_MODE_DSTAR;
*width = 6000; break;
}
return RIG_OK;
}
int id5100_set_vfo(RIG *rig, vfo_t vfo)
{
unsigned char ackbuf[MAXFRAMELEN];
int ack_len = sizeof(ackbuf), retval;
//struct rig_state *rs = &rig->state;
//struct icom_priv_data *priv = (struct icom_priv_data *) rs->priv;
ENTERFUNC;
if (vfo == RIG_VFO_CURR) { vfo = rig->state.current_vfo; }
if (vfo == RIG_VFO_A || vfo == RIG_VFO_B)
{
// then we need to turn off dual watch
if (RIG_OK != (retval = icom_set_func(rig, RIG_VFO_CURR, RIG_FUNC_DUAL_WATCH,
0)))
{
RETURNFUNC2(retval);
}
}
else if (vfo == RIG_VFO_MAIN || vfo == RIG_VFO_SUB)
if (RIG_OK != (retval = icom_set_func(rig, RIG_VFO_CURR, RIG_FUNC_DUAL_WATCH,
1)))
{
RETURNFUNC2(retval);
}
int myvfo = S_MAIN;
if (vfo == RIG_VFO_B || vfo == RIG_VFO_SUB)
{
myvfo = S_SUB;
}
if (RIG_OK != (retval = icom_transaction(rig, C_SET_VFO, myvfo, NULL, 0, ackbuf,
&ack_len)))
{
RETURNFUNC2(retval);
}
return retval;
}
int id5100_set_split_vfo(RIG *rig, vfo_t vfo, split_t split, vfo_t tx_vfo)
{
//unsigned char ackbuf[MAXFRAMELEN];
//int ack_len = sizeof(ackbuf), icvfo, retval;
int retval;
//struct rig_state *rs = &rig->state;
//struct icom_priv_data *priv = (struct icom_priv_data *) rs->priv;
rig_debug(RIG_DEBUG_VERBOSE, "%s called vfo=%s\n", __func__, rig_strvfo(vfo));
if (vfo == RIG_VFO_CURR || vfo == RIG_VFO_A || vfo == RIG_VFO_B)
{
return icom_set_vfo(rig, vfo);
}
if (vfo == RIG_VFO_MAIN)
{
retval = RIG_OK;
}
else
{
retval = RIG_OK;
}
return retval;
}
/*
*/
static struct icom_priv_caps id5100_priv_caps =
{
0x8C, /* default address */
0, /* 731 mode */
1, /* no XCHG */
.dualwatch_split = 1
};
const struct rig_caps id5100_caps =
{
RIG_MODEL(RIG_MODEL_ID5100),
.model_name = "ID-5100",
.mfg_name = "Icom",
.version = BACKEND_VER ".4",
.copyright = "LGPL",
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_MOBILE,
.ptt_type = RIG_PTT_RIG,
.dcd_type = RIG_DCD_RIG,
.port_type = RIG_PORT_SERIAL,
.serial_rate_min = 4800,
.serial_rate_max = 19200,
.serial_data_bits = 8,
.serial_stop_bits = 1,
.serial_parity = RIG_PARITY_NONE,
.serial_handshake = RIG_HANDSHAKE_NONE,
.write_delay = 0,
.post_write_delay = 0,
.timeout = 1000,
.retry = 0,
.has_get_func = ID5100_FUNC_ALL,
.has_set_func = ID5100_FUNC_ALL,
.has_get_level = ID5100_LEVEL_ALL,
.has_set_level = RIG_LEVEL_SET(ID5100_LEVEL_ALL),
.has_get_parm = ID5100_PARM_ALL,
.has_set_parm = ID5100_PARM_ALL,
.level_gran =
{
#include "level_gran_icom.h"
// cppcheck-suppress *
[LVL_RAWSTR] = { .min = { .i = 0 }, .max = { .i = 255 } },
},
.extparms = icom_ext_parms,
.parm_gran = {},
.ctcss_list = common_ctcss_list,
.dcs_list = full_dcs_list,
.preamp = { RIG_DBLST_END, },
.attenuator = { RIG_DBLST_END, },
.max_rit = Hz(0),
.max_xit = Hz(0),
.max_ifshift = Hz(0),
.targetable_vfo = 0,
.vfo_ops = ID5100_VFO_OPS,
.scan_ops = ID5100_SCAN_OPS,
.transceive = RIG_TRN_RIG,
.bank_qty = 0,
.chan_desc_sz = 0,
.chan_list = {
// There's no memory support through CI-V,
// but there is a clone mode apart.
RIG_CHAN_END,
},
.rx_range_list1 = {
{MHz(118), MHz(174), ID5100_ALL_RX_MODES, -1, -1, ID5100_VFO_ALL},
{MHz(375), MHz(550), ID5100_ALL_RX_MODES, -1, -1, ID5100_VFO_ALL},
RIG_FRNG_END,
},
.tx_range_list1 = {
{MHz(144), MHz(146), ID5100_MODES, W(5), W(25), ID5100_VFO_ALL},
{MHz(430), MHz(440), ID5100_MODES, W(5), W(25), ID5100_VFO_ALL},
RIG_FRNG_END,
},
.rx_range_list2 = {
{MHz(118), MHz(174), ID5100_ALL_RX_MODES, -1, -1, ID5100_VFO_ALL},
{MHz(375), MHz(550), ID5100_ALL_RX_MODES, -1, -1, ID5100_VFO_ALL},
RIG_FRNG_END,
},
.tx_range_list2 = {
{MHz(144), MHz(148), ID5100_MODES, W(5), W(50), ID5100_VFO_ALL},
{MHz(430), MHz(450), ID5100_MODES, W(5), W(50), ID5100_VFO_ALL},
RIG_FRNG_END,
},
.tuning_steps = {
// Rem: no support for changing tuning step
{RIG_MODE_ALL, 1},
RIG_TS_END,
},
/* mode/filter list, remember: order matters! */
.filters = {
{RIG_MODE_FM | RIG_MODE_AM, kHz(12)},
{RIG_MODE_FM | RIG_MODE_AM, kHz(6)},
RIG_FLT_END,
},
.str_cal = ID5100_STR_CAL,
.cfgparams = icom_cfg_params,
.set_conf = icom_set_conf,
.get_conf = icom_get_conf,
.priv = (void *)& id5100_priv_caps,
.rig_init = icom_init,
.rig_cleanup = icom_cleanup,
.rig_open = icom_rig_open,
.rig_close = icom_rig_close,
.set_freq = icom_set_freq,
.get_freq = icom_get_freq,
.set_mode = id5100_set_mode,
.get_mode = id5100_get_mode,
.set_vfo = id5100_set_vfo,
.set_split_vfo = id5100_set_split_vfo,
.set_powerstat = icom_set_powerstat,
//.get_powerstat = icom_get_powerstat, // ID-5100 cannot get power status
.decode_event = icom_decode_event,
.set_func = icom_set_func,
.get_func = icom_get_func,
.set_level = icom_set_level,
.get_level = icom_get_level,
.set_parm = icom_set_parm,
.get_parm = icom_get_parm,
.set_ext_parm = icom_set_ext_parm,
.get_ext_parm = icom_get_ext_parm,
.set_ptt = icom_set_ptt,
.get_ptt = icom_get_ptt,
.get_dcd = icom_get_dcd,
.set_rptr_shift = icom_set_rptr_shift,
.get_rptr_shift = icom_get_rptr_shift,
.set_rptr_offs = icom_set_rptr_offs,
.get_rptr_offs = icom_get_rptr_offs,
.set_ctcss_tone = icom_set_ctcss_tone,
.get_ctcss_tone = icom_get_ctcss_tone,
.set_dcs_code = icom_set_dcs_code,
.get_dcs_code = icom_get_dcs_code,
.set_ctcss_sql = icom_set_ctcss_sql,
.get_ctcss_sql = icom_get_ctcss_sql,
.set_dcs_sql = icom_set_dcs_sql,
.get_dcs_sql = icom_get_dcs_sql,
.hamlib_check_rig_caps = HAMLIB_CHECK_RIG_CAPS
};