[Skiboot] [PATCH v11 02/11] skiboot/doc: Add devicetree binding document for IMC

[Madhavan Srinivasan]

On Friday 12 May 2017 09:00 AM, Stewart Smith wrote:
> Madhavan Srinivasan <maddy at linux.vnet.ibm.com> writes:
>> Add a device tree binding documentation for the In Memory
>> Collection counter infrastructure.
>>
>> Signed-off-by: Madhavan Srinivasan <maddy at linux.vnet.ibm.com>
>> ---
>>   doc/device-tree/imc.rst | 67 +++++++++++++++++++++++++++++++++++++++++++++++++
>>   1 file changed, 67 insertions(+)
>>   create mode 100644 doc/device-tree/imc.rst
>>
>> diff --git a/doc/device-tree/imc.rst b/doc/device-tree/imc.rst
>> new file mode 100644
>> index 000000000000..56fcc274bbb9
>> --- /dev/null
>> +++ b/doc/device-tree/imc.rst
>> @@ -0,0 +1,67 @@
>> +.. _device-tree/imc:
>> +
>> +===========================
>> +IMC Device Tree Bindings
>> +===========================
>> +
>> +See :ref:`imc` for general In-Memory Collection (IMC) counter information.
>> +
>> +imc-counters top-level node
>> +----------------------------
>> +.. code-block:: dts
>> +
>> +      imc-counters {
>> +        compatible = "ibm,opal-in-memory-counters";
>> +        imc-nest-size = <0x40000>; /* region of Nest (Chip) counters in reserve-memory (HOMER) */
>> +
>> +        imc-nest-offset = <0x180000>; /* size of Nest (Chip) counters region in reserve-memory (HOMER) */
>> +
>> +        #address-cells = <0x1>;
>> +        #size-cells = <0x1>;
>> +        phandle = <0x1000023a>;
>> +        version-id = <0xd>;
>> +
>> +      };
> Please describe the properties here, notably what is version-id? Is it
> just the version of the description of the counters and mostly for
> debugging purposes?
Yes. Exactly, these are for the debug purpose. Will add more
comments.

>
> (and as mentioned elsewhere, I think the offset and size should not
> directly reference the homer-image, but rather just be in relation to a
> generic offset so that the DT bindings aren't exclusively specific to
> these counters)
Yes will rephrase the comment section accordingly as suggested.

Maddy

>
>