summaryrefslogtreecommitdiff
path: root/docs/configuration/motion_sensors.md
diff options
context:
space:
mode:
authorKeith Short <keithshort@chromium.org>2019-08-20 16:50:13 -0600
committerCommit Bot <commit-bot@chromium.org>2020-02-27 20:53:58 +0000
commitf634e7c0ccf4dc71185ef3c8b2ab96860629538d (patch)
treebaa107be53d8d504e2c0d0f360a16326621f42d0 /docs/configuration/motion_sensors.md
parentc2f751f107d88d910f4631eeb8c6f4f9a99b9d81 (diff)
downloadchrome-ec-f634e7c0ccf4dc71185ef3c8b2ab96860629538d.tar.gz
doc: Add creating a new board checklist.
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>
Diffstat (limited to 'docs/configuration/motion_sensors.md')
-rw-r--r--docs/configuration/motion_sensors.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/configuration/motion_sensors.md b/docs/configuration/motion_sensors.md
new file mode 100644
index 0000000000..4dac939b10
--- /dev/null
+++ b/docs/configuration/motion_sensors.md
@@ -0,0 +1,52 @@
+# Configure Motion Sensors
+
+EC sensors are used for the following capabilities:
+
+- Accelerometers in base and lid measure lid angle to toggle between laptop and
+ tablet modes.
+- Ambient light sensors control display backlight level.
+- All sensor types, including gyroscope, e-compass, and pressure, are used by
+ Android apps.
+- Special sync sensor type, synchronizes sensor events with AP.
+
+*TODO* - there is good content available in the most recent [Chrome EC] overview
+presentation that can be added here.
+
+## Config options
+
+*TODO*
+
+## Feature Parameters
+
+*TODO*
+
+
+## GPIOs and Alternate Pins
+
+*TODO*
+
+- `GPIO_EC_INT_L` - Output from the EC, driven low to indicate an event on the
+ EC is ready for servicing by the AP.
+
+## Data Structures
+
+*TODO*
+
+## Tasks
+
+*TODO*
+
+## Testing and Debugging
+
+*TODO*
+
+### Console Commands
+
+*TODO*
+
+## Example
+
+*TODO*
+
+[Chrome EC]: https://docs.google.com/presentation/d/1Y3PwNSnCQoCqDfL5rYqfaBP_ZqbMOTw_x83_ry4cro8/view#slide=id.g63bdbcea4b_0_27
+