linux-dev/Documentation/i2c/dev-interface, branch master

docs: i2c: convert to ReST and add to driver-api bookset

2019-07-31T19:25:27Z

Convert each file at I2C subsystem, renaming them to .rst and adding to the driver-api book. Signed-off-by: Mauro Carvalho Chehab Acked-by: Wolfram Sang Acked-by: Alexandre Belloni Acked-by: Jonathan Cameron Signed-off-by: Jonathan Corbet

Documentation/i2c: adopt kernel commenting style in examples

2018-04-18T08:09:44Z

The example I2C code is rewritten to adopt the preferred kernel block commenting style. Signed-off-by: Sam Hansen Signed-off-by: Wolfram Sang

Documentation/i2c: sync docs with current state of i2c-tools

2018-04-18T08:09:15Z

Currently, Documentation/i2c/dev-interface describes the use of i2c_smbus_* helper routines as static inlined functions provided by linux/i2c-dev.h. Work has been done to refactor the linux/i2c-dev.h file in the i2c-tools project out into its own library. As a result, these docs have become stale. This patch corrects the discrepancy and directs the reader to the i2c-tools project for more information. Signed-off-by: Sam Hansen Signed-off-by: Wolfram Sang

Documentation/i2c: whitespace cleanup

2018-04-18T08:07:59Z

This strips trailing whitespace in Documentation/i2c/dev-interface. Signed-off-by: Sam Hansen Signed-off-by: Wolfram Sang

i2c: update i2c-dev.h warning in documentation

2017-12-21T20:39:30Z

`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 Cc: Wolfram Sang Signed-off-by: Jonathan Corbet

docs: i2c: dev-interface: adapt to new filenames of the i2c core

2017-05-31T19:01:05Z

The I2C core files were renamed, adapt the textfile to it. Reviewed-by: Andy Shevchenko Signed-off-by: Wolfram Sang

Doc: i2c: Fix typo in Documentation/i2c

2016-02-10T20:12:14Z

This path fix spelling typos found in Documentation/i2c. Signed-off-by: Masanari Iida Signed-off-by: Jonathan Corbet

Documentation: i2c: rename variable "register" to "reg"

2014-09-07T22:21:13Z

The example code provided with the i2c device interface documentation won't compile since it uses the reserved word "register" to name a variable. The compiler fails with this error message: error: expected identifier or '(' before '=' token __u8 register = 0x20; /* Device register to access */ ^ Rename the variable "register" to simply "reg" in the example code. Another couple of typos has been fixed as well. [Change "! =" to "!=".] Signed-off-by: Jose Alarcon Roldan Signed-off-by: Randy Dunlap Acked-by: Wolfram Sang Signed-off-by: Linus Torvalds

i2c: Document the implementation details of the /dev interface

2008-10-14T15:30:05Z

I wrote this explanation to answer a question on the i2c mailing list, and thought it would be good to have in the kernel documentation. Signed-off-by: Jean Delvare

i2c: Improve dev-interface documentation

2008-10-14T15:30:05Z

* Clarify some points. * Point developers to i2c-tools instead of lm_sensors. * Fix coding style in code examples. Signed-off-by: Jean Delvare