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 | |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 21 | $ svn co svn://coreboot.org/repos/trunk/util/superiotool |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 22 | |
Uwe Hermann | 6dbc0e1 | 2007-10-11 18:30:05 +0000 | [diff] [blame] | 23 | $ cd superiotool |
| 24 | |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 25 | $ make |
| 26 | |
| 27 | $ sudo make install |
| 28 | |
| 29 | |
| 30 | Usage |
| 31 | ----- |
| 32 | |
Uwe Hermann | cd474af | 2008-01-18 18:04:28 +0000 | [diff] [blame] | 33 | $ superiotool [-d] [-l] [-V] [-v] [-h] |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 34 | |
Uwe Hermann | 74b29b9 | 2007-11-17 17:13:52 +0000 | [diff] [blame] | 35 | -d | --dump Dump Super I/O register contents |
Uwe Hermann | cd474af | 2008-01-18 18:04:28 +0000 | [diff] [blame] | 36 | -l | --list-supported Show the list of supported Super I/O chips |
Uwe Hermann | eddc473 | 2007-09-20 23:57:44 +0000 | [diff] [blame] | 37 | -V | --verbose Verbose mode |
| 38 | -v | --version Show the superiotool version |
| 39 | -h | --help Show a short help text |
Uwe Hermann | e474956 | 2007-09-19 16:26:18 +0000 | [diff] [blame] | 40 | |
| 41 | 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] | 42 | and print its vendor, name, ID, revision, and config port. |
Uwe Hermann | e474956 | 2007-09-19 16:26:18 +0000 | [diff] [blame] | 43 | |
| 44 | Typical usage of superiotool: |
| 45 | |
| 46 | - Probe/detect the Super I/O in your mainboard: |
| 47 | |
| 48 | $ superiotool |
| 49 | |
Uwe Hermann | eddc473 | 2007-09-20 23:57:44 +0000 | [diff] [blame] | 50 | - 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] | 51 | |
| 52 | $ superiotool -d |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 53 | |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 54 | |
| 55 | Supported Super I/O Chips |
| 56 | ------------------------- |
| 57 | |
Uwe Hermann | cd474af | 2008-01-18 18:04:28 +0000 | [diff] [blame] | 58 | Please see http://coreboot.org/Superiotool#Supported_devices, or type |
| 59 | |
| 60 | $ superiotool -l |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 61 | |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 62 | 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] | 63 | 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] | 64 | proprietary BIOS and/or from coreboot) to the coreboot mailing list |
| 65 | (http://coreboot.org/Mailinglist). |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 66 | |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 67 | |
| 68 | Website and Mailing List |
| 69 | ------------------------ |
| 70 | |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 71 | The main website is http://coreboot.org/Superiotool. |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 72 | |
| 73 | For additional information, patches, and discussions, please join the |
Stefan Reinauer | 997afe6 | 2008-01-18 15:34:24 +0000 | [diff] [blame] | 74 | coreboot mailing list at http://coreboot.org/Mailinglist, where most |
Uwe Hermann | d8a18a2 | 2007-09-18 00:01:27 +0000 | [diff] [blame] | 75 | superiotool developers are subscribed. |
| 76 | |
| 77 | |
| 78 | Copyright and License |
| 79 | --------------------- |
| 80 | |
| 81 | Superiotool is copyrighted by a number of individual developers. Please |
| 82 | refer to the respective source code files for details. |
| 83 | |
| 84 | 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] | 85 | 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] | 86 | |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 87 | |
| 88 | Contributors |
| 89 | ------------ |
| 90 | |
Uwe Hermann | 593f5aa | 2008-01-19 09:43:48 +0000 | [diff] [blame] | 91 | Bingxun Shi <bingxunshi@gmail.com> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 92 | Carl-Daniel Hailfinger <c-d.hailfinger.devel.2006@gmx.net> |
| 93 | David Hendricks <david.hendricks@gmail.com> |
Uwe Hermann | 59b99d9 | 2007-11-29 02:43:50 +0000 | [diff] [blame] | 94 | Frieder Ferlemann <Frieder.Ferlemann@web.de> |
| 95 | Idwer Vollering <idwer_v@hotmail.com> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 96 | Rasmus Wiman <rasmus@wiman.org> |
| 97 | Robinson P. Tryon <bishop.robinson@gmail.com> |
| 98 | Ronald Minnich <rminnich@gmail.com> |
| 99 | Stefan Reinauer <stepan@coresystems.de> |
Uwe Hermann | 59b99d9 | 2007-11-29 02:43:50 +0000 | [diff] [blame] | 100 | Ulf Jordan <jordan@chalmers.se> |
Uwe Hermann | 84bf1e2 | 2007-10-07 19:10:24 +0000 | [diff] [blame] | 101 | Uwe Hermann <uwe@hermann-uwe.de> |
| 102 | Ward Vandewege <ward@gnu.org> |
| 103 | |