1 /*
2  *  Hamlib CI-V backend - description of IC-7000 and variations
3  *  Adapted from IC-7800 code 2006 by Kent Hill
4  *  Copyright (c) 2004-2010 by Stephane Fillod
5  *
6  *
7  *   This library is free software; you can redistribute it and/or
8  *   modify it under the terms of the GNU Lesser General Public
9  *   License as published by the Free Software Foundation; either
10  *   version 2.1 of the License, or (at your option) any later version.
11  *
12  *   This library is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *   Lesser General Public License for more details.
16  *
17  *   You should have received a copy of the GNU Lesser General Public
18  *   License along with this library; if not, write to the Free Software
19  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20  *
21  */
22 
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26 
27 #include <string.h>  /* String function definitions */
28 
29 #include <hamlib/rig.h>
30 #include "idx_builtin.h"
31 
32 #include "icom.h"
33 #include "icom_defs.h"
34 #include "frame.h"
35 #include "bandplan.h"
36 
37 #define IC7000_ALL_RX_MODES (RIG_MODE_AM|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR|RIG_MODE_FM|RIG_MODE_WFM)
38 #define IC7000_1HZ_TS_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR)
39 #define IC7000_NOT_TS_MODES (IC7000_ALL_RX_MODES &~IC7000_1HZ_TS_MODES)
40 
41 #define IC7000_OTHER_TX_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR|RIG_MODE_FM)
42 #define IC7000_AM_TX_MODES (RIG_MODE_AM)
43 
44 #define IC7000_FUNCS (RIG_FUNC_NB|RIG_FUNC_COMP|RIG_FUNC_VOX|RIG_FUNC_TONE|RIG_FUNC_TSQL|RIG_FUNC_SBKIN|RIG_FUNC_FBKIN|RIG_FUNC_NR|RIG_FUNC_MON|RIG_FUNC_MN|RIG_FUNC_ANF|RIG_FUNC_VSC|RIG_FUNC_LOCK|RIG_FUNC_ARO)
45 
46 #define IC7000_LEVELS (RIG_LEVEL_PREAMP|RIG_LEVEL_ATT|RIG_LEVEL_AGC|RIG_LEVEL_COMP|RIG_LEVEL_BKINDL|RIG_LEVEL_NR|RIG_LEVEL_PBT_IN|RIG_LEVEL_PBT_OUT|RIG_LEVEL_CWPITCH|RIG_LEVEL_RFPOWER|RIG_LEVEL_MICGAIN|RIG_LEVEL_KEYSPD|RIG_LEVEL_NOTCHF_RAW|RIG_LEVEL_SQL|RIG_LEVEL_RAWSTR|RIG_LEVEL_STRENGTH|RIG_LEVEL_AF|RIG_LEVEL_RF|RIG_LEVEL_VOXGAIN|RIG_LEVEL_ANTIVOX|RIG_LEVEL_VOXDELAY|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_RFPOWER_METER|RIG_LEVEL_RFPOWER_METER_WATTS|RIG_LEVEL_COMP_METER|RIG_LEVEL_MONITOR_GAIN|RIG_LEVEL_NB)
47 
48 #define IC7000_VFOS (RIG_VFO_A|RIG_VFO_B|RIG_VFO_MEM)
49 #define IC7000_PARMS (RIG_PARM_ANN|RIG_PARM_BACKLIGHT|RIG_PARM_APO|RIG_PARM_TIME|RIG_PARM_BEEP)
50 
51 #define IC7000_VFO_OPS (RIG_OP_CPY|RIG_OP_XCHG|RIG_OP_FROM_VFO|RIG_OP_TO_VFO|RIG_OP_MCL|RIG_OP_TUNE)
52 #define IC7000_SCAN_OPS (RIG_SCAN_MEM|RIG_SCAN_PROG|RIG_SCAN_SLCT|RIG_SCAN_PRIO)
53 
54 #define IC7000_ANTS (RIG_ANT_1|RIG_ANT_2) /* ant-1 is Hf-6m, ant-2 is 2m-70cm */
55 
56 /*
57  * Measurement by Mark, WA0TOP
58  *
59  * s/n 0503103.
60  * Preamp off, ATT off, mode AM, f=10 MHz
61  */
62 #define IC7000_STR_CAL { 14, \
63     { \
64         {   0, -54 }, /* first one is made up */ \
65         {   5, -29 }, \
66         {  15, -27 }, \
67         {  43, -22 }, \
68         {  68, -17 }, \
69         {  92, -12 }, \
70         { 120,  -6 }, \
71         { 141,   2 }, \
72         { 162,  13 }, \
73         { 182,  25 }, \
74         { 202,  38 }, \
75         { 222,  47 }, \
76         { 241,  57 }, \
77         { 255,  63 } \
78     } }
79 
80 #define IC7000_SWR_CAL { 5, \
81     { \
82          { 0, 1.0f }, \
83          { 48, 1.5f }, \
84          { 80, 2.0f }, \
85          { 120, 3.0f }, \
86          { 240, 6.0f } \
87     } }
88 
89 #define IC7000_ALC_CAL { 2, \
90     { \
91          { 0, 0.0f }, \
92          { 120, 1.0f } \
93     } }
94 
95 #define IC7000_RFPOWER_METER_CAL { 13, \
96     { \
97          { 0, 0.0f }, \
98          { 21, 5.0f }, \
99          { 43, 10.0f }, \
100          { 65, 15.0f }, \
101          { 83, 20.0f }, \
102          { 95, 25.0f }, \
103          { 105, 30.0f }, \
104          { 114, 35.0f }, \
105          { 124, 40.0f }, \
106          { 143, 50.0f }, \
107          { 183, 75.0f }, \
108          { 213, 100.0f }, \
109          { 255, 120.0f } \
110     } }
111 
112 
113 #define IC7000_COMP_METER_CAL { 3, \
114     { \
115          { 0, 0.0f }, \
116          { 130, 15.0f }, \
117          { 241, 30.0f } \
118     } }
119 
120 /*
121  *
122  * IC7000 channel caps.
123  */
124 #define IC7000_MEM_CAP {    \
125         .freq = 1,  \
126         .mode = 1,  \
127         .width = 1, \
128         .split = 1, \
129         .tx_freq = 1,   \
130         .tx_mode = 1,   \
131         .tx_width = 1,  \
132         .rptr_offs = 1, \
133         .rptr_shift = 1, \
134         .ctcss_tone = 1, \
135         .ctcss_sql = 1, \
136         .funcs = IC7000_FUNCS, \
137         .levels = RIG_LEVEL_SET(IC7000_LEVELS), \
138 }
139 
140 struct cmdparams ic7000_extcmds[] =
141 {
142     { {.s = RIG_LEVEL_VOXDELAY}, CMD_PARAM_TYPE_LEVEL, C_CTL_MEM, S_MEM_PARM, SC_MOD_RW, 2, {0x01, 0x17}, CMD_DAT_INT, 1 },
143     { {.s = RIG_PARM_NONE} }
144 };
145 
146 /*
147  *  This function does the special bandwidth coding for IC-7000
148  */
ic7000_r2i_mode(RIG * rig,vfo_t vfo,rmode_t mode,pbwidth_t width,unsigned char * md,signed char * pd)149 static int ic7000_r2i_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width,
150                            unsigned char *md, signed char *pd)
151 {
152     int err;
153 
154     err = rig2icom_mode(rig, vfo, mode, width, md, pd);
155 
156     if (err != RIG_OK)
157     {
158         return err;
159     }
160 
161     // CAT section of manual says: nn = 0 -40 > bw = 50Hz > 3600Hz
162     // Tested by Ian G3VPX 20201029
163     // 0 - 9 > bw 50Hz to 500Hz in 50Hz steps
164     // 10 - 40 > bw 600Hz to 3600Hz in 100Hz steps
165     if (width != RIG_PASSBAND_NOCHANGE)
166     {
167         if (width <= 500) { *pd = width / 50 - 1; }
168         else if (width <= 3600) { *pd = width / 100 + 4; }
169         else { *pd = 40; }
170     }
171 
172     return RIG_OK;
173 }
174 
175 /*
176  * IC-7000 rig capabilities.
177  */
178 static const struct icom_priv_caps IC7000_priv_caps =
179 {
180     0x70,    /* default address */
181     0,       /* 731 mode */
182     0,       /* no XCHG */
183     ic7000_ts_sc_list,
184     .agc_levels_present = 1,
185     .agc_levels = {
186         { .level = RIG_AGC_FAST, .icom_level = 1 },
187         { .level = RIG_AGC_MEDIUM, .icom_level = 2 },
188         { .level = RIG_AGC_SLOW, .icom_level = 3 },
189         { .level = -1, .icom_level = 0 },
190     },
191     .extcmds = ic7000_extcmds,
192     .r2i_mode = ic7000_r2i_mode
193 };
194 
195 const struct rig_caps ic7000_caps =
196 {
197     RIG_MODEL(RIG_MODEL_IC7000),
198     .model_name = "IC-7000",
199     .mfg_name =  "Icom",
200     .version =  BACKEND_VER ".1",
201     .copyright =  "LGPL",
202     .status =  RIG_STATUS_STABLE,
203     .rig_type =  RIG_TYPE_TRANSCEIVER,
204     .ptt_type =  RIG_PTT_RIG,
205     .dcd_type =  RIG_DCD_RIG,
206     .port_type =  RIG_PORT_SERIAL,
207     .serial_rate_min =  300,
208     .serial_rate_max =  19200,
209     .serial_data_bits =  8,
210     .serial_stop_bits =  1,
211     .serial_parity =  RIG_PARITY_NONE,
212     .serial_handshake =  RIG_HANDSHAKE_NONE,
213     .write_delay =  0,
214     .post_write_delay =  0,
215     .timeout =  1000,
216     .retry =  3,
217     .has_get_func =  IC7000_FUNCS,
218     .has_set_func =  IC7000_FUNCS,
219     .has_get_level =  IC7000_LEVELS,
220     .has_set_level =  RIG_LEVEL_SET(IC7000_LEVELS),
221     .has_get_parm =  IC7000_PARMS,
222     .has_set_parm =  RIG_PARM_SET(IC7000_PARMS),
223     .level_gran = {
224         // cppcheck-suppress *
225         [LVL_RAWSTR] = { .min = { .i = 0 }, .max = { .i = 255 } },
226         [LVL_VOXDELAY] = { .min = { .i = 0 }, .max = { .i = 20 }, .step = { .i = 1 } },
227         [LVL_KEYSPD] = { .min = { .i = 6 }, .max = { .i = 48 }, .step = { .i = 1 } },
228         [LVL_CWPITCH] = { .min = { .i = 300 }, .max = { .i = 900 }, .step = { .i = 1 } },
229     },
230     .parm_gran =  {},
231     .ctcss_list =  common_ctcss_list,
232     .dcs_list =  common_dcs_list,
233     .preamp =   { 10, RIG_DBLST_END, }, /* FIXME: TBC it's a guess */
234     .attenuator =   { 12, RIG_DBLST_END, },
235     .max_rit =  Hz(9999),
236     .max_xit =  Hz(9999),
237     .max_ifshift =  Hz(0), /* TODO */
238     .agc_level_count = 3,
239     .agc_levels = { RIG_AGC_FAST, RIG_AGC_MEDIUM, RIG_AGC_SLOW },
240     .targetable_vfo =  0,
241     .vfo_ops =  IC7000_VFO_OPS,
242     .scan_ops =  IC7000_SCAN_OPS,
243     .transceive =  RIG_TRN_RIG,
244     .bank_qty =   5,
245     .chan_desc_sz =  0, /* TODO */
246 
247     .chan_list =  {
248         {   1,  99, RIG_MTYPE_MEM,  IC7000_MEM_CAP },
249         { 100, 105, RIG_MTYPE_EDGE, IC7000_MEM_CAP },    /* two by two */
250         { 106, 107, RIG_MTYPE_CALL, IC7000_MEM_CAP },
251         RIG_CHAN_END,
252     },
253 
254     .rx_range_list1 =   { {kHz(30), MHz(199.999999), IC7000_ALL_RX_MODES, -1, -1, IC7000_VFOS},
255         {MHz(400), MHz(470), IC7000_ALL_RX_MODES, -1, -1, IC7000_VFOS}, RIG_FRNG_END,
256     },
257     .tx_range_list1 =   {
258         FRQ_RNG_HF(1, IC7000_OTHER_TX_MODES, W(2), W(100), IC7000_VFOS, RIG_ANT_1),
259         FRQ_RNG_6m(1, IC7000_OTHER_TX_MODES, W(2), W(100), IC7000_VFOS, RIG_ANT_1),
260         FRQ_RNG_2m(1, IC7000_OTHER_TX_MODES, W(2), W(50), IC7000_VFOS, RIG_ANT_2),
261         FRQ_RNG_70cm(1, IC7000_OTHER_TX_MODES, W(2), W(35), IC7000_VFOS, RIG_ANT_2),
262         FRQ_RNG_HF(1, IC7000_AM_TX_MODES, W(1), W(40), IC7000_VFOS, RIG_ANT_1), /* AM class */
263         FRQ_RNG_6m(1, IC7000_AM_TX_MODES, W(1), W(40), IC7000_VFOS, RIG_ANT_1), /* AM class */
264         FRQ_RNG_2m(1, IC7000_AM_TX_MODES, W(2), W(20), IC7000_VFOS, RIG_ANT_2),
265         FRQ_RNG_70cm(1, IC7000_OTHER_TX_MODES, W(2), W(14), IC7000_VFOS, RIG_ANT_2),
266         RIG_FRNG_END,
267     },
268 
269     .rx_range_list2 =   { {kHz(30), MHz(199.999999), IC7000_ALL_RX_MODES, -1, -1, IC7000_VFOS},
270         {MHz(400), MHz(470), IC7000_ALL_RX_MODES, -1, -1, IC7000_VFOS}, RIG_FRNG_END,
271     },
272     .tx_range_list2 =  { /* needs the 5 mhz channels added */
273         FRQ_RNG_HF(2, IC7000_OTHER_TX_MODES, W(2), W(100), IC7000_VFOS, RIG_ANT_1),
274         FRQ_RNG_6m(2, IC7000_OTHER_TX_MODES, W(2), W(100), IC7000_VFOS, RIG_ANT_1),
275         FRQ_RNG_2m(2, IC7000_OTHER_TX_MODES, W(2), W(50), IC7000_VFOS, RIG_ANT_2),
276         FRQ_RNG_70cm(2, IC7000_OTHER_TX_MODES, W(2), W(35), IC7000_VFOS, RIG_ANT_2),
277         FRQ_RNG_HF(2, IC7000_AM_TX_MODES, W(1), W(40), IC7000_VFOS, RIG_ANT_1), /* AM class */
278         FRQ_RNG_6m(2, IC7000_AM_TX_MODES, W(1), W(40), IC7000_VFOS, RIG_ANT_1), /* AM class */
279         FRQ_RNG_2m(2, IC7000_AM_TX_MODES, W(2), W(20), IC7000_VFOS, RIG_ANT_2),
280         FRQ_RNG_70cm(2, IC7000_OTHER_TX_MODES, W(2), W(14), IC7000_VFOS, RIG_ANT_2),
281         RIG_FRNG_END,
282     },
283 
284     .tuning_steps = {
285         {IC7000_1HZ_TS_MODES, 1},
286         {IC7000_NOT_TS_MODES, 10},
287         {IC7000_ALL_RX_MODES, Hz(100)},
288         {IC7000_ALL_RX_MODES, kHz(1)},
289         {IC7000_ALL_RX_MODES, kHz(5)},
290         {IC7000_ALL_RX_MODES, kHz(9)},
291         {IC7000_ALL_RX_MODES, kHz(10)},
292         {IC7000_ALL_RX_MODES, kHz(12.5)},
293         {IC7000_ALL_RX_MODES, kHz(20)},
294         {IC7000_ALL_RX_MODES, kHz(25)},
295         {IC7000_ALL_RX_MODES, kHz(100)},
296         {IC7000_NOT_TS_MODES, MHz(1)},
297         RIG_TS_END,
298     },
299 
300     /* mode/filter list, remember: order matters! But duplication may speed up search.  Put the most commonly used modes first!  Remember these are defaults, with dsp rigs you can change them to anything you want except FM and WFM which are fixed */
301     .filters =  {
302         {RIG_MODE_SSB, kHz(2.4)},
303         {RIG_MODE_SSB, kHz(1.8)},
304         {RIG_MODE_SSB, kHz(3)},
305         {RIG_MODE_FM, kHz(10)},
306         {RIG_MODE_FM, kHz(15)},
307         {RIG_MODE_FM, kHz(7)},
308         {RIG_MODE_CW | RIG_MODE_CWR | RIG_MODE_RTTY | RIG_MODE_RTTYR, Hz(500)},
309         {RIG_MODE_CW | RIG_MODE_CWR | RIG_MODE_RTTY | RIG_MODE_RTTYR, Hz(250)},
310         {RIG_MODE_CW | RIG_MODE_CWR, kHz(1.2)},
311         {RIG_MODE_RTTY | RIG_MODE_RTTYR, kHz(2.4)},
312         {RIG_MODE_AM, kHz(6)},
313         {RIG_MODE_AM, kHz(3)},
314         {RIG_MODE_AM, kHz(9)},
315         {RIG_MODE_WFM, kHz(280)},
316         RIG_FLT_END,
317     },
318 
319     .str_cal = IC7000_STR_CAL,
320     .swr_cal = IC7000_SWR_CAL,
321     .alc_cal = IC7000_ALC_CAL,
322     .rfpower_meter_cal = IC7000_RFPOWER_METER_CAL,
323     .comp_meter_cal = IC7000_COMP_METER_CAL,
324 
325     .cfgparams =  icom_cfg_params,
326     .set_conf =  icom_set_conf,
327     .get_conf =  icom_get_conf,
328 
329     .priv = (void *)& IC7000_priv_caps,
330     .rig_init =   icom_init,
331     .rig_cleanup =   icom_cleanup,
332     .rig_open =  icom_rig_open,
333     .rig_close =  icom_rig_close,
334 
335     .set_freq =  icom_set_freq,
336     .get_freq =  icom_get_freq,
337     .set_mode =  icom_set_mode,
338     .get_mode =  icom_get_mode,
339     .set_vfo =  icom_set_vfo,
340     .set_ant =  NULL,  /*automatically set by rig depending band */
341     .get_ant =  NULL,
342 
343     .decode_event =  icom_decode_event,
344     .set_level =  icom_set_level,
345     .get_level =  icom_get_level,
346     .set_func =  icom_set_func,
347     .get_func =  icom_get_func,
348     .set_parm =  NULL,
349     .get_parm =  NULL,
350     .set_mem =  icom_set_mem,
351     .set_bank =  icom_set_bank,
352     .vfo_op =  icom_vfo_op,
353     .scan =  icom_scan,
354     .set_ptt =  icom_set_ptt,
355     .get_ptt =  icom_get_ptt,
356     .get_dcd =  icom_get_dcd,
357     .set_ts =  icom_set_ts,
358     .get_ts =  NULL,
359     .set_rptr_shift =  icom_set_rptr_shift,
360     .get_rptr_shift =  NULL,
361     .set_rptr_offs =  icom_set_rptr_offs,
362     .get_rptr_offs =  icom_get_rptr_offs,
363     .set_ctcss_tone =  icom_set_ctcss_tone,
364     .get_ctcss_tone =  icom_get_ctcss_tone,
365     .set_ctcss_sql =  icom_set_ctcss_sql,
366     .get_ctcss_sql =  icom_get_ctcss_sql,
367     .set_dcs_code =  icom_set_dcs_code,
368     .get_dcs_code =  icom_get_dcs_code,
369     .set_split_freq =  icom_set_split_freq,
370     .get_split_freq =  icom_get_split_freq,
371     .set_split_mode =  icom_set_split_mode,
372     .get_split_mode =  icom_get_split_mode,
373     .set_split_vfo =  icom_set_split_vfo,
374     .get_split_vfo =  NULL,
375 
376 };
377