README

   1 This is a sample design for Virtex-II V2MB100 Development board using softcore
   2 MCU openMSP430 <http://opencores.org/project,openmsp430>.
   3
   4
   5 TOOLS USED:
   6 ================================================================================
   7   - Xilinx ISE 9.2 (not the WebPack edition!)
   8   - msp430-gcc 4.4.5
   9
  10
  11 DESCRIPTION:
  12 ================================================================================
  13 Sample shows how to use the openMSP430 softcore MCU and connected
  14 periphery. These are rs-232 communication port, quadrature counter and PWM
  15 generator.
  16
  17 For more detailed explanation of exact function see "software/main.c" file.
  18
  19 I/O description is in "openMSP430_uart.ucf" file.
  20
  21 On-board 24MHz oscillator is used (make sure it's not disabled!).
  22
  23 Parameters of rs-232 are 8N1 115200 baud.
  24
  25
  26 BUILDING:
  27 ================================================================================
  28 There is no *.ise project file, the whole process of building and
  29 transfering of the design to the target FPGA is automated by using GNU
  30 make. There are two Makefiles: "software/Makefile" and "build/Makefile".
  31
  32 The first one handles building of software for the MCU and need not be called
  33 directly.
  34
  35 The second one is the main Makefile. (See it for more informations.)
  36
  37 Executing "cd build && make" should produce desired bitfile if an environment
  38 is properly initialized.
  39
  40 If Xilinx ISE Impact is working with your JTAG adapter, then executing
  41 "cd build && make download" builds the design and transfers it to the target
  42 FPGA immediately.
  43
  44
  45 PROJECT OVERVIEW:
  46 ================================================================================
  47
  48   |-- build/                - building directory
  49   |   `-- Makefile          - main Makefile
  50   |
  51   |-- coregen/              - generated memory entities used by MCU
  52   |-- openmsp430/           - GIT submodule with MCU
  53   |-- quadcount/            - GIT submodule with quadrature counter
  54   |-- software/             - software for MCU
  55   |   |-- hardware.h        - description of MCU HW, periphery, ...
  56   |   |-- main.c            - sample application
  57   |   |-- Makefile
  58   |   |-- uart.c            - UART periphery routines
  59   |   `-- uart.h
  60   |-- uart/                 - GIT submodule with UART periphery
  61   |
  62   |-- counter.vhd           - Generic counter needed to generate PWM
  63   |-- memory.bmm            - Descripton of MCU memory map
  64   |-- omsp_pwm.vhd          - MCU PWM periphery
  65   |-- omsp_quadcount.vhd    - MCU interface to quadcount submodule
  66   |-- openMSP430_defines.v  - configuration of MCU (RAM & ROM size, mult, ...)
  67   |
  68   |-- openMSP430_uart.prj   - Description of VHDL and Verilog source files
  69   |-- openMSP430_uart.ucf   - Constraints files (pin positions, timing, ...)
  70   |
  71   |-- openMSP430_uart.vhd   - Top-level source file
  72   |
  73   `-- README
  74