Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/hid/hid
[sfrench/cifs-2.6.git] / Documentation / i2c / busses / i2c-taos-evm.rst
1 ==========================
2 Kernel driver i2c-taos-evm
3 ==========================
4
5 Author: Jean Delvare <jdelvare@suse.de>
6
7 This is a driver for the evaluation modules for TAOS I2C/SMBus chips.
8 The modules include an SMBus master with limited capabilities, which can
9 be controlled over the serial port. Virtually all evaluation modules
10 are supported, but a few lines of code need to be added for each new
11 module to instantiate the right I2C chip on the bus. Obviously, a driver
12 for the chip in question is also needed.
13
14 Currently supported devices are:
15
16 * TAOS TSL2550 EVM
17
18 For additional information on TAOS products, please see
19   http://www.taosinc.com/
20
21
22 Using this driver
23 -----------------
24
25 In order to use this driver, you'll need the serport driver, and the
26 inputattach tool, which is part of the input-utils package. The following
27 commands will tell the kernel that you have a TAOS EVM on the first
28 serial port::
29
30   # modprobe serport
31   # inputattach --taos-evm /dev/ttyS0
32
33
34 Technical details
35 -----------------
36
37 Only 4 SMBus transaction types are supported by the TAOS evaluation
38 modules:
39 * Receive Byte
40 * Send Byte
41 * Read Byte
42 * Write Byte
43
44 The communication protocol is text-based and pretty simple. It is
45 described in a PDF document on the CD which comes with the evaluation
46 module. The communication is rather slow, because the serial port has
47 to operate at 1200 bps. However, I don't think this is a big concern in
48 practice, as these modules are meant for evaluation and testing only.