mirror of
				https://review.coreboot.org/flashrom.git
				synced 2025-11-04 07:00:39 +01:00 
			
		
		
		
	nicintel_spi.c: Refactor singleton states into reentrant pattern
Move global singleton states into a struct and store within the bitbang_spi_master data field for the life-time of the driver. This patch also drops `nicintel` prefix from spi master struct member. This is one of the steps on the way to move spi_master data memory management behind the initialisation API, for more context see other patches under the same topic "register_master_api". BUG=b:185191942 TEST=builds Change-Id: I385d3ced19dfe6453ccc4128a7b792c2dce3a449 Signed-off-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/54995 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
This commit is contained in:
		
				
					committed by
					
						
						Edward O'Callaghan
					
				
			
			
				
	
			
			
			
						parent
						
							4a7d259037
						
					
				
				
					commit
					0d149d9d5b
				
			
							
								
								
									
										128
									
								
								nicintel_spi.c
									
									
									
									
									
								
							
							
						
						
									
										128
									
								
								nicintel_spi.c
									
									
									
									
									
								
							@@ -75,7 +75,9 @@
 | 
			
		||||
 | 
			
		||||
#define BIT(x) (1<<(x))
 | 
			
		||||
 | 
			
		||||
static uint8_t *nicintel_spibar;
 | 
			
		||||
struct nicintel_spi_data {
 | 
			
		||||
	uint8_t *spibar;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const struct dev_entry nics_intel_spi[] = {
 | 
			
		||||
	{PCI_VENDOR_ID_INTEL, 0x105e, OK, "Intel", "82571EB Gigabit Ethernet Controller"},
 | 
			
		||||
@@ -109,60 +111,66 @@ const struct dev_entry nics_intel_spi[] = {
 | 
			
		||||
 | 
			
		||||
static void nicintel_request_spibus(void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	tmp |= BIT(FL_REQ);
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + FLA);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + FLA);
 | 
			
		||||
 | 
			
		||||
	/* Wait until we are allowed to use the SPI bus. */
 | 
			
		||||
	while (!(pci_mmio_readl(nicintel_spibar + FLA) & BIT(FL_GNT))) ;
 | 
			
		||||
	while (!(pci_mmio_readl(data->spibar + FLA) & BIT(FL_GNT))) ;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static void nicintel_release_spibus(void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	tmp &= ~BIT(FL_REQ);
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + FLA);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + FLA);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static void nicintel_bitbang_set_cs(int val, void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	tmp &= ~BIT(FL_CS);
 | 
			
		||||
	tmp |= (val << FL_CS);
 | 
			
		||||
	pci_mmio_writel(tmp,  nicintel_spibar + FLA);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + FLA);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static void nicintel_bitbang_set_sck(int val, void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	tmp &= ~BIT(FL_SCK);
 | 
			
		||||
	tmp |= (val << FL_SCK);
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + FLA);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + FLA);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static void nicintel_bitbang_set_mosi(int val, void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	tmp &= ~BIT(FL_SI);
 | 
			
		||||
	tmp |= (val << FL_SI);
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + FLA);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + FLA);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static int nicintel_bitbang_get_miso(void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	tmp = (tmp >> FL_SO) & 0x1;
 | 
			
		||||
	return tmp;
 | 
			
		||||
}
 | 
			
		||||
@@ -177,20 +185,22 @@ static const struct bitbang_spi_master bitbang_spi_master_nicintel = {
 | 
			
		||||
	.half_period = 1,
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
static int nicintel_spi_shutdown(void *data)
 | 
			
		||||
static int nicintel_spi_shutdown(void *spi_data)
 | 
			
		||||
{
 | 
			
		||||
	struct nicintel_spi_data *data = spi_data;
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	/* Disable writes manually. See the comment about EECD in nicintel_spi_init() for details. */
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + EECD);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + EECD);
 | 
			
		||||
	tmp &= ~FLASH_WRITES_ENABLED;
 | 
			
		||||
	tmp |= FLASH_WRITES_DISABLED;
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + EECD);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + EECD);
 | 
			
		||||
 | 
			
		||||
	free(data);
 | 
			
		||||
	return 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static int nicintel_spi_82599_enable_flash(void)
 | 
			
		||||
