opemMSP430 Demo project
日本語はこちら

This repository is a porting of openMSP430 to Terasic DE0 and DE0CV.
It is released as a Quartus Prime project.
This project includes a UART (basic_uart_tmct) freely available from firmware, an I²C master (I2C controller core) and basic firmware to use them from the uart debug console, so you can start using it immediately as a base project for your FPGA-embedded microcontroller core.

openMSP430 を Terasic DE0 および DE0CV にフィッティングしたものをQuartus Primeのプロジェクトごと公開します。
このプロジェクトには、ファームウェアから自由に使用できるUART(basic_uart_tmct)、I²Cマスタ(I2C controller core) および それらをuartデバッグコンソールから利用するためのファームウェアを内蔵しているため、FPGA内蔵マイコンコアのベースプロジェクトとしてすぐに使い始めることができます。
※日本語の解説文は英語の後にあります。
※開発環境の構築などさらに詳しく知りたい方はこちらをどうぞ。

• What is openMSP430?
• Contents of this demo project
• Default configuration of the demo project
• Hardware assignment
• Using the UART debug console

openMSP430 is a so-called soft-core CPU that reproduces the functions of the MSP430 microcontroller (developed and sold by Texas Instruments) on FPGA. It is available free of charge.
Many people may think that "a free soft-core CPU that can be implemented in FPGA" sounds "fishy" or "it has strange restrictions and cannot be used properly anyway," but it works properly.
The features are roughly as follows:

• Free public release under the BSD license.
  openMSP430 is released under the BSD license, which means that there is no obligation to release development results. Also, as long as the copyright is not erased, it can be used and distributed with almost no restrictions.
  If used well, it will greatly contribute to improving the productivity of not only DIY but also mass-produced products.
• All development environments, including gcc-based compilers, are available for free.
  No money is required to build the software environment.
  (...although the gcc-based development environment is maintained by Texas Instruments, so contribute to sales in some way...)
• The documentation is very well written.
  The developer, Girard Olivier, has described the documentation very carefully, and just reading the documentation is quite enough to deepen your understanding.
• Works properly with real FPGA (Important!)
  Surprisingly, there are many soft-core CPUs that only work properly in simulation because developers are only interested in developing CPU cores. Such projects naturally do not work properly in real FPGAs.
  The openMSP430 has been verified to work properly on real FPGAs and includes a debugger and other tools.

openMSP430 itself is available free of charge at the following site.
It is very gratifying to be provided with such a useful core at free of charge.

The contents of omsp430_demo_tmct are generally as follows.
Note that some folders are omitted from the following, but it is not intended that they are not written because they are not needed. So please be very careful when deleting them.

The configuration and functions of the demo project are configured as follows without any modification.
Since the UART and I²C master function are connected to the peripheral bus, it should be possible to do almost as well as a normal one-chip microcontroller as it is.

The sample firmware implements a uart debug console that can run a full set of hardware by issuing commands from the serial communication terminal.
It can be referenced as a sample of control over the implemented hardware.

The following assignments are made for devices and pins on the board.
Please refer to the pin assignment file included in the project for the pin assignment of each FPGA.

Using the UART debug console implemented as firmware, the hardware can be accessed via text-based command.
The communication specifications are as follows.
To use, connect the COM port (or USB-COM converter) of the PC to the above "UART for firmware". (*Not UART for debugger)

• Baud-rate: 38400
• Start bits: 1 bit
• Data bits: 8 bit
• Stop bits: 1 bit
• Parity bit: None
• Flow control: None
• Line feed code:
  Receive = CR or LF
  Transmit = CR + LF

In the test environment, the board was connected to a GPIO pin header as shown in the following picture, and connected to a PC via USB-COM conversion.
Only the 2.2kΩ Pull Up resistor is visible in the photo, but the I²C EEPROM is on the back of the board.

When the serial console firmware is successfully activated, '>' is output from the UART and the device enters a state waiting for input.
When a linefeed code is input following a control command, the unit performs the operation corresponding to that command, then outputs '>' again and enters the input waiting state.
If it has a return value, it is output before '>'.
The feeling of operation is similar to the Windows prompt or the macOS shell.

The control commands and their formats are shown below.
Parameters are in hexadecimal and all digits are fixed; leading zeros in a 2-byte parameter cannot be omitted.
For example, to write 0x01 to address 0x90 in the CPU bus space, send sw009001[CR].

• openMSP430って何よ？
• デモプロジェクトの中身
• デモプロジェクトのコンフィグレーション
• ハードウェアのアサイン
• UARTデバッグコンソールを使う

