neo430 by zerogravity
A very small msp430-compatible customizable soft-core microcontroller-like processor system written in platform-independent VHDL.
## Introduction Welcome to the __NEO430 Processor__ project! You need a small but still powerful, customizable and microcontroller-like processor system for your next FPGA design? Then the NEO430 is the perfect choice for you! This processor is based on the Texas Instruments MSP430(TM) ISA and provides 100% compatibility with the original instruction set. The NEO430 is not an MSP430 clone – it is more a complete new implementation from the bottom up. The processor features a very small outline, already implementing standard features like a timer, a watchdog, UART, TWI and SPI serial interfaces, general purpose IO ports, an internal bootloader and of course internal memory for program code and data. All of the peripheral modules are optional – so if you do not need them, you can exclude them from implementation to reduce the size of the system. Any additional modules, which make a more customized system, can be connected via a Wishbone-compatible bus interface. By this, you can built a system, that perfectly fits your needs. It is up to you to use the NEO430 as stand-alone, configurable and extensible microcontroller, or to include it as controller within a more complex SoC design. The high-level software development is based on the free TI msp430-gcc compiler tool chain. You can either use Windows or Linux as build environment for your applications – the project comes with build scripts for both worlds. The sw\example folder of this project features several demo programs from which you can start creating your own NEO430 applications. This project is intended to work "out of the box". Just synthesize the test setup from this project, upload it to your FPGA board of choice (the NEO430 uses a vendor-independent VHDL description) and start exploring the capabilities of the NEO430 processor. Application program generation (and installation) works by executing a single "make" command. Jump to the "Let’s Get It Started" chapter, which provides a lot of guides and tutorials to make your first NEO430 setup run: https://github.com/stnolting/neo430/blob/master/doc/NEO430.pdf ## Processor Features <img src="https://github.com/stnolting/neo430/blob/master/doc/figures/neo430_arch.png" width="500px"/> (optional modules are marked using dashed lines in the figure above) - 16-bit open source soft-core microcontroller-like processor system - Code-efficient CISC-like instruction capabilities - Full support of the original MSP430 instruction set architecture - Tool chain based on free TI msp430-gcc compiler - Application compilation scripts for Windows Powershell / Windows Subsystem for Linux / native Linux - Completely described in behavioral, platform-independent VHDL - Fully synchronous design, no latches, no gated clocks - Very small outline and high operating frequency - Internal DMEN (RAM, for data) and IMEM (RAM or ROM, for code), configurable sizes - One external interrupt line - Customizable processor hardware configuration: - Optional multiplier/divider unit (MULDIV) - Optional high-precision timer (TIMER) - Optional universal asynchronous receiver and transmitter (UART) - Optional serial peripheral interface (SPI) - Optional two wire serial interface (TWI) - Optional general purpose parallel IO port (GPIO), 16 inputs, 16 outputs, with pin-change interrupt - Optional 32-bit Wishbone bus interface adapter (WB32) - including bridges to Avalon(TM) bus and AXI4-Lite(TM) - Optional watchdog timer (WDT) - Optional cyclic redundancy check unit (CRC16/32) - Optional custom functions unit (CFU) for user-defined processor extensions - Optional 4 channel PWM controller with 1 to 8 bit resolution (PWM) - Optional internal bootloader (2kB ROM) with serial user console and automatic boot from external SPI EEPROM ## Differences to TI's Original MSP430(TM) Processors - Completely different processor modules with different functionality - Up to 48kB instruction memory and 12kB data memory - Specific memory map – provided NEO430 linker script and compilation script required - Custom binary executable format - Just 4 CPU interrupt channels - Single clock domain for complete processor - Different numbers of instruction execution cycles - Only one power-down (sleep) mode - Wishbone-compatible interface to attach custom IP - Internal bootloader with text interface (via UART serial port) ## Implementation Results Mapping results generated for HW version 0x0300. The full (default) configuration includes all optional processor modules (excluding the CFU), an IMEM size of 4kB and a DMEM size of 2kB. Results generated with Xilinx Vivado 2017.3, Intel Quartus Prime Lite 17.1 and Lattice Radiant 1.0 (Synplify) | __Xilinx Artix-7 (XC7A35TICSG324-1L)__ | LUTs | FFs | BRAMs | DSPs | f_max* | |:----------------------------------------|:---------:|:--------:|:--------:|:------:|:-------:| | Full (default) configuration: | 1006 (5%) | 952 (2%) | 2.5 (5%) | 0 (0%) | 100 MHz | | Minimal configuration (CPU + GPIO): | 879 (4%) | 287 (1%) | 1 (2%) | 0 (0%) | 100 MHz | | __Intel/Altera Cyclone IV (EP4CE22F17C6)__ | LUTs | FFs | Memory bits | DSPs | f_max | |:--------------------------------------------|:---------:|:--------:|:------------:|:------:|:-------:| | Full (default) configuration: | 1676 (8%) | 940 (4%) | 65792 (11%) | 0 (0%) | 116 MHz | | Minimal configuration (CPU + GPIO): | 602 (3%) | 228 (1%) | 49408 (8%) | 0 (0%) | 124 MHz | | __Lattice iCE40 UltraPlus (iCE40UP5K-SG48I)__ | LUTs | FFs | EBRs | DSPs | SRAMs | f_max* | |:-----------------------------------------------|:----------:|:----------:|:--------:|:------:|:------:|:------:| | Full (default) configuration: | 2843 (54%) | 1153 (22%) | 16 (53%) | 0 (0%) | 0 (0%) | 20 MHz | | Minimal configuration (CPU + GPIO): | 1470 (28%) | 493 (9%) | 12 (40%) | 0 (0%) | 0 (0%) | 20 MHz | *) Constrained ## Let's Get It Started! * At first, make sure to get the most recent version of this project from GitHub: ~~~ git clone https://github.com/stnolting/neo430.git ~~~ * Next, install the compiler toolchain from the TI homepage (select the "compiler only" package): http://software-dl.ti.com/msp430/msp430_public_sw/mcu/msp430/MSPGCC/latest/index_FDS.html * Follow the instructions from the "Let's Get It Started" section of the NEO430 documentary: https://github.com/stnolting/neo430/blob/master/doc/NEO430.pdf * The NEO430 documentary will guide you to create a simple test setup, which serves as "hello world" FPGA demo: <img src="https://github.com/stnolting/neo430/blob/master/doc/figures/test_setup.jpg" width="400px"/> * This project also includes some example programs, from which you can start: https://github.com/stnolting/neo430/tree/master/sw/example * Have fun! =) ## Questions? If you have any questions, bug reports, ideas or if you are facing problems with the NEO430, feel free to drop me a line: firstname.lastname@example.org ## Citation If you are using the NEO430 for some kind of publication, please cite it as follows: > S. Nolting, "The NEO430 Processor", github.com/stnolting/neo430 ## Proprietary/Legal Notice "MSP430" is a trademark of Texas Instruments Corporation. "Windows" is a trademark of Microsoft Corporation. "Virtex", "Artix", "ISE" and "Vivado" are trademarks of Xilinx Inc. "Cyclone", "Quartus" and "Avalon Bus" are trademarks of Intel Corporation. "iCE40 UltraPlus" and "Lattice Radiant" are trademarks of Lattice Semiconductor Corporation. "AXI", "AXI4" and "AXI4-Lite" are trademarks of Arm Holdings plc. <img src="https://github.com/stnolting/neo430/blob/master/doc/figures/oshw_logo.png" width="100px"/>
GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.