summaryrefslogtreecommitdiff
path: root/Documentation/i2c/instantiating-devices.rst
Commit message (Collapse)AuthorAgeFilesLines
* docs: i2c: instantiating-devices: add syntax coloring to dts and C blocksLuca Ceresoli2022-08-111-4/+12
| | | | | | | These blocks can be nicely coloured via Sphinx. Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Signed-off-by: Wolfram Sang <wsa@kernel.org>
* docs: i2c: avoid using ReST :doc:`foo` markupMauro Carvalho Chehab2021-06-171-1/+1
| | | | | | | | | | The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Acked-by: Wolfram Sang <wsa@kernel.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/569722e3f7d73d746c145ea78d2b4fbe5defee90.1623824363.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: i2c: instantiating-devices: use monospace for sysfs attributesLuca Ceresoli2020-01-291-7/+7
| | | | | | | | | Use a monospace (literal) formatting for better readability of sysfs attributes. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* docs: i2c: instantiating-devices: rearrange static instatiationLuca Ceresoli2020-01-291-43/+54
| | | | | | | | | | | | | Among the "static" instantiation methods the "board file" method is described first. Move it as last, since it is being replaced by the other methods. Also fix subsubsection heading syntax and remove the "Method 1[abc]" prefix as the subsubsection structure clarifies the logical hierarchy. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* docs: i2c: instantiating-devices: fix internal hyperlinkLuca Ceresoli2020-01-291-1/+1
| | | | | | | | Use ReST syntax so that a proper hyperlink is generated. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* docs: i2c: call it "I2C" consistentlyLuca Ceresoli2020-01-291-1/+1
| | | | | | | | | | Uppercase "I2C" is used almost everywhere in the docs, but the lowercase version "i2c" is used somewhere. Use the uppercase form consistently. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Acked-by: Peter Rosin <peda@axentia.se> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* docs: i2c: use the new API in 'instantiating-devices.rst'Wolfram Sang2020-01-151-4/+4
| | | | | | | i2c_new_device is deprecated, use i2c_new_client_device. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* i2c: replace i2c_new_probed_device with an ERR_PTR variantWolfram Sang2019-11-281-5/+5
| | | | | | | | | | | | | | | In the general move to have i2c_new_*_device functions which return ERR_PTR instead of NULL, this patch converts i2c_new_probed_device(). There are only few users, so this patch converts the I2C core and all users in one go. The function gets renamed to i2c_new_scanned_device() so out-of-tree users will get a build failure to understand they need to adapt their error checking code. Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com> Reviewed-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Max Staudt <max@enpas.org> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
* docs: i2c: convert to ReST and add to driver-api booksetMauro Carvalho Chehab2019-07-311-0/+253
Convert each file at I2C subsystem, renaming them to .rst and adding to the driver-api book. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Wolfram Sang <wsa@the-dreams.de> Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>