summaryrefslogtreecommitdiff
path: root/controller/fw/src/spi_flash.c
diff options
context:
space:
mode:
Diffstat (limited to 'controller/fw/src/spi_flash.c')
-rw-r--r--controller/fw/src/spi_flash.c189
1 files changed, 189 insertions, 0 deletions
diff --git a/controller/fw/src/spi_flash.c b/controller/fw/src/spi_flash.c
new file mode 100644
index 0000000..98c773f
--- /dev/null
+++ b/controller/fw/src/spi_flash.c
@@ -0,0 +1,189 @@
+/* Library for SPI flash 25* devices.
+ * Copyright (c) 2014 Multi-Tech Systems
+ * Copyright (c) 2020 Jan Goette <ma@jaseg.de>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include "spi_flash.h"
+#include <libopencm3/stm32/spi.h>
+
+enum {
+ WRITE_ENABLE = 0x06,
+ WRITE_DISABLE = 0x04,
+ READ_IDENTIFICATION = 0x9F,
+ READ_STATUS = 0x05,
+ WRITE_STATUS = 0x01,
+ READ_DATA = 0x03,
+ READ_DATA_FAST = 0x0B,
+ PAGE_PROGRAM = 0x02,
+ SECTOR_ERASE = 0xD8,
+ BULK_ERASE = 0xC7,
+ DEEP_POWER_DOWN = 0xB9,
+ DEEP_POWER_DOWN_RELEASE = 0xAB,
+};
+
+enum {
+ STATUS_SRWD = 0x80, // 0b 1000 0000
+ STATUS_BP2 = 0x10, // 0b 0001 0000
+ STATUS_BP1 = 0x08, // 0b 0000 1000
+ STATUS_BP0 = 0x04, // 0b 0000 0100
+ STATUS_WEL = 0x02, // 0b 0000 0010
+ STATUS_WIP = 0x01, // 0b 0000 0001
+};
+
+
+static void spif_write_page(struct spi_flash_if *spif, size_t addr, size_t len, const char* data);
+static uint8_t spif_read_status(struct spi_flash_if *spif);
+static void spif_enable_write(struct spi_flash_if *spif);
+static void spif_wait_for_write(struct spi_flash_if *spif);
+
+#define low_byte(x) (x&0xff)
+#define mid_byte(x) ((x>>8)&0xff)
+#define high_byte(x) ((x>>16)&0xff)
+
+
+void spif_init(struct spi_flash_if *spif, size_t page_size, uint32_t spi_base, void (*cs)(bool val)) {
+
+ spif->spi_base = spi_base;
+ spif->page_size = page_size;
+ spif->cs = cs;
+ spif->cs(1);
+
+ spi_reset(spif->spi_base);
+ spi_init_master(spif->spi_base,
+ SPI_CR1_BAUDRATE_FPCLK_DIV_2,
+ SPI_CR1_CPOL_CLK_TO_1_WHEN_IDLE,
+ SPI_CR1_CPHA_CLK_TRANSITION_2,
+ SPI_CR1_DFF_8BIT,
+ SPI_CR1_MSBFIRST);
+
+ spi_enable_software_slave_management(spif->spi_base);
+ spi_set_nss_high(spif->spi_base);
+
+ spi_enable(spif->spi_base);
+
+ spif->cs(0);
+ spi_send(spif->spi_base, READ_IDENTIFICATION);
+ spif->id.mfg_id = spi_xfer(spif->spi_base, 0);
+ spif->id.type = spi_xfer(spif->spi_base, 0);
+ spif->id.size = 1<<spi_xfer(spif->spi_base, 0);
+ spif->cs(1);
+}
+
+void spif_read(struct spi_flash_if *spif, size_t addr, size_t len, char* data) {
+ spif_enable_write(spif);
+
+ spif->cs(0);
+ spi_xfer(spif->spi_base, READ_DATA);
+ spi_xfer(spif->spi_base, high_byte(addr));
+ spi_xfer(spif->spi_base, mid_byte(addr));
+ spi_xfer(spif->spi_base, low_byte(addr));
+
+ for (size_t i = 0; i < len; i++)
+ data[i] = spi_xfer(spif->spi_base, 0);
+
+ spif->cs(1);
+}
+
+void spif_write(struct spi_flash_if *spif, size_t addr, size_t len, const char* data) {
+ size_t written = 0, write_size = 0;
+
+ while (written < len) {
+ write_size = spif->page_size - ((addr + written) % spif->page_size);
+ if (written + write_size > len)
+ write_size = len - written;
+
+ spif_write_page(spif, addr + written, write_size, data + written);
+ written += write_size;
+ }
+}
+
+static uint8_t spif_read_status(struct spi_flash_if *spif) {
+ spif->cs(0);
+ spi_xfer(spif->spi_base, READ_STATUS);
+ uint8_t status = spi_xfer(spif->spi_base, 0);
+ spif->cs(1);
+
+ return status;
+}
+
+void spif_clear_sector(struct spi_flash_if *spif, size_t addr) {
+ spif_enable_write(spif);
+
+ spif->cs(0);
+ spi_xfer(spif->spi_base, SECTOR_ERASE);
+ spi_xfer(spif->spi_base, high_byte(addr));
+ spi_xfer(spif->spi_base, mid_byte(addr));
+ spi_xfer(spif->spi_base, low_byte(addr));
+ spif->cs(1);
+
+ spif_wait_for_write(spif);
+}
+
+void spif_clear_mem(struct spi_flash_if *spif) {
+ spif_enable_write(spif);
+
+ spif->cs(0);
+ spi_xfer(spif->spi_base, BULK_ERASE);
+ spif->cs(1);
+
+ spif_wait_for_write(spif);
+}
+
+static void spif_write_page(struct spi_flash_if *spif, size_t addr, size_t len, const char* data) {
+ spif_enable_write(spif);
+
+ spif->cs(0);
+ spi_xfer(spif->spi_base, PAGE_PROGRAM);
+ spi_xfer(spif->spi_base, high_byte(addr));
+ spi_xfer(spif->spi_base, mid_byte(addr));
+ spi_xfer(spif->spi_base, low_byte(addr));
+
+ for (size_t i = 0; i < len; i++) {
+ spi_xfer(spif->spi_base, data[i]);
+ }
+
+ spif->cs(1);
+ spif_wait_for_write(spif);
+}
+
+static void spif_enable_write(struct spi_flash_if *spif) {
+ spif->cs(0);
+ spi_xfer(spif->spi_base, WRITE_ENABLE);
+ spif->cs(1);
+}
+
+static void spif_wait_for_write(struct spi_flash_if *spif) {
+ while (spif_read_status(spif) & STATUS_WIP)
+ for (int i = 0; i < 800; i++)
+ ;
+}
+
+void spif_deep_power_down(struct spi_flash_if *spif) {
+ spif->cs(0);
+ spi_xfer(spif->spi_base, DEEP_POWER_DOWN);
+ spif->cs(1);
+}
+
+void spif_wakeup(struct spi_flash_if *spif) {
+ spif->cs(0);
+ spi_xfer(spif->spi_base, DEEP_POWER_DOWN_RELEASE);
+ spif->cs(1);
+}