Document and describe the compatibles for Apple A7-A11 SoCs.

There are three feature levels:
- apple,aic: No fast IPI, for A7-A10
- apple,t8015-aic: fast IPI, global only, for A11
- apple,t8103-aic: fast IPI with local and global support, for M1

Each feature level is an extension of the previous, for example, M1 will
also work with the A7 feature level.

All of A7-M1 gets its own SoC-specific compatible, and the "apple,aic"
compatible as a fallback.

Signed-off-by: Nick Chan <towinchenmi@gmail.com>
---
 .../bindings/interrupt-controller/apple,aic.yaml   | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml b/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml
index 698588e9aa86..4be9b596a790 100644
--- a/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml
+++ b/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml
@@ -31,13 +31,25 @@ description: |
   This device also represents the FIQ interrupt sources on platforms using AIC,
   which do not go through a discrete interrupt controller.
 
+  IPIs may be performed via MMIO registers on all variants of AIC. Starting
+  from A11, system registers may also be used for "fast" IPIs. Starting from
+  M1, even faster IPIs within the same cluster may be achieved by writing to
+  a "local" fast IPI register as opposed to using the "global" fast IPI
+  register.
+
 allOf:
   - $ref: /schemas/interrupt-controller.yaml#
 
 properties:
   compatible:
     items:
-      - const: apple,t8103-aic
+      - enum:
+          - apple,s5l8960x-aic
+          - apple,t7000-aic
+          - apple,s8000-aic
+          - apple,t8010-aic
+          - apple,t8015-aic
+          - apple,t8103-aic
       - const: apple,aic
 
   interrupt-controller: true
-- 
2.46.0

> On 31. Aug 2024, at 07:57, Nick Chan <towinchenmi@gmail.com> wrote:
> 
> Document and describe the compatibles for Apple A7-A11 SoCs.
> 
> There are three feature levels:
> - apple,aic: No fast IPI, for A7-A10
> - apple,t8015-aic: fast IPI, global only, for A11
> - apple,t8103-aic: fast IPI with local and global support, for M1
> 
> Each feature level is an extension of the previous, for example, M1 will
> also work with the A7 feature level.
> 
> All of A7-M1 gets its own SoC-specific compatible, and the "apple,aic"
> compatible as a fallback.
> 
> Signed-off-by: Nick Chan <towinchenmi@gmail.com>
> ---

Reviewed-by: Sven Peter <sven@svenpeter.dev>


> .../bindings/interrupt-controller/apple,aic.yaml   | 14 +++++++++++++-
> 1 file changed, 13 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml b/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml
> index 698588e9aa86..4be9b596a790 100644
> --- a/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml
> +++ b/Documentation/devicetree/bindings/interrupt-controller/apple,aic.yaml
> @@ -31,13 +31,25 @@ description: |
>   This device also represents the FIQ interrupt sources on platforms using AIC,
>   which do not go through a discrete interrupt controller.
> 
> +  IPIs may be performed via MMIO registers on all variants of AIC. Starting
> +  from A11, system registers may also be used for "fast" IPIs. Starting from
> +  M1, even faster IPIs within the same cluster may be achieved by writing to
> +  a "local" fast IPI register as opposed to using the "global" fast IPI
> +  register.
> +
> allOf:
>   - $ref: /schemas/interrupt-controller.yaml#
> 
> properties:
>   compatible:
>     items:
> -      - const: apple,t8103-aic
> +      - enum:
> +          - apple,s5l8960x-aic
> +          - apple,t7000-aic
> +          - apple,s8000-aic
> +          - apple,t8010-aic
> +          - apple,t8015-aic
> +          - apple,t8103-aic
>       - const: apple,aic
> 
>   interrupt-controller: true
> --
> 2.46.0
> 

On Sat, Aug 31, 2024 at 01:48:16PM +0800, Nick Chan wrote:
> Document and describe the compatibles for Apple A7-A11 SoCs.
> 
> There are three feature levels:
> - apple,aic: No fast IPI, for A7-A10
> - apple,t8015-aic: fast IPI, global only, for A11
> - apple,t8103-aic: fast IPI with local and global support, for M1
> 
> Each feature level is an extension of the previous, for example, M1 will
> also work with the A7 feature level.
> 
> All of A7-M1 gets its own SoC-specific compatible, and the "apple,aic"
> compatible as a fallback.
> 
> Signed-off-by: Nick Chan <towinchenmi@gmail.com>
> ---
>  .../bindings/interrupt-controller/apple,aic.yaml   | 14 +++++++++++++-
>  1 file changed, 13 insertions(+), 1 deletion(-)

Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

<form letter>
This is an automated instruction, just in case, because many review tags
are being ignored. If you know the process, you can skip it (please do
not feel offended by me posting it here - no bad intentions intended).
If you do not know the process, here is a short explanation:

Please add Acked-by/Reviewed-by/Tested-by tags when posting new
versions, under or above your Signed-off-by tag. Tag is "received", when
provided in a message replied to you on the mailing list. Tools like b4
can help here. However, there's no need to repost patches *only* to add
the tags. The upstream maintainer will do that for tags received on the
version they apply.

https://elixir.bootlin.com/linux/v6.5-rc3/source/Documentation/process/submitting-patches.rst#L577
</form letter>

Best regards,
Krzysztof