summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* usb: document ChromeOS power policy for USBJett Rink2019-08-281-0/+250
| | | | | | | | | | | | | BRANCH=none BUG=chromium:974302 TEST=builds Change-Id: I9b44b51876a0c46cb7b6aaf765afbf2c73c8d87c Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1755644 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org> Reviewed-by: David Schneider <dnschneid@chromium.org> Reviewed-by: Benson Leung <bleung@google.com>
* USBC PD: update usb-c docDenis Brockus2019-08-231-3/+6
| | | | | | | | | | | | | | | change new state machine file references to be up to date with the current code. BUG=none BRANCH=none TEST=none Change-Id: I4182b71bea107c4b9b852b93dcf59be5f4616f4d Signed-off-by: Denis Brockus <dbrockus@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1757086 Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jett Rink <jettrink@chromium.org>
* doc: Update EC termsKeith Short2019-08-212-13/+44
| | | | | | | | | | | | | | Add more EC definitions. Correct the named anchors in the USB-C markdown. And a link from the main EC readme. BUG=none BRANCH=none TEST=none Change-Id: Ica7e7c270373589d850166539fb1b13b1ddbd7e0 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1758826 Reviewed-by: Edward Hill <ecgh@chromium.org>
* docs: Add fingerprint docs for partnersTom Hughes2019-08-1512-0/+440
| | | | | | | | | | | BRANCH=none BUG=none TEST=View in gitiles Change-Id: Ie1dc7ea93f3471dd10863e546b4a9dc001e7f3c1 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1742878 Reviewed-by: Nicolas Norvez <norvez@chromium.org>
* doc: switch to markdown anchorsKeith Short2019-08-092-30/+30
| | | | | | | | | | | | | Switch from HTML to markdown anchors for linked references. BUG=none BRANCH=none TEST=none Change-Id: Ibd032e58cb0bea9234713fa3082db8fb3e259153 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1745346 Reviewed-by: Edward Hill <ecgh@chromium.org>
* doc: Add documentation for EC termsKeith Short2019-08-093-4/+164
| | | | | | | | | | | | | Add documentation for acronyms and technologies used in the EC codebase. BRANCH=none BUG=none TEST=run md_browser.py against changes Change-Id: I2ccc6e7c0c60144ded2e7b8cc171fa2a2897d006 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1740080 Reviewed-by: Edward Hill <ecgh@chromium.org>
* docs: Add fingerprint (FPMCU) docsTom Hughes2019-08-063-0/+532
| | | | | | | | | | | | | | BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I64c6060bdf41f69af05a8ffd64d437fb1fd2b507 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658525 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org> Commit-Queue: Aseda Aboagye <aaboagye@chromium.org>
* docs: add i2c doc to site mapJett Rink2019-07-221-0/+1
| | | | | | | | | | | | BRANCH=none BUG=none TEST=verified markdown rendering Change-Id: Ibef37a8f9818d2cb9e2bd50097819d2c6a646398 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1713737 Commit-Queue: Jack Rosenthal <jrosenth@chromium.org> Reviewed-by: Jack Rosenthal <jrosenth@chromium.org>
* common: add i2c tracing functionalityJack Rosenthal2019-07-171-0/+48
| | | | | | | | | | | | | | | | | | | crbug.com/982442 requests a way for developers to enable tracing of i2c commands when debugging. This adds a new debug feature, the i2ctrace command, which provides that. The command is guarded by CONFIG_I2C_DEBUG. BUG=chromium:982442 BRANCH=none TEST=enabled CONFIG_I2C_DEBUG on arcada_ish, made sure that command functioned as it says on the tin Change-Id: I9c762271237cbf131e5ef7c0f605c89af4f209fd Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1699347 Reviewed-by: Denis Brockus <dbrockus@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Denis Brockus <dbrockus@chromium.org>
* doc: add documentation for usb-c on platform/ecJett Rink2019-07-022-0/+204
| | | | | | | | | | | | | | | Add documentation for common configuration and touch points that need to be considered when implementing the USB-C stack on the platform/ec codebase. BRANCH=none BUG=chromium:974302 TEST=none Change-Id: I24aef187989c14688985d3cba48a6734ee519d23 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1648609 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: add cr50 ccd prerequisitesMary Ruthven2019-06-281-0/+37
| | | | | | | | | | | | | | Add some prerequisites that tell you what you need to emerge. BUG=none BRANCH=none TEST=read doc prerequisites. Make sure information and formatting looks ok. Change-Id: Iedbbd297b9f98890cb07dc658d2643ebb006ef3f Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1682170 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: Add OWNERS for fingerprint docsTom Hughes2019-06-181-0/+1
| | | | | | | | | | | BRANCH=none BUG=chromium:973205 TEST=make buildall -j Change-Id: I092903bb259be2e7dca8e6d486d810f2b073b9cd Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658678 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Add sitemapTom Hughes2019-06-131-0/+19
| | | | | | | | | | | | | | | | | When new docs are added, they should be added to this sitemap, so that the documentation is discoverable and easy to navigate. BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I327d444eb64b0142fb2f00e3e0fd55bc072f47e7 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658629 Reviewed-by: Randall Spangler <rspangler@chromium.org> Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Add "Getting Started Quickly"Tom Hughes2019-06-121-0/+129
| | | | | | | | | | | | | | | | | | | | | Converted the documentation in http://dev.chromium.org/chromium-os/ec-development/getting-started-building-ec-images-quickly to Markdown with go/gdc. I made minor cleanups to the Markdown after the conversion due to bugs in the formatting, but preserved the content/text. It's known that this documentation is out of date, but I wanted to preserve the history, so updates to the context/text should be made after this commit. BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I05b8fbb48345be028a9f8a046bffe422b599c77a Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1655949 Reviewed-by: Jett Rink <jettrink@chromium.org>
* ccd doc: link to suzyq instructions in cr50 setupMary Ruthven2019-05-121-2/+4
| | | | | | | | | | | | | | | Plugging in suzyq and finding the cr50 console requires some knowledge about how CCD works. Link to the specific instructions from the main CCD doc, so people can find out how to do it. BUG=none BRANCH=none TEST=none Change-Id: I49ee6d8d937f61599f8b18378e5775eb78bacfcf Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1599682 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* ccd doc: add more to information about using ccdMary Ruthven2019-05-101-12/+25
| | | | | | | | | | | | BUG=none BRANCH=none TEST=none Change-Id: I5776c16032863a2a0f8d5c82f148c80822379dec Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1599681 Commit-Ready: ChromeOS CL Exonerator Bot <chromiumos-cl-exonerator@appspot.gserviceaccount.com> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* ccd doc: link cr50 doc in main ccd docMary Ruthven2019-05-091-3/+4
| | | | | | | | | | | | | BUG=none BRANCH=none TEST=verify link works Change-Id: I774a0dc1c0965f3655c46b09ff9bdd3e12f21200 Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1599680 Commit-Ready: ChromeOS CL Exonerator Bot <chromiumos-cl-exonerator@appspot.gserviceaccount.com> Reviewed-by: Kevin Shelton <kmshelton@chromium.org> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: add core runtime design documentationVincent Palatin2019-02-191-0/+345
| | | | | | | | | | | | | | | | | | | Start documenting some of the Chromium EC runtime principles and choices. W.I.P: still a bunch of TODOs BRANCH=none BUG=none TEST=~/trunk/chromium/src/tools/md_browser/md_browser.py -d docs Signed-off-by: Vincent Palatin <vpalatin@chromium.org> Change-Id: I9f3d27ab752a714626cc4ec312771367ff67fcea Reviewed-on: https://chromium-review.googlesource.com/445941 Commit-Ready: ChromeOS CL Exonerator Bot <chromiumos-cl-exonerator@appspot.gserviceaccount.com> Tested-by: Nicolas Boichat <drinkcat@chromium.org> Reviewed-by: Aaron Durbin <adurbin@chromium.org>
* Add cr50 CCD documentationMary Ruthven2018-10-162-17/+619
| | | | | | | | | | | | | BUG=none BRANCH=none TEST=none Change-Id: Ie98a333ad2fa3ef92bf42a7d86bfa4ca8f18be61 Signed-off-by: Mary Ruthven <mruthven@google.com> Reviewed-on: https://chromium-review.googlesource.com/1269649 Commit-Ready: Mary Ruthven <mruthven@chromium.org> Tested-by: Mary Ruthven <mruthven@chromium.org> Reviewed-by: Mary Ruthven <mruthven@chromium.org>
* bc12: rename bq24392 driver to max14637Scott Collyer2018-10-021-1/+1
| | | | | | | | | | | | | | | | | | | | The MAX14637 BC 1.2 USB charger detection chip is functionally similar to the bq24392 and can use the same driver. Rather than have 2 copies of the same driver, or a generic named driver than can be used for both chips, rename the existing bq24392 driver to max14637 as that's the BC 1.2 chip that our current designs are using. BUG=b:113267982 BRANCH=none TEST=make -j buildall Change-Id: I03cfb4918513d756c2a41341001a8162652a29b6 Signed-off-by: Scott Collyer <scollyer@google.com> Reviewed-on: https://chromium-review.googlesource.com/1250031 Commit-Ready: Scott Collyer <scollyer@chromium.org> Tested-by: Scott Collyer <scollyer@chromium.org> Reviewed-by: Edward Hill <ecgh@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
* docs: Document low-battery compatibility config.Jonathan Brandmeyer2018-08-311-0/+428
| | | | | | | | | | | | | HOWTO set up an EC board such that plugging it in and turning it on Just Works. BUG=none BRANCH=none TEST=load docs in a markdown viewer for formatting. Change-Id: Ib1b31fe0a3c26ac7aad95d362f89afc25f57bf99 Signed-off-by: Jonathan Brandmeyer <jbrandmeyer@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1180403
* g: rename usb_updater into gsctoolVadim Bendebury2017-10-101-5/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The usb_updater utility has long been not just an updater, and has long been using other interfaces in addition to USB. gsctool is a much more suitable name. CQ-DEPEND=CL:709776 BRANCH=cr50 BUG=b:67007500 TEST=verified that make -C ./extra/usb_updater generates ./extra/usb_updater/gsctool: $ ./extra/usb_updater/gsctool --help Usage: gsctool [options] <binary image> This updates the Cr50 RW firmware over USB. The required argument is the full RO+RW image. Options: [...] $ Change-Id: I3ab70c28acf3664ddefaa923a87ba1fd5c3c437b Signed-off-by: Vadim Bendebury <vbendeb@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/709738 Reviewed-by: Mary Ruthven <mruthven@chromium.org>
* docs/usb_updater: Add more details about the update protocolNicolas Boichat2017-07-151-11/+90
| | | | | | | | | | | | | | | | | In particular, highlight more clearly cr50/common code differences, describe update over USB state machine, and common code commands. Also, replace all cr50/CR50 instances with Cr50. BRANCH=none BUG=b:36375666 TEST=~/chromium/src/tools/md_browser/md_browser.py -d docs Change-Id: I45e26a87c3455e1c67be186b403b1d4c4acade91 Reviewed-on: https://chromium-review.googlesource.com/558537 Commit-Ready: Nicolas Boichat <drinkcat@chromium.org> Tested-by: Nicolas Boichat <drinkcat@chromium.org> Reviewed-by: Vadim Bendebury <vbendeb@chromium.org>
* docs: Add USB updater documentation to docs folderNicolas Boichat2017-07-131-0/+120
| | | | | | | | | | | | | | | | Mostly copied from extra/usb_updater/usb_updater.c, makes it easier to reference from multiple locations (usb_updater, header files, etc.). BRANCH=none BUG=b:36375666 TEST=~/chromium/src/tools/md_browser/md_browser.py -d docs Change-Id: I6939ef74dd18b28ce5b8211c9a84f4adcf4e56b0 Reviewed-on: https://chromium-review.googlesource.com/486479 Commit-Ready: Nicolas Boichat <drinkcat@chromium.org> Tested-by: Nicolas Boichat <drinkcat@chromium.org> Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* USB Serial: Add README and update CCD docsAnton Staaf2016-06-151-12/+19
| | | | | | | | | | | | | | | | | | | | The README points the reader back to the docs directory where the CCD documentation lives. I've added information about the install script, and about how the raiden module identifies a CCD serial console. Signed-off-by: Anton Staaf <robotboy@chromium.org> BRANCH=None BUG=None TEST=make buildall -j Change-Id: I8714dffcad0b8c30f46529a8f2d670b5d432cda6 Reviewed-on: https://chromium-review.googlesource.com/352787 Commit-Ready: Anton Staaf <robotboy@chromium.org> Tested-by: Anton Staaf <robotboy@chromium.org> Reviewed-by: Anton Staaf <robotboy@chromium.org> Reviewed-by: Vadim Bendebury <vbendeb@chromium.org>
* CCD: Add documentationAnton Staaf2015-05-071-0/+143
This document is a user HOWTO for Case Closed Debugging in Markdown format. It can be converted to HTML using pandoc if desired. Signed-off-by: Anton Staaf <robotboy@chromium.org> BRANCH=None BUG=None TEST=pandoc case_closed_debugging.pm > case_closed_debugging.html RTFM Change-Id: I66870894309d20c4cc8e5139b7f4e4aed0b1d9f6 Reviewed-on: https://chromium-review.googlesource.com/269744 Reviewed-by: Bill Richardson <wfrichar@chromium.org> Commit-Queue: Anton Staaf <robotboy@chromium.org> Trybot-Ready: Anton Staaf <robotboy@chromium.org> Tested-by: Anton Staaf <robotboy@chromium.org>
View Lorry Controller Status