From 905cd2b9191193c65db03f8555cdf8f624522ba2 Mon Sep 17 00:00:00 2001
From: Jared Boone <jboone@earfeast.com>
Date: Mon, 10 Nov 2014 10:57:36 -0800
Subject: [PATCH 30/68] SSP: Merge SSP0 and SSP1 code into single unit.

Conflicts:
	firmware/common/hackrf_core.c
---
 firmware/common/hackrf_core.c |  37 ++++++++-------
 firmware/common/hackrf_core.h |   9 ++--
 firmware/common/max2837.c     |   2 +-
 firmware/common/max5864.c     |   2 +-
 firmware/common/spi.h         |   1 +
 firmware/common/spi_ssp.c     | 102 ++++++++++++++++++++++++++++++++++++++++++
 firmware/common/spi_ssp.h     |  44 ++++++++++++++++++
 firmware/common/spi_ssp0.c    |  79 --------------------------------
 firmware/common/spi_ssp0.h    |  44 ------------------
 firmware/common/spi_ssp1.c    |  73 ------------------------------
 firmware/common/spi_ssp1.h    |  44 ------------------
 firmware/common/w25q80bv.c    |   2 +-
 firmware/hackrf-common.cmake  |   3 +-
 13 files changed, 177 insertions(+), 265 deletions(-)
 create mode 100644 firmware/common/spi_ssp.c
 create mode 100644 firmware/common/spi_ssp.h
 delete mode 100644 firmware/common/spi_ssp0.c
 delete mode 100644 firmware/common/spi_ssp0.h
 delete mode 100644 firmware/common/spi_ssp1.c
 delete mode 100644 firmware/common/spi_ssp1.h

--- a/firmware/common/hackrf_core.c
+++ b/firmware/common/hackrf_core.c
@@ -23,8 +23,7 @@
 
 #include "hackrf_core.h"
 #include "si5351c.h"
-#include "spi_ssp0.h"
-#include "spi_ssp1.h"
+#include "spi_ssp.h"
 #include "max2837.h"
 #include "max2837_target.h"
 #include "max5864.h"
@@ -47,7 +46,7 @@
 	.i2c_address = 0x60,
 };
 
