mac-rom-simm-programmer/external_mem.c

/*
 * external_mem.c
 *
 *  Created on: Nov 25, 2011
 *      Author: Doug
 *
 * Copyright (C) 2011-2012 Doug Brown
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */

#include "external_mem.h"
#include "ports.h"
#include <avr/io.h>
#include <util/delay.h>

#define HIGHEST_ADDRESS_LINE	20

// Default setup
static ChipType curChipType = ChipType8BitData_4MBitSize;

// Private functions
uint32_t ExternalMem_MaskForChips(uint8_t chips);
void ExternalMem_WaitCompletion(uint8_t chipsMask);

// Allow this to be initialized more than once.
// In case we mess with the port settings,
// re-initializing ExternalMem should reset everything
// to sensible defaults.
void ExternalMem_Init(void)
{
	// Initialize the ports connected to address/data/control lines
	Ports_Init();

	// Configure all address lines as outputs
	Ports_SetAddressDDR((1UL << (HIGHEST_ADDRESS_LINE + 1)) - 1);

	// Set all data lines as inputs
	Ports_SetDataDDR(0);

	// Disable all pull-ups on the data lines. They aren't needed
	// for normal operation.
	Ports_DataPullups_RMW(0, 0xFFFFFFFFUL);

	// Sensible defaults for address lines:
	// Write out address zero
	Ports_SetAddressOut(0);

	// Control lines
	Ports_SetCSDDR(1);
	Ports_SetOEDDR(1);
	Ports_SetWEDDR(1);

	// Default all control lines to high (de-asserted)
	ExternalMem_Deassert(SIMM_CS | SIMM_OE | SIMM_WE);
}

void ExternalMem_SetAddress(uint32_t address)
{
	Ports_SetAddressOut(address);
}

void ExternalMem_SetData(uint32_t data)
{
	Ports_SetDataDDR(0xFFFFFFFFUL);
	Ports_SetDataOut(data);
}

void ExternalMem_SetAddressAndData(uint32_t address, uint32_t data)
{
	ExternalMem_SetAddress(address);
	ExternalMem_SetData(data);
}

void ExternalMem_SetDataAsInput(void)
{
	Ports_SetDataDDR(0);
	// enable pull-ups as well -- this will give default values if a chip is
	// not responding.
	Ports_DataPullups_RMW(0xFFFFFFFFUL, 0xFFFFFFFFUL);
}

uint32_t ExternalMem_ReadData(void)
{
	return Ports_ReadData();
}

void ExternalMem_Read(uint32_t startAddress, uint32_t *buf, uint32_t len)
{
	// This is just a time saver if we know we will
	// be reading a complete block -- doesn't bother
	// playing with the control lines between each byte
	ExternalMem_Deassert(SIMM_WE);
	ExternalMem_SetDataAsInput();
	ExternalMem_Assert(SIMM_CS | SIMM_OE);

	while (len--)
	{
		ExternalMem_SetAddress(startAddress++);
		// Shouldn't need to wait here. Each clock cycle at 16 MHz is 62.5 nanoseconds, so by the time the SPI
		// read has been signaled with the SPI chip, there will DEFINITELY be good data on the data bus.
		// (Considering these chips will be in the 70 ns or 140 ns range, that's only a few clock cycles at most)
		*buf++ = ExternalMem_ReadData();
	}
}

void ExternalMem_WriteCycle(uint32_t address, uint32_t data)
{
	ExternalMem_Assert(SIMM_CS);
	ExternalMem_Deassert(SIMM_OE | SIMM_WE);
	ExternalMem_SetAddressAndData(address, data);
	ExternalMem_Assert(SIMM_WE);
	ExternalMem_Deassert(SIMM_WE);
}

uint32_t ExternalMem_ReadCycle(uint32_t address)
{
	ExternalMem_Deassert(SIMM_WE);
	ExternalMem_SetDataAsInput();
	ExternalMem_Assert(SIMM_CS | SIMM_OE);
	ExternalMem_SetAddress(address);
	uint32_t tmp = ExternalMem_ReadData();
	ExternalMem_Deassert(SIMM_OE);
	return tmp;
}

