PCB design done + bom and readme
[sgikbd] / README.md
1 SGI - PS/2 keyboard and mouse converter
2 =======================================
3
4 Progress: prototype board completed, firmware not done.
5
6 About
7 -----
8 This project is a converter for connecting PS/2 keyboards and mice to old
9 Silicon Graphics computers which had a proprietary keyboard/mouse interface. It
10 should work on every non-PS/2 SGI computer with mini-DIN6, DB9 and DB15
11 keyboard/mouse connectors, such as:
12
13   - Iris 4D series
14   - Onyx
15   - Indigo
16
17 This converter is not necessary, and will not work, for any later SGI machines,
18 like the indy, O2, indigo2, Octane, and so on, because they use PS/2 keyboards
19 and mice directly.
20
21 It's based on an AVR atmega328pb microcontroller, which reads the PS/2
22 keyboard and mouse ports, and translates scancodes and events to the protocol
23 and electrical signalling used by the SGI computers. For details on the
24 SGI signalling and protocols, see the copy of the keyboard and mouse manpages
25 from the section 7 of the IRIX manual, under `doc/`.
26
27 Directory structure:
28
29   - `hw` - hardware: kicad files and pdf schematics.
30   - `fw` - firmware for the AVR microcontroller.
31   - `doc` - relevant documentation.
32
33 Project website: http://nuclear.mutantstargoat.com/hw/sgikbd
34
35 The firmware is based on my previous
36 [a500kbd](https://github.com/jtsiomb/a500kbd) project, so if you see any
37 leftover references to the Amiga anywhere don't be confused.
38
39 License
40 -------
41 Copyright (C) 2017-2022 John Tsiombikas <nuclear@mutantstargoat.com>
42
43 You are free to use, reproduce, modify, and redistribute any part of this
44 project, provided you make any derivative work you release, freely available
45 under the same terms.
46
47 Both hardware designs, and software parts of this project, are released under
48 the terms of the GNU General Public License v3, or at your option any later
49 version published by the Free Software Foundation. See `LICENSE` for details.
50
51 To comply with the license, when releasing derivative hardware designs, you must
52 provide the full EDA project files, and of course firmware/software source code.
53 Releasing only images of schematics, gerbers, and firmware binaries is *not*
54 sufficient for compliance.