summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* zmake: Implement zmake configure for multi-project.Jeremy Bettis2022-02-193-7/+7
| | | | | | | | | | | | | | | | | Change zmake configure to work as described in go/zmake-cli-v2. BRANCH=None BUG=b:217788621 TEST=Various zmake configure cmds. Cq-Include-Trybots: luci.chromeos.cq:cq-orchestrator Cq-Depend: chromium:3462900 Change-Id: I58fa4d8427efff64c5764eac6ba4752a71785127 Signed-off-by: Jeremy Bettis <jbettis@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3445105 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Commit-Queue: Jeremy Bettis <jbettis@chromium.org> Tested-by: Jeremy Bettis <jbettis@chromium.org>
* zephyr: docs: Add introduction sectionKeith Short2022-02-183-1/+124
| | | | | | | | | | | | | | | | Update the legacy README.md to define "legacy EC" vs "Zephyr EC". Add an Zephyr EC introduction section. BUG=b:207403708 BRANCH=none TEST=view docs with gerrit browse Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I966102d901b516e665d3a6034709cdfc120b5d0a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3474634 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Simon Glass <sjg@chromium.org>
* docs: zephyr: Provide example of motionsense DTSYuval Peress2022-02-181-6/+101
| | | | | | | | | | | | | | Add an example of the various devicetree compontents of initializing motionsense. BRANCH=none BUG=b:208437221 TEST=none Signed-off-by: Yuval Peress <peress@google.com> Change-Id: Ie2be39bd378ff8c6ccd868d916cc10a6a410e098 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3459249 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs: zephyr: Add testing information about motionsenseYuval Peress2022-02-181-1/+26
| | | | | | | | | | | | | | Add some general guidelines for tests that can be run to make sure that motionsense was initialized correctly. BRANCH=none BUG=b:208437221 TEST=none Signed-off-by: Yuval Peress <peress@google.com> Change-Id: I06c0bb77373e149bca8eaee8d08a0581bd04fcab Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3459248 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs: zephyr: Add information about motionsenseYuval Peress2022-02-181-3/+5
| | | | | | | | | | | | | | Include documentation detailing that motionsense requires no board specific code as well as how to configure the motionsense task. BRANCH=none BUG=b:208437221 TEST=none Signed-off-by: Yuval Peress <peress@google.com> Change-Id: I2a408605b734c10e872177f751bae4ad47ca8902 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3459943 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs: zephyr: Add more information about motionsenseYuval Peress2022-02-181-3/+49
| | | | | | | | | | | | | | Add details about the various devicetree nodes and configuration needed for Zephyr motionsense initialization. BRANCH=none BUG=b:208437221 TEST=none Signed-off-by: Yuval Peress <peress@google.com> Change-Id: Id2b0b7622bfc387119a3977069adf673f6943e68 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3459942 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs: Set BOARD in quick build instructionsBobby Casey2022-02-151-0/+13
| | | | | | | | | | | | | | | | | | | | Step 3 of the instructions in the "Building" section indicate to run a make command that includes `make BOARD=${BOARD}`. This assumes that ${BOARD} is set properly but the instructions to not specify to do so. The first paragraph does link to documents that cover this but then go on to state that you can safely ignore them. Fix by adding a step to specify the BOARD env var, including a brief description of where to find this value and a safe default. BUG=b:219081299 BRANCH=none TEST=view in gitiles Signed-off-by: Bobby Casey <bobbycasey@google.com> Change-Id: I9b0a7f9b6b64ff2b1bb5844c5fa750514ecf6d1b Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3460062 Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* docs: add link to the Zephyr new board checklistKeith Short2022-02-101-0/+1
| | | | | | | | | | | | | | Add a link to the index for the Zephyr new board checklist. BUG=b:207403708 BRANCH=none TEST=verify link in Gerrit browse Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: Ib42ef2087f6149c913a176412401e0e0c5458836 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3453162 Reviewed-by: Aaron Massey <aaronmassey@google.com> Commit-Queue: Aaron Massey <aaronmassey@google.com>
* zephyr_gpio: Update docs about GPIOsAndrew McRae2022-02-041-49/+218
| | | | | | | | | | | | | Update the Zephyr GPIO docs BUG=none TEST=none BRANCH=none Signed-off-by: Andrew McRae <amcrae@google.com> Change-Id: I3c2e439cf0224db803c16675e2ec877f1baf7dcf Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3426246 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs/fingerprint: Fix formatting with mdformatTom Hughes2022-02-042-6/+6
| | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I4fbbcd73e78bb7caa5855ed33ff3773c425ede55 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3425447 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: zephyr: Add Kconfig details for motionsenseYuval Peress2022-02-033-1/+221
| | | | | | | | | | | | | | Replicate the zephyr_template.md and document the Kconfig values in zephyr/Kconfig.motionsense and zephyr/Kconfig.sensor_devices BRANCH=none BUG=b:208437221 TEST=none Signed-off-by: Yuval Peress <peress@google.com> Change-Id: I72d36687ea07a840456908a4c66db4167f0a4993 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3405646 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs/fingerprint: Update audit report linkTom Hughes2022-02-011-1/+1
| | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I3cb185e03f6df1e35dccf0923f27cc6e57c6c981 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3425446 Reviewed-by: Diana Z <dzigterman@chromium.org>
* zephyr: fw config doc fixesAndrew McRae2022-01-251-1/+1
| | | | | | | | | | | | | Fixed filename and added missing back quote. BUG=none TEST=none BRANCH=none Signed-off-by: Andrew McRae <amcrae@google.com> Change-Id: I3b8cc7355bb82d16533e1781266cdea0005604e4 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3413591 Reviewed-by: Wai-Hong Tam <waihong@google.com>
* zephyr: Update Zephyr GPIO docsAndrew McRae2022-01-251-18/+91
| | | | | | | | | | | | | | | | | Update GPIO docs - no-auto-init - access for non enum-name based GPIOS - new interrupt handling BUG=b:214608987 TEST=none BRANCH=none Signed-off-by: Andrew McRae <amcrae@google.com> Cq-Depend: chromium:3392111,chromium:3406473 Change-Id: I78c418a4ae635370fa398a597a7b361137b811a7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3411031 Reviewed-by: Fabio Baltieri <fabiobaltieri@google.com>
* zephyr: Update documents with CBI FW_CONFIG featureAndrew McRae2022-01-242-0/+124
| | | | | | | | | | | | | | Add the CBI FW_CONFIG feature to the documentation. BUG=b:212758472 TEST=none BRANCH=none Signed-off-by: Andrew McRae <amcrae@google.com> Change-Id: I6e53289a5b5961978a69f64a0e9fd67daac11c35 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3411032 Reviewed-by: Abe Levkoy <alevkoy@chromium.org> Commit-Queue: Abe Levkoy <alevkoy@chromium.org>
* zephyr: Add details for generating code coverageAl Semjonovs2022-01-191-0/+7
| | | | | | | | | | | | | | Add details for generating code coverage BRANCH=none BUG=b:201602829 TEST=none Signed-off-by: Al Semjonovs <asemjonovs@google.com> Change-Id: I6273f998daba811fd8f404cadbc4c41a585d678d Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3387813 Reviewed-by: Yuval Peress <peress@google.com> Commit-Queue: Yuval Peress <peress@google.com>
* zephyr: docs: Temperature SensorsTristan Honscheid2022-01-193-0/+209
| | | | | | | | | | | | | Add Markdown documentation for adding new temperature sensors. BUG=b:208436220 BRANCH=None TEST=N/A Signed-off-by: Tristan Honscheid <honscheid@google.com> Change-Id: I76c7284673c54f85d926be5f447146f03eeb18ed Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3384016 Reviewed-by: Keith Short <keithshort@chromium.org>
* zephyr: docs: add ADC documentationDawid Niedzwiecki2022-01-183-0/+199
| | | | | | | | | | | | | | | Add documentation for configuring ADC. BUG=b:208435885 TEST=Browse doc in gerrit BRANCH=main Signed-off-by: Dawid Niedzwiecki <dn@semihalf.com> Change-Id: Ib83af48f84582e7e5bf63808cfbc2fac77faacab Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3352468 Tested-by: Dawid Niedźwiecki <dn@semihalf.com> Reviewed-by: Keith Short <keithshort@chromium.org> Commit-Queue: Keith Short <keithshort@chromium.org>
* docs: zephyr: add an initial Zephyr GPIO doc pageFabio Baltieri2022-01-172-0/+217
| | | | | | | | | | | | | Add documentation for configuring GPIO on Zephyr. BRANCH=none BUG=b:208436570 TEST=browse on gerrit Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com> Change-Id: I72d571e8c43ec0d507615b3870410e25b791b5cd Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3367270 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs: Add doc on how to use Goma to compile the EC codeJack Rosenthal2022-01-143-0/+55
| | | | | | | | | | | | | | | | Simple steps on how to use Goma. Not under the zephyr/ directory since I intend to eventually get the Makefile working with Goma as well. BUG=b:214323409 BRANCH=none TEST=view in gitiles Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I5a50a32f009c3c0816e43e1bb8dd9c9708753dcf Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3385777 Reviewed-by: Aaron Massey <aaronmassey@google.com> Reviewed-by: Keith Short <keithshort@chromium.org>
* docs: Cleanup "-l INFO" argument on call to zmakeJack Rosenthal2022-01-141-30/+11
| | | | | | | | | | | | | -l INFO is the default, no need to specify it manually. BUG=none BRANCH=none TEST=none Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I9c687f53a952839be58739759ad3c46fd2a76a14 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3382555 Reviewed-by: Keith Short <keithshort@chromium.org>
* docs/fingerprint: Update JLink installation instructionsTom Hughes2022-01-131-13/+20
| | | | | | | | | | | | | | JLink can now be installed in the chroot with portage. BRANCH=none BUG=b:178132109 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ief8e64e10c9ff1f8cfdc528dce6bca34d3973f0c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3369648 Reviewed-by: Josie Nordrum <josienordrum@google.com> Reviewed-by: Bobby Casey <bobbycasey@google.com>
* docs/fingerprint: Add FPMCU RAM and Flash docTom Hughes2022-01-133-0/+114
| | | | | | | | | | | | | | | This document provides details on the RAM and Flash available on each of the FPMCUs, as well as the Flash layout. BRANCH=none BUG=b:213510520 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Id34399327baaeeac8c03a5fcfe3983824e69497a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3369652 Reviewed-by: Josie Nordrum <josienordrum@google.com> Commit-Queue: Josie Nordrum <josienordrum@google.com>
* zephyr: docs: Use project names for zmake commandsJack Rosenthal2022-01-123-13/+13
| | | | | | | | | | | | | | | | Switch documentation referring to the project path of a zmake build to project name. Project path is still technically supported, but only for project directories with exactly one project defined, which will become fewer and fewer as we start launching real EC projects. BUG=b:193815337 BRANCH=none TEST=view in gitiles Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: Ia2c50363874b8997a8308bbf304f9773965086c8 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3381044 Reviewed-by: Denis Brockus <dbrockus@chromium.org>
* zephyr: docs: Drop "-t zephyr" from configure commandJack Rosenthal2022-01-121-11/+1
| | | | | | | | | | | | | | | | "-t zephyr" was needed at one point for folks building outside of the chromiumos chroot only. Today, zmake can automatically detect which toolchains are available and select the most appropriate one, so we can remove the extra steps here. BUG=b:178731498 BRANCH=none TEST=view in gitiles Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I9a70027a1183782566ca4bc37f3e63e142f71b00 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3381043 Reviewed-by: Keith Short <keithshort@chromium.org>
* zephyr: docs: Cleanup notes about updating the chrootJack Rosenthal2022-01-121-18/+6
| | | | | | | | | | | | | | | | | | This was written before Zmake's re-exec logic, which was the primary reason we cautioned people to update the chroot or manually install zephyr-build-tools so often. Today, an update_chroot is still necessary for a toolchain update, but this happens far less often and does not need noted here. BUG=b:197636145 BRANCH=none TEST=view in gitiles Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I8e06ffa38f3501f5f2da5e390e3d55c3b1a5b3f8 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3381042 Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
* zephyr: docs: Add link to I2C docKeith Short2022-01-111-1/+1
| | | | | | | | | | | | | | Update the Zephyr checklist to point to the completed I2C documentation. BUG=b:208435960 BRANCH=none TEST=Verify link with gerrit browse view Change-Id: If284a9fecdb318fbe38a0e2ead1c0f5bc50511a3 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3378703 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org> Commit-Queue: Jack Rosenthal <jrosenth@chromium.org>
* zephyr: Add project configuration documentationJack Rosenthal2022-01-071-0/+174
| | | | | | | | | | | | | | | | Add some initial documentation focused around the config formats (BUILD.py, CMakeLists.txt, and Kconfig), and how to use this configuration to add a new program or variant. BUG=b:193815337,b:180609783 BRANCH=none TEST=view in Gitiles Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I3a18793fbd2e3b15dd29119b407f71962eb87482 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3256037 Reviewed-by: Keith Short <keithshort@chromium.org> Commit-Queue: Keith Short <keithshort@chromium.org>
* zephyr: docs: I2C busesKeith Short2022-01-062-0/+373
| | | | | | | | | | | | | Add documentation for configuring I2C buses. BUG=b:208435960 BRANCH=none TEST=Browse doc in gerrit Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I23bdd2ba46543f9b1d1ff4099768d8552d156cfd Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3309359 Reviewed-by: Yuval Peress <peress@google.com>
* docs: Add Zephyr New Board checklistKeith Short2021-12-042-0/+121
| | | | | | | | | | | | | Add the initial new board checklist for Zephyr ECs. BUG=b:207403708 BRANCH=none TEST=View docs using gerrit preview/browse Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I1e2585709eaf9b1f9db4f57c9ae665797b3e5608 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3296745 Reviewed-by: Yuval Peress <peress@google.com>
* COIL: Update links for inclusive languageTom Hughes2021-11-294-5/+5
| | | | | | | | | | | BRANCH=none BUG=b:163885307 TEST=none Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I03e1cc19240cc651d4d0e9225b48f1f6962506a1 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3298870 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* config: rename CONFIG_HOSTCMD_SHI to CONFIG_HOST_INTERFACE_SHIKeith Short2021-11-191-1/+1
| | | | | | | | | | | | | | | | Rename CONFIG_HOSTCMD_SHI to CONFIG_HOST_INTERFACE_SHI. This makes the host interface selection configs distinct from configs used to enable/disable specific host commands. BUG=b:195416058 BRANCH=main TEST=compare_build.sh Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I35959149554f58c8911459dcd025720b6d66eb32 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3095843 Tested-by: Michał Barnaś <mb@semihalf.com> Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
* config: rename CONFIG_HOSTCMD_ESPI to CONFIG_HOST_INTERFACE_ESPIKeith Short2021-11-191-1/+1
| | | | | | | | | | | | | | | Rename CONFIG_HOSTCMD_ESPI to CONFIG_HOST_INTERFACE_ESPI. This makes the host interface selection configs distinct from configs used to enable/disable specific host commands. BUG=b:195416058 BRANCH=main TEST=compare_build.sh Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I7f52614ca9a0dd54cc7e96e51bba40453564198e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3095842 Tested-by: Michał Barnaś <mb@semihalf.com>
* config: rename CONFIG_HOSTCMD_LPC to CONFIG_HOST_INTERFACE_LPCKeith Short2021-11-191-1/+1
| | | | | | | | | | | | | | | | Rename CONFIG_HOSTCMD_LPC to CONFIG_HOST_INTERFACE_LPC. This makes the host interface selection configs distinct from configs used to enable/disable specific host commands. BUG=b:195416058 BRANCH=main TEST=compare_build.sh Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I6d8722cd314aa7801ea11c1ead5ef6bdd113fd58 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3095841 Tested-by: Michał Barnaś <mb@semihalf.com> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* config: rename CONFIG_HOSTCMD_HECI to CONFIG_HOST_INTERFACE_HECIKeith Short2021-11-191-1/+1
| | | | | | | | | | | | | | | | Rename CONFIG_HOSTCMD_HECI to CONFIG_HOST_INTERFACE_HECI. This makes the host interface selection configs distinct from configs used to enable/disable specific host commands. BUG=b:195416058 BRANCH=main TEST=compare_build.sh Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I2a9e490c2fd6f54f7ab9be809ed2711aa3244409 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3095840 Tested-by: Michał Barnaś <mb@semihalf.com> Reviewed-by: Aaron Massey <aaronmassey@google.com>
* docs: move Zephyr docs into subdirectoryKeith Short2021-11-198-7/+8
| | | | | | | | | | | | | | Move all the Zephyr related documents into a common subdirectory. BUG=none BRANCH=none TEST=Preview files in gerrit Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: Ib5e0c19343c0aeb81b25e317f919b7f35ef1cdce Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3289297 Commit-Queue: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* coil: docs: Remove blocked termKeith Short2021-11-181-1/+1
| | | | | | | | | | | | | | Replace blocked term with inclusive language. BUG=b:163885307 BRANCH=none TEST=none Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I17f893da69697fd4a0b548bda2769a344d057803 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3289296 Commit-Queue: Sam Hurst <shurst@google.com> Reviewed-by: Sam Hurst <shurst@google.com>
* documentation: Adding background paragraph on USB PD to usb-c.mdJameson Thies2021-11-131-2/+19
| | | | | | | | | | | | | | Basic CL to ramp up on git/gerrit flow. Adding a background paragraph on USB PD to usb-c.md to provide context for why we are using a state machine to handle USB-PD messaging. BUG=b:206148726 TEST=None Signed-off-by: Jameson Thies <jthies@google.com> BRANCH=usbc_md_update Change-Id: I3c60669964b93ccbfa3303cd12ac54858158fb52 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3278637 Reviewed-by: Benson Leung <bleung@google.com>
* docs/fingerprint: Update linksTom Hughes2021-11-021-3/+2
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I654ecdbeb0c92961b46dcd437cd4badde08462af Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3200668 Reviewed-by: Craig Hesling <hesling@chromium.org> Reviewed-by: Josie Nordrum <josienordrum@google.com>
* docs/fingerprint: Fix formatting with mdformatTom Hughes2021-11-021-2/+2
| | | | | | | | | | | | BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ic0d0b4a03850e7f5ec3252fbc0f42dde80c7f4a2 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3202692 Reviewed-by: Craig Hesling <hesling@chromium.org> Reviewed-by: Paul Fagerburg <pfagerburg@chromium.org>
* common: Make EC power delivery cmd more verboseNehemiah Dureus2021-10-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added more detailed output for `pd <port> srccaps` for debugging convenience. For boards that have large enough memory, the output of srccaps will be formatted showing pdo flags, pdo type, etc.: Src 0: (Fixed) 5000mV/3000mA DRP UP USB DRD Src 1: (Aug3.0) 5000mV-2000mV/3000mA DRP UP USB DRD ... For boards that don't have enough memory to support this, defining CONFIG_CMD_PD_SRCCAPS_REDUCED_SIZE will default to displaying the old way of printing out srccaps, shown below: 0: 5000mV/3000mA 1: 5000mV-2000mV/3000mA ... BRANCH=None BUG=b:194402616 TEST=On Delbin, connected with ServoV4, execute `pd <port> srccaps`, Built all boards (make -j buildall) Signed-off-by: Nehemiah Dureus <ndureus@google.com> Cq-Depend: chromium:3248341, chromium:3248342, chromium:3248343, chromium:3248344, chromium:3252409, chromium:3252413 Change-Id: I146f619c5baaf28b56a603c3b0a96fc9efbfb26a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3248345 Reviewed-by: Boris Mittelberg <bmbm@google.com>
* zmake: fail gracefully if missing SDKPeter Marheine2021-10-121-0/+8
| | | | | | | | | | | | | | | | | | The documentation didn't comment on the need to install a Zephyr SDK package when working outside the chroot, and didn't provide any useful output if one was missing (just failing with an assertion). Add mention of the SDK to the documentation and fail with a more useful message if it's missing and requested. BUG=None TEST=Useful message is shown if SDK is missing BRANCH=None Change-Id: I05fee5294c27197d62b3f726cdd5579571ce9e1b Signed-off-by: Peter Marheine <pmarheine@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3216964 Reviewed-by: Andrew McRae <amcrae@google.com> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* docs: replace "master" with "HEAD" in URLsTom Hughes2021-09-2811-18/+18
| | | | | | | | | | | | | | find . -name '*.md' | xargs sed -i 's#refs/heads/master#HEAD#g' find . -name '*.md' | xargs sed -i 's#+/master#+/HEAD#g' BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Iaac99ddc3463c8c7bb08038214e3eb22951db6a2 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3188552 Reviewed-by: Diana Z <dzigterman@chromium.org>
* docs/fingerprint: replace master with HEAD in URLsTom Hughes2021-09-286-60/+60
| | | | | | | | | | | | | | sed -i 's#refs/heads/master#HEAD#g' *.md sed -i 's#+/master#+/HEAD#g' *.md BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I1663701a16fd66b32d48358fa5a754247b9dbb5c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3188550 Reviewed-by: Edward Hill <ecgh@chromium.org>
* docs/fingerprint: Fix linkTom Hughes2021-09-101-2/+2
| | | | | | | | | | | | | The format tool was assuming the parentheses were a markdown link. BRANCH=none BUG=none TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Iea221310e87adaa9fbeaf046d634a57034f142c3 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3153630 Reviewed-by: Craig Hesling <hesling@chromium.org>
* docs: Update Reducing EC Image SizeKeith Short2021-08-061-3/+98
| | | | | | | | | | | | | | | | Mark some additional console commands as required for testing. Add sections detailing CONFIG_LTO, CONFIG_CHIP_INIT_ROM_REGION, and CONFIG_COMMON_GPIO_SHORTNAMES. BUG=none BRANCH=none TEST=View output with gitiles Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I58ac5bde1440ac6dae0caf9f8b6e2ff76bb2ff6f Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3078043 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: Fix link referencesKeith Short2021-08-062-4/+4
| | | | | | | | | | | | | | Correct some links between markdown documents local to the EC code. BUG=none BRANCH=none TEST=verify links with gitiles Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I8e31b7775d25e48f62180c4a754fc6a49ca0e8d9 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3078042 Commit-Queue: Abe Levkoy <alevkoy@chromium.org> Reviewed-by: Abe Levkoy <alevkoy@chromium.org>
* COIL: Change host interface option to CONFIG_HOSTCMD_SHIKeith Short2021-08-032-1/+10
| | | | | | | | | | | | | | Update SPI host interface config option for inclusive language. BUG=b:163885307 BRANCH=none TEST=compare_build.sh Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: I808d5960fa3e746626465bedc626a95e0f0aaa3f Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3066271 Commit-Queue: Paul Fagerburg <pfagerburg@chromium.org> Reviewed-by: Paul Fagerburg <pfagerburg@chromium.org>
* docs: Add document on reducing EC image sizeKeith Short2021-08-032-0/+365
| | | | | | | | | | | | | | Add a document describing tips for reding the EC image size. BUG=none BRANCH=none TEST=gittiles view of markdown Signed-off-by: Keith Short <keithshort@chromium.org> Change-Id: Ic639e069f911812181a10ee25b1bb5a17a8900a6 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3059225 Commit-Queue: Diana Z <dzigterman@chromium.org> Reviewed-by: Diana Z <dzigterman@chromium.org>
* util/flash_jlink: Change JLinkRemoteServer default portCraig Hesling2021-07-271-1/+3
| | | | | | | | | | | | | | | | This changes the used port to JLinkRemoteServerCLExe's actual default port of 19020, so that you don't need to always specify it. BRANCH=none BUG=none TEST=JLinkRemoteServerCLExe # in background make proj-bloonchipper -j ./util/flash_jlink.py --board bloonchipper Signed-off-by: Craig Hesling <hesling@chromium.org> Change-Id: I2a3c1a10e0b5c7b9cc62001a3a26508ea3db8199 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3055111 Reviewed-by: Josie Nordrum <josienordrum@google.com>