Support for Angelbird Wings PCIe SSD (solid-state drive)

It uses a Marvell 88SX7042 SATA controller internally which has access
to a separate flash chip hosting the option ROM.

Thanks to Angelbird Ltd for sponsoring development of this driver!

I expect the code to work for that SATA controller even if it is not
part of the Angelbird SSD.

Corresponding to flashrom svn r1258.

Signed-off-by: Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net>
Acked-by: Stefan Reinauer <stefan.reinauer@coreboot.org>

6 files changed, 235 insertions, 1 deletions

diff --git a/Makefile b/Makefile
index 370318c..9225204 100644
--- a/Makefile
+++ b/Makefile
@@ -155,6 +155,9 @@ CONFIG_BUSPIRATE_SPI ?= yes
 # Disable Dediprog SF100 until support is complete and tested.
 CONFIG_DEDIPROG ?= no
 
+# Always enable Marvell SATA controllers for now.
+CONFIG_SATAMV ?= yes
+
 # Disable wiki printing by default. It is only useful if you have wiki access.
 CONFIG_PRINT_WIKI ?= no
 
@@ -283,6 +286,12 @@ FEATURE_LIBS += -lusb
 PROGRAMMER_OBJS += dediprog.o
 endif
 
+ifeq ($(CONFIG_SATAMV), yes)
+FEATURE_CFLAGS += -D'CONFIG_SATAMV=1'
+PROGRAMMER_OBJS += satamv.o
+NEED_PCI := yes
+endif
+
 ifeq ($(NEED_SERIAL), yes)
 LIB_OBJS += serial.o
 endif
diff --git a/flashrom.c b/flashrom.c
index bf1e3e0..4c6c1fa 100644
--- a/flashrom.c
+++ b/flashrom.c
@@ -52,7 +52,7 @@ enum programmer programmer = PROGRAMMER_DUMMY;
  * if more than one of them is selected. If only one is selected, it is clear
  * that the user wants that one to become the default.
  */
-#if CONFIG_NIC3COM+CONFIG_NICREALTEK+CONFIG_NICNATSEMI+CONFIG_GFXNVIDIA+CONFIG_DRKAISER+CONFIG_SATASII+CONFIG_ATAHPT+CONFIG_FT2232_SPI+CONFIG_SERPROG+CONFIG_BUSPIRATE_SPI+CONFIG_DEDIPROG+CONFIG_RAYER_SPI+CONFIG_NICINTEL_SPI+CONFIG_OGP_SPI > 1
+#if CONFIG_NIC3COM+CONFIG_NICREALTEK+CONFIG_NICNATSEMI+CONFIG_GFXNVIDIA+CONFIG_DRKAISER+CONFIG_SATASII+CONFIG_ATAHPT+CONFIG_FT2232_SPI+CONFIG_SERPROG+CONFIG_BUSPIRATE_SPI+CONFIG_DEDIPROG+CONFIG_RAYER_SPI+CONFIG_NICINTEL_SPI+CONFIG_OGP_SPI+CONFIG_SATAMV > 1
 #error Please enable either CONFIG_DUMMY or CONFIG_INTERNAL or disable support for all programmers except one.
 #endif
 enum programmer programmer =
@@ -99,6 +99,9 @@ enum programmer programmer =
 #if CONFIG_OGP_SPI == 1
 	PROGRAMMER_OGP_SPI
 #endif
+#if CONFIG_SATAMV == 1
+	PROGRAMMER_SATAMV
+#endif
 ;
 #endif
 
@@ -461,6 +464,25 @@ const struct programmer_entry programmer_table[] = {
 	},
 #endif
 
+#if CONFIG_SATAMV == 1
+	{
+		.name			= "satamv",
+		.init			= satamv_init,
+		.shutdown		= satamv_shutdown,
+		.map_flash_region	= fallback_map,
+		.unmap_flash_region	= fallback_unmap,
+		.chip_readb		= satamv_chip_readb,
+		.chip_readw		= fallback_chip_readw,
+		.chip_readl		= fallback_chip_readl,
+		.chip_readn		= fallback_chip_readn,
+		.chip_writeb		= satamv_chip_writeb,
+		.chip_writew		= fallback_chip_writew,
+		.chip_writel		= fallback_chip_writel,
+		.chip_writen		= fallback_chip_writen,
+		.delay			= internal_delay,
+	},
+#endif
+
 	{}, /* This entry corresponds to PROGRAMMER_INVALID. */
 };
 
diff --git a/print.c b/print.c
index 7ba2801..2ed22a7 100644
--- a/print.c
+++ b/print.c
@@ -317,6 +317,11 @@ void print_supported(void)
 	       programmer_table[PROGRAMMER_OGP_SPI].name);
 	print_supported_pcidevs(ogp_spi);
 #endif
+#if CONFIG_SATAMV == 1
+	printf("\nSupported devices for the %s programmer:\n",
+	       programmer_table[PROGRAMMER_SATAMV].name);
+	print_supported_pcidevs(satas_mv);
+#endif
 }
 
 #if CONFIG_INTERNAL == 1
