| 1 | I2C TOOLS FOR LINUX |
|---|
| 2 | =================== |
|---|
| 3 | |
|---|
| 4 | This package contains an heterogeneous set of I2C tools for the Linux kernel. |
|---|
| 5 | These tools were originally part of the lm-sensors project but were finally |
|---|
| 6 | split into their own package for convenience. They compile, run and have been |
|---|
| 7 | tested on GNU/Linux. |
|---|
| 8 | |
|---|
| 9 | |
|---|
| 10 | CONTENTS |
|---|
| 11 | -------- |
|---|
| 12 | |
|---|
| 13 | The various tools included in this package are grouped by category, each |
|---|
| 14 | category has its own sub-directory: |
|---|
| 15 | |
|---|
| 16 | * eeprom |
|---|
| 17 | Perl scripts for decoding different types of EEPROMs (SPD, EDID...) These |
|---|
| 18 | scripts rely on the "eeprom" kernel driver. They are installed by default. |
|---|
| 19 | |
|---|
| 20 | * eepromer |
|---|
| 21 | Tools for writing to EEPROMs. These tools rely on the "i2c-dev" kernel |
|---|
| 22 | driver. They are not installed by default. |
|---|
| 23 | |
|---|
| 24 | * include |
|---|
| 25 | C/C++ header files for I2C and SMBus access over i2c-dev. Installed by |
|---|
| 26 | default. |
|---|
| 27 | |
|---|
| 28 | * py-smbus |
|---|
| 29 | Python wrapper for SMBus access over i2c-dev. Not installed by default. |
|---|
| 30 | |
|---|
| 31 | * stub |
|---|
| 32 | A helper script to use with the i2c-stub kernel driver. Installed by |
|---|
| 33 | default. |
|---|
| 34 | |
|---|
| 35 | * tools |
|---|
| 36 | I2C device detection and register dump tools. These tools rely on the |
|---|
| 37 | "i2c-dev" kernel driver. They are installed by default. |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | INSTALLATION |
|---|
| 41 | ------------ |
|---|
| 42 | |
|---|
| 43 | There's no configure script, so simply run "make" to build the tools, and |
|---|
| 44 | "make install" to install them. You also can use "make uninstall" to remove |
|---|
| 45 | all the files you installed. By default, files are installed in /usr/local |
|---|
| 46 | but you can change this behavior by editing the Makefile file and setting |
|---|
| 47 | prefix to wherever you want. You may change the C compiler and the |
|---|
| 48 | compilation flags as well. |
|---|
| 49 | |
|---|
| 50 | Optionally, you can run "make strip" prior to "make install" if you want |
|---|
| 51 | smaller binaries. However, be aware that this will prevent any further |
|---|
| 52 | attempt to debug the programs. |
|---|
| 53 | |
|---|
| 54 | If you wish to include sub-directories that are not enabled by default, then |
|---|
| 55 | just set them via the EXTRA make variable. For example, to build py-smbus, |
|---|
| 56 | do: |
|---|
| 57 | $ make EXTRA="py-smbus" |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | DOCUMENTATION |
|---|
| 61 | ------------- |
|---|
| 62 | |
|---|
| 63 | The main tools have manual pages, which are installed by "make install". |
|---|
| 64 | See these manual pages for command line interface details and tool specific |
|---|
| 65 | information. |
|---|
| 66 | |
|---|
| 67 | The other tools come with simple text documentation, which isn't installed. |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | QUESTIONS AND BUG REPORTS |
|---|
| 71 | ------------------------- |
|---|
| 72 | |
|---|
| 73 | Please post your questions and bug reports to the linux-i2c mailing list: |
|---|
| 74 | linux-i2c@vger.kernel.org |
|---|
| 75 | For additional information about this list, see: |
|---|
| 76 | http://vger.kernel.org/vger-lists.html#linux-i2c |
|---|