static int nicintel_spi_82599_enable_flash(struct nicintel_spi_data *data)
 | 
			
		||||
{
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
@@ -199,45 +209,53 @@ static int nicintel_spi_82599_enable_flash(void)
 | 
			
		||||
	 * but other bits with side effects as well. Those other bits must be
 | 
			
		||||
	 * left untouched.
 | 
			
		||||
	 */
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + EECD);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + EECD);
 | 
			
		||||
	tmp &= ~FLASH_WRITES_DISABLED;
 | 
			
		||||
	tmp |= FLASH_WRITES_ENABLED;
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + EECD);
 | 
			
		||||
	pci_mmio_writel(tmp, data->spibar + EECD);
 | 
			
		||||
 | 
			
		||||
	/* test if FWE is really set to allow writes */
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + EECD);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + EECD);
 | 
			
		||||
	if ( (tmp & FLASH_WRITES_DISABLED) || !(tmp & FLASH_WRITES_ENABLED) ) {
 | 
			
		||||
		msg_perr("Enabling flash write access failed.\n");
 | 
			
		||||
		return 1;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if (register_shutdown(nicintel_spi_shutdown, NULL))
 | 
			
		||||
	if (register_shutdown(nicintel_spi_shutdown, data))
 | 
			
		||||
		return 1;
 | 
			
		||||
 | 
			
		||||
	return 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static int nicintel_spi_i210_enable_flash(void)
 | 
			
		||||
static int nicintel_spi_i210_shutdown(void *data)
 | 
			
		||||
{
 | 
			
		||||
	free(data);
 | 
			
		||||
	return 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
static int nicintel_spi_i210_enable_flash(struct nicintel_spi_data *data)
 | 
			
		||||
{
 | 
			
		||||
	uint32_t tmp;
 | 
			
		||||
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
	if (tmp & BIT(FL_LOCKED)) {
 | 
			
		||||
		msg_perr("Flash is in Secure Mode. Abort.\n");
 | 
			
		||||
		return 1;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if (!(tmp & BIT(FL_ABORT)))
 | 
			
		||||
		return 0;
 | 
			
		||||
 | 
			
		||||
	tmp |= BIT(FL_CLR_ERR);
 | 
			
		||||
	pci_mmio_writel(tmp, nicintel_spibar + FLA);
 | 
			
		||||
	tmp = pci_mmio_readl(nicintel_spibar + FLA);
 | 
			
		||||
	if (!(tmp & BIT(FL_ABORT))) {
 | 
			
		||||
		msg_perr("Unable to clear Flash Access Error. Abort\n");
 | 
			
		||||
		return 1;
 | 
			
		||||
	if (tmp & BIT(FL_ABORT)) {
 | 
			
		||||
		tmp |= BIT(FL_CLR_ERR);
 | 
			
		||||
		pci_mmio_writel(tmp, data->spibar + FLA);
 | 
			
		||||
		tmp = pci_mmio_readl(data->spibar + FLA);
 | 
			
		||||
		if (!(tmp & BIT(FL_ABORT))) {
 | 
			
		||||
			msg_perr("Unable to clear Flash Access Error. Abort\n");
 | 
			
		||||
			return 1;
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if (register_shutdown(nicintel_spi_i210_shutdown, data))
 | 
			
		||||
		return 1;
 | 
			
		||||
 | 
			
		||||
	return 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -256,25 +274,37 @@ int nicintel_spi_init(void)
 | 
			
		||||
	if (!io_base_addr)
 | 
			
		||||
		return 1;
 | 
			
		||||
 | 
			
		||||
	if ((dev->device_id & 0xfff0) == 0x1530) {
 | 
			
		||||
		nicintel_spibar = rphysmap("Intel I210 Gigabit w/ SPI flash", io_base_addr + 0x12000,
 | 
			
		||||
					   MEMMAP_SIZE);
 | 
			
		||||
		if (!nicintel_spibar || nicintel_spi_i210_enable_flash())
 | 
			
		||||
				return 1;
 | 
			
		||||
	} else if (dev->device_id < 0x10d8) {
 | 
			
		||||
		nicintel_spibar = rphysmap("Intel Gigabit NIC w/ SPI flash", io_base_addr,
 | 
			
		||||
					   MEMMAP_SIZE);
 | 
			
		||||
		if (!nicintel_spibar || nicintel_spi_82599_enable_flash())
 | 
			
		||||
				return 1;
 | 
			
		||||
	} else {
 | 
			
		||||
		nicintel_spibar = rphysmap("Intel 10 Gigabit NIC w/ SPI flash", io_base_addr + 0x10000,
 | 
			
		||||
					   MEMMAP_SIZE);
 | 
			
		||||
		if (!nicintel_spibar || nicintel_spi_82599_enable_flash())
 | 
			
		||||
				return 1;
 | 
			
		||||
	struct nicintel_spi_data *data = calloc(1, sizeof(*data));
 | 
			
		||||
	if (!data) {
 | 
			
		||||
		msg_perr("Unable to allocate space for SPI master data\n");
 | 
			
		||||
		return 1;
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if (register_spi_bitbang_master(&bitbang_spi_master_nicintel, NULL))
 | 
			
		||||
		return 1;
 | 
			
		||||
	if ((dev->device_id & 0xfff0) == 0x1530) {
 | 
			
		||||
		data->spibar = rphysmap("Intel I210 Gigabit w/ SPI flash", io_base_addr + 0x12000,
 | 
			
		||||
					   MEMMAP_SIZE);
 | 
			
		||||
		if (!data->spibar || nicintel_spi_i210_enable_flash(data)) {
 | 
			
		||||
				free(data);
 | 
			
		||||
				return 1;
 | 
			
		||||
		}
 | 
			
		||||
	} else if (dev->device_id < 0x10d8) {
 | 
			
		||||
		data->spibar = rphysmap("Intel Gigabit NIC w/ SPI flash", io_base_addr,
 | 
			
		||||
					   MEMMAP_SIZE);
 | 
			
		||||
		if (!data->spibar || nicintel_spi_82599_enable_flash(data)) {
 | 
			
		||||
				free(data);
 | 
			
		||||
				return 1;
 | 
			
		||||
		}
 | 
			
		||||
	} else {
 | 
			
		||||
		data->spibar = rphysmap("Intel 10 Gigabit NIC w/ SPI flash", io_base_addr + 0x10000,
 | 
			
		||||
					   MEMMAP_SIZE);
 | 
			
		||||
		if (!data->spibar || nicintel_spi_82599_enable_flash(data)) {
 | 
			
		||||
				free(data);
 | 
			
		||||
				return 1;
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	if (register_spi_bitbang_master(&bitbang_spi_master_nicintel, data))
 | 
			
		||||
		return 1; /* shutdown function does cleanup */
 | 
			
		||||
 | 
			
		||||
	return 0;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user