-const ssp1_config_t ssp1_config_max2837 = {
+const ssp_config_t ssp_config_max2837 = {
 	/* FIXME speed up once everything is working reliably */
 	/*
 	// Freq About 0.0498MHz / 49.8KHz => Freq = PCLK / (CPSDVSR * [SCR+1]) with PCLK=PLL1=204MHz
@@ -62,7 +61,7 @@
 	.unselect = max2837_target_spi_unselect,
 };
 
-const ssp1_config_t ssp1_config_max5864 = {
+const ssp_config_t ssp_config_max5864 = {
 	/* FIXME speed up once everything is working reliably */
 	/*
 	// Freq About 0.0498MHz / 49.8KHz => Freq = PCLK / (CPSDVSR * [SCR+1]) with PCLK=PLL1=204MHz
@@ -78,10 +77,11 @@
 };
 
 spi_t spi_ssp1 = {
-	.config = &ssp1_config_max2837,
-	.init = spi_ssp1_init,
-	.transfer = spi_ssp1_transfer,
-	.transfer_gather = spi_ssp1_transfer_gather,
+	.obj = (void*)SSP1_BASE,
+	.config = &ssp_config_max2837,
+	.init = spi_ssp_init,
+	.transfer = spi_ssp_transfer,
+	.transfer_gather = spi_ssp_transfer_gather,
 };
 
 max2837_driver_t max2837 = {
@@ -103,7 +103,7 @@
 	.spi = &rffc5071_spi,
 };
 
-const ssp0_config_t ssp0_config_w25q80bv = {
+const ssp_config_t ssp_config_w25q80bv = {
 	.data_bits = SSP_DATA_8BITS,
 	.serial_clock_rate = 2,
 	.clock_prescale_rate = 2,
@@ -112,10 +112,11 @@
 };
 
 spi_t spi_ssp0 = {
-	.config = &ssp0_config_w25q80bv,
-	.init = spi_ssp0_init,
-	.transfer = spi_ssp0_transfer,
-	.transfer_gather = spi_ssp0_transfer_gather,
+	.obj = (void*)SSP0_BASE,
+	.config = &ssp_config_w25q80bv,
+	.init = spi_ssp_init,
+	.transfer = spi_ssp_transfer,
+	.transfer_gather = spi_ssp_transfer_gather,
 };
 
 w25q80bv_driver_t spi_flash = {
@@ -498,6 +499,12 @@
 	/* Switch APB3 clock over to use PLL1 (204MHz) */
 	CGU_BASE_APB3_CLK = CGU_BASE_APB3_CLK_AUTOBLOCK(1)
 			| CGU_BASE_APB3_CLK_CLK_SEL(CGU_SRC_PLL1);
+
+	CGU_BASE_SSP0_CLK = CGU_BASE_SSP0_CLK_AUTOBLOCK(1)
+			| CGU_BASE_SSP0_CLK_CLK_SEL(CGU_SRC_PLL1);
+
+	CGU_BASE_SSP1_CLK = CGU_BASE_SSP1_CLK_AUTOBLOCK(1)
+			| CGU_BASE_SSP1_CLK_CLK_SEL(CGU_SRC_PLL1);
 }
 
 
@@ -593,12 +600,12 @@
 
 void ssp1_set_mode_max2837(void)
 {
-	spi_init(max2837.spi, &ssp1_config_max2837);
+	spi_init(max2837.spi, &ssp_config_max2837);
 }
 
 void ssp1_set_mode_max5864(void)
 {
-	spi_init(max5864.spi, &ssp1_config_max5864);
+	spi_init(max5864.spi, &ssp_config_max5864);
 }
 
 void pin_setup(void) {
--- a/firmware/common/hackrf_core.h
+++ b/firmware/common/hackrf_core.h
@@ -34,8 +34,7 @@
 
 #include "si5351c_drv.h"
 
-#include "spi_ssp0.h"
-#include "spi_ssp1.h"
+#include "spi_ssp.h"
 
 #include "max2837.h"
 #include "max5864.h"
--- a/firmware/common/max2837.c
+++ b/firmware/common/max2837.c
@@ -79,7 +79,7 @@
 /* Set up all registers according to defaults specified in docs. */
 static void max2837_init(max2837_driver_t* const drv)
 {
-	spi_init(drv->spi, &ssp1_config_max2837);
+	spi_init(drv->spi, &ssp_config_max2837);
 	max2837_mode_shutdown(drv);
 	max2837_target_init(drv);
 
--- a/firmware/common/max5864.c
+++ b/firmware/common/max5864.c
@@ -31,7 +31,7 @@
 }
 
 static void max5864_init(max5864_driver_t* const drv) {
-	spi_init(drv->spi, &ssp1_config_max5864);
+	spi_init(drv->spi, &ssp_config_max5864);
 	max5864_target_init(drv);
 }
 
--- a/firmware/common/spi.h
+++ b/firmware/common/spi.h
@@ -33,6 +33,7 @@
 typedef struct spi_t spi_t;
 
 struct spi_t {
+	void* const obj;
 	const void* config;
 	void (*init)(spi_t* const spi, const void* const config);
 	void (*transfer)(spi_t* const spi, void* const data, const size_t count);
--- /dev/null
+++ b/firmware/common/spi_ssp.c
@@ -0,0 +1,102 @@
+/*
+ * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
+ *
+ * This file is part of HackRF.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include "spi_ssp.h"
+
+#include <libopencm3/lpc43xx/rgu.h>
+#include <libopencm3/lpc43xx/ssp.h>
+
+void spi_ssp_init(spi_t* const spi, const void* const _config) {
+	const ssp_config_t* const config = _config;
+
+	if( spi->obj == (void*)SSP0_BASE ) {
+		/* Reset SPIFI peripheral before to Erase/Write SPIFI memory through SPI */
+		RESET_CTRL1 = RESET_CTRL1_SPIFI_RST;
+	}
+
+	SSP_CR1(spi->obj) = 0;
+	SSP_CPSR(spi->obj) = config->clock_prescale_rate;
+	SSP_CR0(spi->obj) =
+		  (config->serial_clock_rate << 8)
+		| SSP_CPOL_0_CPHA_0
+		| SSP_FRAME_SPI
+		| config->data_bits
+		;
+	SSP_CR1(spi->obj) =
+		  SSP_SLAVE_OUT_ENABLE
+		| SSP_MASTER
+		| SSP_ENABLE
+		| SSP_MODE_NORMAL
+		;
+
+	spi->config = config;
+}
+
+static void spi_ssp_wait_for_tx_fifo_not_full(spi_t* const spi) {
+	while( (SSP_SR(spi->obj) & SSP_SR_TNF) == 0 );
+}
+
+static void spi_ssp_wait_for_rx_fifo_not_empty(spi_t* const spi) {
+	while( (SSP_SR(spi->obj) & SSP_SR_RNE) == 0 );
+}
+
+static void spi_ssp_wait_for_not_busy(spi_t* const spi) {
+	while( SSP_SR(spi->obj) & SSP_SR_BSY );
+}
+
+static uint32_t spi_ssp_transfer_word(spi_t* const spi, const uint32_t data) {
+	spi_ssp_wait_for_tx_fifo_not_full(spi);
+	SSP_DR(spi->obj) = data;
+	spi_ssp_wait_for_not_busy(spi);
+	spi_ssp_wait_for_rx_fifo_not_empty(spi);
+	return SSP_DR(spi->obj);
+}
+
+void spi_ssp_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t count) {
+	const ssp_config_t* const config = spi->config;
+
+	const bool word_size_u16 = (SSP_CR0(spi->obj) & 0xf) > SSP_DATA_8BITS;
+
+	config->select(spi);
+	for(size_t i=0; i<count; i++) {
+		const size_t data_count = transfers[i].count;
+
+		if( word_size_u16 ) {
+			uint16_t* const data = transfers[i].data;
+			for(size_t j=0; j<data_count; j++) {
+				data[j] = spi_ssp_transfer_word(spi, data[j]);
+			}
+		} else {
+			uint8_t* const data = transfers[i].data;
+			for(size_t j=0; j<data_count; j++) {
+				data[j] = spi_ssp_transfer_word(spi, data[j]);
+			}
+		}
+	}
+	config->unselect(spi);
+}
+
+void spi_ssp_transfer(spi_t* const spi, void* const data, const size_t count) {
+	const spi_transfer_t transfers[] = {
+		{ data, count },
+	};
+	spi_ssp_transfer_gather(spi, transfers, 1);
+}
--- /dev/null
+++ b/firmware/common/spi_ssp.h
@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
+ *
+ * This file is part of HackRF.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef __SPI_SSP_H__
+#define __SPI_SSP_H__
+
+#include <stdint.h>
+#include <stddef.h>
+
+#include "spi.h"
+
+#include <libopencm3/lpc43xx/ssp.h>
+
+typedef struct ssp_config_t {
+	ssp_datasize_t data_bits;
+	uint8_t serial_clock_rate;
+	uint8_t clock_prescale_rate;
+	void (*select)(spi_t* const spi);
+	void (*unselect)(spi_t* const spi);
+} ssp_config_t;
+
+void spi_ssp_init(spi_t* const spi, const void* const config);
+void spi_ssp_transfer(spi_t* const spi, void* const data, const size_t count);
+void spi_ssp_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t count);
+
+#endif/*__SPI_SSP_H__*/
--- a/firmware/common/spi_ssp0.c
+++ /dev/null
@@ -1,79 +0,0 @@
-/*
- * Copyright 2013 Michael Ossmann
- * Copyright 2013 Benjamin Vernoux
- * Copyright 2014 Jared Boone, ShareBrained Technology
- *
- * This file is part of HackRF.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- *
- * This program 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 51 Franklin Street,
- * Boston, MA 02110-1301, USA.
- */
-
-#include "spi_ssp0.h"
-
-#include <libopencm3/lpc43xx/rgu.h>
-#include <libopencm3/lpc43xx/ssp.h>
-
-#include "hackrf_core.h"
-
-void spi_ssp0_init(spi_t* const spi, const void* const _config) {
-	/* Reset SPIFI peripheral before to Erase/Write SPIFI memory through SPI */
-	RESET_CTRL1 = RESET_CTRL1_SPIFI_RST;
-	
-	const ssp0_config_t* const config = _config;
-
-	ssp_init(SSP0_NUM,
-		config->data_bits,
-		SSP_FRAME_SPI,
-		SSP_CPOL_0_CPHA_0,
-		config->serial_clock_rate,
-		config->clock_prescale_rate,
-		SSP_MODE_NORMAL,
-		SSP_MASTER,
-		SSP_SLAVE_OUT_ENABLE);
-
-	spi->config = config;
-}
-
-void spi_ssp0_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t count) {
-	const ssp0_config_t* const config = spi->config;
-
-	const size_t word_size = (SSP0_CR0 & 0xf) + 1;
-
-	config->select(spi);
-	for(size_t i=0; i<count; i++) {
-		const size_t data_count = transfers[i].count;
-
-		if( word_size > 8 ) {
-			uint16_t* const data = transfers[i].data;
-			for(size_t j=0; j<data_count; j++) {
-				data[j] = ssp_transfer(SSP0_NUM, data[j]);
-			}
-		} else {
-			uint8_t* const data = transfers[i].data;
-			for(size_t j=0; j<data_count; j++) {
-				data[j] = ssp_transfer(SSP0_NUM, data[j]);
-			}
-		}
-	}
-	config->unselect(spi);
-}
-
-void spi_ssp0_transfer(spi_t* const spi, void* const data, const size_t count) {
-	const spi_transfer_t transfers[] = {
-		{ data, count },
-	};
-	spi_ssp0_transfer_gather(spi, transfers, 1);
-}
--- a/firmware/common/spi_ssp0.h
+++ /dev/null
@@ -1,44 +0,0 @@
-/*
- * Copyright (C) 2014 Jared Boone, ShareBrained Technology
- *
- * This file is part of HackRF.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- *
- * This program 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 51 Franklin Street,
- * Boston, MA 02110-1301, USA.
- */
-
-#ifndef __SPI_SSP0_H__
-#define __SPI_SSP0_H__
-
-#include <stdint.h>
-#include <stddef.h>
-
-#include "spi.h"
-
-#include <libopencm3/lpc43xx/ssp.h>
-
-typedef struct ssp0_config_t {
-	ssp_datasize_t data_bits;
-	uint8_t serial_clock_rate;
-	uint8_t clock_prescale_rate;
-	void (*select)(spi_t* const spi);
-	void (*unselect)(spi_t* const spi);
-} ssp0_config_t;
-
-void spi_ssp0_init(spi_t* const spi, const void* const config);
-void spi_ssp0_transfer(spi_t* const spi, void* const data, const size_t count);
-void spi_ssp0_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t count);
-
-#endif/*__SPI_SSP0_H__*/
--- a/firmware/common/spi_ssp1.c
+++ /dev/null
@@ -1,73 +0,0 @@
-/*
- * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
- *
- * This file is part of HackRF.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- *
- * This program 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 51 Franklin Street,
- * Boston, MA 02110-1301, USA.
- */
-
-#include "spi_ssp1.h"
-
-#include <libopencm3/lpc43xx/ssp.h>
-
-#include "hackrf_core.h"
-
-void spi_ssp1_init(spi_t* const spi, const void* const _config) {
-	const ssp1_config_t* const config = _config;
-
-	ssp_init(SSP1_NUM,
-		config->data_bits,
-		SSP_FRAME_SPI,
-		SSP_CPOL_0_CPHA_0,
-		config->serial_clock_rate,
-		config->clock_prescale_rate,
-		SSP_MODE_NORMAL,
-		SSP_MASTER,
-		SSP_SLAVE_OUT_ENABLE);
-
-	spi->config = config;
-}
-
-void spi_ssp1_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t count) {
-	const ssp1_config_t* const config = spi->config;
-
-	const size_t word_size = (SSP1_CR0 & 0xf) + 1;
-
-	config->select(spi);
-	for(size_t i=0; i<count; i++) {
-		const size_t data_count = transfers[i].count;
-
-		if( word_size > 8 ) {
-			uint16_t* const data = transfers[i].data;
-			for(size_t j=0; j<data_count; j++) {
-				data[j] = ssp_transfer(SSP1_NUM, data[j]);
-			}
-		} else {
-			uint8_t* const data = transfers[i].data;
-			for(size_t j=0; j<data_count; j++) {
-				data[j] = ssp_transfer(SSP1_NUM, data[j]);
-			}
-		}
-	}
-	config->unselect(spi);
-}
-
-void spi_ssp1_transfer(spi_t* const spi, void* const data, const size_t count) {
-	const spi_transfer_t transfers[] = {
-		{ data, count },
-	};
-	spi_ssp1_transfer_gather(spi, transfers, 1);
-}
--- a/firmware/common/spi_ssp1.h
+++ /dev/null
@@ -1,44 +0,0 @@
-/*
- * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
- *
- * This file is part of HackRF.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- *
- * This program 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 51 Franklin Street,
- * Boston, MA 02110-1301, USA.
- */
-
-#ifndef __SPI_SSP1_H__
-#define __SPI_SSP1_H__
-
-#include <stdint.h>
-#include <stddef.h>
-
-#include "spi.h"
-
-#include <libopencm3/lpc43xx/ssp.h>
-
-typedef struct ssp1_config_t {
-	ssp_datasize_t data_bits;
-	uint8_t serial_clock_rate;
-	uint8_t clock_prescale_rate;
-	void (*select)(spi_t* const spi);
-	void (*unselect)(spi_t* const spi);
-} ssp1_config_t;
-
-void spi_ssp1_init(spi_t* const spi, const void* const config);
-void spi_ssp1_transfer(spi_t* const spi, void* const data, const size_t count);
-void spi_ssp1_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t count);
-
-#endif/*__SPI_SSP1_H__*/
--- a/firmware/common/w25q80bv.c
+++ b/firmware/common/w25q80bv.c
@@ -59,7 +59,7 @@
 	drv->num_pages = 4096U;
 	drv->num_bytes = 1048576U;
 
-	spi_init(drv->spi, &ssp0_config_w25q80bv);
+	spi_init(drv->spi, &ssp_config_w25q80bv);
 	w25q80bv_target_init(drv);
 
 	device_id = 0;
--- a/firmware/hackrf-common.cmake
+++ b/firmware/hackrf-common.cmake
@@ -144,8 +144,7 @@
 		${PATH_HACKRF_FIRMWARE_COMMON}/w25q80bv.c
 		${PATH_HACKRF_FIRMWARE_COMMON}/w25q80bv_target.c
 		${PATH_HACKRF_FIRMWARE_COMMON}/spi.c
-		${PATH_HACKRF_FIRMWARE_COMMON}/spi_ssp0.c
-		${PATH_HACKRF_FIRMWARE_COMMON}/spi_ssp1.c
+		${PATH_HACKRF_FIRMWARE_COMMON}/spi_ssp.c
 		m0_bin.s
 	)