mirror of
https://review.coreboot.org/flashrom.git
synced 2025-10-31 05:10:41 +01:00
it85spi: EOL support
This code was originally introduced by ITE for now exceedingly old Chromebooks. The code has had very little attention to maintain it, unlikely tested for a long time and now seems to be just a technical burden to the flashrom project. If someone is later interested it could be resurrected for reference from git history. However, it needs quite a bit of work to bring it back into maintainable order. BUG=b:156143896,b:170689483 TEST=tree builds under meson+make and unit tests pass. Change-Id: I5e8cafd73db837941c518f0e2d72d8192274fd79 Signed-off-by: Edward O'Callaghan <quasisec@google.com> Reviewed-on: https://review.coreboot.org/c/flashrom/+/65378 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
This commit is contained in:
Edward O'Callaghan
committed by
Edward O'Callaghan
Edward O'Callaghan
parent
1bb5ddde60
commit
1cea47eac2
2
Makefile
2
Makefile
@@ -574,7 +574,7 @@ ifeq ($(ARCH), x86)
|
|||||||
ifeq ($(CONFIG_INTERNAL) $(CONFIG_INTERNAL_X86), yes yes)
|
ifeq ($(CONFIG_INTERNAL) $(CONFIG_INTERNAL_X86), yes yes)
|
||||||
FEATURE_FLAGS += -D'CONFIG_INTERNAL=1'
|
FEATURE_FLAGS += -D'CONFIG_INTERNAL=1'
|
||||||
PROGRAMMER_OBJS += processor_enable.o chipset_enable.o board_enable.o cbtable.o \
|
PROGRAMMER_OBJS += processor_enable.o chipset_enable.o board_enable.o cbtable.o \
|
||||||
internal.o it87spi.o it85spi.o sb600spi.o amd_imc.o wbsio_spi.o mcp6x_spi.o \
|
internal.o it87spi.o sb600spi.o amd_imc.o wbsio_spi.o mcp6x_spi.o \
|
||||||
ichspi.o dmi.o
|
ichspi.o dmi.o
|
||||||
endif
|
endif
|
||||||
else
|
else
|
||||||
|
|||||||
@@ -365,9 +365,6 @@ int via_init_spi(uint32_t mmio_base);
|
|||||||
/* amd_imc.c */
|
/* amd_imc.c */
|
||||||
int amd_imc_shutdown(struct pci_dev *dev);
|
int amd_imc_shutdown(struct pci_dev *dev);
|
||||||
|
|
||||||
/* it85spi.c */
|
|
||||||
int it85xx_spi_init(struct superio s);
|
|
||||||
|
|
||||||
/* it87spi.c */
|
/* it87spi.c */
|
||||||
void enter_conf_mode_ite(uint16_t port);
|
void enter_conf_mode_ite(uint16_t port);
|
||||||
void exit_conf_mode_ite(uint16_t port);
|
void exit_conf_mode_ite(uint16_t port);
|
||||||
|
|||||||
364
it85spi.c
364
it85spi.c
@@ -1,364 +0,0 @@
|
|||||||
/*
|
|
||||||
* This file is part of the flashrom project.
|
|
||||||
*
|
|
||||||
* Copyright (C) 2007, 2008, 2009 Carl-Daniel Hailfinger
|
|
||||||
* Copyright (C) 2008 Ronald Hoogenboom <ronald@zonnet.nl>
|
|
||||||
* Copyright (C) 2008 coresystems GmbH
|
|
||||||
* Copyright (C) 2010 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; 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.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Contains the ITE IT85* SPI specific routines
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <string.h>
|
|
||||||
#include <stdio.h>
|
|
||||||
#include <stdlib.h>
|
|
||||||
#include "flash.h"
|
|
||||||
#include "spi.h"
|
|
||||||
#include "programmer.h"
|
|
||||||
#include "hwaccess_x86_io.h"
|
|
||||||
#include "hwaccess_physmap.h"
|
|
||||||
|
|
||||||
#define MAX_TIMEOUT 100000
|
|
||||||
#define MAX_TRY 5
|
|
||||||
|
|
||||||
/* Constants for I/O ports */
|
|
||||||
#define ITE_SUPERIO_PORT1 0x2e
|
|
||||||
#define ITE_SUPERIO_PORT2 0x4e
|
|
||||||
|
|
||||||
/* Legacy I/O */
|
|
||||||
#define LEGACY_KBC_PORT_DATA 0x60
|
|
||||||
#define LEGACY_KBC_PORT_CMD 0x64
|
|
||||||
|
|
||||||
/* Constants for Logical Device registers */
|
|
||||||
#define LDNSEL 0x07
|
|
||||||
|
|
||||||
/* These are standard Super I/O 16-bit base address registers */
|
|
||||||
#define SHM_IO_BAR0 0x60 /* big-endian, this is high bits */
|
|
||||||
#define SHM_IO_BAR1 0x61
|
|
||||||
|
|
||||||
/* The 8042 keyboard controller uses an input buffer and an output buffer to
|
|
||||||
* communicate with the host CPU. Both buffers are 1-byte depth. That means
|
|
||||||
* IBF is set to 1 when the host CPU sends a command to the input buffer
|
|
||||||
* of the EC. IBF is cleared to 0 once the command is read by the EC.
|
|
||||||
*/
|
|
||||||
#define KB_IBF (1 << 1) /* Input Buffer Full */
|
|
||||||
#define KB_OBF (1 << 0) /* Output Buffer Full */
|
|
||||||
|
|
||||||
/* IT8502 supports two access modes:
|
|
||||||
* LPC_MEMORY: through the memory window in 0xFFFFFxxx (follow mode)
|
|
||||||
* LPC_IO: through I/O port (so called indirect memory)
|
|
||||||
*/
|
|
||||||
#undef LPC_MEMORY
|
|
||||||
#define LPC_IO
|
|
||||||
|
|
||||||
#ifdef LPC_IO
|
|
||||||
/* macro to fill in indirect-access registers. */
|
|
||||||
#define INDIRECT_A0(base, value) OUTB(value, (base) + 0) /* little-endian */
|
|
||||||
#define INDIRECT_A1(base, value) OUTB(value, (base) + 1)
|
|
||||||
#define INDIRECT_A2(base, value) OUTB(value, (base) + 2)
|
|
||||||
#define INDIRECT_A3(base, value) OUTB(value, (base) + 3)
|
|
||||||
#define INDIRECT_READ(base) INB((base) + 4)
|
|
||||||
#define INDIRECT_WRITE(base, value) OUTB(value, (base) + 4)
|
|
||||||
#endif /* LPC_IO */
|
|
||||||
|
|
||||||
struct it85spi_data {
|
|
||||||
#ifdef LPC_IO
|
|
||||||
unsigned int shm_io_base;
|
|
||||||
#endif
|
|
||||||
unsigned char *ce_high, *ce_low;
|
|
||||||
int it85xx_scratch_rom_reenter;
|
|
||||||
};
|
|
||||||
|
|
||||||
/* This function will poll the keyboard status register until either
|
|
||||||
* an expected value shows up, or the timeout is reached.
|
|
||||||
* timeout is in usec.
|
|
||||||
*
|
|
||||||
* Returns: 0 -- the expected value showed up.
|
|
||||||
* 1 -- timeout.
|
|
||||||
*/
|
|
||||||
static int wait_for(const unsigned int mask, const unsigned int expected_value,
|
|
||||||
const int timeout, const char * error_message,
|
|
||||||
const char * function_name, const int lineno)
|
|
||||||
{
|
|
||||||
int time_passed;
|
|
||||||
|
|
||||||
for (time_passed = 0;; ++time_passed) {
|
|
||||||
if ((INB(LEGACY_KBC_PORT_CMD) & mask) == expected_value)
|
|
||||||
return 0;
|
|
||||||
if (time_passed >= timeout)
|
|
||||||
break;
|
|
||||||
programmer_delay(1);
|
|
||||||
}
|
|
||||||
if (error_message)
|
|
||||||
msg_perr("%s():%d %s", function_name, lineno, error_message);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* IT8502 employs a scratch RAM when flash is being updated. Call the following
|
|
||||||
* two functions before/after flash erase/program. */
|
|
||||||
static void it85xx_enter_scratch_rom(struct it85spi_data *data)
|
|
||||||
{
|
|
||||||
int ret, tries;
|
|
||||||
|
|
||||||
msg_pdbg("%s():%d was called ...\n", __func__, __LINE__);
|
|
||||||
if (data->it85xx_scratch_rom_reenter > 0)
|
|
||||||
return;
|
|
||||||
|
|
||||||
#if 0
|
|
||||||
/* FIXME: this a workaround for the bug that SMBus signal would
|
|
||||||
* interfere the EC firmware update. Should be removed if
|
|
||||||
* we find out the root cause. */
|
|
||||||
ret = system("stop powerd >&2");
|
|
||||||
if (ret)
|
|
||||||
msg_perr("Cannot stop powerd.\n");
|
|
||||||
#endif
|
|
||||||
|
|
||||||
for (tries = 0; tries < MAX_TRY; ++tries) {
|
|
||||||
/* Wait until IBF (input buffer) is not full. */
|
|
||||||
if (wait_for(KB_IBF, 0, MAX_TIMEOUT,
|
|
||||||
"* timeout at waiting for IBF==0.\n",
|
|
||||||
__func__, __LINE__))
|
|
||||||
continue;
|
|
||||||
|
|
||||||
/* Copy EC firmware to SRAM. */
|
|
||||||
OUTB(0xb4, LEGACY_KBC_PORT_CMD);
|
|
||||||
|
|
||||||
/* Confirm EC has taken away the command. */
|
|
||||||
if (wait_for(KB_IBF, 0, MAX_TIMEOUT,
|
|
||||||
"* timeout at taking command.\n",
|
|
||||||
__func__, __LINE__))
|
|
||||||
continue;
|
|
||||||
|
|
||||||
/* Waiting for OBF (output buffer) has data.
|
|
||||||
* Note sometimes the replied command might be stolen by kernel
|
|
||||||
* ISR so that it is okay as long as the command is 0xFA. */
|
|
||||||
if (wait_for(KB_OBF, KB_OBF, MAX_TIMEOUT, NULL, NULL, 0))
|
|
||||||
msg_pdbg("%s():%d * timeout at waiting for OBF.\n",
|
|
||||||
__func__, __LINE__);
|
|
||||||
if ((ret = INB(LEGACY_KBC_PORT_DATA)) == 0xFA) {
|
|
||||||
break;
|
|
||||||
} else {
|
|
||||||
msg_perr("%s():%d * not run on SRAM ret=%d\n",
|
|
||||||
__func__, __LINE__, ret);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (tries < MAX_TRY) {
|
|
||||||
/* EC already runs on SRAM */
|
|
||||||
data->it85xx_scratch_rom_reenter++;
|
|
||||||
msg_pdbg("%s():%d * SUCCESS.\n", __func__, __LINE__);
|
|
||||||
} else {
|
|
||||||
msg_perr("%s():%d * Max try reached.\n", __func__, __LINE__);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
static void it85xx_exit_scratch_rom(struct it85spi_data *data)
|
|
||||||
{
|
|
||||||
#if 0
|
|
||||||
int ret;
|
|
||||||
#endif
|
|
||||||
int tries;
|
|
||||||
|
|
||||||
msg_pdbg("%s():%d was called ...\n", __func__, __LINE__);
|
|
||||||
if (data->it85xx_scratch_rom_reenter <= 0)
|
|
||||||
return;
|
|
||||||
|
|
||||||
for (tries = 0; tries < MAX_TRY; ++tries) {
|
|
||||||
/* Wait until IBF (input buffer) is not full. */
|
|
||||||
if (wait_for(KB_IBF, 0, MAX_TIMEOUT,
|
|
||||||
"* timeout at waiting for IBF==0.\n",
|
|
||||||
__func__, __LINE__))
|
|
||||||
continue;
|
|
||||||
|
|
||||||
/* Exit SRAM. Run on flash. */
|
|
||||||
OUTB(0xFE, LEGACY_KBC_PORT_CMD);
|
|
||||||
|
|
||||||
/* Confirm EC has taken away the command. */
|
|
||||||
if (wait_for(KB_IBF, 0, MAX_TIMEOUT,
|
|
||||||
"* timeout at taking command.\n",
|
|
||||||
__func__, __LINE__)) {
|
|
||||||
/* We cannot ensure if EC has exited update mode.
|
|
||||||
* If EC is in normal mode already, a further 0xFE
|
|
||||||
* command will reboot system. So, exit loop here. */
|
|
||||||
tries = MAX_TRY;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (tries < MAX_TRY) {
|
|
||||||
data->it85xx_scratch_rom_reenter = 0;
|
|
||||||
msg_pdbg("%s():%d * SUCCESS.\n", __func__, __LINE__);
|
|
||||||
} else {
|
|
||||||
msg_perr("%s():%d * Max try reached.\n", __func__, __LINE__);
|
|
||||||
}
|
|
||||||
|
|
||||||
#if 0
|
|
||||||
/* FIXME: this a workaround for the bug that SMBus signal would
|
|
||||||
* interfere the EC firmware update. Should be removed if
|
|
||||||
* we find out the root cause. */
|
|
||||||
ret = system("start powerd >&2");
|
|
||||||
if (ret)
|
|
||||||
msg_perr("Cannot start powerd again.\n");
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
static int it85xx_shutdown(void *data)
|
|
||||||
{
|
|
||||||
msg_pdbg("%s():%d\n", __func__, __LINE__);
|
|
||||||
it85xx_exit_scratch_rom(data);
|
|
||||||
free(data);
|
|
||||||
|
|
||||||
return 0; /* FIXME: Should probably return something meaningful */
|
|
||||||
}
|
|
||||||
|
|
||||||
/* According to ITE 8502 document, the procedure to follow mode is following:
|
|
||||||
* 1. write 0x00 to LPC/FWH address 0xffff_fexxh (drive CE# high)
|
|
||||||
* 2. write data to LPC/FWH address 0xffff_fdxxh (drive CE# low and MOSI
|
|
||||||
* with data)
|
|
||||||
* 3. read date from LPC/FWH address 0xffff_fdxxh (drive CE# low and get
|
|
||||||
* data from MISO)
|
|
||||||
*/
|
|
||||||
static int it85xx_spi_send_command(const struct flashctx *flash,
|
|
||||||
unsigned int writecnt, unsigned int readcnt,
|
|
||||||
const unsigned char *writearr,
|
|
||||||
unsigned char *readarr)
|
|
||||||
{
|
|
||||||
unsigned int i;
|
|
||||||
struct it85spi_data *data = flash->mst->spi.data;
|
|
||||||
|
|
||||||
it85xx_enter_scratch_rom(data);
|
|
||||||
/*
|
|
||||||
* Exit scratch ROM ONLY when programmer shuts down. Otherwise, the
|
|
||||||
* temporary flash state may halt the EC.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifdef LPC_IO
|
|
||||||
INDIRECT_A1(data->shm_io_base, (((unsigned long int)data->ce_high) >> 8) & 0xff);
|
|
||||||
INDIRECT_WRITE(data->shm_io_base, 0xFF); /* Write anything to this address.*/
|
|
||||||
INDIRECT_A1(data->shm_io_base, (((unsigned long int)data->ce_low) >> 8) & 0xff);
|
|
||||||
#endif
|
|
||||||
#ifdef LPC_MEMORY
|
|
||||||
mmio_writeb(0, data->ce_high);
|
|
||||||
#endif
|
|
||||||
for (i = 0; i < writecnt; ++i) {
|
|
||||||
#ifdef LPC_IO
|
|
||||||
INDIRECT_WRITE(data->shm_io_base, writearr[i]);
|
|
||||||
#endif
|
|
||||||
#ifdef LPC_MEMORY
|
|
||||||
mmio_writeb(writearr[i], data->ce_low);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
for (i = 0; i < readcnt; ++i) {
|
|
||||||
#ifdef LPC_IO
|
|
||||||
readarr[i] = INDIRECT_READ(data->shm_io_base);
|
|
||||||
#endif
|
|
||||||
#ifdef LPC_MEMORY
|
|
||||||
readarr[i] = mmio_readb(data->ce_low);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
#ifdef LPC_IO
|
|
||||||
INDIRECT_A1(data->shm_io_base, (((unsigned long int)data->ce_high) >> 8) & 0xff);
|
|
||||||
INDIRECT_WRITE(data->shm_io_base, 0xFF); /* Write anything to this address.*/
|
|
||||||
#endif
|
|
||||||
#ifdef LPC_MEMORY
|
|
||||||
mmio_writeb(0, data->ce_high);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
static const struct spi_master spi_master_it85xx = {
|
|
||||||
.max_data_read = 64,
|
|
||||||
.max_data_write = 64,
|
|
||||||
.command = it85xx_spi_send_command,
|
|
||||||
.multicommand = default_spi_send_multicommand,
|
|
||||||
.read = default_spi_read,
|
|
||||||
.write_256 = default_spi_write_256,
|
|
||||||
.write_aai = default_spi_write_aai,
|
|
||||||
.shutdown = it85xx_shutdown,
|
|
||||||
};
|
|
||||||
|
|
||||||
int it85xx_spi_init(struct superio s)
|
|
||||||
{
|
|
||||||
chipaddr base;
|
|
||||||
struct it85spi_data *data;
|
|
||||||
unsigned int shm_io_base = 0;
|
|
||||||
|
|
||||||
msg_pdbg("%s():%d superio.vendor=0x%02x internal_buses_supported=0x%x\n",
|
|
||||||
__func__, __LINE__, s.vendor, internal_buses_supported);
|
|
||||||
|
|
||||||
/* Check for FWH because IT85 listens to FWH cycles.
|
|
||||||
* FIXME: The big question is whether FWH cycles are necessary
|
|
||||||
* for communication even if LPC_IO is defined.
|
|
||||||
*/
|
|
||||||
if (!(internal_buses_supported & BUS_FWH)) {
|
|
||||||
msg_pdbg("%s():%d buses not support FWH\n", __func__, __LINE__);
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
msg_pdbg("Registering IT85 SPI.\n");
|
|
||||||
|
|
||||||
#ifdef LPC_IO
|
|
||||||
/* Get LPCPNP of SHM. That's big-endian. */
|
|
||||||
sio_write(s.port, LDNSEL, 0x0F); /* Set LDN to SHM (0x0F) */
|
|
||||||
shm_io_base = (sio_read(s.port, SHM_IO_BAR0) << 8) +
|
|
||||||
sio_read(s.port, SHM_IO_BAR1);
|
|
||||||
msg_pdbg("%s():%d shm_io_base=0x%04x\n", __func__, __LINE__,
|
|
||||||
shm_io_base);
|
|
||||||
|
|
||||||
/* These pointers are not used directly. They will be send to EC's
|
|
||||||
* register for indirect access. */
|
|
||||||
base = 0xFFFFF000;
|
|
||||||
|
|
||||||
/* pre-set indirect-access registers since in most of cases they are
|
|
||||||
* 0xFFFFxx00. */
|
|
||||||
INDIRECT_A0(shm_io_base, base & 0xFF);
|
|
||||||
INDIRECT_A2(shm_io_base, (base >> 16) & 0xFF);
|
|
||||||
INDIRECT_A3(shm_io_base, (base >> 24));
|
|
||||||
#endif
|
|
||||||
#ifdef LPC_MEMORY
|
|
||||||
/* FIXME: We should block accessing that region for anything else.
|
|
||||||
* Major TODO here, and it will be a lot of work.
|
|
||||||
*/
|
|
||||||
base = physmap("it85 communication", 0xFFFFF000, 0x1000);
|
|
||||||
if (base == ERROR_PTR)
|
|
||||||
return 1;
|
|
||||||
|
|
||||||
msg_pdbg("%s():%d base=0x%08x\n", __func__, __LINE__,
|
|
||||||
(unsigned int)base);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
data = calloc(1, sizeof(*data));
|
|
||||||
if (!data) {
|
|
||||||
msg_perr("Unable to allocate space for extra SPI master data.\n");
|
|
||||||
return SPI_GENERIC_ERROR;
|
|
||||||
}
|
|
||||||
|
|
||||||
#ifdef LPC_IO
|
|
||||||
data->shm_io_base = shm_io_base;
|
|
||||||
#endif
|
|
||||||
data->ce_high = ((unsigned char *)base) + 0xE00; /* 0xFFFFFE00 */
|
|
||||||
data->ce_low = ((unsigned char *)base) + 0xD00; /* 0xFFFFFD00 */
|
|
||||||
|
|
||||||
/* FIXME: Really leave FWH enabled? We can't use this region
|
|
||||||
* anymore since accessing it would mess up IT85 communication.
|
|
||||||
* If we decide to disable FWH for this region, we should print
|
|
||||||
* a debug message about it.
|
|
||||||
*/
|
|
||||||
/* Set this as SPI controller. */
|
|
||||||
return register_spi_master(&spi_master_it85xx, data);
|
|
||||||
}
|
|
||||||
12
it87spi.c
12
it87spi.c
@@ -449,18 +449,6 @@ int init_superio_ite(void)
|
|||||||
continue;
|
continue;
|
||||||
|
|
||||||
switch (superios[i].model) {
|
switch (superios[i].model) {
|
||||||
case 0x8500:
|
|
||||||
case 0x8502:
|
|
||||||
case 0x8510:
|
|
||||||
case 0x8511:
|
|
||||||
case 0x8512:
|
|
||||||
/* FIXME: This should be enabled, but we need a check
|
|
||||||
* for laptop whitelisting due to the amount of things
|
|
||||||
* which can go wrong if the EC firmware does not
|
|
||||||
* implement the interface we want.
|
|
||||||
*/
|
|
||||||
//it85xx_spi_init(superios[i]);
|
|
||||||
break;
|
|
||||||
case 0x8705:
|
case 0x8705:
|
||||||
ret |= it8705f_write_enable(superios[i].port);
|
ret |= it8705f_write_enable(superios[i].port);
|
||||||
break;
|
break;
|
||||||
|
|||||||
@@ -271,7 +271,6 @@ if config_internal
|
|||||||
'amd_imc.c',
|
'amd_imc.c',
|
||||||
'dmi.c',
|
'dmi.c',
|
||||||
'ichspi.c',
|
'ichspi.c',
|
||||||
'it85spi.c',
|
|
||||||
'it87spi.c',
|
'it87spi.c',
|
||||||
'mcp6x_spi.c',
|
'mcp6x_spi.c',
|
||||||
'sb600spi.c',
|
'sb600spi.c',
|
||||||
|
|||||||
Reference in New Issue
Block a user