fespi.c File Reference

Include dependency graph for fespi.c:

Go to the source code of this file.

Data Structures
struct	fespi_flash_bank
struct	fespi_target

Macros
#define	FESPI_CMD_TIMEOUT   (100)
#define	FESPI_CSMODE_AUTO   0
#define	FESPI_CSMODE_HOLD   2
#define	FESPI_CSMODE_OFF   3
#define	FESPI_DIR_RX   0
#define	FESPI_DIR_TX   1
#define	FESPI_ENDIAN_LSB   1
#define	FESPI_ENDIAN_MSB   0
#define	FESPI_FCTRL_EN   0x1
#define	FESPI_FMT_DIR(x)   (((x) & 0x1) << 3)
#define	FESPI_FMT_ENDIAN(x)   (((x) & 0x1) << 2)
#define	FESPI_FMT_LEN(x)   (((x) & 0xf) << 16)
#define	FESPI_FMT_PROTO(x)   ((x) & 0x3)
#define	FESPI_INSN_ADDR_LEN(x)   (((x) & 0x7) << 1)
#define	FESPI_INSN_ADDR_PROTO(x)   (((x) & 0x3) << 10)
#define	FESPI_INSN_CMD_CODE(x)   (((x) & 0xff) << 16)
#define	FESPI_INSN_CMD_EN   0x1
#define	FESPI_INSN_CMD_PROTO(x)   (((x) & 0x3) << 8)
#define	FESPI_INSN_DATA_PROTO(x)   (((x) & 0x3) << 12)
#define	FESPI_INSN_PAD_CNT(x)   (((x) & 0xf) << 4)
#define	FESPI_INSN_PAD_CODE(x)   (((x) & 0xff) << 24)
#define	FESPI_IP_RXWM   0x2
#define	FESPI_IP_TXWM   0x1
#define	FESPI_MAX_TIMEOUT   (3000)
#define	FESPI_PROBE_TIMEOUT   (100)
#define	FESPI_PROTO_D   1
#define	FESPI_PROTO_Q   2
#define	FESPI_PROTO_S   0
#define	FESPI_REG_CSDEF   0x14
#define	FESPI_REG_CSID   0x10
#define	FESPI_REG_CSMODE   0x18
#define	FESPI_REG_DCSSCK   0x28
#define	FESPI_REG_DINTERCS   0x2c
#define	FESPI_REG_DINTERXFR   0x2e
#define	FESPI_REG_DSCKCS   0x2a
#define	FESPI_REG_FCTRL   0x60
#define	FESPI_REG_FFMT   0x64
#define	FESPI_REG_FMT   0x40
#define	FESPI_REG_IE   0x70
#define	FESPI_REG_IP   0x74
#define	FESPI_REG_RXCTRL   0x54
#define	FESPI_REG_RXFIFO   0x4c
#define	FESPI_REG_SCKDIV   0x00
#define	FESPI_REG_SCKMODE   0x04
#define	FESPI_REG_TXCTRL   0x50
#define	FESPI_REG_TXFIFO   0x48
#define	FESPI_RXWM(x)   ((x) & 0xffff)
#define	FESPI_SCK_PHA   0x2
#define	FESPI_SCK_POL   0x1
#define	FESPI_TXWM(x)   ((x) & 0xffff)

