From 21eb27c3f33787faea51dae0bf03f7771ca79887 Mon Sep 17 00:00:00 2001 From: Jared Boone Date: Mon, 10 Nov 2014 09:58:49 -0800 Subject: [PATCH] SSP0: Extract SPI interface from W25Q80BV code. --- firmware/common/hackrf_core.c | 22 ++++++ firmware/common/hackrf_core.h | 5 ++ .../common/{w25q80bv_spi.c => spi_ssp0.c} | 69 ++++++++++--------- firmware/common/spi_ssp0.h | 44 ++++++++++++ firmware/common/w25q80bv.c | 19 ++--- firmware/common/w25q80bv.h | 2 - firmware/common/w25q80bv_target.c | 48 +++++++++++++ .../{w25q80bv_spi.h => w25q80bv_target.h} | 19 +++-- firmware/hackrf-common.cmake | 3 + firmware/hackrf_usb/CMakeLists.txt | 2 - 10 files changed, 170 insertions(+), 63 deletions(-) rename firmware/common/{w25q80bv_spi.c => spi_ssp0.c} (68%) create mode 100644 firmware/common/spi_ssp0.h create mode 100644 firmware/common/w25q80bv_target.c rename firmware/common/{w25q80bv_spi.h => w25q80bv_target.h} (61%) diff --git a/firmware/common/hackrf_core.c b/firmware/common/hackrf_core.c index 9f2bb9bd..b5edabd9 100644 --- a/firmware/common/hackrf_core.c +++ b/firmware/common/hackrf_core.c @@ -23,6 +23,7 @@ #include "hackrf_core.h" #include "si5351c.h" +#include "spi_ssp0.h" #include "spi_ssp1.h" #include "max2837.h" #include "max2837_target.h" @@ -30,6 +31,8 @@ #include "max5864_target.h" #include "rffc5071.h" #include "rffc5071_spi.h" +#include "w25q80bv.h" +#include "w25q80bv_target.h" #include "sgpio.h" #include "rf_path.h" #include @@ -96,6 +99,25 @@ rffc5071_driver_t rffc5072 = { .spi = &rffc5071_spi, }; +const ssp0_config_t ssp0_config_w25q80bv = { + .data_bits = SSP_DATA_8BITS, + .serial_clock_rate = 2, + .clock_prescale_rate = 2, + .select = w25q80bv_target_spi_select, + .unselect = w25q80bv_target_spi_unselect, +}; + +spi_t spi_ssp0 = { + .config = &ssp0_config_w25q80bv, + .init = spi_ssp0_init, + .transfer = spi_ssp0_transfer, + .transfer_gather = spi_ssp0_transfer_gather, +}; + +w25q80bv_driver_t spi_flash = { + .spi = &spi_ssp0, +}; + void delay(uint32_t duration) { uint32_t i; diff --git a/firmware/common/hackrf_core.h b/firmware/common/hackrf_core.h index daebe1b5..53270f2f 100644 --- a/firmware/common/hackrf_core.h +++ b/firmware/common/hackrf_core.h @@ -32,11 +32,13 @@ extern "C" #include #include +#include "spi_ssp0.h" #include "spi_ssp1.h" #include "max2837.h" #include "max5864.h" #include "rffc5071.h" +#include "w25q80bv.h" /* hardware identification number */ #define BOARD_ID_JELLYBEAN 0 @@ -356,12 +358,15 @@ typedef enum { void delay(uint32_t duration); +/* TODO: Hide these configurations */ +extern const ssp0_config_t ssp0_config_w25q80bv; extern const ssp1_config_t ssp1_config_max2837; extern const ssp1_config_t ssp1_config_max5864; extern max2837_driver_t max2837; extern max5864_driver_t max5864; extern rffc5071_driver_t rffc5072; +extern w25q80bv_driver_t spi_flash; void cpu_clock_init(void); void cpu_clock_pll1_low_speed(void); diff --git a/firmware/common/w25q80bv_spi.c b/firmware/common/spi_ssp0.c similarity index 68% rename from firmware/common/w25q80bv_spi.c rename to firmware/common/spi_ssp0.c index f51b7b13..a875aa98 100644 --- a/firmware/common/w25q80bv_spi.c +++ b/firmware/common/spi_ssp0.c @@ -21,7 +21,7 @@ * Boston, MA 02110-1301, USA. */ -#include "w25q80bv_spi.h" +#include "spi_ssp0.h" #include #include @@ -30,26 +30,23 @@ #include "hackrf_core.h" -void w25q80bv_spi_init(spi_t* const spi, const void* const config) { - (void)spi; - (void)config; - - const uint8_t serial_clock_rate = 2; - const uint8_t clock_prescale_rate = 2; - +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; - /* initialize SSP0 */ + const ssp0_config_t* const config = _config; + ssp_init(SSP0_NUM, - SSP_DATA_8BITS, - SSP_FRAME_SPI, - SSP_CPOL_0_CPHA_0, - serial_clock_rate, - clock_prescale_rate, - SSP_MODE_NORMAL, - SSP_MASTER, - SSP_SLAVE_OUT_ENABLE); + 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; /* Init SPIFI GPIO to Normal GPIO */ scu_pinmux(P3_3, (SCU_SSP_IO | SCU_CONF_FUNCTION2)); // P3_3 SPIFI_SCK => SSP0_SCK @@ -67,37 +64,41 @@ void w25q80bv_spi_init(spi_t* const spi, const void* const config) { /* configure GPIO pins */ scu_pinmux(SCU_FLASH_HOLD, SCU_GPIO_FAST); scu_pinmux(SCU_FLASH_WP, SCU_GPIO_FAST); - scu_pinmux(SCU_SSP0_SSEL, (SCU_GPIO_FAST | SCU_CONF_FUNCTION4)); /* drive SSEL, HOLD, and WP pins high */ gpio_set(PORT_FLASH, (PIN_FLASH_HOLD | PIN_FLASH_WP)); - gpio_set(PORT_SSP0_SSEL, PIN_SSP0_SSEL); /* Set GPIO pins as outputs. */ GPIO1_DIR |= (PIN_FLASH_HOLD | PIN_FLASH_WP); - GPIO5_DIR |= PIN_SSP0_SSEL; } -void w25q80bv_spi_transfer_gather( - spi_t* const spi, - const spi_transfer_t* const transfers, - const size_t transfer_count -) { - (void)spi; +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; - gpio_clear(PORT_SSP0_SSEL, PIN_SSP0_SSEL); - for(size_t i=0; iselect(spi); + for(size_t i=0; i 8 ) { + uint16_t* const data = transfers[i].data; + for(size_t j=0; junselect(spi); } -void w25q80bv_spi_transfer(spi_t* const spi, void* const data, const size_t count) { +void spi_ssp0_transfer(spi_t* const spi, void* const data, const size_t count) { const spi_transfer_t transfers[] = { { data, count }, }; - w25q80bv_spi_transfer_gather(spi, transfers, 1); + spi_ssp0_transfer_gather(spi, transfers, 1); } diff --git a/firmware/common/spi_ssp0.h b/firmware/common/spi_ssp0.h new file mode 100644 index 00000000..adf420b2 --- /dev/null +++ b/firmware/common/spi_ssp0.h @@ -0,0 +1,44 @@ +/* + * 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 +#include + +#include "spi.h" + +#include + +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__*/ diff --git a/firmware/common/w25q80bv.c b/firmware/common/w25q80bv.c index 6f33edae..a03e30be 100644 --- a/firmware/common/w25q80bv.c +++ b/firmware/common/w25q80bv.c @@ -30,7 +30,9 @@ #include #include "w25q80bv.h" -#include "w25q80bv_spi.h" +#include "w25q80bv_target.h" + +#include "hackrf_core.h" #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0])) @@ -49,7 +51,6 @@ * Set up pins for GPIO and SPI control, configure SSP0 peripheral for SPI. * SSP0_SSEL is controlled by GPIO in order to handle various transfer lengths. */ - void w25q80bv_setup(w25q80bv_driver_t* const drv) { uint8_t device_id; @@ -58,7 +59,8 @@ void w25q80bv_setup(w25q80bv_driver_t* const drv) drv->num_pages = 4096U; drv->num_bytes = 1048576U; - spi_init(drv->spi, NULL); + spi_init(drv->spi, &ssp0_config_w25q80bv); + w25q80bv_target_init(drv); device_id = 0; while(device_id != W25Q80BV_DEVICE_ID_RES) @@ -199,14 +201,3 @@ void w25q80bv_program(w25q80bv_driver_t* const drv, uint32_t addr, uint32_t len, w25q80bv_page_program(drv, addr, len, data); } } - -spi_t w25q80bv_spi = { - .config = NULL, - .init = w25q80bv_spi_init, - .transfer = w25q80bv_spi_transfer, - .transfer_gather = w25q80bv_spi_transfer_gather, -}; - -w25q80bv_driver_t spi_flash = { - .spi = &w25q80bv_spi, -}; diff --git a/firmware/common/w25q80bv.h b/firmware/common/w25q80bv.h index 9d31a286..89c82653 100644 --- a/firmware/common/w25q80bv.h +++ b/firmware/common/w25q80bv.h @@ -49,6 +49,4 @@ void w25q80bv_program(w25q80bv_driver_t* const drv, uint32_t addr, uint32_t len, uint8_t w25q80bv_get_device_id(w25q80bv_driver_t* const drv); void w25q80bv_get_unique_id(w25q80bv_driver_t* const drv, w25q80bv_unique_id_t* unique_id); -extern w25q80bv_driver_t spi_flash; - #endif//__W25Q80BV_H__ diff --git a/firmware/common/w25q80bv_target.c b/firmware/common/w25q80bv_target.c new file mode 100644 index 00000000..e406bbe5 --- /dev/null +++ b/firmware/common/w25q80bv_target.c @@ -0,0 +1,48 @@ +/* + * 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 "w25q80bv_target.h" + +#include +#include +#include "hackrf_core.h" + +/* TODO: Why is SSEL being controlled manually when SSP0 could do it + * automatically? + */ + +void w25q80bv_target_init(w25q80bv_driver_t* const drv) { + (void)drv; + + scu_pinmux(SCU_SSP0_SSEL, (SCU_GPIO_FAST | SCU_CONF_FUNCTION4)); + gpio_set(PORT_SSP0_SSEL, PIN_SSP0_SSEL); + GPIO5_DIR |= PIN_SSP0_SSEL; +} + +void w25q80bv_target_spi_select(spi_t* const spi) { + (void)spi; + gpio_clear(PORT_SSP0_SSEL, PIN_SSP0_SSEL); +} + +void w25q80bv_target_spi_unselect(spi_t* const spi) { + (void)spi; + gpio_set(PORT_SSP0_SSEL, PIN_SSP0_SSEL); +} diff --git a/firmware/common/w25q80bv_spi.h b/firmware/common/w25q80bv_target.h similarity index 61% rename from firmware/common/w25q80bv_spi.h rename to firmware/common/w25q80bv_target.h index dce1a029..f8e7f05e 100644 --- a/firmware/common/w25q80bv_spi.h +++ b/firmware/common/w25q80bv_target.h @@ -1,7 +1,5 @@ /* - * Copyright 2013 Michael Ossmann - * Copyright 2013 Benjamin Vernoux - * Copyright 2014 Jared Boone, ShareBrained Technology + * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc. * * This file is part of HackRF. * @@ -21,15 +19,14 @@ * Boston, MA 02110-1301, USA. */ -#ifndef __W25Q80BV_SPI_H__ -#define __W25Q80BV_SPI_H__ - -#include +#ifndef __W25Q80BV_TARGET_H__ +#define __W25Q80BV_TARGET_H__ +#include "w25q80bv.h" #include "spi.h" -void w25q80bv_spi_init(spi_t* const spi, const void* const config); -void w25q80bv_spi_transfer_gather(spi_t* const spi, const spi_transfer_t* const transfers, const size_t transfer_count); -void w25q80bv_spi_transfer(spi_t* const spi, void* const data, const size_t count); +void w25q80bv_target_init(w25q80bv_driver_t* const drv); +void w25q80bv_target_spi_select(spi_t* const spi); +void w25q80bv_target_spi_unselect(spi_t* const spi); -#endif/*__W25Q80BV_SPI_H__*/ +#endif/*__W25Q80BV_TARGET_H__*/ diff --git a/firmware/hackrf-common.cmake b/firmware/hackrf-common.cmake index 9d4d01ea..c412e121 100644 --- a/firmware/hackrf-common.cmake +++ b/firmware/hackrf-common.cmake @@ -140,7 +140,10 @@ macro(DeclareTargets) ${PATH_HACKRF_FIRMWARE_COMMON}/max5864_target.c ${PATH_HACKRF_FIRMWARE_COMMON}/rffc5071.c ${PATH_HACKRF_FIRMWARE_COMMON}/rffc5071_spi.c + ${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 m0_bin.s ) diff --git a/firmware/hackrf_usb/CMakeLists.txt b/firmware/hackrf_usb/CMakeLists.txt index bf211f9c..10ee4ffb 100644 --- a/firmware/hackrf_usb/CMakeLists.txt +++ b/firmware/hackrf_usb/CMakeLists.txt @@ -44,8 +44,6 @@ set(SRC_M4 usb_api_transceiver.c "${PATH_HACKRF_FIRMWARE_COMMON}/usb_queue.c" "${PATH_HACKRF_FIRMWARE_COMMON}/fault_handler.c" - "${PATH_HACKRF_FIRMWARE_COMMON}/w25q80bv.c" - "${PATH_HACKRF_FIRMWARE_COMMON}/w25q80bv_spi.c" "${PATH_HACKRF_FIRMWARE_COMMON}/cpld_jtag.c" "${PATH_HACKRF_FIRMWARE_COMMON}/xapp058/lenval.c" "${PATH_HACKRF_FIRMWARE_COMMON}/xapp058/micro.c"