summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs/case_closed_debugging_cr50: Expand ccd open instructionsstabilize-rust-13836.B-cr50_stabstabilize-quickfix-13816.67.B-cr50_stabstabilize-LTS-13816.60.B-cr50_stabstabilize-13856.B-cr50_stabstabilize-13851.B-cr50_stabstabilize-13836.B-cr50_stabstabilize-13821.B-cr50_stabstabilize-13816.82.B-cr50_stabstabilize-13816.80.B-cr50_stabstabilize-13816.64.B-cr50_stabstabilize-13816.63.B-cr50_stabstabilize-13816.55.B-cr50_stabstabilize-13816.53.B-cr50_stabstabilize-13816.51.B-cr50_stabstabilize-13816.40.B-cr50_stabrelease-R90-13816.B-cr50_stabDavid Stevens2021-02-261-3/+4
| | | | | | | | | | BUG=b:181273639 TEST=view in gitiles Change-Id: Ibd39f3e93b082757274ccf4f4790d25ac6bb261e Signed-off-by: David Stevens <stevensd@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2719401 Reviewed-by: Mary Ruthven <mruthven@chromium.org>
* coil: cleanup commentsstabilize-rust-13720.B-cr50_stabMary Ruthven2021-01-114-10/+10
| | | | | | | | | | BUG=b:175244613 TEST=make buildall -j Change-Id: Icbd143b072fdd5df3b67d7e5a09ee6c01a77f6b9 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2622889 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
* coil: cleanup i2c commentsMary Ruthven2021-01-082-7/+7
| | | | | | | | | | | | Remove coil terms from i2c comments BUG=b:175244613 TEST=make buildall -j Change-Id: If056c099304e1fa676991e22ddaa9cb91ccfdeb3 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2613509 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
* coil: use links to the main branch in docsMary Ruthven2021-01-066-22/+22
| | | | | | | | | | BUG=b:175244613 TEST=make buildall -j Change-Id: I70b2374985aeefb3550e529dcdc53a9ab2fffecb Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2613453 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
* coil: remove docs that go in the ECMary Ruthven2021-01-068-2471/+1
| | | | | | | | | | | | | This code uses coil terms we're removing, but we don't use it in platform/cr50. Remove the code instead of replacing the terms. BUG=b:175244613 TEST=make buildall -j Change-Id: I2470f37fefb8b109efa1fb6126c9fa3a00bfcd3e Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2613450 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
* ccd_howtos: add test_that commandMary Ruthven2020-07-101-1/+9
| | | | | | | | | | | | | | | | Add a test_that command to show how we run tests locally. BUG=none TEST=none Change-Id: I04d1a5d96c03b1cdceff6677e64893498837ea88 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2092202 Reviewed-by: Shelley Chen <shchen@chromium.org> (cherry picked from commit 4bdb7d9889371ca8ae74599cead640a254ed7b0d) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278525 Tested-by: Vadim Bendebury <vbendeb@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org>
* ccd_howtos: add ccd faft setupMary Ruthven2020-07-101-2/+167
| | | | | | | | | | | | | | | BUG=none TEST=none Change-Id: Ibe22f9131dc34ce4185379d8db166de42a3d1e24 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1873853 Reviewed-by: Patrick Georgi <pgeorgi@chromium.org> (cherry picked from commit e4967bcc38227275d6788f1504e7a679c865357d) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278524 Tested-by: Vadim Bendebury <vbendeb@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* docs/case_closed_debugging_cr50: RefactorTom Hughes2020-07-101-625/+562
| | | | | | | | | | | | | | | Refactor the CCD documentation so it's easier for non-experts to understand. BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I89ba8fd5906119c4acfe1a555db5b7872dd949a9 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2137929 (cherry picked from commit 2ba6907508ecfc223c047db686fe459c9596f026) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278523 Tested-by: Vadim Bendebury <vbendeb@chromium.org>
* docs/case_closed_debugging_cr50.md: Unify shell prompt formattingTom Hughes2020-07-101-140/+211
| | | | | | | | | | | | | | | | | | | | | | | Use the standard used across the documentation for specifying different shell prompts: (chroot) $ (dut) $ cr50 > This makes it clear where the command should be run. BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I0383e00825b5d9b500464ac1979555ca5afd8296 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2136870 Commit-Queue: Mary Ruthven <mruthven@chromium.org> Reviewed-by: Mary Ruthven <mruthven@chromium.org> (cherry picked from commit 8f13313b8b0b8787e01f5604cc6b812155c2a6ac) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278522 Tested-by: Vadim Bendebury <vbendeb@chromium.org>
* docs/case_closed_debugging_cr50.md: Run mdformatTom Hughes2020-07-101-133/+126
| | | | | | | | | | | | | | | | | | | | No content changes. Command used: mdformat --compatibility -w docs/case_closed_debugging_cr50.md BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ieb84866ad610122da08873087f79a6d45ea17ab3 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2137633 Reviewed-by: Justin TerAvest <teravest@chromium.org> Commit-Queue: Justin TerAvest <teravest@chromium.org> (cherry picked from commit 14c35054e52bba725a3b34e64f50cf3446f4f1d5) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278361 Tested-by: Vadim Bendebury <vbendeb@chromium.org>
* docs: Add cr50 rescue mode detailsJustin TerAvest2020-07-101-0/+127
| | | | | | | | | | | | | | | | | | | | | This adapts the "UART rescue mode" text from go/cr50-devel to open-source documentation in the EC codebase. This information has been necessary for partners to update cr50 on their own internal boards, where other update methods may not be viable. BUG=None TEST=worked with partner to reflash cr50 with attached instructions Change-Id: I6cf5defd38432e0ceda3cc809d43d94fa14797b4 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1974501 Reviewed-by: Keith Short <keithshort@chromium.org> Commit-Queue: Justin TerAvest <teravest@chromium.org> Tested-by: Justin TerAvest <teravest@chromium.org> (cherry picked from commit bccc832b7dbc056f464d549dd5f347277670d1b3) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278360 Tested-by: Vadim Bendebury <vbendeb@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* ccd: add information about AP flash programming speed up.Vadim Bendebury2020-07-101-0/+78
| | | | | | | | | | | | | | | | | | | | When programming AP flash for the very first time it is sufficient to program just a few sections. This makes it possible for the device to boot Chrome OS, at which point the rest of the AP flash can be programmed much faster. BUG=none TEST=verified proper rendering using gerrit Change-Id: I444b857302e67c6d7c54c026b9205d0ec734e24a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1981085 Tested-by: Vadim Bendebury <vbendeb@chromium.org> Reviewed-by: Mary Ruthven <mruthven@chromium.org> Commit-Queue: Vadim Bendebury <vbendeb@chromium.org> (cherry picked from commit 85326c1662f8db3cdc9ed801986f65127ccca123) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278359 Commit-Queue: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* docs: Update CCD docsTom Hughes2020-07-101-56/+73
| | | | | | | | | | | | BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I7da8856cb0d39befead6418e53e709569adae613 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2134806 (cherry picked from commit 263b54489f08557690791fe7f0aaed634ddc6a2e) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278358 Tested-by: Vadim Bendebury <vbendeb@chromium.org>
* docs: Run mdformat on case_closed_debugging.mdTom Hughes2020-07-101-97/+107
| | | | | | | | | | | | | BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Id55665d87e80a472af61f0ccb7ecb8bc097ebb3c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2134646 Reviewed-by: Furquan Shaikh <furquan@chromium.org> (cherry picked from commit 697b49ae69ae35e1df9188e2c6f4df07b0cdc2cc) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278357 Tested-by: Vadim Bendebury <vbendeb@chromium.org>
* cr50_vboot_doc: improve picture renederingVadim Bendebury2020-06-291-15/+22
| | | | | | | | | | | | | | | | | | This patch addresses gerrit markdown rendering deficiency where the target image is not properly rendered gerrit by the gerrit server. The images were duplicated on Google Drive, such that the smaller in the page version of the image is still loaded from the local tree, but the target image comes from Drive, which allows to see full size images when required. BUG=none TEST=verified proper rendering of the full size images Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Change-Id: Ief2f18bd9b3805b391b19b8ebb8828d9e5ca05b4 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2274302 Reviewed-by: Mary Ruthven <mruthven@chromium.org>
* Cr50: vboot troubleshooting docVadim Bendebury2020-06-265-0/+223
| | | | | | | | | | | | | | A document describing how AP and H1 interact during the boot up process, and typical failures causing the Chrome OS device falling into recovery mode. BUG=none TEST=none Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Change-Id: Ib71ffbc9c7dadd5f42923c0bfac038ae7f0ca8e5 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2261318 Reviewed-by: Andrey Pronin <apronin@chromium.org>
* make: add preprocessor stageVadim Bendebury2020-03-311-0/+180
| | | | | | | | | | | | | | | | | | | | | | | | | | | For the upcoming introduction of transitioning Cr50 console communications to packet mode, there is a need to be able to replace all print function invocations in the code with calls to packet sending function. This replacement is easiest to make in C preprocessor outputs, as there all macros are replaced with actual function invocations. This patch adds a configuration option CONFIG_EXTRACT_PRINTF_STRINGS, when enabled, building of the image object files starts happening in three steps instead of one, instead of .c => .o transition, the steps are .c => .E => .Ep => .o, where .E is the C preprocessor output, and .Ep is result of post processing by ./util/util_precompile.py. BUG=b:149964350 TEST=image layout does not change if CONFIG_EXTRACT_PRINTF_STRINGS is not defined. With the rest of the patches applied defining the above config option allows to build a Cr50 image supporting packet console communications mode. Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Change-Id: I20b8ba7c5d13cb54ac6adbdbce856d92023ce997 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2113122 Reviewed-by: Randall Spangler <rspangler@chromium.org>
* cr50: change OWNERS to cr50 team membersMary Ruthven2019-12-101-1/+0
| | | | | | | | | | | | | | Change the OWNERS to cr50 team members and remove OWNERS files from all subdirectories. BUG=none BRANCH=none TEST=none Change-Id: I5ddff7c433a55b6724d92c026e9e64e82e1492ad Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1957850 Reviewed-by: Vadim Bendebury <vbendeb@chromium.org>
* docs: Add Fingerprint Authentication Design DocTom Hughes2019-11-202-0/+763
| | | | | | | | | | | | | BRANCH=none BUG=b:139532396 TEST=view in gitiles Change-Id: I3d215bd27ad80f91e9ded54b1f3dc5e54439ed55 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1919651 Reviewed-by: Yicheng Li <yichengli@chromium.org> Commit-Queue: Yicheng Li <yichengli@chromium.org> Tested-by: Yicheng Li <yichengli@chromium.org>
* docs: Removing battery disables HW write protectionTom Hughes2019-11-191-0/+3
| | | | | | | | | | | BRANCH=none BUG=none TEST=none Change-Id: Ic8f5a4378ce7b02e21518921c7a29edfaa031bf4 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1922064 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs/fingerprint: Add details on types of keysTom Hughes2019-11-181-9/+22
| | | | | | | | | | | | BRANCH=none BUG=none TEST=none Change-Id: I2c0b404ddfbd8e35fcc7455d93c1830167baa564 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1922229 Reviewed-by: Craig Hesling <hesling@chromium.org> Commit-Queue: Craig Hesling <hesling@chromium.org>
* docs/fingerprint: Clarify flash_fp_mcu behaviorTom Hughes2019-11-181-3/+4
| | | | | | | | | | | | BRANCH=none BUG=none TEST=none Change-Id: I9305add05965579e5cc4ffed54704a17da27e275 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1922228 Reviewed-by: Craig Hesling <hesling@chromium.org> Commit-Queue: Craig Hesling <hesling@chromium.org>
* docs: ccd_cr50 fix headingsMary Ruthven2019-10-311-18/+18
| | | | | | | | | | | BUG=none BRANCH=none TEST=view docs Change-Id: I68ba4ffcb09942fe80d6c0406bf946795114eb54 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1894130 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: Add dartmonkey to FPMCU partner docsTom Hughes2019-10-093-25/+43
| | | | | | | | | | | | | Also rename dragonclaw to bloonchipper. BRANCH=none BUG=none TEST=View in gitiles Change-Id: Ib2da4547bc4d8dbf44a0bc12b79a9136786a3764 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1842214 Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs/sitemap: add ccd howtosMary Ruthven2019-10-081-0/+1
| | | | | | | | | | | BUG=b:140551928 BRANCH=none TEST=link takes you to the howtos doc. Change-Id: Id018dccb08bd0e74463b5917f02fcd4f8ad5b867 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1846678 Reviewed-by: Wai-Hong Tam <waihong@google.com>
* docs: ccd gsc: add description of G3 WP issueMary Ruthven2019-10-082-3/+30
| | | | | | | | | | | | | | Cr50 may not be able to disable write protect in G3. Add a description and workaround for this issue to the ccd gsc docs. BUG=b:140551928 BRANCH=none TEST=none Change-Id: I752a1d4fd5a148af44b595924e57aaa7ec64e7a4 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1845780 Reviewed-by: Wai-Hong Tam <waihong@google.com>
* docs: add disable write protect howtoMary Ruthven2019-10-081-0/+136
| | | | | | | | | | | BUG=b:140551928 BRANCH=none TEST=read doc Change-Id: I37409c284a1959c584146e41d3d586785a6683f2 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1816927 Reviewed-by: Wai-Hong Tam <waihong@google.com>
* docs: add tutorial for using suzyqMary Ruthven2019-10-021-0/+69
| | | | | | | | | | | BUG=b:140551928 BRANCH=none TEST=read doc. Change-Id: I1032433de1f8284cffff1e12e906d3fffd5ae32a Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1816871 Reviewed-by: Wai-Hong Tam <waihong@google.com>
* docs: add an overview of AP to EC communicationstabilize-12560.BHarry Cutts2019-10-022-0/+154
| | | | | | | | | | | | | | | | | | | | This document is intended to replace the existing AP / EC communication page on the wiki [0]. (I'll link to it from there once this CL is submitted.) It's basically a write-up of what I learned while working on supporting host commands over I2C with the MAX32660, so it's probably missing various details, but I believe it's an improvement on the current page. [0]: https://sites.google.com/a/chromium.org/dev/chromium-os/ec-development/ap-ec-communication BRANCH=none BUG=none TEST=Check the rendering in Gitiles Change-Id: Ic62c98b41a5bf69ab10dee9143e7c45957f01bf2 Signed-off-by: Harry Cutts <hcutts@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1807964 Reviewed-by: Alexandru M Stan <amstan@chromium.org>
* doc: Add additional USB termsKeith Short2019-09-182-0/+30
| | | | | | | | | | | | | Add more USB terms to the EC glossary. BUG=none BRANCH=none TEST=none Change-Id: Ibc2c0d43959749d9527de08337f4a83b41a429ce Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1778634 Reviewed-by: Jett Rink <jettrink@chromium.org>
* doc: add link to sitemap for USB power policyJett Rink2019-09-181-1/+2
| | | | | | | | | | | BRANCH=none BUG=chromium:974302 TEST=view markdown Change-Id: I3ea124253f885f0fe94e60f89dab07cedcbab344 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1784123 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Add uServo to fp partner doc and cleanupCraig Hesling2019-09-145-63/+140
| | | | | | | | | | | | | | | | | * Add information about servo micro to fingerprint partner development doc. * Ran mdformat (http://go/mdformat#command-line) * General cleanup BRANCH=none BUG=b:132902349 TEST=Previewed in gitiles Change-Id: Iec6fc526339a7f8c1600ac4f7a136a41294928e7 Signed-off-by: Craig Hesling <hesling@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1789419 Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* docs: Updates to USB-PDKeith Short2019-09-101-8/+9
| | | | | | | | | | | | | | Minor updates to the USB-PD description. BUG=none BRANCH=none TEST=make buildall Change-Id: Id428f0815027ca25d798b56f00e41b2985609417 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1788245 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* usb: document ChromeOS power policy for USBJett Rink2019-08-281-0/+250
| | | | | | | | | | | | | BRANCH=none BUG=chromium:974302 TEST=builds Change-Id: I9b44b51876a0c46cb7b6aaf765afbf2c73c8d87c Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1755644 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org> Reviewed-by: David Schneider <dnschneid@chromium.org> Reviewed-by: Benson Leung <bleung@google.com>
* USBC PD: update usb-c docDenis Brockus2019-08-231-3/+6
| | | | | | | | | | | | | | | change new state machine file references to be up to date with the current code. BUG=none BRANCH=none TEST=none Change-Id: I4182b71bea107c4b9b852b93dcf59be5f4616f4d Signed-off-by: Denis Brockus <dbrockus@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1757086 Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jett Rink <jettrink@chromium.org>
* doc: Update EC termsKeith Short2019-08-212-13/+44
| | | | | | | | | | | | | | Add more EC definitions. Correct the named anchors in the USB-C markdown. And a link from the main EC readme. BUG=none BRANCH=none TEST=none Change-Id: Ica7e7c270373589d850166539fb1b13b1ddbd7e0 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1758826 Reviewed-by: Edward Hill <ecgh@chromium.org>
* docs: Add fingerprint docs for partnersTom Hughes2019-08-1512-0/+440
| | | | | | | | | | | BRANCH=none BUG=none TEST=View in gitiles Change-Id: Ie1dc7ea93f3471dd10863e546b4a9dc001e7f3c1 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1742878 Reviewed-by: Nicolas Norvez <norvez@chromium.org>
* doc: switch to markdown anchorsKeith Short2019-08-092-30/+30
| | | | | | | | | | | | | Switch from HTML to markdown anchors for linked references. BUG=none BRANCH=none TEST=none Change-Id: Ibd032e58cb0bea9234713fa3082db8fb3e259153 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1745346 Reviewed-by: Edward Hill <ecgh@chromium.org>
* doc: Add documentation for EC termsKeith Short2019-08-093-4/+164
| | | | | | | | | | | | | Add documentation for acronyms and technologies used in the EC codebase. BRANCH=none BUG=none TEST=run md_browser.py against changes Change-Id: I2ccc6e7c0c60144ded2e7b8cc171fa2a2897d006 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1740080 Reviewed-by: Edward Hill <ecgh@chromium.org>
* docs: Add fingerprint (FPMCU) docsTom Hughes2019-08-063-0/+532
| | | | | | | | | | | | | | BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I64c6060bdf41f69af05a8ffd64d437fb1fd2b507 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658525 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org> Commit-Queue: Aseda Aboagye <aaboagye@chromium.org>
* docs: add i2c doc to site mapJett Rink2019-07-221-0/+1
| | | | | | | | | | | | BRANCH=none BUG=none TEST=verified markdown rendering Change-Id: Ibef37a8f9818d2cb9e2bd50097819d2c6a646398 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1713737 Commit-Queue: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* common: add i2c tracing functionalityJack Rosenthal2019-07-171-0/+48
| | | | | | | | | | | | | | | | | | | crbug.com/982442 requests a way for developers to enable tracing of i2c commands when debugging. This adds a new debug feature, the i2ctrace command, which provides that. The command is guarded by CONFIG_I2C_DEBUG. BUG=chromium:982442 BRANCH=none TEST=enabled CONFIG_I2C_DEBUG on arcada_ish, made sure that command functioned as it says on the tin Change-Id: I9c762271237cbf131e5ef7c0f605c89af4f209fd Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1699347 Reviewed-by: Denis Brockus <dbrockus@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Denis Brockus <dbrockus@chromium.org>
* doc: add documentation for usb-c on platform/ecJett Rink2019-07-022-0/+204
| | | | | | | | | | | | | | | Add documentation for common configuration and touch points that need to be considered when implementing the USB-C stack on the platform/ec codebase. BRANCH=none BUG=chromium:974302 TEST=none Change-Id: I24aef187989c14688985d3cba48a6734ee519d23 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1648609 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: add cr50 ccd prerequisitesMary Ruthven2019-06-281-0/+37
| | | | | | | | | | | | | | Add some prerequisites that tell you what you need to emerge. BUG=none BRANCH=none TEST=read doc prerequisites. Make sure information and formatting looks ok. Change-Id: Iedbbd297b9f98890cb07dc658d2643ebb006ef3f Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1682170 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: Add OWNERS for fingerprint docsTom Hughes2019-06-181-0/+1
| | | | | | | | | | | BRANCH=none BUG=chromium:973205 TEST=make buildall -j Change-Id: I092903bb259be2e7dca8e6d486d810f2b073b9cd Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658678 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Add sitemapTom Hughes2019-06-131-0/+19
| | | | | | | | | | | | | | | | | When new docs are added, they should be added to this sitemap, so that the documentation is discoverable and easy to navigate. BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I327d444eb64b0142fb2f00e3e0fd55bc072f47e7 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658629 Reviewed-by: Randall Spangler <rspangler@chromium.org> Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Add "Getting Started Quickly"Tom Hughes2019-06-121-0/+129
| | | | | | | | | | | | | | | | | | | | | Converted the documentation in http://dev.chromium.org/chromium-os/ec-development/getting-started-building-ec-images-quickly to Markdown with go/gdc. I made minor cleanups to the Markdown after the conversion due to bugs in the formatting, but preserved the content/text. It's known that this documentation is out of date, but I wanted to preserve the history, so updates to the context/text should be made after this commit. BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I05b8fbb48345be028a9f8a046bffe422b599c77a Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1655949 Reviewed-by: Jett Rink <jettrink@chromium.org>
* ccd doc: link to suzyq instructions in cr50 setupMary Ruthven2019-05-121-2/+4
| | | | | | | | | | | | | | | Plugging in suzyq and finding the cr50 console requires some knowledge about how CCD works. Link to the specific instructions from the main CCD doc, so people can find out how to do it. BUG=none BRANCH=none TEST=none Change-Id: I49ee6d8d937f61599f8b18378e5775eb78bacfcf Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1599682 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* ccd doc: add more to information about using ccdMary Ruthven2019-05-101-12/+25
| | | | | | | | | | | | BUG=none BRANCH=none TEST=none Change-Id: I5776c16032863a2a0f8d5c82f148c80822379dec Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1599681 Commit-Ready: ChromeOS CL Exonerator Bot <chromiumos-cl-exonerator@appspot.gserviceaccount.com> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* ccd doc: link cr50 doc in main ccd docMary Ruthven2019-05-091-3/+4
| | | | | | | | | | | | | BUG=none BRANCH=none TEST=verify link works Change-Id: I774a0dc1c0965f3655c46b09ff9bdd3e12f21200 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1599680 Commit-Ready: ChromeOS CL Exonerator Bot <chromiumos-cl-exonerator@appspot.gserviceaccount.com> Reviewed-by: Kevin Shelton <kmshelton@chromium.org> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>