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