octphy: add support for 16x oversampling mode

The latest octphy firmware release (octsdr-2g-02.11.00-B1927-alpha),
introduces a 16X oversampling option which is not yet supported in
osmo-bts.

- Add oversampling flag in phy_link.h
- Add VTY commands to enable/disable oversampling
- Add phy messages to enable/disable oversampling
- Add conditional compilation to preserve support for legacy
  header files and firmware

Change-Id: Ib78f92bfe03ff20aa0a257763c90844fb7b87cf0
Related: SYS#4257
Patch-by: Octasic inc.

configure.ac

@@ -250,6 +250,13 @@ if test "$enable_octphy" = "yes" ; then
 			[],
 			[#include <octphy/octvc1/hw/octvc1_hw_api.h>])
 
+	AC_CHECK_MEMBER([tOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_CMD.ulOversample16xEnableFlag],
+			AC_DEFINE([OCTPHY_USE_16X_OVERSAMPLING],
+			[1],
+			[Define to 1 if your octphy header files support 16x oversampling]),
+			[],
+			[#include <octphy/octvc1/gsm/octvc1_gsm_api.h>])
+
 	CPPFLAGS=$oldCPPFLAGS
 fi
 

include/osmo-bts/phy_link.h

@@ -74,6 +74,7 @@ struct phy_link {
 			uint32_t rx_gain_db;
 			bool tx_atten_flag;
 			uint32_t tx_atten_db;
+			bool over_sample_16x;
 #if OCTPHY_MULTI_TRX == 1
 			/* arfcn used by TRX with id 0 */
 			uint16_t center_arfcn;

src/osmo-bts-octphy/l1_if.c

@@ -1659,6 +1659,7 @@ void bts_model_phy_link_set_defaults(struct phy_link *plink)
 	plink->u.octphy.rf_port_index = 0;
 	plink->u.octphy.rx_gain_db = 70;
 	plink->u.octphy.tx_atten_db = 0;
+	plink->u.octphy.over_sample_16x = true;
 }
 
 void bts_model_phy_instance_set_defaults(struct phy_instance *pinst)

src/osmo-bts-octphy/l1_oml.c

@@ -1375,6 +1375,57 @@ int l1if_trx_open(struct gsm_bts_trx *trx)
 	return l1if_req_compl(fl1h, msg, trx_open_compl_cb, NULL);
 }
 
+#if OCTPHY_USE_16X_OVERSAMPLING == 1
+static int over_sample_16x_modif_compl_cb(struct octphy_hdl *fl1,
+					  struct msgb *resp, void *data)
+{
+	tOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_RSP *mcr =
+	    (tOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_RSP*) resp->l2h;
+
+	/* in a completion call-back, we take msgb ownership and must
+	 * release it before returning */
+
+	mOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_RSP_SWAP(mcr);
+
+	LOGP(DL1C, LOGL_INFO, "Rx OVER-SAMPLE-16x-MODIFY.conf\n");
+
+	msgb_free(resp);
+
+	return 0;
+}
+
+static int l1if_over_sample_16x_modif(struct gsm_bts_trx *trx)
+{
+	/* NOTE: The 16x oversampling mode should always be enabled. Single-
+	 * TRX operation will work with standard 4x oversampling, but multi-
+	 * TRX requires 16x oversampling */
+
+	struct phy_instance *pinst = trx_phy_instance(trx);
+	struct phy_link *plink = pinst->phy_link;
+	struct octphy_hdl *fl1h = pinst->phy_link->u.octphy.hdl;
+	struct msgb *msg = l1p_msgb_alloc();
+	tOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_CMD *mc;
+
+	mc = (tOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_CMD*) msgb_put(msg,
+									  sizeof
+									  (*mc));
+	mOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_CMD_DEF(mc);
+	l1if_fill_msg_hdr(&mc->Header, msg, fl1h, cOCTVC1_MSG_TYPE_COMMAND,
+			  cOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_CID);
+
+	if (plink->u.octphy.over_sample_16x == true)
+		mc->ulOversample16xEnableFlag = 1;
+	else
+		mc->ulOversample16xEnableFlag = 0;
+
+	mOCTVC1_GSM_MSG_OVERSAMPLE_SELECT_16X_MODIFY_CMD_SWAP(mc);
+
+	LOGP(DL1C, LOGL_INFO, "Tx OVER-SAMPLE-16x-MODIF.req\n");
+
+	return l1if_req_compl(fl1h, msg, over_sample_16x_modif_compl_cb, 0);
+}
+#endif
+
 uint32_t trx_get_hlayer1(struct gsm_bts_trx * trx)
 {
 	return 0;
@@ -1393,6 +1444,10 @@ static int trx_init(struct gsm_bts_trx *trx)
 	l1if_check_app_version(trx);
 	l1if_check_app_sys_version(trx);
 
+#if OCTPHY_USE_16X_OVERSAMPLING == 1
+	l1if_over_sample_16x_modif(trx);
+#endif
+
 	return l1if_trx_open(trx);
 }
 

src/osmo-bts-octphy/octphy_vty.c

@@ -195,6 +195,29 @@ DEFUN(cfg_phy_tx_atten_db, cfg_phy_tx_atten_db_cmd,
 	return CMD_SUCCESS;
 }
 
+#if OCTPHY_USE_16X_OVERSAMPLING == 1
+DEFUN(cfg_phy_over_sample_16x, cfg_phy_over_sample_16x_cmd,
+      "octphy over-sample-16x <0-1>",
+      OCT_STR "Configure 16x over sampling rate for this TRX (restart required)\n"
+      "Over Sampling Rate\n")
+{
+	struct phy_link *plink = vty->index;
+
+	if (plink->state != PHY_LINK_SHUTDOWN) {
+		vty_out(vty, "Can only reconfigure a PHY link that is down%s",
+			VTY_NEWLINE);
+		return CMD_WARNING;
+	}
+
+	if(atoi(argv[0]))
+		plink->u.octphy.over_sample_16x = true;
+	else
+		plink->u.octphy.over_sample_16x = false;
+
+	return CMD_SUCCESS;
+}
+#endif
+
 void show_rf_port_stats_cb(struct msgb *resp, void *data)
 {
 	struct vty *vty = (struct vty*) data;
@@ -370,6 +393,10 @@ void bts_model_config_write_phy(struct vty *vty, struct phy_link *plink)
 	vty_out(vty, " octphy rx-ant-id %u%s", plink->u.octphy.rx_ant_id,
 		VTY_NEWLINE);
 #endif
+#if OCTPHY_USE_16X_OVERSAMPLING == 1
+	vty_out(vty, " octphy over-sample-16x %u%s", plink->u.octphy.over_sample_16x,
+		VTY_NEWLINE);
+#endif
 }
 
 void bts_model_config_write_phy_inst(struct vty *vty, struct phy_instance *pinst)
@@ -423,7 +450,9 @@ int bts_model_vty_init(struct gsm_bts *bts)
 #endif
 	install_element(PHY_NODE, &cfg_phy_rx_gain_db_cmd);
 	install_element(PHY_NODE, &cfg_phy_tx_atten_db_cmd);
-
+#if OCTPHY_USE_16X_OVERSAMPLING == 1
+	install_element(PHY_NODE, &cfg_phy_over_sample_16x_cmd);
+#endif
 	install_element_ve(&show_rf_port_stats_cmd);
 	install_element_ve(&show_clk_sync_stats_cmd);
 	install_element_ve(&show_sys_info_cmd);