summaryrefslogtreecommitdiff
path: root/docs/i2c-debugging.md
diff options
context:
space:
mode:
authorSean Abraham <seanabraham@chromium.org>2021-03-01 15:13:48 -0700
committerSean Abraham <seanabraham@chromium.org>2021-03-01 22:59:54 +0000
commit1e800ac838504c0d2950c7aa90cdfe7bde251545 (patch)
tree64706ca3d77a1452ac653d40fb71e6ae9d6a34bc /docs/i2c-debugging.md
parentef6a915de0a2b65c18c03074b66717d597675162 (diff)
downloadchrome-ec-master.tar.gz
docs: point md files in master to main/HEADmaster
Master md files are out of date. Point to main branch in case someone lands in master branch from an old link. BUG=b:180952272,b:180921286 BRANCH=None TEST=Preview changes with gerrit Exempt-From-Owner-Approval: fixing docs Change-Id: I6583b6c7fc21248eb49a6cd71e077fbdb5de2435 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2727846 Reviewed-by: Sean Abraham <seanabraham@chromium.org> Reviewed-by: Rob Barnes <robbarnes@google.com> Auto-Submit: Sean Abraham <seanabraham@chromium.org> Tested-by: Sean Abraham <seanabraham@chromium.org>
Diffstat (limited to 'docs/i2c-debugging.md')
-rw-r--r--docs/i2c-debugging.md57
1 files changed, 4 insertions, 53 deletions
diff --git a/docs/i2c-debugging.md b/docs/i2c-debugging.md
index 7ab84f9d8d..304f72aa2c 100644
--- a/docs/i2c-debugging.md
+++ b/docs/i2c-debugging.md
@@ -1,54 +1,5 @@
-I²C Debugging Tips
-==================
+*** note
+**Warning: This document is old & has moved. Please update any links:**<br>
+https://chromium.googlesource.com/chromiumos/platform/ec/+/HEAD/docs/i2c-debugging.md
+***
-The EC codebase has functionality to help you debug I²C errors without
-pulling out the scope. Some of the debug functionality is disabled by
-default to save space, but can be enabled with the `CONFIG_I2C_DEBUG`
-option.
-
-Tracing
--------
-
-You can use the `i2ctrace` command to monitor (ranges of) addresses:
-
-```
-i2ctrace [list
- | disable <id>
- | enable <port> <address>
- | enable <port> <address-low> <address-high>]
-```
-
-For example:
-
-```
-> i2ctrace enable 0 0x10 0x30
-> i2ctrace enable 1 0x20
-> i2ctrace list
-id port address
--- ---- -------
-0 0 0x10 to 0x30
-1 1 0x40 to 0x50
-... debug spam may follow ...
-i2c: 1:0x20 wr 0x10 rd 0x01 0x00
-i2c: 1:0x20 wr 0x10 0x01 0x00
-...
-> i2ctrace disable 1
-> i2ctrace list
-id port address
--- ---- -------
-0 0 0x10 to 0x30
-```
-
-A maximum of 8 debug entries are supported at a single time.
-
-Note that `i2ctrace enable` will merge debug entries when possible:
-
-```
-> i2ctrace enable 0 0x10 0x30
-> i2ctrace enable 0 0x40 0x50
-> i2ctrace enable 0 0x31 0x3f
-> i2ctrace list
-id port address
--- ---- -------
-0 0 0x10 to 0x50
-``` \ No newline at end of file