////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
//
|
//
|
// Filename: flashdrvr.cpp
|
// Filename: flashdrvr.cpp
|
//
|
//
|
// Project: XuLA2-LX25 System on a Chip
|
// Project: XuLA2-LX25 System on a Chip
|
//
|
//
|
// Purpose: Flash driver. Encapsulate writing to the flash device.
|
// Purpose: Flash driver. Encapsulate writing to the flash device.
|
//
|
//
|
// Creator: Dan Gisselquist
|
// Creator: Dan Gisselquist
|
// Gisselquist Tecnology, LLC
|
// Gisselquist Tecnology, LLC
|
//
|
//
|
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
//
|
//
|
// Copyright (C) 2016, Gisselquist Technology, LLC
|
// Copyright (C) 2016, Gisselquist Technology, LLC
|
//
|
//
|
// This program is free software (firmware): you can redistribute it and/or
|
// This program is free software (firmware): you can redistribute it and/or
|
// modify it under the terms of the GNU General Public License as published
|
// modify it under the terms of the GNU General Public License as published
|
// by the Free Software Foundation, either version 3 of the License, or (at
|
// by the Free Software Foundation, either version 3 of the License, or (at
|
// your option) any later version.
|
// your option) any later version.
|
//
|
//
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
|
// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// for more details.
|
// for more details.
|
//
|
//
|
// License: GPL, v3, as defined and found on www.gnu.org,
|
// License: GPL, v3, as defined and found on www.gnu.org,
|
// http://www.gnu.org/licenses/gpl.html
|
// http://www.gnu.org/licenses/gpl.html
|
//
|
//
|
//
|
//
|
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
//
|
//
|
//
|
//
|
//
|
//
|
#include <stdio.h>
|
#include <stdio.h>
|
#include <stdlib.h>
|
#include <stdlib.h>
|
#include <unistd.h>
|
#include <unistd.h>
|
#include <strings.h>
|
#include <strings.h>
|
#include <ctype.h>
|
#include <ctype.h>
|
#include <string.h>
|
#include <string.h>
|
#include <signal.h>
|
#include <signal.h>
|
#include <assert.h>
|
#include <assert.h>
|
|
|
#include "port.h"
|
#include "port.h"
|
#include "regdefs.h"
|
#include "regdefs.h"
|
#include "flashdrvr.h"
|
#include "flashdrvr.h"
|
|
|
const bool HIGH_SPEED = false;
|
const bool HIGH_SPEED = false;
|
|
|
void FLASHDRVR::flwait(void) {
|
void FLASHDRVR::flwait(void) {
|
DEVBUS::BUSW v;
|
DEVBUS::BUSW v;
|
|
|
v = m_fpga->readio(R_QSPI_EREG);
|
v = m_fpga->readio(R_QSPI_EREG);
|
if ((v&ERASEFLAG)==0)
|
if ((v&ERASEFLAG)==0)
|
return;
|
return;
|
m_fpga->writeio(R_ICONTROL, ISPIF_DIS);
|
m_fpga->writeio(R_ICONTROL, ISPIF_DIS);
|
m_fpga->clear();
|
m_fpga->clear();
|
m_fpga->writeio(R_ICONTROL, ISPIF_EN);
|
m_fpga->writeio(R_ICONTROL, ISPIF_EN);
|
|
|
do {
|
do {
|
// Start by checking that we are still erasing. The interrupt
|
// Start by checking that we are still erasing. The interrupt
|
// may have been generated while we were setting things up and
|
// may have been generated while we were setting things up and
|
// disabling things, so this just double checks for us. If
|
// disabling things, so this just double checks for us. If
|
// the interrupt was tripped, we're done. If not, we can now
|
// the interrupt was tripped, we're done. If not, we can now
|
// wait for an interrupt.
|
// wait for an interrupt.
|
v = m_fpga->readio(R_QSPI_EREG);
|
v = m_fpga->readio(R_QSPI_EREG);
|
if (v&ERASEFLAG) {
|
if (v&ERASEFLAG) {
|
m_fpga->usleep(400);
|
m_fpga->usleep(400);
|
if (m_fpga->poll()) {
|
if (m_fpga->poll()) {
|
m_fpga->clear();
|
m_fpga->clear();
|
m_fpga->writeio(R_ICONTROL, ISPIF_EN);
|
m_fpga->writeio(R_ICONTROL, ISPIF_EN);
|
}
|
}
|
}
|
}
|
} while(v & ERASEFLAG);
|
} while(v & ERASEFLAG);
|
}
|
}
|
|
|
bool FLASHDRVR::erase_sector(const unsigned sector, const bool verify_erase) {
|
bool FLASHDRVR::erase_sector(const unsigned sector, const bool verify_erase) {
|
DEVBUS::BUSW page[SZPAGE];
|
DEVBUS::BUSW page[SZPAGE];
|
|
|
printf("Erasing sector: %08x\n", sector);
|
printf("Erasing sector: %08x\n", sector);
|
m_fpga->writeio(R_QSPI_EREG, DISABLEWP);
|
m_fpga->writeio(R_QSPI_EREG, DISABLEWP);
|
m_fpga->writeio(R_QSPI_EREG, ERASEFLAG + sector);
|
m_fpga->writeio(R_QSPI_EREG, ERASEFLAG + sector);
|
|
|
// If we're in high speed mode and we want to verify the erase, then
|
// If we're in high speed mode and we want to verify the erase, then
|
// we can skip waiting for the erase to complete by issueing a read
|
// we can skip waiting for the erase to complete by issueing a read
|
// command immediately. As soon as the erase completes the read will
|
// command immediately. As soon as the erase completes the read will
|
// begin sending commands back. This allows us to recover the lost
|
// begin sending commands back. This allows us to recover the lost
|
// time between the interrupt and the next command being received.
|
// time between the interrupt and the next command being received.
|
if ((!HIGH_SPEED)||(!verify_erase)) {
|
if ((!HIGH_SPEED)||(!verify_erase)) {
|
flwait();
|
flwait();
|
|
|
printf("@%08x -> %08x\n", R_QSPI_EREG,
|
printf("@%08x -> %08x\n", R_QSPI_EREG,
|
m_fpga->readio(R_QSPI_EREG));
|
m_fpga->readio(R_QSPI_EREG));
|
printf("@%08x -> %08x\n", R_QSPI_SREG,
|
printf("@%08x -> %08x\n", R_QSPI_SREG,
|
m_fpga->readio(R_QSPI_SREG));
|
m_fpga->readio(R_QSPI_SREG));
|
printf("@%08x -> %08x\n", sector,
|
printf("@%08x -> %08x\n", sector,
|
m_fpga->readio(sector));
|
m_fpga->readio(sector));
|
}
|
}
|
|
|
// Now, let's verify that we erased the sector properly
|
// Now, let's verify that we erased the sector properly
|
if (verify_erase) {
|
if (verify_erase) {
|
for(int i=0; i<NPAGES; i++) {
|
for(int i=0; i<NPAGES; i++) {
|
m_fpga->readi(sector+i*SZPAGE, SZPAGE, page);
|
m_fpga->readi(sector+i*SZPAGE, SZPAGE, page);
|
for(int i=0; i<SZPAGE; i++)
|
for(int i=0; i<SZPAGE; i++)
|
if (page[i] != 0xffffffff)
|
if (page[i] != 0xffffffff)
|
return false;
|
return false;
|
}
|
}
|
}
|
}
|
|
|
return true;
|
return true;
|
}
|
}
|
|
|
bool FLASHDRVR::write_page(const unsigned addr, const unsigned len,
|
bool FLASHDRVR::write_page(const unsigned addr, const unsigned len,
|
const unsigned *data, const bool verify_write) {
|
const unsigned *data, const bool verify_write) {
|
DEVBUS::BUSW buf[SZPAGE];
|
DEVBUS::BUSW buf[SZPAGE];
|
|
|
assert(len > 0);
|
assert(len > 0);
|
assert(len <= PGLEN);
|
assert(len <= PGLEN);
|
assert(PAGEOF(addr)==PAGEOF(addr+len-1));
|
assert(PAGEOF(addr)==PAGEOF(addr+len-1));
|
|
|
if (len <= 0)
|
if (len <= 0)
|
return true;
|
return true;
|
|
|
// Write the page
|
// Write the page
|
m_fpga->writeio(R_ICONTROL, ISPIF_DIS);
|
m_fpga->writeio(R_ICONTROL, ISPIF_DIS);
|
m_fpga->clear();
|
m_fpga->clear();
|
m_fpga->writeio(R_ICONTROL, ISPIF_EN);
|
m_fpga->writeio(R_ICONTROL, ISPIF_EN);
|
printf("Writing page: 0x%08x - 0x%08x\n", addr, addr+len-1);
|
printf("Writing page: 0x%08x - 0x%08x\n", addr, addr+len-1);
|
m_fpga->writeio(R_QSPI_EREG, DISABLEWP);
|
m_fpga->writeio(R_QSPI_EREG, DISABLEWP);
|
m_fpga->writei(addr, len, data);
|
m_fpga->writei(addr, len, data);
|
|
|
// If we're in high speed mode and we want to verify the write, then
|
// If we're in high speed mode and we want to verify the write, then
|
// we can skip waiting for the write to complete by issueing a read
|
// we can skip waiting for the write to complete by issueing a read
|
// command immediately. As soon as the write completes the read will
|
// command immediately. As soon as the write completes the read will
|
// begin sending commands back. This allows us to recover the lost
|
// begin sending commands back. This allows us to recover the lost
|
// time between the interrupt and the next command being received.
|
// time between the interrupt and the next command being received.
|
if ((!HIGH_SPEED)||(!verify_write)) {
|
|
flwait();
|
flwait();
|
} if (verify_write) {
|
// if ((!HIGH_SPEED)||(!verify_write)) { }
|
|
if (verify_write) {
|
|
// printf("Attempting to verify page\n");
|
// NOW VERIFY THE PAGE
|
// NOW VERIFY THE PAGE
|
m_fpga->readi(addr, len, buf);
|
m_fpga->readi(addr, len, buf);
|
for(unsigned i=0; i<len; i++) {
|
for(unsigned i=0; i<len; i++) {
|
if (buf[i] != data[i]) {
|
if (buf[i] != data[i]) {
|
printf("\nVERIFY FAILS[%d]: %08x\n", i, i+addr);
|
printf("\nVERIFY FAILS[%d]: %08x\n", i, i+addr);
|
printf("\t(Flash[%d]) %08x != %08x (Goal[%08x])\n",
|
printf("\t(Flash[%d]) %08x != %08x (Goal[%08x])\n",
|
i, buf[i], data[i], i+addr);
|
i, buf[i], data[i], i+addr);
|
return false;
|
return false;
|
}
|
}
|
}
|
}
|
} return true;
|
} return true;
|
}
|
}
|
|
|
bool FLASHDRVR::write(const unsigned addr, const unsigned len,
|
bool FLASHDRVR::write(const unsigned addr, const unsigned len,
|
const unsigned *data, const bool verify) {
|
const unsigned *data, const bool verify) {
|
// Work through this one sector at a time.
|
// Work through this one sector at a time.
|
// If this buffer is equal to the sector value(s), go on
|
// If this buffer is equal to the sector value(s), go on
|
// If not, erase the sector
|
// If not, erase the sector
|
|
|
// m_fpga->writeio(R_QSPI_CREG, 2);
|
// m_fpga->writeio(R_QSPI_CREG, 2);
|
// m_fpga->readio(R_VERSION); // Read something innocuous
|
// m_fpga->readio(R_VERSION); // Read something innocuous
|
// m_fpga->writeio(R_QSPI_SREG, 0);
|
// m_fpga->writeio(R_QSPI_SREG, 0);
|
// m_fpga->readio(R_VERSION); // Read something innocuous
|
// m_fpga->readio(R_VERSION); // Read something innocuous
|
|
|
for(unsigned s=SECTOROF(addr); s<SECTOROF(addr+len+SECTORSZ-1); s+=SECTORSZ) {
|
for(unsigned s=SECTOROF(addr); s<SECTOROF(addr+len+SECTORSZ-1); s+=SECTORSZ) {
|
// printf("IN LOOP, s=%08x\n", s);
|
// printf("IN LOOP, s=%08x\n", s);
|
// Do we need to erase?
|
// Do we need to erase?
|
bool need_erase = false;
|
bool need_erase = false;
|
unsigned newv = 0; // (s<addr)?addr:s;
|
unsigned newv = 0; // (s<addr)?addr:s;
|
{
|
{
|
DEVBUS::BUSW *sbuf = new DEVBUS::BUSW[SECTORSZ];
|
DEVBUS::BUSW *sbuf = new DEVBUS::BUSW[SECTORSZ];
|
const DEVBUS::BUSW *dp;
|
const DEVBUS::BUSW *dp;
|
unsigned base,ln;
|
unsigned base,ln;
|
base = (addr>s)?addr:s;
|
base = (addr>s)?addr:s;
|
ln=((addr+len>s+SECTORSZ)?(s+SECTORSZ):(addr+len))-base;
|
ln=((addr+len>s+SECTORSZ)?(s+SECTORSZ):(addr+len))-base;
|
m_fpga->readi(base, ln, sbuf);
|
m_fpga->readi(base, ln, sbuf);
|
|
|
dp = &data[base-addr];
|
dp = &data[base-addr];
|
for(unsigned i=0; i<ln; i++) {
|
for(unsigned i=0; i<ln; i++) {
|
if ((sbuf[i]&dp[i]) != dp[i]) {
|
if ((sbuf[i]&dp[i]) != dp[i]) {
|
printf("\nNEED-ERASE @0x%08x ... %08x != %08x (Goal)\n",
|
printf("\nNEED-ERASE @0x%08x ... %08x != %08x (Goal)\n",
|
i+base-addr, sbuf[i], dp[i]);
|
i+base, sbuf[i], dp[i]);
|
need_erase = true;
|
need_erase = true;
|
newv = i+base;
|
newv = i+base;
|
break;
|
break;
|
} else if ((sbuf[i] != dp[i])&&(newv == 0)) {
|
} else if ((sbuf[i] != dp[i])&&(newv == 0)) {
|
// if (newv == 0)
|
// if (newv == 0)
|
// printf("MEM[%08x] = %08x (!= %08x (Goal))\n",
|
// printf("MEM[%08x] = %08x (!= %08x (Goal))\n",
|
// i+base, sbuf[i], dp[i]);
|
// i+base, sbuf[i], dp[i]);
|
newv = i+base;
|
newv = i+base;
|
}
|
}
|
}
|
}
|
}
|
}
|
|
|
if (newv == 0)
|
if (newv == 0)
|
continue; // This sector already matches
|
continue; // This sector already matches
|
|
|
// Just erase anyway
|
// Just erase anyway
|
if ((need_erase)&&(!erase_sector(s, verify))) {
|
if (!need_erase)
|
printf("SECTOR ERASE FAILED!\n");
|
|
return false;
|
|
} else if (!need_erase)
|
|
printf("NO ERASE NEEDED\n");
|
printf("NO ERASE NEEDED\n");
|
else {
|
else {
|
printf("ERASING SECTOR %08x\n", s);
|
printf("ERASING SECTOR: %08x\n", s);
|
newv = (s<addr) ? addr : s;
|
if (!erase_sector(s, verify)) {
|
|
printf("SECTOR ERASE FAILED!\n");
|
|
return false;
|
|
} newv = (s<addr) ? addr : s;
|
}
|
}
|
for(unsigned p=newv; (p<s+SECTORSZ)&&(p<addr+len); p=PAGEOF(p+PGLEN))
|
for(unsigned p=newv; (p<s+SECTORSZ)&&(p<addr+len); p=PAGEOF(p+PGLEN)) {
|
if (!write_page(p, (p+PGLEN<addr+len)
|
unsigned start = p, len = addr+len-start;
|
?((PAGEOF(p)!=PAGEOF(p+PGLEN-1))?(PAGEOF(p+PGLEN-1)-p):PGLEN)
|
|
:(addr+len-p), &data[p-addr]), verify) {
|
// BUT! if we cross page boundaries, we need to clip
|
|
// our results to the page boundary
|
|
if (PAGEOF(start+len-1)!=PAGEOF(start))
|
|
len = PAGEOF(start+PGLEN)-start;
|
|
if (!write_page(start, len, &data[p-addr], verify)) {
|
printf("WRITE-PAGE FAILED!\n");
|
printf("WRITE-PAGE FAILED!\n");
|
return false;
|
return false;
|
}
|
}
|
|
}
|
}
|
}
|
|
|
m_fpga->writeio(R_QSPI_EREG, 0); // Re-enable write protection
|
m_fpga->writeio(R_QSPI_EREG, 0); // Re-enable write protection
|
|
|
return true;
|
return true;
|
}
|
}
|
|
|
|
|
