OpenCores
URL https://opencores.org/ocsvn/a-z80/a-z80/trunk

Subversion Repositories a-z80

[/] [a-z80/] [trunk/] [readme.txt] - Diff between revs 17 and 18

Go to most recent revision | Show entire file | Details | Blame | View Log

Rev 17 Rev 18
Line 3... Line 3...
             ------------------------------------------
             ------------------------------------------
                for Altera, Xilinx and Lattice FPGAs
                for Altera, Xilinx and Lattice FPGAs
 
 
This project is described in more details at www.baltazarstudios.com
This project is described in more details at www.baltazarstudios.com
 
 
Prerequisites:
For additional information, read 'Quick Start' and 'Users Guide' documents
 
in the 'docs' folder. Also read a 'readme.txt' file in each of the folders.
 
 
 
Prerequisites
 
=============
* Altera Quartus and Modelsim (free web editions) OR
* Altera Quartus and Modelsim (free web editions) OR
* Xilinx ISE (free Webpack edition) OR
* Xilinx ISE (free Webpack edition) OR
* Lattice ICECube toolchain from Synopsis (Lattice tested by JuanS)
* Lattice ICECube toolchain from Synopsis (Lattice tested by JuanS)
* Python 3.5.x
* Python 3.5.x
 
 
 
Description of Folders
 
======================
"cpu" folder contains A-Z80 CPU functional blocks and top-level modules:
"cpu" folder contains A-Z80 CPU functional blocks and top-level modules:
  alu         contains ALU block, ALU control and flags logic
  alu         contains ALU block, ALU control and flags logic
  bus         contains data bus switches, pin logic, address latch and the
  bus         contains data bus switches, pin logic, address latch and the
              address incrementer
              address incrementer
 
  control     contains PLA decoder, the sequencer and other control blocks
  registers   contains CPU register file and the register control logic
  registers   contains CPU register file and the register control logic
  control     contains PLA, the sequencer and other control blocks
 
  toplevel    A-Z80 top level core, interfaces and test code
  toplevel    A-Z80 top level core, interfaces and test code
 
 
When exporting CPU files to use in your own project, run "export.py" script.
IMPORTANT:
 
If you want to use A-Z80 in your own project, run "export.py" script which
 
will copy only files that are needed (so, don't copy everything yourself).
 
 
"host" folder integrates the A-Z80 CPU into several fully functional designs:
"host" folder integrates the A-Z80 CPU into several fully functional designs:
  "basic_de1" contains a simplified board consisting of A-Z80 CPU, memory
  "basic_de1" contains a simplified board consisting of A-Z80 CPU, memory
          and UART modules that can run small Z80 programs on Altera DE1
          and UART modules that can run small Z80 programs on Altera DE1
  "basic_nexys3" contains the same example project but for Xilinx Nexys3 board
  "basic_nexys3" contains the same example project but for Xilinx Nexys3 board
  "zxspectrum_de1" contains an implementation of the Sinclair ZX Spectrum
  "zxspectrum_de1" contains an implementation of the Sinclair ZX Spectrum
          for Altera DE1 board
          for Altera DE1 board
 
 
You may want to start by loading one of those designs.
"tools", "resources" contain various tools related to the project; reverse
 
  engineering Z80, design verification and testing.
"tools", "resources" contain various tools related to the project, reverse
 
  engineering Z80 and testing.
 
 
 
Read the 'readme.txt' files in each of the folders for additional information.
 
Read 'Quick Start' and 'Users Guide' documents in the 'docs' folder.
 
 
 
A-Z80 Logic Design
 
==================
 
Each functional block contains a Quartus project file:
 
.//test_.qpf
 
 
 
Quartus projects are only used as containers for files within individual
 
modules; complete and working top-level solutions that use A-Z80 are in the
 
"host" folder.
 
 
 
Majority of sub-modules are designed in the Quartus schematic editor and then
 
exported to Verilog for simulation and top-level integration.
 
 
 
Simulation
Email me if you have any questions, issues or you want to use A-Z80 or any of
==========
the files herein; I'd like to hear from you,
Before you can load and simulate any module through Modelsim, you need to set up
 
the environment by running 'modelsim_setup.py'. The script creates relative file
 
path mapping to source files in all module project folders.
 
 
 
Each functional block, including the top level, contains a Modelsim simulation
 
profile: .//simulation/modelsim/test_.mpf
 
 
 
After opening a Modelsim session, create a library and compile sources:
 
ModelSim> vlib work
 
Compile->Compile All
 
Run a simulation through one of the defined configurations.
 
 
 
If you get a message "Unable to compile", you likely forgot to run 'modelsim_setup.py'.
 
Exit ModelSim, revert changes to ".mpf" file, delete "work" folder and run
 
'modelsim_setup.py'.
 
 
 
Each project contains a set of predefined waveform scripts which you can
 
load before running a simulation:
 
.//simulation/modelsim/wave_.do
 
 
 
Email me if you have any questions,
 
Goran Devic
Goran Devic
gdevic@yahoo.com
gdevic@yahoo.com
 
 
----------------------------------------------------------------------------------
----------------------------------------------------------------------------------
This complete project and each file therein is covered under the GNU GPL2.0 license.
This project and each file therein is covered under the GNU GPL2.0 license.
It basically states that anyone is free to use it and distribute it, but the full
It basically states that anyone is free to use it and distribute it, but the full
source needs to be available under the same terms:
source needs to be available under the same terms.
 
 
    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.
 
source needs to be available under the same terms.
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.