Re: [PATCH v4 2/3] Documentation: mailbox: Add APM X-Gene SLIMpro mailbox dts documentation
From: Duc Dang
Date: Tue Jan 19 2016 - 18:54:11 EST
On Sat, Jan 16, 2016 at 4:13 PM, Rob Herring <robh@xxxxxxxxxx> wrote:
> On Fri, Jan 15, 2016 at 06:57:18PM -0800, Duc Dang wrote:
>> This adds the APM X-Gene SLIMpro mailbox device tree
>> node documentation.
>>
>> Signed-off-by: Feng Kan <fkan@xxxxxxx>
>> Signed-off-by: Duc Dang <dhdang@xxxxxxx>
>> ---
>> Changes since v3:
>> - Rebase over v4.4
>> - Change number of mailbox IRQs to 8
>> - Fix white spaces, typos.
>>
>> .../bindings/mailbox/xgene-slimpro-mailbox.txt | 35 ++++++++++++++++++++++
>> 1 file changed, 35 insertions(+)
>> create mode 100644 Documentation/devicetree/bindings/mailbox/xgene-slimpro-mailbox.txt
>>
>> diff --git a/Documentation/devicetree/bindings/mailbox/xgene-slimpro-mailbox.txt b/Documentation/devicetree/bindings/mailbox/xgene-slimpro-mailbox.txt
>> new file mode 100644
>> index 0000000..91774d7
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mailbox/xgene-slimpro-mailbox.txt
>> @@ -0,0 +1,35 @@
>> +The APM X-Gene SLIMpro mailbox is used to communicate messages between
>> +the ARM64 processors and the Cortex M3 (dubbed SLIMpro). It uses a simple
>> +interrupt based door bell mechanism and can exchange simple messages using the
>> +internal registers.
>> +
>> +There are total of 7 interrupts in this mailbox. Each used for an individual
>> +door bell (or mailbox channel).
>> +
>> +Required properties:
>> +- compatible: Should be as "apm,xgene-slimpro-mbox".
>> +
>> +- reg: Contains the mailbox register address range.
>> +
>> +- interrupts: 8 interrupts must be from 0 to 7, interrupt 0 define the
>> + the interrupt for mailbox channel 0 and interrupt 1 for
>> + mailbox channel 1 and so likewise for the reminder.
>> +
>> +- #mbox-cells: only one to specify the mailbox channel number.
>> +
>> +Example:
>> +
>> +Mailbox Node:
>> + slimpro-mbox: slimpro-mbox@10540000 {
>
> Nit: just use mailbox@ or mbox@ (whatever others are using) for node
> name. Otherwise:
>
> Acked-by: Rob Herring <robh@xxxxxxxxxx>
Thanks, Rob.
I will change the node name to mailbox@10540000 in the document and DT
as well in the next version.
Regards,
Duc Dang.