uint32_t ExternalMem_MaskForChips(uint8_t chips)
{
	// This is a private function we can use to
	// ignore results from chips we don't want to address
	// (or to stop from programming them)
	uint32_t mask = 0;

	if (chips & (1 << 0))
	{
		mask |= 0x000000FFUL;
	}
	if (chips & (1 << 1))
	{
		mask |= 0x0000FF00UL;
	}
	if (chips & (1 << 2))
	{
		mask |= 0x00FF0000UL;
	}
	if (chips & (1 << 3))
	{
		mask |= 0xFF000000UL;
	}

	return mask;
}

void ExternalMem_UnlockChips(uint8_t chipsMask)
{
	// Use a mask so we don't unlock chips we don't want to talk with
	uint32_t mask = ExternalMem_MaskForChips(chipsMask);

	// The unlock sequence changes depending on the chip
	if (curChipType == ChipType8BitData_4MBitSize)
	{
		// First part of unlock sequence:
		// Write 0x55555555 to the address bus and 0xAA to the data bus
		// (Some datasheets may only say 0x555 or 0x5555, but they ignore
		// the upper bits, so writing the alternating pattern to all address lines
		// should make it compatible with larger chips)
		ExternalMem_WriteCycle(0x55555555UL, 0xAAAAAAAAUL & mask);

		// Second part of unlock sequence is the same thing, but reversed.
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0x55555555UL & mask);
	}
	// The protocol is slightly different for 8/16-bit devices in 8-bit mode:
	else if (curChipType == ChipType8Bit16BitData_16MBitSize)
	{
		// First part of unlock sequence:
		// Write 0xAAAAAAAA to the address bus and 0xAA to the data bus
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0xAAAAAAAAUL & mask);

		// Second part of unlock sequence is the reversed pattern.
		ExternalMem_WriteCycle(0x55555555UL, 0x55555555UL & mask);
	}
	// shouldn't ever be a value other than those two, so I'm not writing
	// any extra code for that case.
}

void ExternalMem_IdentifyChips(struct ChipID *chips)
{
	// Start by writing the unlock sequence to ALL chips
	ExternalMem_UnlockChips(ALL_CHIPS);

	// Write 0x90 to 0x55555555 for the identify command...
	if (curChipType == ChipType8BitData_4MBitSize)
	{
		ExternalMem_WriteCycle(0x55555555UL, 0x90909090UL);
	}
	else if (curChipType == ChipType8Bit16BitData_16MBitSize)
	{
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0x90909090UL);
	}
	// shouldn't ever be a value other than those two, so I'm not writing
	// any extra code for that case.

	// Now we can read the vendor and product ID
	uint32_t result = ExternalMem_ReadCycle(0);

	chips[3].manufacturerID = (uint8_t)result;
	chips[2].manufacturerID = (uint8_t)(result >> 8);
	chips[1].manufacturerID = (uint8_t)(result >> 16);
	chips[0].manufacturerID = (uint8_t)(result >> 24);

	result = ExternalMem_ReadCycle(1);

	chips[3].deviceID = (uint8_t)result;
	chips[2].deviceID = (uint8_t)(result >> 8);
	chips[1].deviceID = (uint8_t)(result >> 16);
	chips[0].deviceID = (uint8_t)(result >> 24);

	// Exit software ID mode
	ExternalMem_WriteCycle(0, 0xF0F0F0F0UL);
}

void ExternalMem_EraseChips(uint8_t chipsMask)
{
	ExternalMem_UnlockChips(chipsMask);
	if (curChipType == ChipType8BitData_4MBitSize)
	{
		ExternalMem_WriteCycle(0x55555555UL, 0x80808080UL);
	}
	else if (curChipType == ChipType8Bit16BitData_16MBitSize)
	{
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0x80808080UL);
	}
	ExternalMem_UnlockChips(chipsMask);
	if (curChipType == ChipType8BitData_4MBitSize)
	{
		ExternalMem_WriteCycle(0x55555555UL, 0x10101010UL);
	}
	else if (curChipType == ChipType8Bit16BitData_16MBitSize)
	{
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0x10101010UL);
	}

	ExternalMem_WaitCompletion(chipsMask);
}

