Browse Source

README cleanups

master
Jeff Moe 2 years ago
parent
commit
fef8bd3827
  1. 25
      README.md

25
README.md

@ -6,9 +6,9 @@ Free Software, Open Source Hardware keyboard controller
**Software for building FPGA firmware (for linux xubuntu 16.04, x64):**
**Software for building FPGA firmware (for GNU/Linux Xubuntu 16.04, x64):**
1. Atom (version 1.32.2 x64), with apio-ide package (version 0.7.0), and with installed apio (version 0.4.0). Experemental open FPGA IDE. Link https://github.com/FPGAwars/apio-ide/wiki
1. Atom (version 1.32.2 x64), with apio-ide package (version 0.7.0), and with installed apio (version 0.4.0). Experimental free software FPGA IDE. Link https://github.com/FPGAwars/apio-ide/wiki
2. Project IceStorm. Link http://www.clifford.at/icestorm/
@ -19,18 +19,18 @@ Free Software, Open Source Hardware keyboard controller
5. Yosys. Link http://www.clifford.at/yosys/
There are 3 options of FPGA firmware building and uploading to chip:
There are three options to build the FPGA firmware and upload it to the chip:
1. Atom-apio-ide. Open i2c_keyboard_ice40 project in atom and press Apio:Build button. File hardware.bin will be generated. Then you can press button Apio:Upload and firmware will be uploaded to Lattice IceStick board. Sometimes there are some errors in build process and bin file is not generated (option 3 generates bin file from the same sources successfully)
1. Atom-apio-ide. Open i2c_keyboard_ice40 project in atom and press Apio:Build button. File hardware.bin will be generated. Then you can press button Apio:Upload and firmware will be uploaded to the Lattice IceStick board. Sometimes there are some errors in build process and bin file is not generated (option 3 generates bin file from the same sources successfully).
2. Yosys+Arachne-pnr+Icestorm. If you want to use this variant, execute "make" command in console and file i2c_kbd_alt.bin will be generated. Then you can execute command "iceprog i2c_kbd_alt.bin" and firmware will be uploaded to Lattice IceStick board. Sometimes there are some errors(not the same as in option 1) in build process and bin file is not generated (option 3 generates bin file from the same sources successfully).
2. Yosys+Arachne-pnr+Icestorm. If you want to use this variant, execute "make" command in console and file i2c_kbd_alt.bin will be generated. Then you can execute command "iceprog i2c_kbd_alt.bin" and firmware will be uploaded to the Lattice IceStick board. Sometimes there are some errors (not the same as in option 1) in build process and bin file is not generated (option 3 generates bin file from the same sources successfully).
3. Yosys+Next-pnr+Icestorm. If you want to use this option, execute "make nextpnr" command in console and file i2c_kbd_alt.bin will be generated. Then you can execute command "iceprog i2c_kbd_alt.bin" and firmware will be uploaded to Lattice IceStick board. Most stable toolchain. But has more occuped LCs then first 2 options.
3. Yosys+Next-pnr+Icestorm. If you want to use this option, execute "make nextpnr" command in console and file i2c_kbd_alt.bin will be generated. Then you can execute command "iceprog i2c_kbd_alt.bin" and firmware will be uploaded to the Lattice IceStick board. This is the most stable toolchain. But has more occupied LCs than the first two options.
If you want to run I2C-HID-HOST emulator or fpga debug output collector, you need qtcreator ant qt5serialport lib (Qt5 is installing with nextpnr).
If you want to run the I2C-HID-HOST emulator or FPGA debug output collector, you need qtcreator and qt5serialport library (Qt5 is a nextpnr dependency).
Packets names in Ubuntu:
Package names in Ubuntu:
- qtcreator
- libqt5serialport5
@ -39,12 +39,13 @@ Packets names in Ubuntu:
**Hardware:**
- FT2232 breakout board
- chip 24LC16B
- Chip 24LC16B
- LATTICE ICE40HX1K board
- resistors
- Resistors
You can open file inouts.pcf, all FPGA pins (which are needed) are described in this file. In comments you can see joint numbers on IceStick board. Also all COLUMN lines must have pull-up resistors to 3.3 V (used 10kOhm resistors for pull-up). If there are no pull-ups on I2C lines in host deivce, you must set pull-up resistors for these lines. And connected all lines (from IceStick to keyboard and from IceStick to host device) throw protection resistors (used 300 Ohm resistors), because avoid short circuits.
You can open file inouts.pcf, all the FPGA pins which are needed are described in this file. In the comments you can see joint numbers on the IceStick board. All COLUMN lines must have pull-up resistors to 3.3 V (used 10kOhm resistors for pull-up). If there are no pull-ups on the I2C lines in host deivce, you must set pull-up resistors for these lines. And connected all lines (from IceStick to keyboard and from IceStick to host device) throw protection resistors (used 300 Ohm resistors), to avoid short circuits.
**Warning:**
This is only keyboard controller prototype! It might have software and hardware bugs.
This is a keyboard controller prototype! It has software and hardware bugs.

Loading…
Cancel
Save