diff options
| -rw-r--r-- | Documentation/i2c/summary | 45 |
1 files changed, 4 insertions, 41 deletions
diff --git a/Documentation/i2c/summary b/Documentation/i2c/summary index 003c7319b8c7..13ab076dcd92 100644 --- a/Documentation/i2c/summary +++ b/Documentation/i2c/summary | |||
| @@ -1,5 +1,3 @@ | |||
| 1 | This is an explanation of what i2c is, and what is supported in this package. | ||
| 2 | |||
| 3 | I2C and SMBus | 1 | I2C and SMBus |
| 4 | ============= | 2 | ============= |
| 5 | 3 | ||
| @@ -33,52 +31,17 @@ When we talk about I2C, we use the following terms: | |||
| 33 | Client | 31 | Client |
| 34 | 32 | ||
| 35 | An Algorithm driver contains general code that can be used for a whole class | 33 | An Algorithm driver contains general code that can be used for a whole class |
| 36 | of I2C adapters. Each specific adapter driver depends on one algorithm | 34 | of I2C adapters. Each specific adapter driver either depends on one algorithm |
| 37 | driver. | 35 | driver, or includes its own implementation. |
| 38 | 36 | ||
| 39 | A Driver driver (yes, this sounds ridiculous, sorry) contains the general | 37 | A Driver driver (yes, this sounds ridiculous, sorry) contains the general |
| 40 | code to access some type of device. Each detected device gets its own | 38 | code to access some type of device. Each detected device gets its own |
| 41 | data in the Client structure. Usually, Driver and Client are more closely | 39 | data in the Client structure. Usually, Driver and Client are more closely |
| 42 | integrated than Algorithm and Adapter. | 40 | integrated than Algorithm and Adapter. |
| 43 | 41 | ||
| 44 | For a given configuration, you will need a driver for your I2C bus (usually | 42 | For a given configuration, you will need a driver for your I2C bus, and |
| 45 | a separate Adapter and Algorithm driver), and drivers for your I2C devices | 43 | drivers for your I2C devices (usually one driver for each device). |
| 46 | (usually one driver for each device). There are no I2C device drivers | ||
| 47 | in this package. See the lm_sensors project http://www.lm-sensors.nu | ||
| 48 | for device drivers. | ||
| 49 | 44 | ||
| 50 | At this time, Linux only operates I2C (or SMBus) in master mode; you can't | 45 | At this time, Linux only operates I2C (or SMBus) in master mode; you can't |
| 51 | use these APIs to make a Linux system behave as a slave/device, either to | 46 | use these APIs to make a Linux system behave as a slave/device, either to |
| 52 | speak a custom protocol or to emulate some other device. | 47 | speak a custom protocol or to emulate some other device. |
| 53 | |||
| 54 | |||
| 55 | Included Bus Drivers | ||
| 56 | ==================== | ||
| 57 | Note that only stable drivers are patched into the kernel by 'mkpatch'. | ||
| 58 | |||
| 59 | |||
| 60 | Base modules | ||
| 61 | ------------ | ||
| 62 | |||
| 63 | i2c-core: The basic I2C code, including the /proc/bus/i2c* interface | ||
| 64 | i2c-dev: The /dev/i2c-* interface | ||
| 65 | i2c-proc: The /proc/sys/dev/sensors interface for device (client) drivers | ||
| 66 | |||
| 67 | Algorithm drivers | ||
| 68 | ----------------- | ||
| 69 | |||
| 70 | i2c-algo-bit: A bit-banging algorithm | ||
| 71 | i2c-algo-pcf: A PCF 8584 style algorithm | ||
| 72 | i2c-algo-ibm_ocp: An algorithm for the I2C device in IBM 4xx processors (NOT BUILT BY DEFAULT) | ||
| 73 | |||
| 74 | Adapter drivers | ||
| 75 | --------------- | ||
| 76 | |||
| 77 | i2c-elektor: Elektor ISA card (uses i2c-algo-pcf) | ||
| 78 | i2c-elv: ELV parallel port adapter (uses i2c-algo-bit) | ||
| 79 | i2c-pcf-epp: PCF8584 on a EPP parallel port (uses i2c-algo-pcf) (NOT mkpatched) | ||
| 80 | i2c-philips-par: Philips style parallel port adapter (uses i2c-algo-bit) | ||
| 81 | i2c-adap-ibm_ocp: IBM 4xx processor I2C device (uses i2c-algo-ibm_ocp) (NOT BUILT BY DEFAULT) | ||
| 82 | i2c-pport: Primitive parallel port adapter (uses i2c-algo-bit) | ||
| 83 | i2c-velleman: Velleman K8000 parallel port adapter (uses i2c-algo-bit) | ||
| 84 | |||