bool ExternalMem_EraseSectors(uint32_t address, uint32_t length, uint8_t chipsMask)
{
	bool result = false;

	// Make sure the area requested to be erased is on 64 KB boundaries.
	// True, the 2 MB SIMM doesn't require 64 KB boundaries, but I'm going to
	// keep it to 2 MB boundaries to simplify everything.
#define ERASABLE_SECTOR_SIZE	(64*1024UL)
	if ((address % ERASABLE_SECTOR_SIZE) ||
		(length % ERASABLE_SECTOR_SIZE))
	{
		return false;
	}

	// We're good to go. Let's do it.

	if (curChipType == ChipType8BitData_4MBitSize)
	{
#define SECTOR_SIZE_4MBIT	(4096)
		// This chip sucks because you have to erase each sector with its own
		// complete erase unlock command, which can take a while. At least
		// individual erase operations are much faster on this chip...
		while (length)
		{
			// Start the erase command
			ExternalMem_UnlockChips(chipsMask);
			ExternalMem_WriteCycle(0x55555555UL, 0x80808080UL);
			ExternalMem_UnlockChips(chipsMask);

			// Now provide a sector address, but only one. Then the whole
			// unlock sequence has to be done again after this sector is done.
			ExternalMem_WriteCycle(address, 0x30303030UL);

			address += SECTOR_SIZE_4MBIT;
			length -= SECTOR_SIZE_4MBIT;

			// Wait for completion of this individual erase operation before
			// we can start a new erase operation.
			ExternalMem_WaitCompletion(chipsMask);
		}

		result = true;
	}
	else if (curChipType == ChipType8Bit16BitData_16MBitSize)
	{
#define SECTOR_SIZE_16MBIT	(64*1024UL)
		// This chip is nicer because it can take all the sector addresses at
		// once and then do the final erase operation in one fell swoop.

		// Start the erase command
		ExternalMem_UnlockChips(chipsMask);
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0x80808080UL);
		ExternalMem_UnlockChips(chipsMask);

		// Now provide as many sector addresses as needed to erase.

		// The first address is a bit of a special case because the boot sector
		// actually has finer granularity for sector sizes.
		if (address == 0)
		{
			ExternalMem_WriteCycle(0x00000000UL, 0x30303030UL);
			ExternalMem_WriteCycle(0x00004000UL, 0x30303030UL);
			ExternalMem_WriteCycle(0x00006000UL, 0x30303030UL);
			ExternalMem_WriteCycle(0x00008000UL, 0x30303030UL);
			address += SECTOR_SIZE_16MBIT;
			length -= SECTOR_SIZE_16MBIT;
		}

		// The remaining sectors can use a more generic algorithm
		while (length)
		{
			ExternalMem_WriteCycle(address, 0x30303030UL);
			address += SECTOR_SIZE_16MBIT;
			length -= SECTOR_SIZE_16MBIT;
		}

		// Wait for completion of the entire erase operation
		ExternalMem_WaitCompletion(chipsMask);

		result = true;
	}

	return result;
}

