Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 1 | ------------------------------------------------------------------------------- |
| 2 | Superiotool README |
| 3 | ------------------------------------------------------------------------------- |
| 4 | |
| 5 | Superiotool is a user-space utility which can |
| 6 | |
| 7 | - detect which Super I/O chip is soldered onto your mainboard, |
| 8 | |
| 9 | - at which configuration port it's located (usually 0x2e or 0x4e), and |
| 10 | |
| 11 | - dump all register contents of the Super I/O chip, together with the |
| 12 | default values as per datasheet (to make comparing the values easy). |
| 13 | |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 14 | It is mainly used for coreboot development purposes (see coreboot.org |
| 15 | for details on coreboot), but it may also be useful for other things. |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 16 | |
| 17 | |
| 18 | Installation |
| 19 | ------------ |
| 20 | |
Paul Menzel | 4d6ab4e | 2013-04-03 23:10:22 +0200 | [diff] [blame] | 21 | $ git clone http://review.coreboot.org/p/coreboot.git |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 22 | |
Paul Menzel | 72ef888 | 2013-04-04 14:12:26 +0200 | [diff] [blame] | 23 | $ cd coreboot/util/superiotool |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 24 | |
Uwe Hermann | 480b37f | 2010-01-24 17:29:38 +0000 | [diff] [blame] | 25 | Optional: Edit the Makefile and set 'CONFIG_PCI = no' if you don't want to |
| 26 | support PCI-attached "Super I/Os" (which needs libpci-dev) such as the |
| 27 | VIA VT82686A/B southbridge with integrated Super I/O functionality. |
| 28 | |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 29 | $ make |
| 30 | |
| 31 | $ sudo make install |
| 32 | |
| 33 | |
| 34 | Usage |
| 35 | ----- |
| 36 | |
Uwe Hermann | 969a9f6 | 2008-03-17 13:43:48 +0000 | [diff] [blame] | 37 | Please read the superiotool(8) manpage or type 'superiotool --help'. |
Uwe Hermann | e474956 | 2007-09-19 16:26:18 +0000 | [diff] [blame] | 38 | |
| 39 | Per default (no options) superiotool will just probe for a Super I/O |
Uwe Hermann | e4d4eba | 2007-10-01 13:39:02 +0000 | [diff] [blame] | 40 | and print its vendor, name, ID, revision, and config port. |
Uwe Hermann | e474956 | 2007-09-19 16:26:18 +0000 | [diff] [blame] | 41 | |
| 42 | Typical usage of superiotool: |
| 43 | |
| 44 | - Probe/detect the Super I/O in your mainboard: |
| 45 | |
| 46 | $ superiotool |
| 47 | |
Uwe Hermann | eddc473 | 2007-09-20 23:57:44 +0000 | [diff] [blame] | 48 | - Register dump as table of hex-values of the Super I/O (if detected): |
Uwe Hermann | e474956 | 2007-09-19 16:26:18 +0000 | [diff] [blame] | 49 | |
| 50 | $ superiotool -d |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 51 | |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 52 | |
| 53 | Supported Super I/O Chips |
| 54 | ------------------------- |
| 55 | |
Uwe Hermann | cd474af | 2008-01-18 18:04:28 +0000 | [diff] [blame] | 56 | Please see http://coreboot.org/Superiotool#Supported_devices, or type |
| 57 | |
| 58 | $ superiotool -l |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 59 | |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 60 | There's also a collection of sample register dumps from various Super I/O |
Uwe Hermann | cd474af | 2008-01-18 18:04:28 +0000 | [diff] [blame] | 61 | chips on that web page. Please send further register dumps (either from a |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 62 | proprietary BIOS and/or from coreboot) to the coreboot mailing list |
| 63 | (http://coreboot.org/Mailinglist). |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 64 | |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 65 | |
| 66 | Website and Mailing List |
| 67 | ------------------------ |
| 68 | |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 69 | The main website is http://coreboot.org/Superiotool. |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 70 | |
| 71 | For additional information, patches, and discussions, please join the |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 72 | coreboot mailing list at http://coreboot.org/Mailinglist, where most |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 73 | superiotool developers are subscribed. |
| 74 | |
| 75 | |
| 76 | Copyright and License |
| 77 | --------------------- |
| 78 | |
| 79 | Superiotool is copyrighted by a number of individual developers. Please |
| 80 | refer to the respective source code files for details. |
| 81 | |
| 82 | It is licensed under the terms of the GNU General Public License (GPL), |
Uwe Hermann | cd474af | 2008-01-18 18:04:28 +0000 | [diff] [blame] | 83 | either version 2 of the license, or (at your option) any later version. |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 84 | |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 85 | |
| 86 | Contributors |
| 87 | ------------ |
| 88 | |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 89 | Anders Juel Jensen <andersjjensen@gmail.com> |
Andriy Gapon | c880a36 | 2008-10-19 21:03:41 +0000 | [diff] [blame] | 90 | Andriy Gapon <avg@icyb.net.ua> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 91 | Arjan Koers <0h3q2rmn2bdb@list.nospam.xutrox.com> |
Uwe Hermann | 593f5aa | 2008-01-19 09:43:48 +0000 | [diff] [blame] | 92 | Bingxun Shi <bingxunshi@gmail.com> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 93 | Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 94 | David Bartley <dtbartle@csclub.uwaterloo.ca> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 95 | David Hendricks <david.hendricks@gmail.com> |
Edward O'Callaghan | 5b5f834 | 2014-01-26 00:19:58 +1100 | [diff] [blame] | 96 | Edward O'Callaghan <eocallaghan@alterapraxis.com> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 97 | François-Regis Vuillemin <coreboot@miradou.com> |
Uwe Hermann | 59b99d9 | 2007-11-29 02:43:50 +0000 | [diff] [blame] | 98 | Frieder Ferlemann <Frieder.Ferlemann@web.de> |
| 99 | Idwer Vollering <idwer_v@hotmail.com> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 100 | Ioannis Barkas <tripl3fault@yahoo.com> |
Josh Profitt | b9c6b0e | 2008-10-14 16:28:50 +0000 | [diff] [blame] | 101 | Josh Profitt <zorn169@gmail.com> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 102 | Luc Verhaegen <libv@skynet.be> |
| 103 | Michael Gold <mgold@ncf.ca> |
Uwe Hermann | 83da8dc | 2009-03-25 17:38:40 +0000 | [diff] [blame] | 104 | Michał Mirosław <mirq-linux@rere.qmqm.pl> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 105 | Nikos Barkas <levelwol@gmail.com> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 106 | Rasmus Wiman <rasmus@wiman.org> |
| 107 | Robinson P. Tryon <bishop.robinson@gmail.com> |
Ronald Hoogenboom | 0be73bb | 2008-02-25 22:32:41 +0000 | [diff] [blame] | 108 | Ronald Hoogenboom <hoogenboom30@zonnet.nl> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 109 | Ronald Minnich <rminnich@gmail.com> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 110 | Sean Young <sean@mess.org> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 111 | Stefan Reinauer <stepan@coresystems.de> |
Uwe Hermann | 2ca9491 | 2010-01-24 17:15:25 +0000 | [diff] [blame] | 112 | Tom Sylla <tsylla@gmail.com> |
Uwe Hermann | 59b99d9 | 2007-11-29 02:43:50 +0000 | [diff] [blame] | 113 | Ulf Jordan <jordan@chalmers.se> |
Urja Rannikko | 38204a2 | 2008-10-23 23:33:18 +0000 | [diff] [blame] | 114 | Urja Rannikko <urjaman@gmail.com> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 115 | Uwe Hermann <uwe@hermann-uwe.de> |
| 116 | Ward Vandewege <ward@gnu.org> |