diff --git a/print_wiki.c b/print_wiki.c
index db5743e..d71c571 100644
--- a/print_wiki.c
+++ b/print_wiki.c
@@ -302,6 +302,9 @@ void print_supported_wiki(void)
 #if CONFIG_OGP_SPI == 1
 	print_supported_pcidevs_wiki(ogp_spi);
 #endif
+#if CONFIG_SATAMV == 1
+	print_supported_pcidevs_wiki(satas_mv);
+#endif
 	printf("\n|}\n");
 }
 
diff --git a/programmer.h b/programmer.h
index 7bd1405..1f5fa25 100644
--- a/programmer.h
+++ b/programmer.h
@@ -79,6 +79,9 @@ enum programmer {
 #if CONFIG_OGP_SPI == 1
 	PROGRAMMER_OGP_SPI,
 #endif
+#if CONFIG_SATAMV == 1
+	PROGRAMMER_SATAMV,
+#endif
 	PROGRAMMER_INVALID /* This must always be the last entry. */
 };
 
@@ -415,6 +418,15 @@ int ogp_spi_shutdown(void);
 extern const struct pcidev_status ogp_spi[];
 #endif
 
+/* satamv.c */
+#if CONFIG_SATAMV == 1
+int satamv_init(void);
+int satamv_shutdown(void);
+void satamv_chip_writeb(uint8_t val, chipaddr addr);
+uint8_t satamv_chip_readb(const chipaddr addr);
+extern const struct pcidev_status satas_mv[];
+#endif
+
 /* satasii.c */
 #if CONFIG_SATASII == 1
 int satasii_init(void);
