Re: [PATCH v2 6/8] PCI/AER: Add ratelimits to PCI AER Documentation

[Karolina Stolarek <karolina.stolarek@oracle.com>]

On 14/02/2025 03:35, Jon Pan-Doh wrote:
> Add ratelimits section for rationale and defaults.
> 
> Signed-off-by: Jon Pan-Doh <pandoh@google.com>
> ---
>   Documentation/PCI/pcieaer-howto.rst | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/Documentation/PCI/pcieaer-howto.rst b/Documentation/PCI/pcieaer-howto.rst
> index f013f3b27c82..167c0b277b62 100644
> --- a/Documentation/PCI/pcieaer-howto.rst
> +++ b/Documentation/PCI/pcieaer-howto.rst
> @@ -85,6 +85,14 @@ In the example, 'Requester ID' means the ID of the device that sent
>   the error message to the Root Port. Please refer to PCIe specs for other
>   fields.
>   
> +AER Ratelimits
> +--------------
> +
> +Error messages are ratelimited per device and error type. This prevents
> +spammy devices from flooding the console and stalling execution. Set the
> +default ratelimit to DEFAULT_RATELIMIT_BURST over
> +DEFAULT_RATELIMIT_INTERVAL (10 per 5 seconds).

The imperative tone of the last sentence doesn't fit here. How about 
adding information about the ratelimit values to the first one, to 
specify how frequently we limit the error reporting?

If you're eager, you can explain here that the errors are reported on 
each interrupt generated for an Error Message, and that PCIe registers 
can only toggle error generation on and off, with no option to control 
the rate. Feel free to use bits of my cover letter[1] and if you do so, 
please add my SOB to the patch.

All the best,
Karolina

[1] - 
https://lore.kernel.org/linux-pci/cover.1734005191.git.karolina.stolarek@oracle.com/T/#u
> +
>   AER Statistics / Counters
>   -------------------------
>