HAMLIB IC-7300 Rig Driver (patches submitted to upstream)

Copyright correction

From 3255281e8afa934f4784244c9351209096152a45 Mon Sep 17 00:00:00 2001
From: Peter Jackson <pete@peteonrails.com>
Date: Fri, 8 Apr 2016 04:28:43 -0400
Subject: [PATCH 2/2] Update copyright notice and credit

---
 icom/ic7300.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/icom/ic7300.c b/icom/ic7300.c
index d329520..e6369e6 100644
--- a/icom/ic7300.c
+++ b/icom/ic7300.c
@@ -1,7 +1,7 @@
 /*
  *  Hamlib CI-V backend - description of IC-7300 and variations
- *  Adapted by P.Jackson from IC7200_SCAN_OPS00 code (c) 2004 by J.Watson
- *
+ *  Adapted by P.Jackson from IC7000 code (c) 2004-2010 by Stephane Fillod
+ *  With further credit to Kent Hill for his IC-7800 code
  *
  *   This library is free software; you can redistribute it and/or
  *   modify it under the terms of the GNU Lesser General Public
-- 
2.6.3

IC7300 Support Patch for Hamlib

From d93e8ed8b56bebf0553a75ce23f897ae133441a9 Mon Sep 17 00:00:00 2001
From: Peter Jackson <pete@peteonrails.com>
Date: Fri, 8 Apr 2016 04:25:35 -0400
Subject: [PATCH 1/2] Add support for the ICOM IC-7300

Followed all of the instructions in README.developer, cloning
the model file for the IC-7000 and changing the default address
to match the IC-7300's out of box configuration.

Tested against my IC-7300 and set_freq, get_freq, set_mode, get_mode
get_vfo, set_vfo all working.
---
 icom/Android.mk          |   2 +-
 icom/Makefile.am         |   2 +-
 icom/ic7300.c            | 256 +++++++++++++++++++++++++++++++++++++++++++++++
 icom/icom.c              |  13 ++-
 icom/icom.h              |   2 +
 include/hamlib/riglist.h |   6 +-
 6 files changed, 276 insertions(+), 5 deletions(-)
 create mode 100644 icom/ic7300.c

diff --git a/icom/Android.mk b/icom/Android.mk
index f1f972a..db70d92 100644
--- a/icom/Android.mk
+++ b/icom/Android.mk
@@ -11,7 +11,7 @@ LOCAL_SRC_FILES := ic706.c icr8500.c ic735.c ic775.c ic756.c  \
 		icr10.c icr20.c icr71.c icr72.c icr75.c icrx7.c \
 		id1.c id5100.c ic2730.c \
 		ic707.c ic728.c ic751.c ic761.c \
-		ic78.c ic7800.c ic7000.c ic7100.c ic7200.c ic7600.c ic7700.c \
+		ic78.c ic7800.c ic7000.c ic7100.c ic7200.c ic7300.c ic7600.c ic7700.c \
 		icom.c frame.c optoscan.c
 LOCAL_MODULE := icom
 
diff --git a/icom/Makefile.am b/icom/Makefile.am
index 079879a..d71ece2 100644
--- a/icom/Makefile.am
+++ b/icom/Makefile.am
@@ -7,7 +7,7 @@ ICOMSRC = ic706.c icr8500.c ic735.c ic775.c ic756.c  \
 	icr10.c icr20.c icr71.c icr72.c icr75.c icrx7.c \
 	id1.c id5100.c ic2730.c \
 	ic707.c ic728.c ic751.c ic761.c \
-	ic78.c ic7800.c ic7000.c ic7100.c ic7200.c ic7600.c ic7700.c \
+	ic78.c ic7800.c ic7000.c ic7100.c ic7200.c ic7300.c ic7600.c ic7700.c \
 	icom.c icom.h icom_defs.h frame.c frame.h optoscan.c optoscan.h
 
 noinst_LTLIBRARIES = libhamlib-icom.la
diff --git a/icom/ic7300.c b/icom/ic7300.c
new file mode 100644
index 0000000..d329520
--- /dev/null
+++ b/icom/ic7300.c
@@ -0,0 +1,256 @@
+/*
+ *  Hamlib CI-V backend - description of IC-7300 and variations
+ *  Adapted by P.Jackson from IC7200_SCAN_OPS00 code (c) 2004 by J.Watson
+ *
+ *
+ *   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
+ *   MERCHANTAILITY 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
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <stdlib.h>
+#include <string.h>  /* String function definitions */
+
+#include <hamlib/rig.h>
+#include "token.h"
+#include "idx_builtin.h"
+
+#include "icom.h"
+#include "icom_defs.h"
+#include "frame.h"
+#include "misc.h"
+#include "bandplan.h"
+
+#define IC7300_ALL_RX_MODES (RIG_MODE_AM|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR|RIG_MODE_PKTLSB|RIG_MODE_PKTUSB)
+#define IC7300_1HZ_TS_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR|RIG_MODE_PKTLSB|RIG_MODE_PKTUSB)
+#define IC7300_NOT_TS_MODES (IC7300_ALL_RX_MODES &~IC7300_1HZ_TS_MODES)
+
+#define IC7300_OTHER_TX_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR)
+#define IC7300_AM_TX_MODES (RIG_MODE_AM)
+
+#define IC7300_FUNCS (RIG_FUNC_FAGC|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)
+
+#define IC7300_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|RIG_LEVEL_SQL|RIG_LEVEL_RAWSTR|RIG_LEVEL_AF|RIG_LEVEL_RF|RIG_LEVEL_VOXGAIN|RIG_LEVEL_VOXDELAY|RIG_LEVEL_SWR|RIG_LEVEL_ALC)
+
+#define IC7300_VFOS (RIG_VFO_A|RIG_VFO_B|RIG_VFO_MEM)
+#define IC7300_PARMS (RIG_PARM_ANN|RIG_PARM_BACKLIGHT|RIG_PARM_APO|RIG_PARM_TIME|RIG_PARM_BEEP)
+
+#define IC7300_VFO_OPS (RIG_OP_CPY|RIG_OP_XCHG|RIG_OP_FROM_VFO|RIG_OP_TO_VFO|RIG_OP_MCL|RIG_OP_TUNE)
+#define IC7300_SCAN_OPS (RIG_SCAN_MEM|RIG_SCAN_PROG|RIG_SCAN_SLCT|RIG_SCAN_PRIO)
+
+#define IC7300_ANTS (RIG_ANT_1) /* ant-1 is Hf-6m */
+
+/*
+ * FIXME: This is a guess real measures please!
+ */
+#define IC7300_STR_CAL { 2, \
+  { \
+		{   0, -54 }, /* first one is made up */ \
+		{   5, -29 }, \
+		{  15, -27 }, \
+		{  43, -22 }, \
+		{  68, -17 }, \
+		{  92, -12 }, \
+		{ 120,  -6 }, \
+		{ 141,   2 }, \
+		{ 162,  13 }, \
+		{ 182,  25 }, \
+		{ 202,  38 }, \
+		{ 222,  47 }, \
+		{ 241,  57 }, \
+		{ 255,  63 } \
+	} }
+
+  /*
+   *
+   * IC7300 channel caps.
+   */
+  #define IC7300_MEM_CAP {    \
+          .freq = 1,  \
+          .mode = 1,  \
+          .width = 1, \
+          .split = 1, \
+          .tx_freq = 1,   \
+          .tx_mode = 1,   \
+          .tx_width = 1,  \
+          .rptr_offs = 1, \
+          .rptr_shift = 1, \
+          .ctcss_tone = 1, \
+          .ctcss_sql = 1, \
+          .funcs = IC7300_FUNCS, \
+          .levels = RIG_LEVEL_SET(IC7300_LEVELS), \
+  }
+/*
+ * IC-7300 rig capabilities.
+ *
+ * TODO: complete command set (esp. the $1A bunch!) and testing..
+ */
+static const struct icom_priv_caps IC7300_priv_caps = {
+		0x94,	/* default address */
+		0,		/* 731 mode */
+    0,    /* no XCHG */
+		ic7300_ts_sc_list
+};
+
+
+const struct rig_caps ic7300_caps = {
+.rig_model =  RIG_MODEL_IC7300,
+.model_name = "IC-7300",
+.mfg_name =  "Icom",
+.version =  BACKEND_VER,
+.copyright =  "LGPL",
+.status =  RIG_STATUS_BETA,
+.rig_type =  RIG_TYPE_TRANSCEIVER,
+.ptt_type =  RIG_PTT_RIG,
+.dcd_type =  RIG_DCD_RIG,
+.port_type =  RIG_PORT_SERIAL,
+.serial_rate_min =  300,
+.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 =  3,
+.has_get_func =  IC7300_FUNCS,
+.has_set_func =  IC7300_FUNCS,
+.has_get_level =  IC7300_LEVELS,
+.has_set_level =  RIG_LEVEL_SET(IC7300_LEVELS),
+.has_get_parm =  IC7300_PARMS,
+.has_set_parm =  RIG_PARM_SET(IC7300_PARMS),
+.level_gran = {
+	[LVL_RAWSTR] = { .min = { .i = 0 }, .max = { .i = 255 } },
+},
+.parm_gran =  {},
+.ctcss_list =  NULL,
+.dcs_list =  NULL,
+.preamp =   { 10, RIG_DBLST_END, },	/* FIXME: TBC it's a guess*/
+.attenuator =   { 20, RIG_DBLST_END, }, /* value taken from p.45 of manual*/
+.max_rit =  Hz(9999),
+.max_xit =  Hz(9999),
+.max_ifshift =  Hz(0),
+.targetable_vfo =  0,
+.vfo_ops =  IC7300_VFO_OPS,
+.scan_ops =  IC7300_SCAN_OPS,
+.transceive =  RIG_TRN_RIG,
+.bank_qty =   1,
+.chan_desc_sz =  0,
+
+.chan_list =  {
+	   {   1,  199, RIG_MTYPE_MEM  },
+	   { 200, 201, RIG_MTYPE_EDGE },    /* two by two */
+	   RIG_CHAN_END,
+	},
+
+.rx_range_list1 =   { {kHz(30),MHz(60),IC7300_ALL_RX_MODES,-1,-1,IC7300_VFOS}, RIG_FRNG_END, },
+.tx_range_list1 =   {
+	FRQ_RNG_HF(1,IC7300_OTHER_TX_MODES, W(2),W(100),IC7300_VFOS,RIG_ANT_1),
+	FRQ_RNG_6m(1,IC7300_OTHER_TX_MODES, W(2),W(100),IC7300_VFOS,RIG_ANT_1),
+	FRQ_RNG_HF(1,IC7300_AM_TX_MODES, W(1),W(40),IC7300_VFOS,RIG_ANT_1),   /* AM class */
+	FRQ_RNG_6m(1,IC7300_AM_TX_MODES, W(1),W(40),IC7300_VFOS,RIG_ANT_1),   /* AM class */
+   	RIG_FRNG_END, },
+
+.rx_range_list2 =   { {kHz(30),MHz(60),IC7300_ALL_RX_MODES,-1,-1,IC7300_VFOS}, RIG_FRNG_END, },
+.tx_range_list2 =  { /* needs the 5 mhz channels added */
+	FRQ_RNG_HF(2,IC7300_OTHER_TX_MODES, W(2),W(100),IC7300_VFOS,RIG_ANT_1),
+	FRQ_RNG_6m(2,IC7300_OTHER_TX_MODES, W(2),W(100),IC7300_VFOS,RIG_ANT_1),
+	FRQ_RNG_HF(2,IC7300_AM_TX_MODES, W(1),W(40),IC7300_VFOS,RIG_ANT_1),   /* AM class */
+	FRQ_RNG_6m(2,IC7300_AM_TX_MODES, W(1),W(40),IC7300_VFOS,RIG_ANT_1),   /* AM class */
+    	RIG_FRNG_END, },
+
+.tuning_steps = {
+	 {IC7300_1HZ_TS_MODES,1},
+	 {IC7300_NOT_TS_MODES,10},
+	 {IC7300_ALL_RX_MODES,Hz(100)},
+	 {IC7300_ALL_RX_MODES,kHz(1)},
+	 {IC7300_ALL_RX_MODES,kHz(5)},
+	 {IC7300_ALL_RX_MODES,kHz(9)},
+	 {IC7300_ALL_RX_MODES,kHz(10)},
+	 RIG_TS_END,
+	},
+
+	/* 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 */
+.filters = 	{
+		{RIG_MODE_SSB, kHz(2.4)},
+		{RIG_MODE_SSB, kHz(1.8)},
+		{RIG_MODE_SSB, kHz(3)},
+		{RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_RTTY|RIG_MODE_RTTYR, Hz(500)},
+		{RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_RTTY|RIG_MODE_RTTYR, Hz(250)},
+		{RIG_MODE_CW|RIG_MODE_CWR, kHz(1.2)},
+		{RIG_MODE_RTTY|RIG_MODE_RTTYR, kHz(2.4)},
+		{RIG_MODE_AM, kHz(6)},
+		{RIG_MODE_AM, kHz(3)},
+		{RIG_MODE_AM, kHz(9)},
+		RIG_FLT_END,
+	},
+
+.str_cal = IC7300_STR_CAL,
+
+.cfgparams =  icom_cfg_params,
+.set_conf =  icom_set_conf,
+.get_conf =  icom_get_conf,
+
+.priv =  (void*)&IC7300_priv_caps,
+.rig_init =   icom_init,
+.rig_cleanup =   icom_cleanup,
+.rig_open =  NULL,
+.rig_close =  NULL,
+
+.set_freq =  icom_set_freq,
+.get_freq =  icom_get_freq,
+.set_mode =  icom_set_mode_with_data,
+.get_mode =  icom_get_mode_with_data,
+.set_vfo =  icom_set_vfo,
+.set_ant =  NULL,  /*automatically set by rig depending band */
+.get_ant =  NULL,
+
+.set_rit =  icom_set_rit,
+
+.decode_event =  icom_decode_event,
+.set_level =  icom_set_level,
+.get_level =  icom_get_level,
+.set_func =  icom_set_func,
+.get_func =  icom_get_func,
+.set_parm =  NULL,
+.get_parm =  NULL,
+.set_mem =  icom_set_mem,
+.vfo_op =  icom_vfo_op,
+.scan =  icom_scan,
+.set_ptt =  icom_set_ptt,
+.get_ptt =  icom_get_ptt,
+.get_dcd =  icom_get_dcd,
+.set_ts =  icom_set_ts,
+.get_ts =  NULL,
+.set_rptr_shift =  icom_set_rptr_shift,
+.get_rptr_shift =  NULL,
+.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_ctcss_sql =  icom_set_ctcss_sql,
+.get_ctcss_sql =  icom_get_ctcss_sql,
+.set_split_freq =  icom_set_split_freq,
+.get_split_freq =  icom_get_split_freq,
+.set_split_mode =  icom_set_split_mode,
+.get_split_mode =  icom_get_split_mode,
+.set_split_vfo =  icom_set_split_vfo,
+.get_split_vfo =  NULL,
+
+};
diff --git a/icom/icom.c b/icom/icom.c
index a47f539..947bd92 100644
--- a/icom/icom.c
+++ b/icom/icom.c
@@ -220,6 +220,16 @@ const struct ts_sc_list ic7200_ts_sc_list[] = {
 	{ 0, 0 },
 };
 
