summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* docs: Add factory quick guide to sitemapPhilip Chen2020-03-271-0/+2
| | | | | | | | | | | | | BUG=none BRANCH=none TEST=View Markdown in gitiles Change-Id: I047797c977643cf1c5a3b87c8573ddcbce963f63 Signed-off-by: Philip Chen <philipchen@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2124877 Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org> Tested-by: Tom Hughes <tomhughes@chromium.org>
* Docs: Adding TCPMv2 overview documentDiana Z2020-03-277-8/+187
| | | | | | | | | | | | | | | General overview of TCPMv2, converted to md format. Updated new stack portion of the USB-C overview to link to this document, so only one location needs to be updated in the future with config changes. BUG=None BRANCH=None TEST=rendered in chrome with markdown preview plus extension Signed-off-by: Diana Z <dzigterman@chromium.org> Change-Id: Iab74dbee97eeb8c39fe210787bb142c6a1ec6af8 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2124010 Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs/fingerprint: Add factory quick guidePhilip Chen2020-03-271-0/+97
| | | | | | | | | | | | | BUG=none BRANCH=none TEST=View Markdown in gitiles Change-Id: I0cba21879388ac228d306f54011e020130b0a233 Signed-off-by: Philip Chen <philipchen@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2116494 Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org> Tested-by: Tom Hughes <tomhughes@chromium.org>
* code_reviews: Add an example of CLs linked by topicAbe Levkoy2020-03-201-1/+3
| | | | | | | | | | | | BUG=none TEST=View rendered Markdown BRANCH=none Change-Id: Icabde60da7758d89ab11abe11d5870f25fda4209 Signed-off-by: Abe Levkoy <alevkoy@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2108862 Reviewed-by: Keith Short <keithshort@chromium.org> Commit-Queue: Keith Short <keithshort@chromium.org>
* docs/ide-suport.md: Add better editor settingsCraig Hesling2020-03-171-3/+19
| | | | | | | | | | | | | | | This adds a more complete view of file styles in EC. This may not represent the goal, but more the trend of file styles seen in EC. BRANCH=none BUG=none TEST=viewed in gitiles Signed-off-by: Craig Hesling <hesling@chromium.org> Change-Id: Ib981590703088fa34320ab0f7496e7cb0a23df55 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2103866 Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs/ide-support.md: Add .vscode/setting.json tipCraig Hesling2020-03-121-0/+20
| | | | | | | | | | | BRANCH=none BUG=none TEST=viewed in gitiles Signed-off-by: Craig Hesling <hesling@chromium.org> Change-Id: I25810b8a7aa2b55200ef07f2eb4a45c1d03c9160 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2101591 Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: Add IDE SupportCraig Hesling2020-03-122-0/+47
| | | | | | | | | | | | | | Had to uglify the table content because Gitiles doesn't understand | inside backticks, in a table. It also doesn't like < or > inside backticks. BRANCH=none BUG=none TEST=Observe in gitiles Signed-off-by: Craig Hesling <hesling@chromium.org> Change-Id: Id6e29899878f1b17c12a475e5e882553d32b712b Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2085157
* docs/fingerprint: Add a step to prepare screenKevin Shelton2020-03-111-0/+5
| | | | | | | | | | | | | | | screen is not distributed as part of the sdk. BRANCH=none BUG=none TEST=Run `sudo emerge screen` and the next step in the doc succeeds TEST=View Markdown in gitiles Change-Id: Ic78838d0e9f22c011579484cb784109b7e6d9740 Signed-off-by: Kevin Shelton <kmshelton@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2095751 Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Tom Hughes <tomhughes@chromium.org>
* docs/fingerprint: Remove reference to fixed issueKevin Shelton2020-03-111-6/+0
| | | | | | | | | | | | | | | | | Sweetberry now builds cleanly with recent versions of the sdk. BRANCH=none BUG=chromium:992082 TEST=Run `make buildall -j` and confirm /ec/build/sweetberry/ec.bin is created TEST=View Markdown in gitiles Change-Id: I76fba6452860e3c2057e38d0e926165c4cb67d18 Signed-off-by: Kevin Shelton <kmshelton@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2093159 Commit-Queue: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org> Reviewed-by: Andrew Luo <aluo@chromium.org>
* docs: Update code review guidelines with feedbackAbe Levkoy2020-03-101-4/+9
| | | | | | | | | | | | | | | Remove optional ways to indicate WIP to avoid confusion. Add a 1-business-day response SLO for reviewers. BUG=none TEST=Viewed rendered Markdown BRANCH=none Change-Id: I74411cebf6d51886f845122886fa56c8732336e6 Signed-off-by: Abe Levkoy <alevkoy@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2095749 Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jett Rink <jettrink@chromium.org>
* i2c: Cleanup I2C tracing outputKeith Short2020-03-101-27/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The output of the I2C tracing is hard to parse, especially for reads to I2C registers. This change creates only a single I2C trace for each I2C transfer (instead of 2 entries), and labels the write and read parts of the I2C transaction clearly. Example output (TCPC device during disconnect): i2c: 1:0x20 wr 0x10 rd 0x01 0x00 i2c: 1:0x20 wr 0x10 0x01 0x00 i2c: 1:0x20 wr 0x1A rd 0x1A i2c: 1:0x20 wr 0x1D rd 0x10 i2c: 1:0x20 wr 0x1C rd 0x70 i2c: 1:0x20 wr 0x2F 0x21 i2c: 1:0x20 wr 0x1C 0x70 i2c: 1:0x20 wr 0x2F 0x00 i2c: 1:0x20 wr 0x1C rd 0x70 i2c: 1:0x20 wr 0x1C 0x60 BUG=none BRANCH=none TEST=make buildall TEST=Enable CONFIG_I2C_DEBUG and verify output. Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I077196e70ae3abb6c462cf08a3f944b43fdcf82a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2091573 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs/fingerprint: Add issue tracker docsTom Hughes2020-03-101-0/+18
| | | | | | | | | | | | | | | Add details on how to use the partner issue tracker and expectations around communication. BRANCH=none BUG=none TEST=view in gitiles Change-Id: I49e81b9331c514371dc9f49d44b1ff8856081cee Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2092914 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* code_review: add 's' to --no-email optionJett Rink2020-03-101-2/+2
| | | | | | | | | | | | | According to `repo help upload`, the option should be --no-emails instead of --no-email. BRANCH=none BUG=none TEST=`repo upload --no-emails` works Signed-off-by: Jett Rink <jettrink@chromium.org> Change-Id: I72b6d2b01e75864ea3223763fd2c8d463f2b5919 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2095948
* ccd_howtos: add test_that commandMary Ruthven2020-03-061-1/+9
| | | | | | | | | | | | | Add a test_that command to show how we run tests locally. BUG=none BRANCH=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>
* docs/fingerprint: Add instructions for adding private repoTom Hughes2020-02-281-1/+24
| | | | | | | | | | | | BRANCH=none BUG=b:147702944 TEST=view in gitiles Change-Id: I6262b47b0438fe34aee6a3c562198e1ee41b6f83 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2076583 Tested-by: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs: Add code-review guidelinesAbe Levkoy2020-02-271-0/+108
| | | | | | | | | | | | | | | | | These should help code reviews go more smoothly. They are the consensus position of an out-of-band discussion among EC developers. BUG=none TEST=Observed rendered MD BRANCH=none Change-Id: I3b5e31a00481cc43732f5399c80a1ec82fec05b4 Signed-off-by: Abe Levkoy <alevkoy@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2062761 Reviewed-by: Vijay P Hiremath <vijay.p.hiremath@intel.com> Reviewed-by: Keith Short <keithshort@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jett Rink <jettrink@chromium.org>
* doc: Add creating a new board checklist.Keith Short2020-02-2716-0/+1297
| | | | | | | | | | | | | | | | Add the high-level steps for creating a new board in the EC code base. The entry point is the docs/new_board_checklist.md file, which then links to files found under docs/configuration/. BUG=b:147905484 BRANCH=none TEST=none Change-Id: Ia0ca4f6547735a5d1ee93145ee18962cf7559fe3 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1778635 Reviewed-by: Jett Rink <jettrink@chromium.org> Reviewed-by: Paul Fagerburg <pfagerburg@chromium.org>
* docs: Add unit test documentationTom Hughes2020-02-253-17/+142
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Change-Id: I4c282ed8bb831afa534e1c40bc619cd8e6d772ad Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1958255 Commit-Queue: Jett Rink <jettrink@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: Minor formatting fixesAbe Levkoy2020-02-251-5/+6
| | | | | | | | | | | | BUG=none TEST=Observed rendered MD BRANCH=none Change-Id: Iab52f7759028dae68b592ec59b7712a0b04344c7 Signed-off-by: Abe Levkoy <alevkoy@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2062990 Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jett Rink <jettrink@chromium.org>
* docs/fingerprint: Instructions on verifying firmware and biod installTom Hughes2020-02-191-1/+40
| | | | | | | | | | | | | | | Documentation that describes how to verify that biod and the FPMCU firmware get installed to the rootfs for a given Chrome OS board. BRANCH=none BUG=none TEST=view in gitiles Change-Id: I757c6a0bf0f43f6248430dd3f8248783f9b55d23 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2020513 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs: Remove statement about disabling HW WP + rebootCraig Hesling2020-02-151-5/+0
| | | | | | | | | | | | BRANCH=nocturne,hatch BUG=none TEST=Remove HW WP and issue reboot_ec command Change-Id: I2430f3b08bc8136928e471dcb453cb0c779e3e77 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1989367 Tested-by: Craig Hesling <hesling@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org> Commit-Queue: Craig Hesling <hesling@chromium.org>
* docs/fingerprint: Remove unnecessary BOARD env variableTom Hughes2020-02-071-4/+4
| | | | | | | | | | | | | | Since we're running the host tests (using the "host" board), we don't need to set the BOARD environment variable. BRANCH=none BUG=none TEST=view in gitiles Change-Id: I8ddf90a1562f2f91a784c2c0781bb4293efbf0a6 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1962449 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs/fingerprint: Add details on using fingerprint with Chrome OS buildTom Hughes2020-01-242-1/+97
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Change-Id: Icedacbe7897d8aaf441e7d76be50e440f46c5a54 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2017576 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs/fingerprint: Update chromeos-config and flashing instructionsTom Hughes2020-01-222-9/+32
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Change-Id: Ibc97efb7a1746cb6cbb5422104d72be8b708681e Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2015141 Commit-Queue: Craig Hesling <hesling@chromium.org> Reviewed-by: Craig Hesling <hesling@chromium.org>