Skip to content

Commit

Permalink
docs: i2c: instantiating-devices: add syntax coloring to dts and C bl…
Browse files Browse the repository at this point in the history
…ocks

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>
  • Loading branch information
Luca Ceresoli authored and Wolfram Sang committed Aug 11, 2022
1 parent 6c12ec2 commit 43310e2
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions Documentation/i2c/instantiating-devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Declare the I2C devices via devicetree
On platforms using devicetree, the declaration of I2C devices is done in
subnodes of the master controller.

Example::
Example:

.. code-block:: dts
i2c1: i2c@400a0000 {
/* ... master properties skipped ... */
Expand Down Expand Up @@ -71,7 +73,9 @@ code. Instantiating I2C devices via board files is done with an array of
struct i2c_board_info which is registered by calling
i2c_register_board_info().

Example (from omap2 h4)::
Example (from omap2 h4):

.. code-block:: c
static struct i2c_board_info h4_i2c_board_info[] __initdata = {
{
Expand Down Expand Up @@ -111,7 +115,9 @@ bus in advance, so the method 1 described above can't be used. Instead,
you can instantiate your I2C devices explicitly. This is done by filling
a struct i2c_board_info and calling i2c_new_client_device().

Example (from the sfe4001 network driver)::
Example (from the sfe4001 network driver):

.. code-block:: c
static struct i2c_board_info sfe4001_hwmon_info = {
I2C_BOARD_INFO("max6647", 0x4e),
Expand All @@ -136,7 +142,9 @@ it may have different addresses from one board to the next (manufacturer
changing its design without notice). In this case, you can call
i2c_new_scanned_device() instead of i2c_new_client_device().

Example (from the nxp OHCI driver)::
Example (from the nxp OHCI driver):

.. code-block:: c
static const unsigned short normal_i2c[] = { 0x2c, 0x2d, I2C_CLIENT_END };
Expand Down

0 comments on commit 43310e2

Please sign in to comment.