diff --git a/satamv.c b/satamv.c
new file mode 100644
index 0000000..d7db7e9
--- /dev/null
+++ b/satamv.c
@@ -0,0 +1,183 @@
+/*
+ * This file is part of the flashrom project.
+ *
+ * Copyright (C) 2010,2011 Carl-Daniel Hailfinger
+ * Written by Carl-Daniel Hailfinger for Angelbird Ltd.
+ *
+ * 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; version 2 of the License.
+ *
+ * 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; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+/* Datasheets are not public (yet?) */
+
+#include <stdlib.h>
+#include "flash.h"
+#include "programmer.h"
+
+uint8_t *mv_bar;
+uint16_t mv_iobar;
+
+const struct pcidev_status satas_mv[] = {
+	/* 88SX6041 and 88SX6042 are the same according to the datasheet. */
+	{0x11ab, 0x7042, OK, "Marvell", "88SX7042 PCI-e 4-port SATA-II"},
+
+	{},
+};
+
+#define NVRAM_PARAM			0x1045c
+#define FLASH_PARAM			0x1046c
+#define EXPANSION_ROM_BAR_CONTROL	0x00d2c
+#define PCI_BAR2_CONTROL		0x00c08
+#define GPIO_PORT_CONTROL		0x104f0
+
+/*
+ * Random notes:
+ * FCE#		Flash Chip Enable
+ * FWE#		Flash Write Enable
+ * FOE#		Flash Output Enable
+ * FALE[1:0]	Flash Address Latch Enable
+ * FAD[7:0]	Flash Multiplexed Address/Data Bus
+ * FA[2:0]	Flash Address Low
+ *
+ * GPIO[15,2]	GPIO Port Mode
+ * GPIO[4:3]	Flash Size
+ *
+ * 0xd2c	Expansion ROM BAR Control
+ * 0xc08	PCI BAR2 (Flash/NVRAM) Control
+ * 0x1046c	Flash Parameters
+ */
+int satamv_init(void)
+{
+	uintptr_t addr;
+	uint32_t tmp;
+
+	get_io_perms();
+
+	/* BAR0 has all internal registers memory mapped. */
+	/* No need to check for errors, pcidev_init() will not return in case
+	 * of errors.
+	 */
+	addr = pcidev_init(0x11ab, PCI_BASE_ADDRESS_0, satas_mv);
+
+	mv_bar = physmap("Marvell 88SX7042 registers", addr, 0x20000);
+	if (mv_bar == ERROR_PTR)
+		goto error_out;
+
+	tmp = pci_mmio_readl(mv_bar + FLASH_PARAM);
+	msg_pspew("Flash Parameters:\n");
+	msg_pspew("TurnOff=0x%01x\n", (tmp >> 0) & 0x7);
+	msg_pspew("Acc2First=0x%01x\n", (tmp >> 3) & 0xf);
+	msg_pspew("Acc2Next=0x%01x\n", (tmp >> 7) & 0xf);
+	msg_pspew("ALE2Wr=0x%01x\n", (tmp >> 11) & 0x7);
+	msg_pspew("WrLow=0x%01x\n", (tmp >> 14) & 0x7);
+	msg_pspew("WrHigh=0x%01x\n", (tmp >> 17) & 0x7);
+	msg_pspew("Reserved[21:20]=0x%01x\n", (tmp >> 20) & 0x3);
+	msg_pspew("TurnOffExt=0x%01x\n", (tmp >> 22) & 0x1);
+	msg_pspew("Acc2FirstExt=0x%01x\n", (tmp >> 23) & 0x1);
+	msg_pspew("Acc2NextExt=0x%01x\n", (tmp >> 24) & 0x1);
+	msg_pspew("ALE2WrExt=0x%01x\n", (tmp >> 25) & 0x1);
+	msg_pspew("WrLowExt=0x%01x\n", (tmp >> 26) & 0x1);
+	msg_pspew("WrHighExt=0x%01x\n", (tmp >> 27) & 0x1);
+	msg_pspew("Reserved[31:28]=0x%01x\n", (tmp >> 28) & 0xf);
+
+	tmp = pci_mmio_readl(mv_bar + EXPANSION_ROM_BAR_CONTROL);
+	msg_pspew("Expansion ROM BAR Control:\n");
+	msg_pspew("ExpROMSz=0x%01x\n", (tmp >> 19) & 0x7);
+
+	/* Enable BAR2 mapping to flash */
+	tmp = pci_mmio_readl(mv_bar + PCI_BAR2_CONTROL);
+	msg_pspew("PCI BAR2 (Flash/NVRAM) Control:\n");
+	msg_pspew("Bar2En=0x%01x\n", (tmp >> 0) & 0x1);
+	msg_pspew("BAR2TransAttr=0x%01x\n", (tmp >> 1) & 0x1f);
+	msg_pspew("BAR2Sz=0x%01x\n", (tmp >> 19) & 0x7);
+	tmp &= 0xffffffc0;
+	tmp |= 0x0000001f;
+	/* FIXME: This needs to be an auto-reversible write. */
+	pci_mmio_writel(tmp, mv_bar + PCI_BAR2_CONTROL);
+
+	/* Enable flash: GPIO Port Control Register 0x104f0 */
+	tmp = pci_mmio_readl(mv_bar + GPIO_PORT_CONTROL);
+	msg_pspew("GPIOPortMode=0x%01x\n", (tmp >> 0) & 0x3);
+	if (((tmp >> 0) & 0x3) != 0x2)
+		msg_pinfo("Warning! Either the straps are incorrect or you "
+			  "have no flash or someone overwrote the strap "
+			  "values!\n");
+	tmp &= 0xfffffffc;
+	tmp |= 0x2;
+	/* FIXME: This needs to be an auto-reversible write. */
+	pci_mmio_writel(tmp, mv_bar + GPIO_PORT_CONTROL);
+
+	/* Get I/O BAR location. */
+	tmp = pci_read_long(pcidev_dev, PCI_BASE_ADDRESS_2) &
+	      PCI_BASE_ADDRESS_IO_MASK;
+	/* Truncate to reachable range.
+	 * FIXME: Check if the I/O BAR is actually reachable.
+	 * This is an arch specific check.
+	 */
+	mv_iobar = tmp & 0xffff;
+	msg_pspew("Activating I/O BAR at 0x%04x\n", mv_iobar);
+
+	buses_supported = CHIP_BUSTYPE_PARALLEL;
+
+	/* 512 kByte with two 8-bit latches, and
+	 * 4 MByte with additional 3-bit latch. */
+	max_rom_decode.parallel = 4 * 1024 * 1024;
+
+	return 0;
+
+error_out:
+	pci_cleanup(pacc);
+	release_io_perms();
+	return 1;
+}
+
+int satamv_shutdown(void)
+{
+	physunmap(mv_bar, 0x20000);
+	pci_cleanup(pacc);
+	release_io_perms();
+	return 0;
+}
+
+/* BAR2 (MEM) can map NVRAM and flash. We set it to flash in the init function.
+ * If BAR2 is disabled, it still can be accessed indirectly via BAR1 (I/O).
+ * This code only supports indirect accesses for now.
+ */
+
+/* Indirect access to via the I/O BAR1. */
+static void satamv_indirect_chip_writeb(uint8_t val, chipaddr addr)
+{
+	/* 0x80000000 selects BAR2 for remapping. */
+	OUTL(((uint32_t)addr | 0x80000000) & 0xfffffffc, mv_iobar);
+	OUTB(val, mv_iobar + 0x80 + (addr & 0x3));
+}
+
+/* Indirect access to via the I/O BAR1. */
+static uint8_t satamv_indirect_chip_readb(const chipaddr addr)
+{
+	/* 0x80000000 selects BAR2 for remapping. */
+	OUTL(((uint32_t)addr | 0x80000000) & 0xfffffffc, mv_iobar);
+	return INB(mv_iobar + 0x80 + (addr & 0x3));
+}
+
+/* FIXME: Prefer direct access to BAR2 if BAR2 is active. */
+void satamv_chip_writeb(uint8_t val, chipaddr addr)
+{
+	satamv_indirect_chip_writeb(val, addr);
+}
+
+/* FIXME: Prefer direct access to BAR2 if BAR2 is active. */
+uint8_t satamv_chip_readb(const chipaddr addr)
+{
+	return satamv_indirect_chip_readb(addr);
+}