zephyr/tests/subsys/edac/ibecc
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>.
This patch proposes to then include <zephyr/kernel.h> instead of
<zephyr/zephyr.h> since it is more clear that you are including the
Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a
catch-all header that may be confusing. Most applications need to
include a bunch of other things to compile, e.g. driver headers or
subsystem headers like BT, logging, etc.

The idea of a catch-all header in Zephyr is probably not feasible
anyway. Reason is that Zephyr is not a library, like it could be for
example `libpython`. Zephyr provides many utilities nowadays: a kernel,
drivers, subsystems, etc and things will likely grow. A catch-all header
would be massive, difficult to keep up-to-date. It is also likely that
an application will only build a small subset. Note that subsystem-level
headers may use a catch-all approach to make things easier, though.

NOTE: This patch is **NOT** removing the header, just removing its usage
in-tree. I'd advocate for its deprecation (add a #warning on it), but I
understand many people will have concerns.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-09-05 16:31:47 +02:00
..
src includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
CMakeLists.txt
prj.conf tests: subsys: edac: move ibecc to new ztest API 2022-07-21 13:57:25 +00:00
README.rst
testcase.yaml ztest: Fix userspace ztests in new API 2022-05-25 11:20:13 +09:00

.. _edac_ibecc_tests:

Testing Error Detection and Correction
######################################
Tests verify API and use error injection method to inject
errors.

Prerequisites
*************
IBECC should be enabled in BIOS. This is usually enabled in the default
BIOS configuration. Verify following:
Intel Advanced Menu -> Memory Configuration -> In-Band ECC ->  <Enabled>.
Verify also operational mode with:
Intel Advanced Menu -> Memory Configuration -> In-Band ECC Operation Mode -> 2

For injection test Error Injection should be enabled.

Error Injection
===============
IBECC includes a feature to ease the verification effort such as Error
Injection capability. This helps to test the error checking, logging and
reporting mechanism within IBECC.

In order to use Error Injection user need to use BIOS Boot Guard 0 profile.

Additionally Error Injection need to be enabled in the following BIOS menu:
Intel Advanced Menu -> Memory Configuration -> In-Band ECC Error -> <Enabled>.

Configurations
**************
Due to high security risk Error Injection capability should not be
enabled for production. Due to this reason test has production configuration
and debug configuration. The main difference is that debug configuration
includes Error Injection.