summaryrefslogtreecommitdiff
path: root/Documentation/i2c
diff options
context:
space:
mode:
authorLuca Ceresoli <luca@lucaceresoli.net>2020-01-29 16:19:32 +0100
committerWolfram Sang <wsa@the-dreams.de>2020-01-29 22:01:29 +0100
commitf72beb8bf9c401483a08fb548bbc9b946680a637 (patch)
tree7867b8fd9b0c272463d8f7c1895ad0837a270b25 /Documentation/i2c
parent48ca3b7fb82ccc00a20e8d97f35ee7e6813ac1f9 (diff)
docs: i2c: i2c-protocol: fix kernel-doc function syntax
This clarifies these are functions and adds a hyperlink to the function documentation. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Reviewed-by: Jean Delvare <jdelvare@suse.de> Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
Diffstat (limited to 'Documentation/i2c')
-rw-r--r--Documentation/i2c/i2c-protocol.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/i2c/i2c-protocol.rst b/Documentation/i2c/i2c-protocol.rst
index 0222c97f3436..f289d7759a51 100644
--- a/Documentation/i2c/i2c-protocol.rst
+++ b/Documentation/i2c/i2c-protocol.rst
@@ -28,7 +28,7 @@ Count (8 bits): A data byte containing the length of a block operation.
Simple send transaction
=======================
-This corresponds to i2c_master_send::
+This corresponds to i2c_master_send()::
S Addr Wr [A] Data [A] Data [A] ... [A] Data [A] P
@@ -36,7 +36,7 @@ This corresponds to i2c_master_send::
Simple receive transaction
==========================
-This corresponds to i2c_master_recv::
+This corresponds to i2c_master_recv()::
S Addr Rd [A] [Data] A [Data] A ... A [Data] NA P
@@ -44,7 +44,7 @@ This corresponds to i2c_master_recv::
Combined transactions
=====================
-This corresponds to i2c_transfer
+This corresponds to i2c_transfer().
They are just like the above transactions, but instead of a stop bit P
a start bit S is sent and the transaction continues. An example of