void ExternalMem_WaitCompletion(uint8_t chipsMask)
{
	// Mark the chips not requested as already completed,
	// so we don't end up waiting for them...
	// (We probably wouldn't anyway, but this is just
	// to be safe)
	uint8_t doneChipsMask = ~chipsMask & 0x0F;

	// Prime the loop...
	union
	{
		uint32_t word;
		uint8_t bytes[4];
	} lastBits, tmp;
	lastBits.word = ExternalMem_ReadCycle(0);
	while (doneChipsMask != 0x0F)
	{
#define TOGGLE_BIT		0x40

		tmp.word = ExternalMem_ReadCycle(0);

		// Note: The following assumes little endian byte ordering
		// (e.g. tmpBytes[0] is the least significant byte of tmpWord

		// Has this chip completed its operation? No?
		if ((doneChipsMask & (1 << 0)) == 0)
		{
			// No toggle means erase completed
			if ((tmp.bytes[0] & TOGGLE_BIT) == (lastBits.bytes[0] & TOGGLE_BIT))
			{
				doneChipsMask |= (1 << 0);
			}
		}

		if ((doneChipsMask & (1 << 1)) == 0)
		{
			// No toggle means erase completed
			if ((tmp.bytes[1] & TOGGLE_BIT) == (lastBits.bytes[1] & TOGGLE_BIT))
			{
				doneChipsMask |= (1 << 1);
			}
		}

		if ((doneChipsMask & (1 << 2)) == 0)
		{
			// No toggle means erase completed
			if ((tmp.bytes[2] & TOGGLE_BIT) == (lastBits.bytes[2] & TOGGLE_BIT))
			{
				doneChipsMask |= (1 << 2);
			}
		}

		if ((doneChipsMask & (1 << 3)) == 0)
		{
			// No toggle means erase completed
			if ((tmp.bytes[3] & TOGGLE_BIT) == (lastBits.bytes[3] & TOGGLE_BIT))
			{
				doneChipsMask |= (1 << 3);
			}
		}

		lastBits.word = tmp.word;
	}
}

void ExternalMem_WriteByteToChips(uint32_t address, uint32_t data, uint8_t chipsMask)
{
	// Use a mask so we don't unlock chips we don't want to talk with
	uint32_t mask = ExternalMem_MaskForChips(chipsMask);

	ExternalMem_UnlockChips(chipsMask);
	if (curChipType == ChipType8BitData_4MBitSize)
	{
		ExternalMem_WriteCycle(0x55555555UL, 0xA0A0A0A0UL & mask);
	}
	else if (curChipType == ChipType8Bit16BitData_16MBitSize)
	{
		ExternalMem_WriteCycle(0xAAAAAAAAUL, 0xA0A0A0A0UL & mask);
	}
	ExternalMem_WriteCycle(address, data & mask);
	ExternalMem_WaitCompletion(chipsMask);
}

uint8_t ExternalMem_Write(uint32_t startAddress, uint32_t *buf, uint32_t len, uint8_t chipsMask, bool doVerify)
{
	// Use a mask so we don't worry about chips we don't want to talk with
	uint32_t mask = ExternalMem_MaskForChips(chipsMask);

	while (len--)
	{
		ExternalMem_WriteByteToChips(startAddress, *buf, chipsMask);
		if (doVerify)
		{
			#define VERIFY_EXTRA_READ_TRIES	2

			// Read back the word we just wrote to make sure it's OK...
			uint32_t readback = ExternalMem_ReadCycle(startAddress) & mask;
			if (readback != (*buf & mask))
			{
				// We found a failure, but don't despair yet. Let's try reading
				// two more times in case it a fluke of the data toggle polling
				// algorithm.
				bool secondFailureFound = false;
				int try = 0;

				while ((try < VERIFY_EXTRA_READ_TRIES) && !secondFailureFound)
				{
					try++;
					readback = ExternalMem_ReadCycle(startAddress) & mask;
					if (readback != (*buf & mask))
					{
						secondFailureFound = true;
					}
				}

				// If we re-read it a few times and it failed again, the write
				// failed. Otherwise, it was probably just the data toggle
				// polling algorithm giving us fits.
				if (secondFailureFound)
				{
					uint8_t failMask = 0;
					// Figure out the mask of chip(s) acting up
					int x;
					for (x = 0; x < NUM_CHIPS; x++)
					{
						// Is this a chip we're working with?
						if (chipsMask & (1 << x))
						{
							if ((readback & (0xFFUL << (8*x))) != (*buf & (0xFFUL << (8*x))))
							{
								// Save the failMask in reverse order
								// (so bit 0 refers to IC1 rather than IC4)
								failMask |= (1 << ((NUM_CHIPS - 1) - x));
							}
						}
					}
					return failMask;
				}
			}
		}

		startAddress++;
		buf++;
	}

	return 0;
}

void ExternalMem_SetChipType(ChipType type)
{
	curChipType = type;
}

ChipType ExternalMem_GetChipType(void)
{
	return curChipType;
}