summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* pre-upload: Make BRANCH= optional, disable Signed-off-byJack Rosenthal2023-05-021-7/+6
| | | | | | | | | | | | | | | | | | | | | | | | Signed-off-by is useless. Gerrit enforces that contributors have signed a CLA in order to upload, and therefore, it's not necessary for contributors to acknowledge they've signed a CLA in their commit message. This would be consistent with the rest of ChromeOS. Additionally, BRANCH= is not used by the rest of the OS, and as we move our EC towards a branching model that does not depend on manual cherry picks, it's becoming less and less useful. Most commits these days have stuff like BRANCH=none, or BRANCH=i don't care stop bothering me. We could make BRANCH= optional only for commits which wish to specify it, but not a requirement to upload. BUG=b:280345831 TEST=pre-upload passes Change-Id: I1f2f728b9d6890ce2b21dbf3316afe4354ba3054 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4497661 Reviewed-by: Jeremy Bettis <jbettis@chromium.org> Commit-Queue: Jeremy Bettis <jbettis@chromium.org> Auto-Submit: Jack Rosenthal <jrosenth@chromium.org> Tested-by: Jack Rosenthal <jrosenth@chromium.org>
* cr50/README.md: Use futility over obsolete scriptEdward O'Callaghan2023-01-161-1/+1
| | | | | | | | | | | | | | | | BUG=b:260531154 BRANCH=none TEST=none Change-Id: I9e9cb4aadb7b59d7d1f64847d3e4852ca15f5b9e Signed-off-by: Edward O'Callaghan <quasisec@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4160818 Tested-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org> Code-Coverage: Zoss <zoss-cl-coverage@prod.google.com> Commit-Queue: Peter Marheine <pmarheine@chromium.org> Auto-Submit: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Evan Benn <evanbenn@chromium.org>
* docs: Document the code coverage test requirementsKeith Short2023-01-131-1/+6
| | | | | | | | | | | | | | Document the code coverage test requirements. BUG=b:261987897 BRANCH=none TEST=View docs in preview mode Change-Id: I0bde6ed3f36f88f4e7d1102c29ea73d112b82e74 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4166320 Code-Coverage: Zoss <zoss-cl-coverage@prod.google.com> Reviewed-by: Jeremy Bettis <jbettis@chromium.org>
* Update license boilerplate text in source code filesMike Frysinger2022-09-121-1/+1
| | | | | | | | | | | | | | | Normally we don't do this, but enough changes have accumulated that we're doing a tree-wide one-off update of the name & style. BRANCH=none BUG=chromium:1098010 TEST=`repo upload` works Change-Id: Icd3a1723c20595356af83d190b2c6a9078b3013b Signed-off-by: Mike Frysinger <vapier@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3891203 Reviewed-by: Jeremy Bettis <jbettis@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* Update header templates/examplesAlex Klein2022-07-291-1/+1
| | | | | | | | | | | | | | | | ChromiumOS instead of Chromium OS and drop "All rights reserved.". BRANCH=None BUG=b:230609017 TEST=None Signed-off-by: Alex Klein <saklein@google.com> Change-Id: I6a28e041909f484298f499c9b1730ea7e6cccd6a Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3791657 Auto-Submit: Alex Klein <saklein@chromium.org> Reviewed-by: Ram Chandrasekar <rchandrasekar@google.com> Commit-Queue: Ram Chandrasekar <rchandrasekar@google.com> Tested-by: Alex Klein <saklein@chromium.org>
* cq: Remove instructions for ec-covJeremy Bettis2022-07-121-15/+0
| | | | | | | | | | | | | | | | I removed firmware-ec-cov-cq, so no need to manually test it. BRANCH=None BUG=b:231639771 TEST=None Signed-off-by: Jeremy Bettis <jbettis@google.com> Change-Id: Id26f4ad36779d2132c84bada320f21c9a8f29fed Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3755963 Commit-Queue: Jack Rosenthal <jrosenth@chromium.org> Tested-by: Jeremy Bettis <jbettis@chromium.org> Auto-Submit: Jeremy Bettis <jbettis@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* README: Emphasize with inline code instead of boldPatrick Thompson2022-07-071-1/+1
| | | | | | | | | | | | | | | | | README.md has angle brackets that are supposed to be displayed but are not because bold (**) does not escape brackets. The rest of the file uses inline code (backtics) for emphasis so that's what I changed it to. BUG=b:231139247 BRANCH=None TEST=None Change-Id: I7b3c791c402fd7f7e270a4e340cb40bcca166ead Signed-off-by: Patrick Thompson <ptf@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3749530 Reviewed-by: Tom Hughes <tomhughes@chromium.org>
* README: Update emerge EC binary pathmparuchuri2022-05-101-0/+16
| | | | | | | | | | | | | | | | After building the ChromeOS EC repo using emerge, the ec.bin is not found in the current path mentioned in Readme. This commit is updating that path. BUG=none BRANCH=none TEST=Manually check the ec.bin file at current and updated path Signed-off-by: Madhurima Paruchuri <mparuchuri@google.com> Change-Id: If91e290637cfaa5fdb404fc348ca17c4ff5cd413 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3626474 Reviewed-by: Fabio Baltieri <fabiobaltieri@google.com> Reviewed-by: Boris Mittelberg <bmbm@google.com>
* cq: Parse memory report files and add to metricsJeremy Bettis2022-03-171-0/+32
| | | | | | | | | | | | | | | | | | | | In the build stage of firmware_builder.py, parse all memsize.txt files and write the sizes to the metrics proto. Document how to run the builder manually. Formatted python code, and fixed cros lint errors. BRANCH=None BUG=b:223846977 TEST=Ran commands in README. Signed-off-by: Jeremy Bettis <jbettis@google.com> Change-Id: Icca1165fc3e13ec89898550e53b12440bbe053d4 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3530151 Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jeremy Bettis <jbettis@chromium.org> Tested-by: Jeremy Bettis <jbettis@chromium.org>
* zephyr: docs: Add introduction sectionKeith Short2022-02-181-0/+6
| | | | | | | | | | | | | | | | 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>
* README.md: Update recommended dev OSAseda Aboagye2021-04-131-2/+2
| | | | | | | | | | | | | | | | | | Our documentation recommends a version of Ubuntu from 2014 which is super out of date. This commit changes that to recommend the latest Debian Stable instead. BUG=None BRANCH=None TEST=None Signed-off-by: Aseda Aboagye <aaboagye@google.com> Change-Id: I384d32f6f7172953febed5419b6fdc0128f898cb Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2819024 Tested-by: Aseda Aboagye <aaboagye@chromium.org> Auto-Submit: Aseda Aboagye <aaboagye@chromium.org> Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org> Commit-Queue: Aseda Aboagye <aaboagye@chromium.org>
* README: Run mdformatTom Hughes2021-02-021-2/+2
| | | | | | | | | | | | BRANCH=none BUG=b:178648877 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: Ia1736c4fef0b76c752393462808b5af1da15801e Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2668977 Commit-Queue: Diana Z <dzigterman@chromium.org> Reviewed-by: Diana Z <dzigterman@chromium.org>
* COIL: Update documentation with appropriate branch namesDossym Nurmukhanov2021-02-021-11/+11
| | | | | | | | | | | | | | Branch names have changed as part of go/coil initiative. BUG=b:165682717 BRANCH=none TEST=none Signed-off-by: dossym@chromium.org Change-Id: I901984a7786ca31d4b8d85492fc4a7953080c6e7 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2667026 Commit-Queue: Aseda Aboagye <aaboagye@chromium.org> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: Run mdformat on all .md filesTom Hughes2021-01-281-18/+16
| | | | | | | | | | | BRANCH=none BUG=b:178648877 TEST=view in gitiles Signed-off-by: Tom Hughes <tomhughes@chromium.org> Change-Id: I0ac5581ba7bc512234d40dbf34222422afa9c725 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2650551 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* doc: README: drop the (chroot) not efrom the set_gbb_flags commandFabio Baltieri2021-01-221-2/+2
| | | | | | | | | | | | | | These are to be run on the device, so there should be not (chroot) prompt there. BUG=none BRANCH=none TEST=ran the command, it worked Change-Id: Ibc66b64484a839fdd489b51d9eacc32b4094ee99 Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2643321 Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* doc: Add creating a new board checklist.Keith Short2020-02-271-1/+4
| | | | | | | | | | | | | | | | 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: update link to host commands documentationHarry Cutts2019-11-061-1/+1
| | | | | | | | | | | | | | The Google Sites version was deprecated when https://crrev.com/c/1807964 was submitted. BRANCH=none BUG=none TEST=Check the rendering in Gitiles Change-Id: I440ae76501a4eb747e4a2e4550c192565c3c6717 Signed-off-by: Harry Cutts <hcutts@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1900666 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: change docs finding EC consoleMary Ruthven2019-09-201-1/+1
| | | | | | | | | | | BUG=none BRANCH=none TEST=none Change-Id: I62b04adf970abf5534d5ce6c7630f6b09749222c Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1816305 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* doc: Update EC termsKeith Short2019-08-211-0/+3
| | | | | | | | | | | | | | 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 (FPMCU) docsTom Hughes2019-08-061-170/+17
| | | | | | | | | | | | | | 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>
* Improve unit test and fuzzer documentation storyCraig Hesling2019-07-201-3/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update **test** directory description to README.md. * Add ** fuzz** directory description to README.md. * Add unit test and fuzzer make targets to `make help` * Change showboards to print-boards to be more consistent * Change showboards to use auto pretty print * Add print-tests, print-host-tests, and print-host-fuzzers This is necessary to remove the ambiguity about what a special name is for a given unit test. Documentation Story: The idea is to give a brief overview of what the test and fuzz directories are in README.md. README.md also mentions you should see `make help` for more detail. Running `make help` shows you more general test/fuzz commands, including the print-* commands. Running the print-* commands show you exact target names for all possible unit/fuzz test (both the build-only and run target names). BRANCH=none BUG=none TEST=make help TEST=make print-tests TEST=make print-host-tests TEST=make print-host-fuzzers TEST=make print-host-fuzzers | cat TEST=make print-boards TEST=make print-boards | cat TEST=make buildall -j Change-Id: I34b68196ac635ba71a1d45ceb5d35a3b36fd129f Signed-off-by: Craig Hesling <hesling@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1684714 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org> Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* Don't refer to specific MCUs in the README introHarry Cutts2019-07-091-5/+1
| | | | | | | | | | | | | | | | | | | | This statement seems pretty out-of-date, and keeping it up-to-date isn't going to be worthwhile, so just make it more generic. (This is the same change as was made in revision #41 of the sites page before it was migrated [0], but it seems the Markdown migration took the version before.) [0]: https://sites.google.com/a/chromium.org/dev/system/app/pages/admin/compare?wuid=wuid:gx:3ac9dfd5b19509d3&rev1=41&rev2=40 BRANCH=none BUG=none TEST=none Change-Id: I0570b719af6699b4467309fccd312e1be68d6f14 Signed-off-by: Harry Cutts <hcutts@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1693335 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Update READMETom Hughes2019-06-121-0/+781
Converted the documentation in http://dev.chromium.org/chromium-os/ec-development 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: Ifdb2494f0f82b7226c1c77925e6a03656e604d14 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1653597 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
View Lorry Controller Status