summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* docs/fingerprint: update Bloonchipper power numbersVincent Palatin2020-12-161-8/+23
| | | | | | | | | | | | | | | | | | | | | | Re-measure power numbers on a Bloonchipper dev board connected to a servo micro. Put numbers for the 2 possible idle modes of the MCU by toggling the slp_s3 line: - regular idle when the host processor is running - low power idle when the host processor is suspended Signed-off-by: Vincent Palatin <vpalatin@chromium.org> BRANCH=none BUG=b:130561737 TEST=view in gitiles Change-Id: I2cf1f069252dbb8461dd941c4ae83bd62cb48856 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2595270 Tested-by: Vincent Palatin <vpalatin@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org> Reviewed-by: Todd Broch <tbroch@chromium.org> Commit-Queue: Vincent Palatin <vpalatin@chromium.org>
* ide-support: Add vscode default settings.json and gitignoresCraig Hesling2020-12-141-36/+5
| | | | | | | | | | | | | | | | | | | | | | This adds a .default settings.json file for vscode, so that you do not need to copy/paste form the ide-support.md doc. This also makes it easier for people that don't known that the ide-support.md doc exists. This also adds the .vscode directory to the gitignores, so that local customization/settings are not always in the git status. BRANCH=none BUG=none TEST=Checked in Gitiles TEST=Check that my settings.json is not in "git status". TEST=Check that ec.code-workspace is not in "git status". Change-Id: I4dd8cfcd79c291a6f4fb0d573df131f0cb0d9844 Signed-off-by: Craig Hesling <hesling@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2586041 Commit-Queue: Jett Rink <jettrink@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs/ide-support.md: Run mdformatCraig Hesling2020-12-141-36/+42
| | | | | | | | | | | | | | mdformat -w --compatibility docs/ide-support.md BRANCH=none BUG=none TEST=Check in Gitiles Change-Id: I5c381679bff894b48a49c7a5a20e8e5268678762 Signed-off-by: Craig Hesling <hesling@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2586040 Commit-Queue: Jett Rink <jettrink@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: Fix typos in write protection docTom Hughes2020-12-071-11/+11
| | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ib512490365a0f20380813bd871f7effbf374a435 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2552604 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* docs: Fix headers in write protection docTom Hughes2020-12-071-7/+7
| | | | | | | | | | | | | gitiles doesn't render backticks in headers. BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I312799ad938d35e8452a90d129baf933ff6639e0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2552603 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* docs/fingerprint: Add instructions to run firmware testsYicheng Li2020-11-242-0/+112
| | | | | | | | | | | | BRANCH=none BUG=b:171422264 TEST=none Change-Id: I677b1f17a997a21e906674bb4dc9e02a8e207a1f Signed-off-by: Yicheng Li <yichengli@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2552353 Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org>
* docs: Run mdformat on write protection docTom Hughes2020-11-231-25/+30
| | | | | | | | | | | | | | Command used: (outside) $ mdformat -in_place --compatibility docs/write_protection.md BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I3889b3279165b5897f5489549d4530681b6ac5b6 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2552602 Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
* docs: Add links in write protection docTom Hughes2020-11-201-1/+2
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I1542ceef2f14c06faff2d02fe584c88384e36e21 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2552601 Commit-Queue: Aseda Aboagye <aaboagye@chromium.org> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs/fingerprint: Add links to Nucleo boardsTom Hughes2020-11-201-4/+8
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I6d9ca47ee14580092812446992eb785a47874dcf Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2546030 Commit-Queue: Yicheng Li <yichengli@chromium.org> Reviewed-by: Yicheng Li <yichengli@chromium.org>
* i2c_master: extend i2c_xfer_no_retry to also support large writestabilize-13605.B-masterTing Shen2020-11-171-1/+1
| | | | | | | | | | | | | | | | | This CL extends CONFIG_I2C_XFER_LARGE_READ to also support large (greater than 255 bytes) write. Related config name is also updated to reflect the behavior change, BUG=b:169651794 TEST=flash fw successfully on Zed. BRANCH=none Signed-off-by: Ting Shen <phoenixshen@google.com> Change-Id: Icb889013da01f48708cd0227207561b8186bac63 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2537412 Reviewed-by: Nicolas Boichat <drinkcat@chromium.org> Commit-Queue: Ting Shen <phoenixshen@chromium.org> Tested-by: Ting Shen <phoenixshen@chromium.org>
* docs/fingerprint: Add fingerprint template sizesTom Hughes2020-11-061-4/+15
| | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I68d9364c0d02fdf30e00df40f514f68829d2cece Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2521835 Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs/fingerprint: Run mdformat on markdown docsTom Hughes2020-11-063-4/+10
| | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ib5a0f5e3e910b238139bee690d059362a40622ac Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2521453 Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs/fingerprint: Workaround mdformat and gitiles note syntaxTom Hughes2020-11-064-0/+44
| | | | | | | | | | | | | | mdformat incorrectly formats "*** note" blocks, so disable mdformat on those blocks. BRANCH=none BUG=none TEST=View in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I4a7894402373a4c91688263454d33554b324aece Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2521452 Reviewed-by: Craig Hesling <hesling@chromium.org>
* COIL: Rename CONFIG_I2C_CONTROLLERDiana Z2020-11-051-1/+1
| | | | | | | | | | | | | Rename CONFIG_I2C_CONTROLLER and related comments. BRANCH=None BUG=None TEST=make -j buildall Signed-off-by: Diana Z <dzigterman@chromium.org> Change-Id: Ied6a1829bf54a5c9a32e6772982a4b8aa31aaf23 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2518659 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* COIL: Rename CONFIG_HOSTCMD_I2C_ADDR_FLAGSDiana Z2020-10-311-1/+1
| | | | | | | | | | | | | Rename for CONFIG_HOSTCMD_I2C_ADDR_FLAGS and surrounding comments. BRANCH=None BUG=None TEST=make -j buildall Signed-off-by: Diana Z <dzigterman@chromium.org> Change-Id: I49dc12753957da7baa1bb387e212d75c75e81d86 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2511093 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* test: support building base32 as a Zephyr testPaul Fagerburg2020-10-283-38/+217
| | | | | | | | | | | | | | | | With the Ztest API supported now, add the files to build the base32 unit test as a Zephyr test (instead of an EC test). BUG=b:168032590 BRANCH=None TEST=follow instructions in docs/ztest.md to build as a Zephyr test Signed-off-by: Paul Fagerburg <pfagerburg@google.com> Change-Id: I06dd7864f2de48aab5776950d4840f81728137f1 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2500465 Tested-by: Paul Fagerburg <pfagerburg@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Paul Fagerburg <pfagerburg@chromium.org>
* test: Allow EC unit test to use Ztest APIPaul Fagerburg2020-10-231-3/+69
| | | | | | | | | | | | | | | | | | | | | | | | Provide a translation layer in test_utils.h for the Zephyr zassert macros to map onto EC's TEST_ASSERT macros. With a little bit of duplicated-but-not-quite-duplicated code (test_main vs. run_test) and some extra macros for the return type of the test cases, the tests can build for either the EC framework (by default) or the Zephyr Ztest framework (#ifdef CONFIG_ZEPHYR). Update the unit test documentation to explain why (and a brief "how") developers should use the Ztest API for new unit tests. BUG=b:168032590 BRANCH=none TEST=`TEST_LIST_HOST=base32 make runhosttests` Signed-off-by: Paul Fagerburg <pfagerburg@google.com> Change-Id: I26e60788c1468e44fed565dd31162759c7587ea6 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2492527 Tested-by: Paul Fagerburg <pfagerburg@chromium.org> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Paul Fagerburg <pfagerburg@chromium.org>
* Doc: Update plans for TCPMv2 type-c power policyDiana Z2020-10-123-54/+54
| | | | | | | | | | | | | | | | This updates the existing planned type-c power policy behavior, and adds a note clarifying that this page represents an ideal which has not yet been added to the codebase. BRANCH=None BUG=b:168862110 TEST=rendered the .md file and images to ensure they work correctly Signed-off-by: Diana Z <dzigterman@chromium.org> Change-Id: I82ea19b7b7ac84080bed6fd1841ec7273b55e84a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2460857 Reviewed-by: Keith Short <keithshort@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: Fix typosTom Hughes2020-10-121-42/+42
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I5ca6773dfdfe41fc99780e6f3f532fa27b25424b Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2464007 Commit-Queue: Diana Z <dzigterman@chromium.org> Reviewed-by: Diana Z <dzigterman@chromium.org>
* docs: Run mdlint on core_runtime.mdTom Hughes2020-10-121-181/+165
| | | | | | | | | | | | | | Command used: mdformat --compatibility -w ./platform/ec/docs/core_runtime.md BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I94d9f9580d3bca9b023d30eedcd0c8f408bef0da Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2464004 Reviewed-by: Diana Z <dzigterman@chromium.org>
* doc: add zephyr shim designJett Rink2020-10-011-0/+168
| | | | | | | | | | | | | | | | We are turning platform/ec code into a zephyr module that we can then shim into a zephyr build. We are going to do this while we are transitioning to the zephyr codebase. BRANCH=none BUG=none TEST=none Signed-off-by: Jett Rink <jettrink@chromium.org> Change-Id: I68fb215296e872c68fef1cb5cd92902f3f8ee8e2 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2438807 Commit-Queue: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* docs/fingerprint: Add link to reference manualsTom Hughes2020-09-241-2/+2
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I53ddbad8cef8bccf44df3d771b9d9e0e0f9ef928 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2429493 Commit-Queue: Yicheng Li <yichengli@chromium.org> Reviewed-by: Yicheng Li <yichengli@chromium.org>
* util: update recommended JLink versionTom Hughes2020-09-181-2/+2
| | | | | | | | | | | | | BRANCH=none BUG=b:158327221 TEST==With dragonclaw v0.2 connected to Segger J-Trace and servo micro: ./test/run_device_tests.py Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ibef704e447ecb94e383cd1463e7258c382272998 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2410830 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* COIL: remove master/slave instances from EC termsKeith Short2020-08-211-15/+26
| | | | | | | | | | | | | | | | | | | | Google is working to change its source code to use more inclusive language. To that end, replace the terms "master" and "slve" with more inclusive alternatives. For SPI description, follow terminology suggested by the open source hardware association. https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names/ BUG=b:163885307 BRANCH=none TEST=Verify md output in gitiles. Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: Ib12ce61a79b44744fbf3fb6ff19df077e150139c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2358192 Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
* ec: change usage of dummySam Hurst2020-08-071-3/+3
| | | | | | | | | | | | | | | | | | | Google is working to change its source code to use more inclusive language. To that end, replace the term "dummy" with inclusive alternatives. BUG=b:162896016 BRANCH=None TEST=make -j buildall `grep -ir dummy *` The only results are in "private/nordic_keyboard/sdk8.0.0" which is not our code. Signed-off-by: Sam Hurst <shurst@google.com> Change-Id: Ibb61a014ca0d835fcdecbb7b64e8cf2d3938cec4 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2339781 Reviewed-by: Jett Rink <jettrink@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* Dragonclaw in CQ Prototype EnvironmentAadit Modi2020-08-062-0/+6
| | | | | | | | | | | | | | Adding diagram for dragonclaw in CQ. BUG=b:161567966 TEST=rendered with gittiles Change-Id: If0bf25366ac141d6d353a64b293a8032ed7bd48b Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2321885 Tested-by: Aadit Maheshkumar Modi <modia@chromium.org> Reviewed-by: Yicheng Li <yichengli@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Aadit Maheshkumar Modi <modia@chromium.org>
* ec: change usage of dummySam Hurst2020-08-052-2/+2
| | | | | | | | | | | | | | | | | | Google is working to change its source code to use more inclusive language. To that end, replace the term "dummy" with inclusive alternatives. BUG=b:162781382 BRANCH=None TEST=make -j buildall `grep -ir dummy *` The only results are in "private/nordic_keyboard/sdk8.0.0" which is not our code. Signed-off-by: Sam Hurst <shurst@google.com> Change-Id: I6a42183d998e4db4bb61625f962867fda10722e2 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2335737 Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* docs: Add note about downloading HTML schematicsTom Hughes2020-07-291-2/+4
| | | | | | | | | | BRANCH=none BUG=b:147154913 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ide185001a90896a3ccab69e86c2810a65ff44b6c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2317176
* docs: add links to fingerprint schematicsTom Hughes2020-07-234-8/+14
| | | | | | | | | | | | BRANCH=none BUG=b:147154913 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I81cccf5832ff269eb476d3f8b079cd9b620e986f Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2310864 Commit-Queue: Yicheng Li <yichengli@chromium.org> Reviewed-by: Yicheng Li <yichengli@chromium.org>
* docs: Add dragonclaw v0.2 schematicsTom Hughes2020-07-235-0/+7436
| | | | | | | | | | | | | | | Schematics from commit ab219060b29f55c904192cae83fe7d668b73d4b9 in EE board/dragonclaw repo. BRANCH=none BUG=b:147154913 TEST=none Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I67506f243419a0bb120e5726f7f2cb269422d328 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2310851 Commit-Queue: Yicheng Li <yichengli@chromium.org> Reviewed-by: Yicheng Li <yichengli@chromium.org>
* docs/fingerprint: Format with mdformatTom Hughes2020-07-213-55/+57
| | | | | | | | | | | | | | No content changes. BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ib723245b20c34c0b9c65128e10cebfdd0de27ff6 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2254995 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs: update CCD docs locationsVadim Bendebury2020-07-106-1454/+17
| | | | | | | | | | | | | BRANCH=none BUG=none TEST=verified that gitfiles points at the correct documents. Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Change-Id: I6123e74449d6dbda1645f4293dd24914ccaf0d37 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2276330 Reviewed-by: Jett Rink <jettrink@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org>
* docs/fingerprint: Add power measurementsTom Hughes2020-07-062-1/+48
| | | | | | | | | | BRANCH=none BUG=b:148296085 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ia8dde9ce8dd605777ca8eaf92fa16076bda3ef5a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2254993
* docs: add reference to Cr50 branch versionsVadim Bendebury2020-07-011-3/+11
| | | | | | | | | | | | | | | | | | Most accurate versions of Cr50 documents are maintained in the cr50_stab branch, they should be referenced in the site map. Also, let's add a separate section for verified boot troubleshooting, it could be enhanced later with EC EFS related documents. BRANCH=none BUG=none TEST=using the gerrit gitfiles link verified that the documents are rendered as expected and from the expected location Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Change-Id: Ie76af05f9def669be99abc35cbc6bab6f3cace18 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2278130 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
* docs/fingerprint: Add instructions for toggling hardware write protectTom Hughes2020-06-231-0/+25
| | | | | | | | | | | | BRANCH=none BUG=none TEST=none Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ibd8fa4a504798860acb85ae8fc4c4383ee55337e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2190821 Reviewed-by: Craig Hesling <hesling@chromium.org> Commit-Queue: Craig Hesling <hesling@chromium.org>
* docs: Design doc for Detachable Base Verified BootTom Hughes2020-06-172-0/+436
| | | | | | | | | | | | | | | Original document: http://go/detachable-base-vboot Cleanup document: https://docs.google.com/document/d/1Gm2LXaoQeyo-eppss62sQdKkxd_qD2FdBPDOHQId3qI/ BRANCH=none BUG=b:145815809 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ic27848f2a86234a8f757262ecaba784f19e0ba38 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2249462 Commit-Queue: Nicolas Boichat <drinkcat@chromium.org> Reviewed-by: Nicolas Boichat <drinkcat@chromium.org>
* makefile: use separate directory for code coveragePaul Fagerburg2020-06-121-20/+1
| | | | | | | | | | | | | | | | | | | | | | | When building host-based unit tests for code coverage, put the build outputs in a different directory. Because the code coverage build has calls into gcov library functions, a partial rebuild without code coverage will result in undefined linker errors. The previous solution was an inefficient cycle of `make clobber` and full rebuild when switching between building with and without code coverage. BUG=b:157091606 BRANCH=None TEST=`make buildall -j ; make coverage -j` Verify that build/host and build/coverage both exist, and that code coverage data (*.gcno, *.gcda, *.info) is only in build/coverage. Signed-off-by: Paul Fagerburg <pfagerburg@google.com> Change-Id: Iac0b18068082d34546aa15b174f86efb6a7f41a7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2242351 Tested-by: Paul Fagerburg <pfagerburg@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Commit-Queue: Paul Fagerburg <pfagerburg@chromium.org>
* unit_tests.md: refine tutorialKevin Shelton2020-06-111-2/+8
| | | | | | | | | | | | | BRANCH=none BUG=b:157576189 TEST=rendered in gitiles Signed-off-by: Kevin Shelton <kmshelton@chromium.org> Change-Id: I925d396c5f0d9e9ef6fe6349c5ffb1ea2ab2eaf1 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2242397 Commit-Queue: Tom Hughes <tomhughes@chromium.org> Tested-by: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* test: Pass commandline arguments to run_testTom Hughes2020-05-301-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | run_test is called by the "runtest" console command. Console commands can take arguments, so pass along the arguments to run_test to allow parameters to be passed to run_test. The following command was used for automatic replacement: git grep --name-only 'void run_test(void)' |\ xargs sed -i 's#void run_test(void)#void run_test(int argc, char **argv)##' BRANCH=none BUG=b:155897971 TEST=make buildall -j TEST=Build and flash flash_write_protect test > runtest 1 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ib20b955d5ec6b98f525c94c24aadefd7a6a320a5 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2209418 Reviewed-by: Yicheng Li <yichengli@chromium.org> Commit-Queue: Yicheng Li <yichengli@chromium.org> Tested-by: Yicheng Li <yichengli@chromium.org>
* docs/case_closed_debugging_cr50: RefactorTom Hughes2020-05-271-625/+562
| | | | | | | | | | | | | Refactor the CCD documentation so it's easier for non-experts to understand. BRANCH=none 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
* TCPMv2: Only include PD3.0 functionality when CONFIG_USB_PD_REV30Sam Hurst2020-05-211-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | The TCPMv2 stack defaults to PD2.0 functionality. Defining CONFIG_USB_PD_REV30 enables PD3.0 functionality. BUG=b:155879504 BRANCH=none TEST=make -j buildall Manual tests: passed FAFT_PD running on kohaku Before patch: *** 18624 bytes in flash and 29216 bytes in RAM on kohaku RO **** *** 18544 bytes in flash and 29216 bytes in RAM on kohaku RW **** After patch: *** 23320 bytes in flash and 30336 bytes in RAM on kohaku RO **** *** 23228 bytes in flash and 30336 bytes in RAM on kohaku RW **** Flash savings of 4696 bytest Ram savings of 1120 Signed-off-by: Sam Hurst <shurst@google.com> Change-Id: I082cf62617a91b487d2d3567afd5e340bd52258c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2184547 Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: add howto for code coveragePaul Fagerburg2020-05-202-0/+54
| | | | | | | | | | | | | | Add documentation for how to build the unit tests for code coverage. BUG=b:156553508 BRANCH=none TEST=renders in gerrit Signed-off-by: Paul Fagerburg <pfagerburg@chromium.org> Change-Id: Iaf7a4e231f6817f51848af101dac6c73afe3f59a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2209427 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: Update CCD docsTom Hughes2020-05-151-56/+73
| | | | | | | | | | BRANCH=none 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
* util: Add support to auto-flash with Segger J-Link gdbserverTom Hughes2020-05-051-5/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Automatically flash the EC binary when running gdb combined with Segger J-Link gdbserver and JTrace. For most code changes, the flashing only takes a 10-20 seconds. Also updated FPMCU debugging docs to mention the gdbinit. BRANCH=none BUG=none TEST=On machine with dragonclaw attached to J-Trace: JLink_Linux_V670e_x86_64/JLinkGDBServerCLExe -select USB -device STM32F412CG -endian little -if SWD -speed auto -noir -noLocalhostOnly BOARD=bloonchipper GDBSERVER=segger gdb --ex "target remote 127.0.0.1:2331" TEST=Same as above, but using CLion for gdb as described in https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/docs/fingerprint/fingerprint-debugging.md and setting USING_CLION=FALSE Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I88440c0bc8c9b170b239335a33b3c0a0387447f2 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2166143 Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs: Remove firmware code review guidelinesAbe Levkoy2020-04-271-102/+7
| | | | | | | | | | | | | | They have moved to the top-level docs directory. BUG=none TEST=Viewed rendered Markdown BRANCH=none Cq-Depend: chromium:2145046 Change-Id: Ibd140549b4b008448589abcb83b6120dca4ef642 Signed-off-by: Abe Levkoy <alevkoy@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2145080 Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs/fingerprint: Add another power measurement commandTom Hughes2020-04-171-1/+7
| | | | | | | | | | | | | | | | | Also update the servod commandline for the change in https://crrev.com/c/2142757 (the INA files are now included in the board-specific XML file, so there is no need to specify them when running servod). BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I93f7d41314003c7160e1c7805e0248934a6d8ee0 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2144369 Reviewed-by: Craig Hesling <hesling@chromium.org> Commit-Queue: Craig Hesling <hesling@chromium.org>
* docs/fingerprint: Make power its own sectionTom Hughes2020-04-081-9/+10
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: If8b15ac197f1e18eb85b30b9fa29023a20e02ac6 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2140923 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs/case_closed_debugging_cr50.md: Unify shell prompt formattingTom Hughes2020-04-061-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. BRANCH=none 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>
* docs/case_closed_debugging_cr50.md: Run mdformatTom Hughes2020-04-061-133/+126
| | | | | | | | | | | | | | | | | | No content changes. Command used: mdformat --compatibility -w docs/case_closed_debugging_cr50.md BRANCH=none 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>
* docs: Run mdformat on case_closed_debugging.mdTom Hughes2020-04-021-97/+107
| | | | | | | | | | | BRANCH=none 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>