* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
+/* STM Serial Memory Interface (SMI) controller is a SPI bus controller
+ * specifically designed for SPI memories.
+ * Only SPI "mode 3" (CPOL=1 and CPHA=1) is supported.
+ * Two working modes are available:
+ * - SW mode: the SPI is controlled by SW. Any custom commands can be sent
+ * on the bus.
+ * - HW mode: the SPI but is under SMI control. Memory content is directly
+ * accessible in CPU memory space. CPU can read, write and execute memory
+ * content. */
+
/* ATTENTION:
* To have flash memory mapped in CPU memory space, the SMI controller
* have to be in "HW mode". This requires following constraints:
#endif
#include "imp.h"
-#include "spearsmi.h"
#include <jtag/jtag.h>
#include <helper/time_support.h>
-#define JTAG_ID_3XX_6XX (0x07926041)
-
#define SMI_READ_REG(a) (_SMI_READ_REG(a))
#define _SMI_READ_REG(a) \
{ \
#define SMI_BANK_SIZE (0x01000000)
-#define SMI_BASE_3XX_6XX (0xf8000000)
-#define SMI_CFGREG_3XX_6XX (0xfc000000)
-
-/* #define SMI_BASE_13XX (0xe6000000) */
-/* #define SMI_CFGREG_13XX (0xea000000) */
-
#define SMI_CR1 (0x00) /* Control register 1 */
#define SMI_CR2 (0x04) /* Control register 2 */
#define SMI_SR (0x08) /* Status register */
#define SMI_PROBE_TIMEOUT (100)
#define SMI_MAX_TIMEOUT (3000)
+struct stmsmi_flash_bank
+{
+ int probed;
+ uint32_t io_base;
+ uint32_t bank_num;
+ struct flash_device *dev;
+};
+
/* data structure to maintain flash ids from different vendors */
struct flash_device {
char *name;
.size_in_bytes = size \
}
+/* List below is taken from Linux driver. It is not exhaustive of all the
+ * possible SPI memories, nor exclusive for SMI. Could be shared with
+ * other SPI drivers. */
static struct flash_device flash_devices[] = {
/* name, erase_cmd, device_id, pagesize, sectorsize, size_in_bytes */
FLASH_ID("st m25p05", 0xd8, 0x00102020, 0x80, 0x8000, 0x10000),
FLASH_ID(NULL, 0, 0, 0, 0, 0)
};
-FLASH_BANK_COMMAND_HANDLER(spearsmi_flash_bank_command)
+struct stmsmi_target {
+ char *name;
+ uint32_t tap_idcode;
+ uint32_t smi_base;
+ uint32_t io_base;
+};
+
+static struct stmsmi_target target_devices[] = {
+ /* name, tap_idcode, smi_base, io_base */
+ { "SPEAr3xx/6xx", 0x07926041, 0xf8000000, 0xfc000000 },
+ { "STR75x", 0x4f1f0041, 0x80000000, 0x90000000 },
+ { NULL, 0, 0, 0 }
+};
+
+FLASH_BANK_COMMAND_HANDLER(stmsmi_flash_bank_command)
{
- struct spearsmi_flash_bank *spearsmi_info;
+ struct stmsmi_flash_bank *stmsmi_info;
LOG_DEBUG(__FUNCTION__);
if (CMD_ARGC < 6)
{
- LOG_WARNING("incomplete flash_bank spearsmi configuration");
+ LOG_WARNING("incomplete flash_bank stmsmi configuration");
return ERROR_FLASH_BANK_INVALID;
}
- spearsmi_info = malloc(sizeof(struct spearsmi_flash_bank));
- if (spearsmi_info == NULL)
+ stmsmi_info = malloc(sizeof(struct stmsmi_flash_bank));
+ if (stmsmi_info == NULL)
{
LOG_ERROR("not enough memory");
return ERROR_FAIL;
}
- bank->driver_priv = spearsmi_info;
- spearsmi_info->probed = 0;
+ bank->driver_priv = stmsmi_info;
+ stmsmi_info->probed = 0;
return ERROR_OK;
}
return ERROR_FLASH_OPERATION_FAILED;
}
+/* Read the status register of the external SPI flash chip.
+ * The operation is triggered by setting SMI_RSR bit.
+ * SMI sends the proper SPI command (0x05) and returns value in SMI_SR */
static int read_status_reg(struct flash_bank *bank, uint32_t *status)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
/* clear transmit finished flag */
SMI_CLEAR_TFF();
/* Read status */
- SMI_WRITE_REG(SMI_CR2, spearsmi_info->bank_num | SMI_RSR);
+ SMI_WRITE_REG(SMI_CR2, stmsmi_info->bank_num | SMI_RSR);
/* Poll transmit finished flag */
SMI_POLL_TFF(SMI_CMD_TIMEOUT);
/* clear transmit finished flag */
SMI_CLEAR_TFF();
- /* Check write enabled */
*status = SMI_READ_REG(SMI_SR) & 0x0000ffff;
/* clean-up SMI_CR2 */
return ERROR_FAIL;
}
+/* Send "write enable" command to SPI flash chip.
+ * The operation is triggered by setting SMI_WE bit, and SMI sends
+ * the proper SPI command (0x06) */
static int smi_write_enable(struct flash_bank *bank)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
uint32_t status;
int retval;
SMI_CLEAR_TFF();
/* Send write enable command */
- SMI_WRITE_REG(SMI_CR2, spearsmi_info->bank_num | SMI_WE);
+ SMI_WRITE_REG(SMI_CR2, stmsmi_info->bank_num | SMI_WE);
/* Poll transmit finished flag */
SMI_POLL_TFF(SMI_CMD_TIMEOUT);
return ERROR_OK;
}
-static uint32_t erase_command(struct spearsmi_flash_bank *spearsmi_info,
+static uint32_t erase_command(struct stmsmi_flash_bank *stmsmi_info,
uint32_t offset)
{
union {
uint8_t x[4];
} cmd;
- cmd.x[0] = spearsmi_info->dev->erase_cmd;
+ cmd.x[0] = stmsmi_info->dev->erase_cmd;
cmd.x[1] = offset >> 16;
cmd.x[2] = offset >> 8;
cmd.x[3] = offset;
static int smi_erase_sector(struct flash_bank *bank, int sector)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
uint32_t cmd;
int retval;
/* clear transmit finished flag */
SMI_CLEAR_TFF();
- /* send erase command */
- cmd = erase_command(spearsmi_info, bank->sectors[sector].offset);
+ /* send SPI command "block erase" */
+ cmd = erase_command(stmsmi_info, bank->sectors[sector].offset);
SMI_WRITE_REG(SMI_TR, cmd);
- SMI_WRITE_REG(SMI_CR2, spearsmi_info->bank_num | SMI_SEND | SMI_TX_LEN_4);
+ SMI_WRITE_REG(SMI_CR2, stmsmi_info->bank_num | SMI_SEND | SMI_TX_LEN_4);
/* Poll transmit finished flag */
SMI_POLL_TFF(SMI_CMD_TIMEOUT);
return ERROR_OK;
}
-static int spearsmi_erase(struct flash_bank *bank, int first, int last)
+static int stmsmi_erase(struct flash_bank *bank, int first, int last)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
int retval = ERROR_OK;
int sector;
return ERROR_FLASH_SECTOR_INVALID;
}
- if (!(spearsmi_info->probed))
+ if (!(stmsmi_info->probed))
{
LOG_ERROR("Flash bank not probed");
return ERROR_FLASH_BANK_NOT_PROBED;
return retval;
}
-static int spearsmi_protect(struct flash_bank *bank, int set,
+static int stmsmi_protect(struct flash_bank *bank, int set,
int first, int last)
{
int sector;
uint32_t address, uint32_t len)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
int retval;
LOG_DEBUG("%s: address=0x%08" PRIx32 " len=0x%08" PRIx32,
return ERROR_OK;
}
-static int spearsmi_write(struct flash_bank *bank, uint8_t *buffer,
+static int stmsmi_write(struct flash_bank *bank, uint8_t *buffer,
uint32_t offset, uint32_t count)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
uint32_t cur_count, page_size, page_offset;
int sector;
int retval = ERROR_OK;
return ERROR_TARGET_NOT_HALTED;
}
- if (offset + count > spearsmi_info->dev->size_in_bytes)
+ if (offset + count > stmsmi_info->dev->size_in_bytes)
{
LOG_WARNING("Write pasts end of flash. Extra data discarded.");
- count = spearsmi_info->dev->size_in_bytes - offset;
+ count = stmsmi_info->dev->size_in_bytes - offset;
}
/* Check sector protection */
}
}
- page_size = spearsmi_info->dev->pagesize;
+ page_size = stmsmi_info->dev->pagesize;
/* unaligned buffer head */
if (count > 0 && (offset & 3) != 0)
static int read_flash_id(struct flash_bank *bank, uint32_t *id)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- uint32_t io_base = spearsmi_info->io_base;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ uint32_t io_base = stmsmi_info->io_base;
int retval;
if (target->state != TARGET_HALTED)
/* clear transmit finished flag */
SMI_CLEAR_TFF();
- /* Require read flash ID */
+ /* Send SPI command "read ID" */
SMI_WRITE_REG(SMI_TR, SMI_READ_ID);
SMI_WRITE_REG(SMI_CR2,
- spearsmi_info->bank_num | SMI_SEND | SMI_RX_LEN_3 | SMI_TX_LEN_1);
+ stmsmi_info->bank_num | SMI_SEND | SMI_RX_LEN_3 | SMI_TX_LEN_1);
/* Poll transmit finished flag */
SMI_POLL_TFF(SMI_CMD_TIMEOUT);
/* clear transmit finished flag */
SMI_CLEAR_TFF();
- /* read ID */
+ /* read ID from Receive Register */
*id = SMI_READ_REG(SMI_RR) & 0x00ffffff;
return ERROR_OK;
}
-static int spearsmi_probe(struct flash_bank *bank)
+static int stmsmi_probe(struct flash_bank *bank)
{
struct target *target = bank->target;
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
uint32_t io_base;
struct flash_sector *sectors;
uint32_t id = 0; /* silence uninitialized warning */
+ struct stmsmi_target *target_device;
int retval;
- if (spearsmi_info->probed)
+ if (stmsmi_info->probed)
free(bank->sectors);
- spearsmi_info->probed = 0;
+ stmsmi_info->probed = 0;
- /* check for SPEAr device */
- switch (target->tap->idcode)
- {
- case JTAG_ID_3XX_6XX:
- /* SPEAr3xx/6xx */
- spearsmi_info->io_base = SMI_CFGREG_3XX_6XX;
- switch (bank->base)
- {
- case SMI_BASE_3XX_6XX:
- spearsmi_info->bank_num = SMI_SEL_BANK0;
- break;
- case SMI_BASE_3XX_6XX + SMI_BANK_SIZE:
- spearsmi_info->bank_num = SMI_SEL_BANK1;
- break;
- case SMI_BASE_3XX_6XX + 2*SMI_BANK_SIZE:
- spearsmi_info->bank_num = SMI_SEL_BANK2;
- break;
- case SMI_BASE_3XX_6XX + 3*SMI_BANK_SIZE:
- spearsmi_info->bank_num = SMI_SEL_BANK3;
- break;
- default:
- LOG_ERROR("Invalid base address 0x%" PRIx32, bank->base);
- return ERROR_FAIL;
- }
+ for (target_device=target_devices ; target_device->name ; ++target_device)
+ if (target_device->tap_idcode == target->tap->idcode)
break;
+ if (!target_device->name)
+ {
+ LOG_ERROR("Device ID 0x%" PRIx32 " is not known as SMI capable",
+ target->tap->idcode);
+ return ERROR_FAIL;
+ }
+ switch (bank->base - target_device->smi_base)
+ {
+ case 0:
+ stmsmi_info->bank_num = SMI_SEL_BANK0;
+ break;
+ case SMI_BANK_SIZE:
+ stmsmi_info->bank_num = SMI_SEL_BANK1;
+ break;
+ case 2*SMI_BANK_SIZE:
+ stmsmi_info->bank_num = SMI_SEL_BANK2;
+ break;
+ case 3*SMI_BANK_SIZE:
+ stmsmi_info->bank_num = SMI_SEL_BANK3;
+ break;
default:
- LOG_ERROR("0x%" PRIx32 " is invalid id for SPEAr device",
- target->tap->idcode);
+ LOG_ERROR("Invalid SMI base address 0x%" PRIx32, bank->base);
return ERROR_FAIL;
}
- io_base = spearsmi_info->io_base;
+ io_base = target_device->io_base;
+ stmsmi_info->io_base = io_base;
+
+ LOG_DEBUG("Valid SMI on device %s at address 0x%" PRIx32,
+ target_device->name, bank->base);
/* read and decode flash ID; returns in SW mode */
retval = read_flash_id(bank, &id);
if (retval != ERROR_OK)
return retval;
+ stmsmi_info->dev = NULL;
for (struct flash_device *p = flash_devices; p->name ; p++)
if (p->device_id == id) {
- spearsmi_info->dev = p;
+ stmsmi_info->dev = p;
break;
}
- if (!spearsmi_info->dev)
+ if (!stmsmi_info->dev)
{
LOG_ERROR("Unknown flash device (ID 0x%08" PRIx32 ")", id);
return ERROR_FAIL;
}
LOG_INFO("Found flash device \'%s\' (ID 0x%08" PRIx32 ")",
- spearsmi_info->dev->name, spearsmi_info->dev->device_id);
+ stmsmi_info->dev->name, stmsmi_info->dev->device_id);
/* Set correct size value */
- bank->size = spearsmi_info->dev->size_in_bytes;
+ bank->size = stmsmi_info->dev->size_in_bytes;
/* create and fill sectors array */
bank->num_sectors =
- spearsmi_info->dev->size_in_bytes / spearsmi_info->dev->sectorsize;
+ stmsmi_info->dev->size_in_bytes / stmsmi_info->dev->sectorsize;
sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
if (sectors == NULL)
{
for (int sector = 0; sector < bank->num_sectors; sector++)
{
- sectors[sector].offset = sector * spearsmi_info->dev->sectorsize;
- sectors[sector].size = spearsmi_info->dev->sectorsize;
+ sectors[sector].offset = sector * stmsmi_info->dev->sectorsize;
+ sectors[sector].size = stmsmi_info->dev->sectorsize;
sectors[sector].is_erased = -1;
sectors[sector].is_protected = 1;
}
bank->sectors = sectors;
- spearsmi_info->probed = 1;
+ stmsmi_info->probed = 1;
return ERROR_OK;
}
-static int spearsmi_auto_probe(struct flash_bank *bank)
+static int stmsmi_auto_probe(struct flash_bank *bank)
{
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
- if (spearsmi_info->probed)
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
+ if (stmsmi_info->probed)
return ERROR_OK;
- return spearsmi_probe(bank);
+ return stmsmi_probe(bank);
}
-static int spearsmi_protect_check(struct flash_bank *bank)
+static int stmsmi_protect_check(struct flash_bank *bank)
{
/* Nothing to do. Protection is only handled in SW. */
return ERROR_OK;
}
-static int get_spearsmi_info(struct flash_bank *bank, char *buf, int buf_size)
+static int get_stmsmi_info(struct flash_bank *bank, char *buf, int buf_size)
{
- struct spearsmi_flash_bank *spearsmi_info = bank->driver_priv;
+ struct stmsmi_flash_bank *stmsmi_info = bank->driver_priv;
int printed;
- if (!(spearsmi_info->probed))
+ if (!(stmsmi_info->probed))
{
printed = snprintf(buf, buf_size,
- "\nSPEAr SMI flash bank not probed yet\n");
+ "\nSMI flash bank not probed yet\n");
return ERROR_OK;
}
- printed = snprintf(buf, buf_size, "\nSPEAr SMI flash information:\n"
+ printed = snprintf(buf, buf_size, "\nSMI flash information:\n"
" Device \'%s\' (ID 0x%08x)\n",
- spearsmi_info->dev->name, spearsmi_info->dev->device_id);
+ stmsmi_info->dev->name, stmsmi_info->dev->device_id);
buf += printed;
buf_size -= printed;
return ERROR_OK;
}
-struct flash_driver spearsmi_flash = {
- .name = "spearsmi",
- .flash_bank_command = spearsmi_flash_bank_command,
- .erase = spearsmi_erase,
- .protect = spearsmi_protect,
- .write = spearsmi_write,
+struct flash_driver stmsmi_flash = {
+ .name = "stmsmi",
+ .flash_bank_command = stmsmi_flash_bank_command,
+ .erase = stmsmi_erase,
+ .protect = stmsmi_protect,
+ .write = stmsmi_write,
.read = default_flash_read,
- .probe = spearsmi_probe,
- .auto_probe = spearsmi_auto_probe,
+ .probe = stmsmi_probe,
+ .auto_probe = stmsmi_auto_probe,
.erase_check = default_flash_blank_check,
- .protect_check = spearsmi_protect_check,
- .info = get_spearsmi_info,
+ .protect_check = stmsmi_protect_check,
+ .info = get_stmsmi_info,
};