+const struct ts_sc_list ic7300_ts_sc_list[] = {
+	{ 10, 0x00 },
+	{ 100, 0x01 },
+	{ kHz(1), 0x02 },
+	{ kHz(5), 0x03 },
+	{ kHz(9), 0x04 },
+	{ kHz(10), 0x05 },
+	{ 0, 0 },
+};
+
 const struct ts_sc_list ic910_ts_sc_list[] = {
         { Hz(1), 0x00 },
         { Hz(10), 0x01 },
@@ -3713,7 +3723,8 @@ DECLARE_INITRIG_BACKEND(icom)
 	rig_register(&ic7800_caps);
 	rig_register(&ic7000_caps);
 	rig_register(&ic7100_caps);
-	rig_register(&ic7200_caps);
+  rig_register(&ic7200_caps);
+  rig_register(&ic7300_caps);
 	rig_register(&ic781_caps);
 	rig_register(&ic707_caps);
 	rig_register(&ic728_caps);
diff --git a/icom/icom.h b/icom/icom.h
index 1802a59..6897cde 100644
--- a/icom/icom.h
+++ b/icom/icom.h
@@ -135,6 +135,7 @@ extern const struct ts_sc_list ic706_ts_sc_list[];
 extern const struct ts_sc_list ic7000_ts_sc_list[];
 extern const struct ts_sc_list ic7100_ts_sc_list[];
 extern const struct ts_sc_list ic7200_ts_sc_list[];
+extern const struct ts_sc_list ic7300_ts_sc_list[];
 extern const struct ts_sc_list ic910_ts_sc_list[];
 extern const struct ts_sc_list ic718_ts_sc_list[];
 
@@ -227,6 +228,7 @@ extern const struct rig_caps ic7800_caps;
 extern const struct rig_caps ic7000_caps;
 extern const struct rig_caps ic7100_caps;
 extern const struct rig_caps ic7200_caps;
+extern const struct rig_caps ic7300_caps;
 extern const struct rig_caps ic781_caps;
 extern const struct rig_caps ic820h_caps;
 extern const struct rig_caps ic821h_caps;
diff --git a/include/hamlib/riglist.h b/include/hamlib/riglist.h
index b34915f..803bf9b 100644
--- a/include/hamlib/riglist.h
+++ b/include/hamlib/riglist.h
@@ -212,7 +212,9 @@
 #define RIG_MODEL_IC7100 RIG_MAKE_MODEL(RIG_ICOM, 70)
 #define RIG_MODEL_ID5100 RIG_MAKE_MODEL(RIG_ICOM, 71)
 #define RIG_MODEL_IC2730 RIG_MAKE_MODEL(RIG_ICOM, 72)
-/* next one is 73 */
+#define RIG_MODEL_IC7300 RIG_MAKE_MODEL(RIG_ICOM, 73)
+
+/* next one is 74 */
 
 	/*
 	 * Optoelectronics (CI-V)
@@ -456,7 +458,7 @@
 
 
 	/*
-	 * VEB Funkwerk K�penick RFT
+	 * VEB Funkwerk Köpenick RFT
 	 */
 #define RIG_RFT 24
 #define RIG_BACKEND_RFT "rft"
-- 
2.6.3