Functions
static int	fespi_auto_probe (struct flash_bank *bank)
static int	fespi_disable_hw_mode (struct flash_bank *bank)
static int	fespi_enable_hw_mode (struct flash_bank *bank)
static int	fespi_erase (struct flash_bank *bank, unsigned int first, unsigned int last)
static int	fespi_erase_sector (struct flash_bank *bank, int sector)
static int	fespi_probe (struct flash_bank *bank)
static int	fespi_protect (struct flash_bank *bank, int set, unsigned int first, unsigned int last)
static int	fespi_protect_check (struct flash_bank *bank)
static int	fespi_read_flash_id (struct flash_bank *bank, uint32_t *id)
static int	fespi_read_reg (struct flash_bank *bank, uint32_t *value, target_addr_t address)
static int	fespi_rx (struct flash_bank *bank, uint8_t *out)
static int	fespi_set_dir (struct flash_bank *bank, bool dir)
static int	fespi_tx (struct flash_bank *bank, uint8_t in)
static int	fespi_txwm_wait (struct flash_bank *bank)
static int	fespi_wip (struct flash_bank *bank, int timeout)
static int	fespi_write (struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
static int	fespi_write_reg (struct flash_bank *bank, target_addr_t address, uint32_t value)
	FLASH_BANK_COMMAND_HANDLER (fespi_flash_bank_command)
static int	get_fespi_info (struct flash_bank *bank, struct command_invocation *cmd)
static int	slow_fespi_write_buffer (struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t len)

Variables
const struct flash_driver	fespi_flash
static const uint8_t	riscv32_bin []
static const uint8_t	riscv64_bin []
static const struct fespi_target	target_devices []

Macro Definition Documentation

FESPI_CMD_TIMEOUT

#define FESPI_CMD_TIMEOUT   (100)

Definition at line 108 of file fespi.c.

FESPI_CSMODE_AUTO

#define FESPI_CSMODE_AUTO   0

Definition at line 92 of file fespi.c.

FESPI_CSMODE_HOLD

#define FESPI_CSMODE_HOLD   2

Definition at line 93 of file fespi.c.

FESPI_CSMODE_OFF

#define FESPI_CSMODE_OFF   3

Definition at line 94 of file fespi.c.

FESPI_DIR_RX

#define FESPI_DIR_RX   0

Definition at line 96 of file fespi.c.

FESPI_DIR_TX

#define FESPI_DIR_TX   1

Definition at line 97 of file fespi.c.

FESPI_ENDIAN_LSB

#define FESPI_ENDIAN_LSB   1

Definition at line 104 of file fespi.c.

FESPI_ENDIAN_MSB

#define FESPI_ENDIAN_MSB   0

Definition at line 103 of file fespi.c.

FESPI_FCTRL_EN

#define FESPI_FCTRL_EN   0x1

Definition at line 79 of file fespi.c.

FESPI_FMT_DIR

#define FESPI_FMT_DIR

(

x

)

(((x) & 0x1) << 3)

Definition at line 68 of file fespi.c.

FESPI_FMT_ENDIAN

#define FESPI_FMT_ENDIAN

(

x

)

(((x) & 0x1) << 2)

Definition at line 67 of file fespi.c.

FESPI_FMT_LEN

#define FESPI_FMT_LEN

(

x

)

(((x) & 0xf) << 16)

Definition at line 69 of file fespi.c.

FESPI_FMT_PROTO

#define FESPI_FMT_PROTO

(

x

)

((x) & 0x3)

Definition at line 66 of file fespi.c.

FESPI_INSN_ADDR_LEN

#define FESPI_INSN_ADDR_LEN

(

x

)

(((x) & 0x7) << 1)

Definition at line 82 of file fespi.c.

FESPI_INSN_ADDR_PROTO

#define FESPI_INSN_ADDR_PROTO

(

x

)

(((x) & 0x3) << 10)

Definition at line 85 of file fespi.c.

FESPI_INSN_CMD_CODE

#define FESPI_INSN_CMD_CODE

(

x

)

(((x) & 0xff) << 16)

Definition at line 87 of file fespi.c.

FESPI_INSN_CMD_EN

#define FESPI_INSN_CMD_EN   0x1

Definition at line 81 of file fespi.c.

FESPI_INSN_CMD_PROTO

#define FESPI_INSN_CMD_PROTO

(

x

)

(((x) & 0x3) << 8)

Definition at line 84 of file fespi.c.

FESPI_INSN_DATA_PROTO

#define FESPI_INSN_DATA_PROTO

(

x

)

(((x) & 0x3) << 12)

Definition at line 86 of file fespi.c.

FESPI_INSN_PAD_CNT

#define FESPI_INSN_PAD_CNT

(

x

)

(((x) & 0xf) << 4)

Definition at line 83 of file fespi.c.

FESPI_INSN_PAD_CODE

#define FESPI_INSN_PAD_CODE

(

x

)

(((x) & 0xff) << 24)

Definition at line 88 of file fespi.c.

FESPI_IP_RXWM

#define FESPI_IP_RXWM   0x2

Definition at line 77 of file fespi.c.

FESPI_IP_TXWM

#define FESPI_IP_TXWM   0x1

Definition at line 76 of file fespi.c.

FESPI_MAX_TIMEOUT

#define FESPI_MAX_TIMEOUT   (3000)

Definition at line 110 of file fespi.c.

FESPI_PROBE_TIMEOUT

#define FESPI_PROBE_TIMEOUT   (100)

Definition at line 109 of file fespi.c.

FESPI_PROTO_D

#define FESPI_PROTO_D   1

Definition at line 100 of file fespi.c.

FESPI_PROTO_Q

#define FESPI_PROTO_Q   2

Definition at line 101 of file fespi.c.

FESPI_PROTO_S

#define FESPI_PROTO_S   0

Definition at line 99 of file fespi.c.

FESPI_REG_CSDEF

#define FESPI_REG_CSDEF   0x14

Definition at line 41 of file fespi.c.

FESPI_REG_CSID

#define FESPI_REG_CSID   0x10

Definition at line 40 of file fespi.c.

FESPI_REG_CSMODE

#define FESPI_REG_CSMODE   0x18

Definition at line 42 of file fespi.c.

FESPI_REG_DCSSCK

#define FESPI_REG_DCSSCK   0x28

Definition at line 44 of file fespi.c.

FESPI_REG_DINTERCS

#define FESPI_REG_DINTERCS   0x2c

Definition at line 46 of file fespi.c.

FESPI_REG_DINTERXFR

#define FESPI_REG_DINTERXFR   0x2e

Definition at line 47 of file fespi.c.

FESPI_REG_DSCKCS

#define FESPI_REG_DSCKCS   0x2a

Definition at line 45 of file fespi.c.

FESPI_REG_FCTRL

#define FESPI_REG_FCTRL   0x60

Definition at line 55 of file fespi.c.

FESPI_REG_FFMT

#define FESPI_REG_FFMT   0x64

Definition at line 56 of file fespi.c.

FESPI_REG_FMT

#define FESPI_REG_FMT   0x40

Definition at line 49 of file fespi.c.

FESPI_REG_IE

#define FESPI_REG_IE   0x70

Definition at line 58 of file fespi.c.

FESPI_REG_IP

#define FESPI_REG_IP   0x74

Definition at line 59 of file fespi.c.

FESPI_REG_RXCTRL

#define FESPI_REG_RXCTRL   0x54

Definition at line 53 of file fespi.c.

FESPI_REG_RXFIFO

#define FESPI_REG_RXFIFO   0x4c

Definition at line 51 of file fespi.c.

FESPI_REG_SCKDIV

#define FESPI_REG_SCKDIV   0x00

Definition at line 38 of file fespi.c.

FESPI_REG_SCKMODE

#define FESPI_REG_SCKMODE   0x04

Definition at line 39 of file fespi.c.

FESPI_REG_TXCTRL

#define FESPI_REG_TXCTRL   0x50

Definition at line 52 of file fespi.c.

FESPI_REG_TXFIFO

#define FESPI_REG_TXFIFO   0x48

Definition at line 50 of file fespi.c.

FESPI_RXWM

#define FESPI_RXWM

(

x

)

((x) & 0xffff)

Definition at line 74 of file fespi.c.

FESPI_SCK_PHA

#define FESPI_SCK_PHA   0x2

Definition at line 64 of file fespi.c.

FESPI_SCK_POL

#define FESPI_SCK_POL   0x1

Definition at line 63 of file fespi.c.

FESPI_TXWM

#define FESPI_TXWM

(

x

)

((x) & 0xffff)

Definition at line 72 of file fespi.c.

Function Documentation

fespi_auto_probe()

static int fespi_auto_probe ( struct flash_bank *  bank )

static

Definition at line 820 of file fespi.c.

References bank, ERROR_OK, fespi_probe(), and fespi_flash_bank::probed.

fespi_disable_hw_mode()

static int fespi_disable_hw_mode ( struct flash_bank *  bank )

static

Definition at line 188 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, FESPI_FCTRL_EN, fespi_read_reg(), FESPI_REG_FCTRL, and fespi_write_reg().

Referenced by fespi_erase(), fespi_probe(), and fespi_write().

fespi_enable_hw_mode()

static int fespi_enable_hw_mode ( struct flash_bank *  bank )

static

Definition at line 196 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, FESPI_FCTRL_EN, fespi_read_reg(), FESPI_REG_FCTRL, and fespi_write_reg().

Referenced by fespi_erase(), fespi_probe(), and fespi_write().

fespi_erase()

static int fespi_erase ( struct flash_bank *  bank, unsigned int  first, unsigned int  last  )

static

Definition at line 356 of file fespi.c.

References bank, fespi_flash_bank::dev, flash_device::erase_cmd, ERROR_FAIL, ERROR_FLASH_BANK_NOT_PROBED, ERROR_FLASH_OPER_UNSUPPORTED, ERROR_FLASH_SECTOR_INVALID, ERROR_OK, ERROR_TARGET_NOT_HALTED, fespi_disable_hw_mode(), fespi_enable_hw_mode(), fespi_erase_sector(), FESPI_PROBE_TIMEOUT, FESPI_REG_TXCTRL, FESPI_TXWM, fespi_txwm_wait(), fespi_wip(), fespi_write_reg(), keep_alive(), LOG_DEBUG, LOG_ERROR, fespi_flash_bank::probed, target::state, and TARGET_HALTED.

fespi_erase_sector()

static int fespi_erase_sector ( struct flash_bank *  bank, int  sector  )

static

Definition at line 311 of file fespi.c.

References bank, fespi_flash_bank::dev, flash_device::erase_cmd, ERROR_FAIL, ERROR_OK, FESPI_CSMODE_AUTO, FESPI_CSMODE_HOLD, FESPI_MAX_TIMEOUT, FESPI_REG_CSMODE, fespi_tx(), fespi_txwm_wait(), fespi_wip(), fespi_write_reg(), and SPIFLASH_WRITE_ENABLE.

Referenced by fespi_erase().

fespi_probe()

static int fespi_probe ( struct flash_bank *  bank )

static

Definition at line 723 of file fespi.c.

References bank, fespi_flash_bank::ctrl_base, fespi_target::ctrl_base, fespi_flash_bank::dev, flash_device::device_id, ERROR_FAIL, ERROR_OK, FESPI_DIR_TX, fespi_disable_hw_mode(), fespi_enable_hw_mode(), fespi_read_flash_id(), FESPI_REG_TXCTRL, fespi_set_dir(), FESPI_TXWM, fespi_write_reg(), flash_devices, jtag_tap::idcode, flash_sector::is_erased, flash_sector::is_protected, LOG_DEBUG, LOG_ERROR, LOG_INFO, LOG_WARNING, fespi_target::name, flash_device::name, NULL, flash_sector::offset, fespi_flash_bank::probed, flash_device::sectorsize, flash_sector::size, flash_device::size_in_bytes, target::tap, fespi_target::tap_idcode, TARGET_ADDR_FMT, and target_devices.

Referenced by fespi_auto_probe().

fespi_protect()

static int fespi_protect ( struct flash_bank *  bank, int  set, unsigned int  first, unsigned int  last  )

static

Definition at line 421 of file fespi.c.

References bank, and ERROR_OK.

fespi_protect_check()

static int fespi_protect_check ( struct flash_bank *  bank )

static

Definition at line 828 of file fespi.c.

References ERROR_OK.

fespi_read_flash_id()

static int fespi_read_flash_id ( struct flash_bank *  bank, uint32_t *  id  )

static

Definition at line 671 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, ERROR_TARGET_NOT_HALTED, FESPI_CSMODE_AUTO, FESPI_CSMODE_HOLD, FESPI_DIR_RX, FESPI_DIR_TX, FESPI_PROBE_TIMEOUT, FESPI_REG_CSMODE, fespi_rx(), fespi_set_dir(), fespi_tx(), fespi_txwm_wait(), fespi_wip(), fespi_write_reg(), LOG_ERROR, NULL, SPIFLASH_READ_ID, target::state, and TARGET_HALTED.

Referenced by fespi_probe().

fespi_read_reg()

static int fespi_read_reg ( struct flash_bank *  bank, uint32_t *  value, target_addr_t  address  )

static

Definition at line 160 of file fespi.c.

References bank, fespi_flash_bank::ctrl_base, ERROR_OK, LOG_ERROR, TARGET_ADDR_FMT, and target_read_u32().

Referenced by fespi_disable_hw_mode(), fespi_enable_hw_mode(), fespi_rx(), fespi_set_dir(), fespi_tx(), and fespi_txwm_wait().

fespi_rx()

static int fespi_rx ( struct flash_bank *  bank, uint8_t *  out  )

static

Definition at line 254 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, ERROR_TARGET_TIMEOUT, fespi_read_reg(), FESPI_REG_RXFIFO, LOG_ERROR, start, and timeval_ms().

Referenced by fespi_read_flash_id(), and fespi_wip().

fespi_set_dir()

static int fespi_set_dir ( struct flash_bank *  bank, bool  dir  )

static

Definition at line 204 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, FESPI_FMT_DIR, fespi_read_reg(), FESPI_REG_FMT, and fespi_write_reg().

Referenced by fespi_probe(), fespi_read_flash_id(), and fespi_wip().

fespi_tx()

static int fespi_tx ( struct flash_bank *  bank, uint8_t  in  )

static

Definition at line 234 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, ERROR_TARGET_TIMEOUT, fespi_read_reg(), FESPI_REG_TXFIFO, fespi_write_reg(), LOG_ERROR, start, and timeval_ms().

Referenced by fespi_erase_sector(), fespi_read_flash_id(), fespi_wip(), and slow_fespi_write_buffer().

fespi_txwm_wait()

static int fespi_txwm_wait ( struct flash_bank *  bank )

static

Definition at line 214 of file fespi.c.

References bank, ERROR_FAIL, ERROR_OK, ERROR_TARGET_TIMEOUT, FESPI_IP_TXWM, fespi_read_reg(), FESPI_REG_IP, LOG_ERROR, start, and timeval_ms().

Referenced by fespi_erase(), fespi_erase_sector(), fespi_read_flash_id(), fespi_write(), and slow_fespi_write_buffer().

fespi_wip()

static int fespi_wip ( struct flash_bank *  bank, int  timeout  )

static

Definition at line 278 of file fespi.c.

References alive_sleep(), bank, ERROR_FAIL, ERROR_OK, FESPI_CSMODE_AUTO, FESPI_CSMODE_HOLD, FESPI_DIR_RX, FESPI_DIR_TX, FESPI_REG_CSMODE, fespi_rx(), fespi_set_dir(), fespi_tx(), fespi_write_reg(), LOG_ERROR, NULL, SPIFLASH_BSY_BIT, SPIFLASH_READ_STATUS, and timeval_ms().

Referenced by fespi_erase(), fespi_erase_sector(), fespi_read_flash_id(), and fespi_write().

fespi_write()

static int fespi_write ( struct flash_bank *  bank, const uint8_t *  buffer, uint32_t  offset, uint32_t  count  )

static

Definition at line 481 of file fespi.c.

References working_area::address, ARRAY_SIZE, bank, buf_get_u64(), buf_set_u64(), buffer, count, fespi_flash_bank::ctrl_base, fespi_flash_bank::dev, ERROR_FAIL, ERROR_OK, ERROR_TARGET_NOT_HALTED, fespi_disable_hw_mode(), fespi_enable_hw_mode(), FESPI_PROBE_TIMEOUT, fespi_txwm_wait(), fespi_wip(), init_reg_param(), is_riscv(), LOG_DEBUG, LOG_ERROR, LOG_WARNING, MIN, NULL, offset, flash_device::pagesize, PARAM_IN_OUT, PARAM_OUT, flash_device::pprog_cmd, riscv32_bin, riscv64_bin, riscv_info(), riscv_xlen(), flash_device::size_in_bytes, slow_fespi_write_buffer(), SPIFLASH_DEF_PAGESIZE, target::state, TARGET_ADDR_FMT, target_alloc_working_area(), target_free_working_area(), target_get_working_area_avail(), TARGET_HALTED, TARGET_PRIxADDR, target_run_algorithm(), target_write_buffer(), reg_param::value, and riscv_info::xlen.

fespi_write_reg()

static int fespi_write_reg ( struct flash_bank *  bank, target_addr_t  address, uint32_t  value  )

static

Definition at line 174 of file fespi.c.

References bank, fespi_flash_bank::ctrl_base, ERROR_OK, LOG_ERROR, TARGET_ADDR_FMT, and target_write_u32().

Referenced by fespi_disable_hw_mode(), fespi_enable_hw_mode(), fespi_erase(), fespi_erase_sector(), fespi_probe(), fespi_read_flash_id(), fespi_set_dir(), fespi_tx(), fespi_wip(), and slow_fespi_write_buffer().

FLASH_BANK_COMMAND_HANDLER()

FLASH_BANK_COMMAND_HANDLER

(

fespi_flash_bank_command

)

Definition at line 133 of file fespi.c.

References bank, CMD_ARGC, CMD_ARGV, COMMAND_PARSE_ADDRESS, fespi_flash_bank::ctrl_base, ERROR_COMMAND_SYNTAX_ERROR, ERROR_FAIL, ERROR_OK, LOG_DEBUG, LOG_ERROR, fespi_flash_bank::probed, and TARGET_ADDR_FMT.

get_fespi_info()

static int get_fespi_info ( struct flash_bank *  bank, struct command_invocation *  cmd  )

static

Definition at line 834 of file fespi.c.

slow_fespi_write_buffer()

static int slow_fespi_write_buffer ( struct flash_bank *  bank, const uint8_t *  buffer, uint32_t  offset, uint32_t  len  )

static

Definition at line 429 of file fespi.c.

References bank, buffer, fespi_flash_bank::dev, ERROR_FAIL, ERROR_OK, FESPI_CSMODE_AUTO, FESPI_CSMODE_HOLD, FESPI_REG_CSMODE, fespi_tx(), fespi_txwm_wait(), fespi_write_reg(), keep_alive(), offset, flash_device::pprog_cmd, and SPIFLASH_WRITE_ENABLE.

Referenced by fespi_write().

Variable Documentation

fespi_flash

const struct flash_driver fespi_flash

Initial value:

= {
    .name = "fespi",
    .flash_bank_command = fespi_flash_bank_command,
    .erase = fespi_erase,
    .protect = fespi_protect,
    .write = fespi_write,
    .read = default_flash_read,
    .probe = fespi_probe,
    .auto_probe = fespi_auto_probe,
    .erase_check = default_flash_blank_check,
    .protect_check = fespi_protect_check,
    .info = get_fespi_info,
    .free_driver_priv = default_flash_free_driver_priv
}

Definition at line 834 of file fespi.c.

riscv32_bin

const uint8_t riscv32_bin[]

static

Initial value:

= {
}

Definition at line 473 of file fespi.c.

Referenced by fespi_write().

riscv64_bin

const uint8_t riscv64_bin[]

static

Initial value:

= {
}

Definition at line 477 of file fespi.c.

Referenced by fespi_write().

target_devices

const struct fespi_target target_devices[]

static

Initial value:

= {
    
    { "Freedom E310-G000 SPI Flash", 0x10e31913, 0x10014000 },
    { "Freedom E310-G002 SPI Flash", 0x20000913, 0x10014000 },
    { NULL, 0, 0 }
}

Definition at line 1 of file fespi.c.

Referenced by fespi_probe().