From facc08c47aded7002b1a867fb7dd67640f6e2830 Mon Sep 17 00:00:00 2001
From: Patrick Rudolph <patrick.rudolph@9elements.com>
Date: Fri, 25 May 2018 11:04:45 +0200
Subject: Documentation: Add HP Compaq 8200 and NPCD378

Change-Id: I56db0cc11cfa5a1a537091553393542312d4f212
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Reviewed-on: https://review.coreboot.org/26543
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
---
 Documentation/superio/index.md           |   7 ++
 Documentation/superio/nuvoton/npcd378.md | 125 +++++++++++++++++++++++++++++++
 2 files changed, 132 insertions(+)
 create mode 100644 Documentation/superio/index.md
 create mode 100644 Documentation/superio/nuvoton/npcd378.md

(limited to 'Documentation/superio')

diff --git a/Documentation/superio/index.md b/Documentation/superio/index.md
new file mode 100644
index 000000000000..eef4d579efa3
--- /dev/null
+++ b/Documentation/superio/index.md
@@ -0,0 +1,7 @@
+# SuperIO-specific documentation
+
+This section contains documentation about coreboot on specific SuperIOs.
+
+## Nuvoton
+
+- [NPCD378](nuvoton/npcd378.md)
diff --git a/Documentation/superio/nuvoton/npcd378.md b/Documentation/superio/nuvoton/npcd378.md
new file mode 100644
index 000000000000..f7fe1a56c67f
--- /dev/null
+++ b/Documentation/superio/nuvoton/npcd378.md
@@ -0,0 +1,125 @@
+# NPCD378
+
+This page describes the [Nuvoton] SuperIO chip that can be found on various [HP]
+mainboards.
+
+As no datasheet is available most of the functions have been reverse engineered and
+might be inacurate or wrong.
+
+## LDNs
+
+```eval_rst
++-------+---------------------------+
+| LDN # | Function                  |
++=======+===========================+
+| 0     | FDC                       |
++-------+---------------------------+
+| 1     | Parallel Port             |
++-------+---------------------------+
+| 2     | Com1                      |
++-------+---------------------------+
+| 3     | Com2 / IR                 |
++-------+---------------------------+
+| 4     | LED and PWR button CTRL   |
++-------+---------------------------+
+| 5     | PS/2 AUX                  |
++-------+---------------------------+
+| 6     | PS/2 KB                   |
++-------+---------------------------+
+| 7     | WDT1                      |
++-------+---------------------------+
+| 8     | HWM                       |
++-------+---------------------------+
+| 0xf   | GPIO                      |
++-------+---------------------------+
+| 0x15  | I2C ?                     |
++-------+---------------------------+
+| 0x1e  | SUSPEND CTL ?             |
++-------+---------------------------+
+| 0x1c  | GPIO ?                    |
++-------+---------------------------+
+```
+
+### LDN0
+
+Follows [Nuvoton]'s default FDC register set. See [NCT6102D] for more details.
+
+### LDN1
+
+Follows [Nuvoton]'s default LPT register set. See [NCT6102D] for more details.
+
+### LDN2
+
+Follows [Nuvoton]'s default COM1 register set. See [NCT6102D] for more details.
+
+### LDN3
+
+Follows [Nuvoton]'s default COM2 register set. See [NCT6102D] for more details.
+
+### LDN4
+
+On most SuperIOs the use of LDN4 is forbidden. That's not the case on NPCD378.
+
+It exposes 16 byte of IO config space to control the front LEDs PWM duty cycle
+and power button behaviour on normal / during S3 resume.
+
+### LDN5
+
+A custom PS/2 AUX port.
+
+### LDN6
+
+Follows [Nuvoton]'s default KBC register set. See [NCT6102D] for more details.
+
+### LDN7
+
+Looks like a WDT.
+
+### LDN8
+
+Custom HWM space. It exposes 256 byte of IO config space.
+See [HWM](#HWM) for more details.
+
+## HWM
+
+### Register
+
+The registers are accessible via IO space and are located at LDN8's IOBASE.
+
+```eval_rst
++---------------+-----------------------+
+| IOBASE offset | Register              |
++---------------+-----------------------+
+| 0x4           | Host Write CTRL       |
++---------------+-----------------------+
+| 0x10 - 0xfe   | HWM Page #            |
++---------------+-----------------------+
+| 0xff          | Page index select     |
++---------------+-----------------------+
+```
+
+### Host Write CTRL
+Bit 0 must be cleared prior to writing any of the HWM register and it must be
+set after writing to HWM register to signal the SuperIO that data has changed.
+Reading register is possible at any time and doesn't need special locking.
+
+### HWM Page
+The SuperIO exposes 16 different pages. Nearly all registers are unknown.
+
+**Page 1**
+
+```eval_rst
++---------------+-----------------------+
+| IOBASE offset | Register              |
++---------------+-----------------------+
+| 0x98          | PSU fan PWM           |
++---------------+-----------------------+
+```
+
+### Page index
+The 4 LSB of the page index register selects which HWM page is active.
+A write takes effect immediately.
+
+[NCT6102D]: https://www.nuvoton.com/resource-files/NCT6102D_NCT6106D_Datasheet_V1_0.pdf
+[Nuvoton]: http://www.nuvoton.com/hq/
+[HP]: https://www.hp.com/
-- 
cgit v1.2.3