|
Packit Bot |
d6d9d0 |
I2C TOOLS FOR LINUX
|
|
Packit Bot |
d6d9d0 |
===================
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
This package contains an heterogeneous set of I2C tools for the Linux kernel
|
|
Packit Bot |
d6d9d0 |
as well as an I2C library. The tools were originally part of the lm-sensors
|
|
Packit Bot |
d6d9d0 |
project but were finally split into their own package for convenience. The
|
|
Packit Bot |
d6d9d0 |
library is used by some of the tools, but can also be used by third-party
|
|
Packit Bot |
d6d9d0 |
applications. The tools and library compile, run and have been tested on
|
|
Packit Bot |
d6d9d0 |
GNU/Linux.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
The latest version of the code can be downloaded from:
|
|
Packit Bot |
d6d9d0 |
https://i2c.wiki.kernel.org/index.php/I2C_Tools
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
CONTENTS
|
|
Packit Bot |
d6d9d0 |
--------
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
The various tools included in this package are grouped by category, each
|
|
Packit Bot |
d6d9d0 |
category has its own sub-directory:
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* eeprom
|
|
Packit Bot |
d6d9d0 |
Perl scripts for decoding different types of EEPROMs (SPD, EDID...) These
|
|
Packit Bot |
d6d9d0 |
scripts rely on the "eeprom" kernel driver. They are installed by default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* eeprog, eepromer
|
|
Packit Bot |
d6d9d0 |
Tools for writing to EEPROMs. These tools rely on the "i2c-dev" kernel
|
|
Packit Bot |
d6d9d0 |
driver. They are not installed by default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* include
|
|
Packit Bot |
d6d9d0 |
C/C++ header files for I2C and SMBus access over i2c-dev. Installed by
|
|
Packit Bot |
d6d9d0 |
default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* lib
|
|
Packit Bot |
d6d9d0 |
The I2C library, used by eeprog, py-smbus and tools. Installed by
|
|
Packit Bot |
d6d9d0 |
default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* py-smbus
|
|
Packit Bot |
d6d9d0 |
Python wrapper for SMBus access over i2c-dev. Not installed by default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* stub
|
|
Packit Bot |
d6d9d0 |
A helper script to use with the i2c-stub kernel driver. Installed by
|
|
Packit Bot |
d6d9d0 |
default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
* tools
|
|
Packit Bot |
d6d9d0 |
I2C device detection and register dump tools. These tools rely on the
|
|
Packit Bot |
d6d9d0 |
"i2c-dev" kernel driver. They are installed by default.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
LICENSE
|
|
Packit Bot |
d6d9d0 |
-------
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
Check the documentation of individual tools for licensing information.
|
|
Packit Bot |
d6d9d0 |
The library is released under the LGPL version 2.1 or later, while most
|
|
Packit Bot |
d6d9d0 |
tools are released under the GPL version 2 or later, but there are a few
|
|
Packit Bot |
d6d9d0 |
exceptions.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
INSTALLATION
|
|
Packit Bot |
d6d9d0 |
------------
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
There's no configure script, so simply run "make" to build the library and
|
|
Packit Bot |
d6d9d0 |
tools, and "make install" to install them. You also can use "make uninstall"
|
|
Packit Bot |
d6d9d0 |
to remove all the files you installed. By default, files are installed in
|
|
Packit Bot |
d6d9d0 |
/usr/local but you can change the location by editing the Makefile file and
|
|
Packit Bot |
d6d9d0 |
setting prefix to wherever you want. You may change the C compiler and the
|
|
Packit Bot |
d6d9d0 |
compilation flags as well, and also decide whether to build the static
|
|
Packit Bot |
d6d9d0 |
library or not.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
Optionally, you can run "make strip" prior to "make install" if you want
|
|
Packit Bot |
d6d9d0 |
smaller binaries. However, be aware that this will prevent any further
|
|
Packit Bot |
d6d9d0 |
attempt to debug the library and tools.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
If you wish to include sub-directories that are not enabled by default, then
|
|
Packit Bot |
d6d9d0 |
just set them via the EXTRA make variable. For example, to build py-smbus,
|
|
Packit Bot |
d6d9d0 |
do:
|
|
Packit Bot |
d6d9d0 |
$ make EXTRA="py-smbus"
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
DOCUMENTATION
|
|
Packit Bot |
d6d9d0 |
-------------
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
The main tools have manual pages, which are installed by "make install".
|
|
Packit Bot |
d6d9d0 |
See these manual pages for command line interface details and tool specific
|
|
Packit Bot |
d6d9d0 |
information.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
The other tools come with simple text documentation, which isn't installed.
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
QUESTIONS AND BUG REPORTS
|
|
Packit Bot |
d6d9d0 |
-------------------------
|
|
Packit Bot |
d6d9d0 |
|
|
Packit Bot |
d6d9d0 |
Please post your questions and bug reports to the linux-i2c mailing list:
|
|
Packit Bot |
d6d9d0 |
linux-i2c@vger.kernel.org
|
|
Packit Bot |
d6d9d0 |
with Cc to the current maintainer:
|
|
Packit Bot |
d6d9d0 |
Jean Delvare <jdelvare@suse.de>
|
|
Packit Bot |
d6d9d0 |
For additional information about this list, see:
|
|
Packit Bot |
d6d9d0 |
http://vger.kernel.org/vger-lists.html#linux-i2c
|