27 Commits

Author SHA1 Message Date
Tim Crawford
7a60055f68 docs: Update CSME note about S0ix/TGL-U
CSME should be enabled when S0ix is used for power savings during
suspend. TGL-U is just one case where we default as our TGL-U models
do not support S3. Other models may use S0ix as well, such as darp8 and
darp9 due to new batches just not working with S3 anymore [1].

[1]: https://github.com/system76/firmware-open/issues/507

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2024-03-01 12:36:53 -07:00
Tim Crawford
7a2d4da31f docs: Move info from README to docs/
Signed-off-by: Tim Crawford <tcrawford@system76.com>
2024-02-28 13:22:54 -07:00
Tim Crawford
cab3891487 docs: Build with mdBook
Signed-off-by: Tim Crawford <tcrawford@system76.com>
2024-02-28 13:22:54 -07:00
Tim Crawford
269b537c00 docs: Update note about coreboot config
The whole coreboot generated `.config` has not been used since
ff0a27ad9c60 ("Use defconfig to generate .config"). The required
`coreboot.config` is much simpler now and can usually just be copied
from another model.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2024-02-21 07:35:52 -07:00
Tim Crawford
7d5a50d26b Remove devicetree script
This script is stale. It hasn't worked since TGL and only produced a few
useful values. The format of devicetree.cb also continues to change with
each SoC generation.

The removal of devmem2 should also fix setup on Debian, which does not
package it.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2024-02-21 07:35:52 -07:00
Tim Crawford
6f1e65308e docs: Update note about Secure Boot support
Secure Boot support is enabled. Make it clear in the doc that it was
enabled so Windows could be installed, and not as a means for securing
the system.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2023-12-12 11:45:08 -07:00
Tim Crawford
52f6d72713 docs: Add note about checking CSME state
I had forgotten that CSME reporting an error was normal when disabled.
Document what is should report when enabled/disabled.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2023-09-07 10:24:10 -04:00
Jacob Kauffmann
55c071e4f1 fix (docs): Update link to EC debugging 2023-08-10 09:34:33 -06:00
Tim Crawford
3f91e984a1 docs: Add section for smart amp to porting notes
Document how to find the Realtek smart amp init data from the
proprietary firmware image.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2023-04-03 13:23:12 -06:00
leviport
2680d93538
docs (flashing): Remove chip package info (#348)
Since there are now two different chip package types used in our laptops, mentioning only one may cause confusion.
2022-08-12 13:42:42 -06:00
Tim Crawford
2e133ed72e docs: Add things to dump before porting
Information required for porting may not be in the schematics and
require inspection while running the proprietary firmware.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2022-07-27 10:12:02 -06:00
Tim Crawford
b2d8bda2b9 docs: Add note about regenerating CSME
CSME image may need to be configured to disable PTT, Boot Guard, and
locking of the descriptor.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2022-06-22 09:36:04 -06:00
Tim Crawford
b3242efba6 docs: Add info for enabling debug logging
Signed-off-by: Tim Crawford <tcrawford@system76.com>
2022-02-28 16:00:54 -07:00
Tim Crawford
8c88ca0252 docs: Add notes about UEFI features
Document that only UEFI booting is supported, the current status of
Secure Boot, and that the shell and networking are disabled.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2021-12-21 13:11:09 -07:00
Tim Crawford
9c63db4c9f docs: Update Intel ME info
Document the new CMOS option for enabling/disabling the IME.

Signed-off-by: Tim Crawford <tcrawford@system76.com>
2021-12-21 13:11:09 -07:00
smth-0
9b096dc283
Replace "out of stock" Amazon link and add AliExpress one (#202) 2021-06-18 09:47:24 -06:00
Tim Crawford
57c3682201 docs: Use devicetree.py for dt values 2021-03-18 08:01:52 -06:00
Tim Crawford
9373a7ff15 docs: Commands to collect some devicetree values
These values were originally comments in every devicetree. Add them here
for now.
2021-03-01 13:22:14 -07:00
Tim Crawford
c59c6e7fa4 docs: Add note about IME state on TGL-U
Explain why we ship galp5/lemp10 with the IME enabled.
2021-02-26 10:17:14 -07:00
Tim Crawford
a1fc562bc0 docs: Link to smart-amp for TAS5825M info 2020-09-30 16:20:21 -06:00
Tim Crawford
124c9fd887 docs: Add recommended hardware for porting 2020-09-09 11:00:25 -06:00
Tim Crawford
aa482271fd docs: Move Intel ME note to separate file 2020-08-31 11:19:27 -06:00
Tim Crawford
43af66c388 docs: Extra info for flashing
- Add note why first boot after flashing takes so long
- Add note about power off when flashing EC
- Add note on identifying the BIOS chip
2020-08-31 11:19:27 -06:00
Tim Crawford
5f780ee2ec docs: Update notes for adding a new board
- Update note about microcode.rom
- Remove note about different model names for firmware-open and EC
2020-08-31 11:19:27 -06:00
Tim Crawford
9314cf5989 docs: Move flashing to a separate file 2020-08-31 11:19:27 -06:00
Tim Crawford
9ee2150d43 docs: Use generate.sh for board bringup 2020-07-22 09:40:37 -06:00
Tim Crawford
8b8e48b2ce Add doc for supporting a new board 2020-07-22 09:40:37 -06:00