Blame view
Documentation/i2c/i2c-stub
1.85 KB
1da177e4c Linux-2.6.12-rc2 |
1 2 3 |
MODULE: i2c-stub DESCRIPTION: |
471031789 i2c-stub: Impleme... |
4 5 6 |
This module is a very simple fake I2C/SMBus driver. It implements five types of SMBus commands: write quick, (r/w) byte, (r/w) byte data, (r/w) word data, and (r/w) I2C block data. |
1da177e4c Linux-2.6.12-rc2 |
7 |
|
9d90c1fd9 i2c-stub: Support... |
8 9 |
You need to provide chip addresses as a module parameter when loading this driver, which will then only react to SMBus commands to these addresses. |
7a8d29cec i2c-stub: Chip ad... |
10 |
|
1da177e4c Linux-2.6.12-rc2 |
11 |
No hardware is needed nor associated with this module. It will accept write |
9d90c1fd9 i2c-stub: Support... |
12 13 14 15 |
quick commands to the specified addresses; it will respond to the other commands (also to the specified addresses) by reading from or writing to arrays in memory. It will also spam the kernel logs for every command it handles. |
1da177e4c Linux-2.6.12-rc2 |
16 17 18 19 20 21 22 |
A pointer register with auto-increment is implemented for all byte operations. This allows for continuous byte reads like those supported by EEPROMs, among others. The typical use-case is like this: 1. load this module |
6471b6898 i2c-stub: Documen... |
23 24 |
2. use i2cset (from the i2c-tools project) to pre-load some data 3. load the target chip driver module |
1da177e4c Linux-2.6.12-rc2 |
25 |
4. observe its behavior in the kernel log |
b3af547e1 i2c-stub: Mention... |
26 27 |
There's a script named i2c-stub-from-dump in the i2c-tools package which can load register values automatically from a chip dump. |
7a8d29cec i2c-stub: Chip ad... |
28 |
PARAMETERS: |
9d90c1fd9 i2c-stub: Support... |
29 30 |
int chip_addr[10]: The SMBus addresses to emulate chips at. |
7a8d29cec i2c-stub: Chip ad... |
31 |
|
38f41f282 i2c-stub: Allow u... |
32 33 34 35 36 |
unsigned long functionality: Functionality override, to disable some commands. See I2C_FUNC_* constants in <linux/i2c.h> for the suitable values. For example, value 0x1f0000 would only enable the quick, byte and byte data commands. |
1da177e4c Linux-2.6.12-rc2 |
37 |
CAVEATS: |
1da177e4c Linux-2.6.12-rc2 |
38 39 40 41 42 43 44 45 46 |
If your target driver polls some byte or word waiting for it to change, the stub could lock it up. Use i2cset to unlock it. If the hardware for your driver has banked registers (e.g. Winbond sensors chips) this module will not work well - although it could be extended to support that pretty easily. If you spam it hard enough, printk can be lossy. This module really wants something like relayfs. |