summaryrefslogtreecommitdiff
path: root/docs/zephyr_init.md
diff options
context:
space:
mode:
authorJack Rosenthal <jrosenth@chromium.org>2021-11-04 12:11:58 -0600
committerCommit Bot <commit-bot@chromium.org>2021-11-05 04:22:34 +0000
commit252457d4b21f46889eebad61d4c0a65331919cec (patch)
tree01856c4d31d710b20e85a74c8d7b5836e35c3b98 /docs/zephyr_init.md
parent08f5a1e6fc2c9467230444ac9b582dcf4d9f0068 (diff)
downloadchrome-ec-stabilize-14396.B-ish.tar.gz
In the interest of making long-term branch maintenance incur as little technical debt on us as possible, we should not maintain any files on the branch we are not actually using. This has the added effect of making it extremely clear when merging CLs from the main branch when changes have the possibility to affect us. The follow-on CL adds a convenience script to actually pull updates from the main branch and generate a CL for the update. BUG=b:204206272 BRANCH=ish TEST=make BOARD=arcada_ish && make BOARD=drallion_ish Signed-off-by: Jack Rosenthal <jrosenth@chromium.org> Change-Id: I17e4694c38219b5a0823e0a3e55a28d1348f4b18 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3262038 Reviewed-by: Jett Rink <jettrink@chromium.org> Reviewed-by: Tom Hughes <tomhughes@chromium.org>
Diffstat (limited to 'docs/zephyr_init.md')
-rw-r--r--docs/zephyr_init.md53
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/zephyr_init.md b/docs/zephyr_init.md
deleted file mode 100644
index 8822736efb..0000000000
--- a/docs/zephyr_init.md
+++ /dev/null
@@ -1,53 +0,0 @@
-# Zephyr OS-based EC Initialization Order
-
-Zephyr provides Z_INIT_ENTRY_DEFINE() & the extend macro to install the initial
-function. The initialize flow for different levels would be like the following
-(not very detailed):
-* architecture-specific initialization
-* `PRE_KERNEL_1` level
-* `PRE_KERNEL_2` level
-* `POST_KERNEL` level
-* `APPLICATION` level
-* main()
-
-The kernel and driver initial functions separate into specific initialize
-levels. It couldn't put all initial functions in main() for the Zephyr OS-based
-EC. It is also hard to maintain those initial priority which separates into
-different files.
-
-This file defines some Zephyr OS-based EC initial priorities which have critical
-sequence requirement for initializing:
-
-## PRE_KERNEL_1
-* Priority (0-9) - Reserved for system testability:
-
- The highest priority could be used in zephyr. Don't use it when system
- development. Buffer it for the following system development & testing.
-
-* Priority (10-19) - Chip level system pre-initialization:
-
- These priorities in this range are used for critical chip initialization,
- including determining the reset cause and initializing the battery-backed
- RAM driver. Most chip drivers should only be initialized after
- `PLATFORM_EC_SYSTEM_PRE_INIT`.
-
-* Priority (20) - PLATFORM_EC_SYSTEM_PRE_INIT:
-
- At this initialization priority, the CROS system checks the reset cause and
- initializing the system reset flags. Any chip level drivers related to
- determining the reset type must be at a higher priority.
-
-* TODO
-
-## PRE_KERNEL_2
-* TODO
-
-## POST_KERNEL
-* TODO
-
-## APPLICATION
-* TODO
-
-## main()
-* TODO
-* Start the tasks.