summaryrefslogtreecommitdiffstats
path: root/Documentation/i2c/dev-interface
Commit message (Collapse)AuthorAgeFilesLines
* Documentation/i2c: adopt kernel commenting style in examplesSam Hansen2018-04-181-2/+4
| | | | | | | | The example I2C code is rewritten to adopt the preferred kernel block commenting style. Signed-off-by: Sam Hansen <hansens@google.com> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* Documentation/i2c: sync docs with current state of i2c-toolsSam Hansen2018-04-181-11/+5Star
| | | | | | | | | | | | | | 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 <hansens@google.com> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* Documentation/i2c: whitespace cleanupSam Hansen2018-04-181-6/+6
| | | | | | | This strips trailing whitespace in Documentation/i2c/dev-interface. Signed-off-by: Sam Hansen <hansens@google.com> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* i2c: update i2c-dev.h warning in documentationCengiz C2017-12-211-7/+10
| | | | | | | | | | | | | | | | | | | | | | | `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>
* docs: i2c: dev-interface: adapt to new filenames of the i2c coreWolfram Sang2017-05-311-7/+7
| | | | | | | The I2C core files were renamed, adapt the textfile to it. Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* Doc: i2c: Fix typo in Documentation/i2cMasanari Iida2016-02-101-1/+1
| | | | | | | This path fix spelling typos found in Documentation/i2c. Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: i2c: rename variable "register" to "reg"Jose Manuel Alarcon Roldan2014-09-081-5/+5
| | | | | | | | | | | | | | | | | | | | | | 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 <jose.alarcon.roldan@gmail.com> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Wolfram Sang <wsa@the-dreams.de> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
* i2c: Document the implementation details of the /dev interfaceJean Delvare2008-10-141-0/+45
| | | | | | | 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 <khali@linux-fr.org>
* i2c: Improve dev-interface documentationJean Delvare2008-10-141-25/+40
| | | | | | | | * Clarify some points. * Point developers to i2c-tools instead of lm_sensors. * Fix coding style in code examples. Signed-off-by: Jean Delvare <khali@linux-fr.org>
* i2c: Rename the PEC functionality bitDavid Brownell2007-10-131-3/+8
| | | | | | | | | | | | Rename I2C_FUNC_SMBUS_HWPEC_CALC as I2C_FUNC_SMBUS_PEC, and list that functionality as always available through the software implementation. Update documentation accordingly (and list similar requirements). The way it's currently packaged doesn't present the capability in a useful way. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net> Signed-off-by: Jean Delvare <khali@linux-fr.org>
* [PATCH] I2C: Clarify the usage of i2c-dev.hJean Delvare2005-07-111-4/+7
| | | | | | | | | Upon suggestion by Nils Roeder, here is an update to the i2c documentation to clarify which header files user-space applications relying on the i2c-dev interface should include. Signed-off-by: Jean Delvare <khali@linux-fr.org> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* [PATCH] I2C: Documentation fixJan Veldeman2005-07-111-2/+2
| | | | | | | Fix documentation to match code in include/linux/i2c-dev.h Signed-off-by: Jan Veldeman <jan@mind.be> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
* Linux-2.6.12-rc2Linus Torvalds2005-04-171-0/+146
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!