openMSP430はTexas Instrumentsが開発・販売しているMSP430マイコンの機能をFPGA上で再現したもので、無償で公開されているいわゆるソフトコアCPUです。
「FPGAに実装可能な無償のソフトコアCPU」と聞くと『胡散臭い』『どうせ変な制約があってマトモに使えないだろう』と邪推する人も多いでしょうが、マトモに動きます。
ざっくり以下のような特徴があります。

• BSDライセンスで無償公開されている
  openMSP430はBSDライセンスで公開されており、開発成果物を公開する義務がありません。また、著作権を消さない限りはほぼ制約なく利用・配布することができます。
  うまく利用すればDIYだけでなく量産製品の生産性向上にも大きく寄与することでしょう。
• 開発環境はgccベースのコンパイラなど含めすべて無償で入手できる
  ソフトウェア環境の構築にはいっさいお金はかかりません。
  (…とはいえgccベースの開発環境はTexas Instrumentsがメンテナンスしてくれているので何らかの形で売上に貢献しましょう。)
• ドキュメントが非常に詳しく書かれている
  開発者のGirard Olivierさんが非常に丁寧にドキュメントを記載してくれており、ただドキュメントを読み込むだけでもかなり理解を深めることができます。
  英語の勉強にもなりますしね(ニッコリ)
• 実FPGAできちんと動作する(重要！)
  ソフトコアCPUの中には、開発者がCPUコアを開発することしか興味がなく「シミュレーション上は動いてますが、実際のFPGA上でプログラムが動くことは確認してません。する予定もありません。(おわり)」みたいなものが意外と多くあります。
  openMSP430は実FPGAでもきちんと動作することが確認されている上、デバッガなども同梱されています。

openMSP430自体は以下のサイトで無償公開されています。
このような有用なコアを無償で提供して頂いていることに感謝します。

omsp430_demo_tmctの中身は概ね以下のようになっています。
なお、以下からは省略しているフォルダもありますが、要らないから書いてないという意図ではないので削除する場合は十分に注意してください。

デモプロジェクトのコンフィグレーションや機能は何もいじらない状態では以下の通り構成されています。
ペリフェラルバスに UART と I²Cマスター機能 を接続しているので、このままでもほぼ普通のワンチップマイコンと遜色ないことはできるはず。

サンプルファームウェアにはシリアル通信ターミナルからのコマンド発行でハードウェアを一通り動かすことができるシリアルコンソールが実装されています。
実装されたハードウェアに対する制御のサンプルとして参照するとよいでしょう。

ボード上のデバイスやピンに対しては以下のようにアサインされています。
各FPGAのピンアサインはプロジェクトに含まれるピンアサインファイルをご覧ください。

ファームウェアとして実装されているUARTデバッグコンソールを使用すると、ファームウェア用UARTからテキストベースのコマンド授受によってハードウェアにアクセスすることができます。
通信仕様は以下の通りです。
使用する場合は上記「ファームウェア用UART」にパソコンのCOMポート(またはUSB-COM変換)を接続します。(※デバッガ用UARTではありません)

• Baud-rate: 38400
• Start bits: 1 bit
• Data bits: 8 bit
• Stop bits: 1 bit
• Parity bit: None
• Flow control: None
• Line feed code:
  Receive = CR or LF
  Transmit = CR + LF

テスト環境では以下の写真のようにGPIOピンヘッダに基板を接続し、USB-COM変換を介してパソコンに接続しました。
写真では2.2kΩのPull Up抵抗だけが見えていますが、基板の裏にはI²C EEPROMが載っています。

シリアルコンソールファームウェアが正常に起動するとUARTから > が出力され、入力待ち状態になります。
制御コマンドに続いてラインフィードコードが入力されるとそのコマンドに応じた動作を行った後、再び > を出力して入力待ち状態になります。
戻り値がある場合は > の前に出力されます。
操作感としてはWindowsのプロンプトやmacOSのシェルなどと同じようなイメージです。

制御コマンドとその書式を以下に示します。
パラメータは16進数かつ桁数はすべて固定です。2バイトのパラメータの先頭ゼロを省略して与えることはできません。
たとえばCPUバス空間のアドレス 0x90 に 0x01 を Write する場合、 sw009001[CR] を送ります。

開発環境の構築などさらに詳しく知りたい方はこちらをどうぞ。

tmct web-site: openMSP430を使ってみる［導入・開発環境整備編］