From 42cfdf5184b3e94805958a3368f2e049c09119ac Mon Sep 17 00:00:00 2001 From: Furquan Shaikh Date: Wed, 21 Dec 2016 10:58:26 -0800 Subject: soc/intel/skylake: Use the new SPI driver interface 1. Define controller for fast SPI. 2. Separate out functions that are specific to SPI and flash controller in different files. BUG=chrome-os-partner:59832 BRANCh=None TEST=Compiles successfully for chell and eve. Change-Id: I2fe0ef937297297339d4ea19dc37d3061caaa80c Signed-off-by: Furquan Shaikh Reviewed-on: https://review.coreboot.org/17933 Tested-by: build bot (Jenkins) Reviewed-by: Aaron Durbin --- src/soc/intel/skylake/Makefile.inc | 5 ++ src/soc/intel/skylake/flash_controller.c | 74 +++++++++------------- .../intel/skylake/include/soc/flash_controller.h | 5 +- src/soc/intel/skylake/romstage/spi.c | 2 +- src/soc/intel/skylake/smihandler.c | 3 +- src/soc/intel/skylake/spi.c | 40 ++++++++++++ 6 files changed, 82 insertions(+), 47 deletions(-) create mode 100644 src/soc/intel/skylake/spi.c (limited to 'src/soc/intel') diff --git a/src/soc/intel/skylake/Makefile.inc b/src/soc/intel/skylake/Makefile.inc index 56cfdee099..3a474e725e 100644 --- a/src/soc/intel/skylake/Makefile.inc +++ b/src/soc/intel/skylake/Makefile.inc @@ -25,6 +25,7 @@ bootblock-y += monotonic_timer.c bootblock-y += pch.c bootblock-y += pcr.c bootblock-y += pmutil.c +bootblock-y += spi.c bootblock-y += tsc_freq.c verstage-y += flash_controller.c @@ -33,6 +34,7 @@ verstage-y += pch.c verstage-$(CONFIG_UART_DEBUG) += uart_debug.c verstage-y += pmutil.c verstage-y += bootblock/i2c.c +verstage-y += spi.c romstage-y += flash_controller.c romstage-y += gpio.c @@ -46,6 +48,7 @@ romstage-y += pmutil.c romstage-$(CONFIG_PLATFORM_USES_FSP2_0) += reset.c romstage-y += smbus_common.c romstage-y += early_smbus.c +romstage-y += spi.c romstage-y += tsc_freq.c romstage-$(CONFIG_UART_DEBUG) += uart_debug.c @@ -80,6 +83,7 @@ ramstage-y += smbus.c ramstage-y += smbus_common.c ramstage-y += smi.c ramstage-y += smmrelocate.c +ramstage-y += spi.c ramstage-y += systemagent.c ramstage-y += tsc_freq.c ramstage-y += uart.c @@ -95,6 +99,7 @@ smm-y += pch.c smm-y += pmutil.c smm-y += smihandler.c smm-$(CONFIG_SPI_FLASH_SMM) += flash_controller.c +smm-$(CONFIG_SPI_FLASH_SMM) += spi.c smm-y += tsc_freq.c smm-$(CONFIG_UART_DEBUG) += uart_debug.c diff --git a/src/soc/intel/skylake/flash_controller.c b/src/soc/intel/skylake/flash_controller.c index 501f80f3ce..476a08c6e1 100644 --- a/src/soc/intel/skylake/flash_controller.c +++ b/src/soc/intel/skylake/flash_controller.c @@ -25,23 +25,23 @@ #include #include -static inline uint16_t spi_read_hsfs(pch_spi_regs * const regs) +static inline uint16_t spi_flash_read_hsfs(pch_spi_flash_regs * const regs) { return readw_(®s->hsfs); } -static inline void spi_clear_status(pch_spi_regs * const regs) +static inline void spi_flash_clear_status(pch_spi_flash_regs * const regs) { /* clear FDONE, FCERR, AEL by writing 1 to them (if they are set) */ - writew_(spi_read_hsfs(regs), ®s->hsfs); + writew_(spi_flash_read_hsfs(regs), ®s->hsfs); } -static inline uint16_t spi_read_hsfc(pch_spi_regs * const regs) +static inline uint16_t spi_flash_read_hsfc(pch_spi_flash_regs * const regs) { return readw_(®s->hsfc); } -static inline uint32_t spi_read_faddr(pch_spi_regs * const regs) +static inline uint32_t spi_flash_read_faddr(pch_spi_flash_regs * const regs) { return readl_(®s->faddr) & SPIBAR_FADDR_MASK; } @@ -52,7 +52,7 @@ static inline uint32_t spi_read_faddr(pch_spi_regs * const regs) * Returns 0 if the cycle completes successfully without errors within * timeout, 1 on errors. */ -static int wait_for_completion(pch_spi_regs * const regs, int timeout_ms, +static int wait_for_completion(pch_spi_flash_regs * const regs, int timeout_ms, size_t len) { uint16_t hsfs; @@ -64,15 +64,15 @@ static int wait_for_completion(pch_spi_regs * const regs, int timeout_ms, stopwatch_init_msecs_expire(&sw, timeout_ms); do { - hsfs = spi_read_hsfs(regs); + hsfs = spi_flash_read_hsfs(regs); if ((hsfs & (HSFS_FDONE | HSFS_FCERR))) break; } while (!(timeout = stopwatch_expired(&sw))); if (timeout) { - addr = spi_read_faddr(regs); - hsfc = spi_read_hsfc(regs); + addr = spi_flash_read_faddr(regs); + hsfc = spi_flash_read_hsfc(regs); printk(BIOS_ERR, "%ld ms Transaction timeout between offset " "0x%08x and 0x%08zx (= 0x%08x + %zd) HSFC=%x HSFS=%x!\n", stopwatch_duration_msecs(&sw), addr, addr + len - 1, @@ -81,8 +81,8 @@ static int wait_for_completion(pch_spi_regs * const regs, int timeout_ms, } if (hsfs & HSFS_FCERR) { - addr = spi_read_faddr(regs); - hsfc = spi_read_hsfc(regs); + addr = spi_flash_read_faddr(regs); + hsfc = spi_flash_read_hsfc(regs); printk(BIOS_ERR, "Transaction error between offset 0x%08x and " "0x%08zx (= 0x%08x + %zd) HSFC=%x HSFS=%x!\n", addr, addr + len - 1, addr, len - 1, @@ -94,13 +94,14 @@ static int wait_for_completion(pch_spi_regs * const regs, int timeout_ms, } /* Start operation returning 0 on success, non-zero on error or timeout. */ -static int spi_do_operation(int op, size_t offset, size_t size, int timeout_ms) +static int spi_flash_do_operation(int op, size_t offset, size_t size, + int timeout_ms) { uint16_t hsfc; - pch_spi_regs * const regs = get_spi_bar(); + pch_spi_flash_regs * const regs = get_spi_bar(); /* Clear status prior to operation. */ - spi_clear_status(regs); + spi_flash_clear_status(regs); /* Set the FADDR */ writel_(offset & SPIBAR_FADDR_MASK, ®s->faddr); @@ -126,7 +127,7 @@ unsigned int spi_crop_chunk(unsigned int cmd_len, unsigned int buf_len) return min(SPI_FDATA_BYTES, buf_len); } -static size_t spi_get_flash_size(pch_spi_regs *spi_bar) +static size_t spi_get_flash_size(pch_spi_flash_regs *spi_bar) { uint32_t flcomp; size_t size; @@ -151,7 +152,7 @@ static size_t spi_get_flash_size(pch_spi_regs *spi_bar) return size; } -void spi_init(void) +void spi_flash_init(void) { uint8_t bios_cntl; device_t dev = PCH_DEV_SPI; @@ -178,7 +179,7 @@ int pch_hwseq_erase(const struct spi_flash *flash, u32 offset, size_t len) end = start + len; while (offset < end) { - if (spi_do_operation(HSFC_FCYCLE_4KE, offset, 0, 5000)) { + if (spi_flash_do_operation(HSFC_FCYCLE_4KE, offset, 0, 5000)) { printk(BIOS_ERR, "SF: Erase failed at %x\n", offset); ret = -1; goto out; @@ -197,7 +198,7 @@ out: static void pch_read_data(uint8_t *data, int len) { int i; - pch_spi_regs *spi_bar; + pch_spi_flash_regs *spi_bar; uint32_t temp32 = 0; spi_bar = get_spi_bar(); @@ -230,7 +231,7 @@ int pch_hwseq_read(const struct spi_flash *flash, u32 addr, size_t len, if (block_len > (~addr & 0xff)) block_len = (~addr & 0xff) + 1; - if (spi_do_operation(HSFC_FCYCLE_RD, addr, block_len, + if (spi_flash_do_operation(HSFC_FCYCLE_RD, addr, block_len, timeout_ms)) return -1; @@ -251,7 +252,7 @@ static void pch_fill_data(const uint8_t *data, int len) { uint32_t temp32 = 0; int i; - pch_spi_regs *spi_bar; + pch_spi_flash_regs *spi_bar; spi_bar = get_spi_bar(); if (len <= 0) @@ -277,7 +278,7 @@ int pch_hwseq_write(const struct spi_flash *flash, u32 addr, size_t len, { uint8_t block_len; uint32_t start = addr; - pch_spi_regs *spi_bar; + pch_spi_flash_regs *spi_bar; spi_bar = get_spi_bar(); @@ -296,7 +297,7 @@ int pch_hwseq_write(const struct spi_flash *flash, u32 addr, size_t len, block_len = (~addr & 0xff) + 1; pch_fill_data(buf, block_len); - if (spi_do_operation(HSFC_FCYCLE_WR, addr, block_len, + if (spi_flash_do_operation(HSFC_FCYCLE_WR, addr, block_len, timeout_ms)) { printk(BIOS_ERR, "SF: write failure at %x\n", addr); return -1; @@ -315,7 +316,7 @@ int pch_hwseq_read_status(const struct spi_flash *flash, u8 *reg) size_t block_len = SPI_READ_STATUS_LENGTH; const int timeout_ms = 6; - if (spi_do_operation(HSFC_FCYCLE_RS, 0, block_len, timeout_ms)) + if (spi_flash_do_operation(HSFC_FCYCLE_RS, 0, block_len, timeout_ms)) return -1; pch_read_data(reg, block_len); @@ -332,7 +333,7 @@ struct spi_flash *spi_flash_programmer_probe(struct spi_slave *spi, int force) flash = car_get_var_ptr(&boot_flash); /* Ensure writes can take place to the flash. */ - spi_init(); + spi_flash_init(); memcpy(&flash->spi, spi, sizeof(*spi)); flash->name = "Opaque HW-sequencing"; @@ -350,22 +351,9 @@ struct spi_flash *spi_flash_programmer_probe(struct spi_slave *spi, int force) return flash; } -int spi_setup_slave(unsigned int bus, unsigned int cs, struct spi_slave *slave) -{ - /* This is special hardware. We expect bus 0 and CS line 0 here. */ - if ((bus != 0) || (cs != 0)) - return -1; - - slave->bus = bus; - slave->cs = cs; - slave->ctrlr = NULL; - - return 0; -} - int spi_flash_get_fpr_info(struct fpr_info *info) { - pch_spi_regs *spi_bar = get_spi_bar(); + pch_spi_flash_regs *spi_bar = get_spi_bar(); if (!spi_bar) return -1; @@ -378,13 +366,13 @@ int spi_flash_get_fpr_info(struct fpr_info *info) #if ENV_RAMSTAGE /* - * spi_init() needs run unconditionally in every boot (including resume) to - * allow write protect to be disabled for eventlog and firmware updates. + * spi_flash_init() needs run unconditionally in every boot (including resume) + * to allow write protect to be disabled for eventlog and firmware updates. */ -static void spi_init_cb(void *unused) +static void spi_flash_init_cb(void *unused) { - spi_init(); + spi_flash_init(); } -BOOT_STATE_INIT_ENTRY(BS_PRE_DEVICE, BS_ON_ENTRY, spi_init_cb, NULL); +BOOT_STATE_INIT_ENTRY(BS_PRE_DEVICE, BS_ON_ENTRY, spi_flash_init_cb, NULL); #endif diff --git a/src/soc/intel/skylake/include/soc/flash_controller.h b/src/soc/intel/skylake/include/soc/flash_controller.h index 00500670fe..25e77344e5 100644 --- a/src/soc/intel/skylake/include/soc/flash_controller.h +++ b/src/soc/intel/skylake/include/soc/flash_controller.h @@ -28,6 +28,7 @@ int pch_hwseq_read(const struct spi_flash *flash, u32 addr, size_t len, void *buf); int pch_hwseq_read_status(const struct spi_flash *flash, u8 *reg); +void spi_flash_init(void); #if IS_ENABLED(CONFIG_DEBUG_SPI_FLASH) static u8 readb_(const void *addr) @@ -134,7 +135,7 @@ static void writel_(u32 b, void *addr) #define SPI_FDATA_REGS 16 #define SPI_FDATA_BYTES (SPI_FDATA_REGS * sizeof(uint32_t)) -typedef struct pch_spi_regs { +typedef struct pch_spi_flash_regs { uint32_t bfpr; uint16_t hsfs; uint16_t hsfc; @@ -164,7 +165,7 @@ typedef struct pch_spi_regs { uint32_t srdl; uint32_t srdc; uint32_t srd; -} __attribute__((packed)) pch_spi_regs; +} __attribute__((packed)) pch_spi_flash_regs; enum { HSFS_FDONE = 0x0001, diff --git a/src/soc/intel/skylake/romstage/spi.c b/src/soc/intel/skylake/romstage/spi.c index 16224046d7..41e06a7933 100644 --- a/src/soc/intel/skylake/romstage/spi.c +++ b/src/soc/intel/skylake/romstage/spi.c @@ -27,7 +27,7 @@ int early_spi_read_wpsr(u8 *sr) uint8_t rdsr; int ret = 0; - spi_init(); + spi_flash_init(); /* sending NULL for spiflash struct parameter since we are not * calling HWSEQ read_status() call via Probe. diff --git a/src/soc/intel/skylake/smihandler.c b/src/soc/intel/skylake/smihandler.c index 872cce1e15..382bdfc80f 100644 --- a/src/soc/intel/skylake/smihandler.c +++ b/src/soc/intel/skylake/smihandler.c @@ -26,6 +26,7 @@ #include #include #include +#include #include #include #include @@ -276,7 +277,7 @@ static void finalize(void) if (IS_ENABLED(CONFIG_SPI_FLASH_SMM)) /* Re-init SPI driver to handle locked BAR */ - spi_init(); + spi_flash_init(); } static void southbridge_smi_apmc(void) diff --git a/src/soc/intel/skylake/spi.c b/src/soc/intel/skylake/spi.c new file mode 100644 index 0000000000..a8a83c6f31 --- /dev/null +++ b/src/soc/intel/skylake/spi.c @@ -0,0 +1,40 @@ +/* + * This file is part of the coreboot project. + * + * Copyright 2016 Google Inc. + * + * 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 of the License, 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. + */ + +#include +#include + +/* SPI controller managing the flash-device SPI. */ +static int flash_spi_ctrlr_setup(const struct spi_slave *dev) +{ + if ((dev->bus != 0) || (dev->cs != 0)) { + printk(BIOS_ERR, "%s: Unsupported device bus=0x%x,cs=0x%x!\n", + __func__, dev->bus, dev->cs); + return -1; + } + + return 0; +} + +static const struct spi_ctrlr flash_spi_ctrlr = { + .setup = flash_spi_ctrlr_setup, +}; + +const struct spi_ctrlr_buses spi_ctrlr_bus_map[] = { + { .ctrlr = &flash_spi_ctrlr, .bus_start = 0, .bus_end = 0 }, +}; + +const size_t spi_ctrlr_bus_map_count = ARRAY_SIZE(spi_ctrlr_bus_map); -- cgit v1.2.3