Re: [PATCH v14 1/9] hw/misc: Add Nuvoton's PCI Mailbox Module

[Peter Maydell]

On Mon, 22 Jan 2024 at 17:37, Nabih Estefan <nabihestefan@google.com> wrote:
>
> From: Hao Wu <wuhaotsh@google.com>
>
> The PCI Mailbox Module is a high-bandwidth communcation module
> between a Nuvoton BMC and CPU. It features 16KB RAM that are both
> accessible by the BMC and core CPU. and supports interrupt for
> both sides.
>
> This patch implements the BMC side of the PCI mailbox module.
> Communication with the core CPU is emulated via a chardev and
> will be in a follow-up patch.


> +// The device is using a Little Endian Protocol.
> +// If running into errors, please check what protocol is being expected.

(1) This is not the right format for a comment in our coding style.
(2) This is not sufficient to count as protocol documentation.

The protocol should be documented in enough detail that I could,
by reading *only the comment and not the code at all*, implement
something that connects to the chardev and talks to the device.

thanks
-- PMM