linux/Documentation/i2c
Cengiz C 91b28aeb17 i2c: update i2c-dev.h warning in documentation
`Documentation/i2c/dev-interface` gives examples for accessing i2c from
userspace.

There's a note that warns developers about the two `i2c-dev.h` header
files which were shipped with the kernel and i2c-tools separately.

However, following i2c-tools commits suggest that the header files are now
identical (in functionality) and `i2c_*` helper functions are now defined
in a separate header called `i2c/smbus.h`, which is distributed with
i2c-tools:

commit 652619121974 ("Minimize differences with kernel flavor")
commit 93caf007f4cb ("Move SMBus helper functions to include/i2c/smbus.h")

Thus, I've converted the warning paragraph into a historical note and
updated the suggested header files.

Signed-off-by: Cengiz Can <cengizc@gmail.com>
Cc: Wolfram Sang <wsa@the-dreams.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-12-21 13:39:30 -07:00
..
busses i2c: i801: Add support for Intel Cedar Fork 2017-10-05 14:44:56 +02:00
muxes i2c: i2c-mux-gpio: rename i2c-gpio-mux to i2c-mux-gpio 2017-02-09 17:01:47 +01:00
dev-interface i2c: update i2c-dev.h warning in documentation 2017-12-21 13:39:30 -07:00
fault-codes Documentation: i2c: Remove obsolete example 2014-01-09 23:02:46 +01:00
functionality i2c: fix reference to functionality constants definition 2015-02-19 16:57:48 +01:00
i2c-protocol Documentation: i2c: improve section about flags mangling the protocol 2014-04-06 13:53:48 +02:00
i2c-stub i2c: stub: Add support for banked register ranges 2014-07-17 19:56:15 +02:00
i2c-topology i2c: Documentation: i2c-topology: mention recent driver additions 2017-08-22 08:36:57 +02:00
instantiating-devices Documentation: i2c: mention ACPI method for instantiating devices 2014-02-15 19:46:34 +01:00
old-module-parameters i2c: Drop probe, ignore and force module parameters 2009-12-06 17:06:24 +01:00
slave-eeprom-backend Doc: i2c: Fix typo in Documentation/i2c 2016-02-10 13:12:14 -07:00
slave-interface Documentation: i2c: slave-interface: add note for driver development 2016-09-08 16:57:14 +02:00
smbus-protocol i2c: use an IRQ to report Host Notify events, not alert 2016-11-24 16:22:06 +01:00
summary Documentation: i2c: describe the new slave mode 2015-03-27 16:53:39 +01:00
ten-bit-addresses i2c: support 10 bit and slave addresses in sysfs 'new_device' 2015-08-24 14:05:15 +02:00
upgrading-clients Documentation: i2c: Use PM ops instead of legacy suspend/resume 2014-12-04 19:09:03 +01:00
writing-clients Documentation: i2c: Use PM ops instead of legacy suspend/resume 2014-12-04 19:09:03 +01:00