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>
This commit is contained in:
Tim Crawford 2023-02-08 15:00:48 -07:00 committed by Jeremy Soller
parent 2a568cfb2e
commit 3f91e984a1

View File

@ -71,8 +71,6 @@ Other things that should be dumped before porting/flashing are:
To port coreboot to a new board, see the coreboot documentation.
- [TAS5825M] smart amp
Once coreboot is ported, add its configuration.
```
@ -84,6 +82,19 @@ cp coreboot/.config models/<model>/coreboot.config
`generate.sh` does not create `devicetree.cb`. Some values for this file can be
produced using the `devicetree.py` script.
### Smart amp
Boards may have a smart amp, which must be configured for speaker output to
work.
The initialization data for Realtek smart amps can be dumped from the module
that does the codec init in proprietary firmware. The correct module can be
found using UEFITool by searching for the vendor/device ID of the codec, such
as "10ec1220" for the ALC1220. This is the start of the `cim_verb_data` array
in coreboot.
For info on the TI TAS5825M smart amp, see the [smart-amp] repo.
## Configuring Intel CSME
The CSME image may need to be regenerated. Common changes that may be required
@ -106,4 +117,4 @@ READMEs.
[external-programmer]: ./flashing.md#external-programmer
[intel-microcode]: https://github.com/system76/intel-microcode
[mega2560]: https://github.com/system76/ec/blob/master/doc/mega2560.md
[TAS5825M]: https://github.com/system76/smart-amp
[smart-amp]: https://github.com/system76/smart-amp