[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID:
<DB9PR04MB8461684315E753DAFDDBACA788A12@DB9PR04MB8461.eurprd04.prod.outlook.com>
Date: Mon, 15 Jul 2024 11:47:56 +0000
From: Peng Fan <peng.fan@....com>
To: Cristian Marussi <cristian.marussi@....com>, "Peng Fan (OSS)"
<peng.fan@....nxp.com>
CC: Jonathan Corbet <corbet@....net>, Shawn Guo <shawnguo@...nel.org>, Sascha
Hauer <s.hauer@...gutronix.de>, Pengutronix Kernel Team
<kernel@...gutronix.de>, Fabio Estevam <festevam@...il.com>, Sudeep Holla
<sudeep.holla@....com>, Rob Herring <robh@...nel.org>, Krzysztof Kozlowski
<krzk+dt@...nel.org>, Conor Dooley <conor+dt@...nel.org>, Alexandre Belloni
<alexandre.belloni@...tlin.com>, Dmitry Torokhov <dmitry.torokhov@...il.com>,
"linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
"imx@...ts.linux.dev" <imx@...ts.linux.dev>,
"linux-arm-kernel@...ts.infradead.org"
<linux-arm-kernel@...ts.infradead.org>, "devicetree@...r.kernel.org"
<devicetree@...r.kernel.org>, "arm-scmi@...r.kernel.org"
<arm-scmi@...r.kernel.org>, "linux-rtc@...r.kernel.org"
<linux-rtc@...r.kernel.org>, "linux-input@...r.kernel.org"
<linux-input@...r.kernel.org>
Subject: RE: [PATCH v5 1/7] Documentation: firmware-guide: add NXP i.MX95 SCMI
documentation
> Subject: Re: [PATCH v5 1/7] Documentation: firmware-guide: add NXP
> i.MX95 SCMI documentation
>
> On Fri, Jun 21, 2024 at 03:04:36PM +0800, Peng Fan (OSS) wrote:
> > From: Peng Fan <peng.fan@....com>
> >
> > Add NXP i.MX95 System Control Management Interface(SCMI)
> vendor
> > extensions protocol documentation.
> >
>
> Hi,
>
> beside the final location of this file in the tree, and a few nitpicks down
> below.
Thanks for reviewing the patches. Except Documentation/firmware-guide,
I not have good idea where to put the API doc.
Sudeep,
Do you have any suggestions?
Thanks,
Peng.
>
> LGTM.
> Reviewed-by: Cristian Marussi <cristian.marussi@....com>
>
> > Signed-off-by: Peng Fan <peng.fan@....com>
> > ---
>
> [snip]
>
> > +MISC_CONTROL_GET
> > +~~~~~~~~~~~~~~~~
> > +
> > +message_id: 0x4
> > +protocol_id: 0x84
> > +
> > ++------------------+-----------------------------------------------------------+
> > +|Parameters |
> > ++------------------+-----------------------------------------------------------+
> > +|Name |Description |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 index |Index of the control |
> > ++------------------+-----------------------------------------------------------+
> > +|Return values |
> > ++------------------+-----------------------------------------------------------+
> > +|Name |Description |
> > ++------------------+-----------------------------------------------------------+
> > +|int32 status |SUCCESS: if the control was get successfully.
> |
> > +| |NOT_FOUND: if the index is not valid. |
> > +| |DENIED: if the agent does not have permission to get
> the |
> > +| |control |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 num |Size of the return data in words, max 8
> |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 | |
> > +|val[0, num - 8] |value data array |
>
> val[0, num - 1] --- typo ?
>
> which I suppose means that this field is variable in size depending on
> num value...
>
> In the gneral SCMI spec I think usually we write something like
>
> uint32 val[N] with N as specified in num.
>
> ... but I am fine even with this val[0, num - 1] if it is intended to meanb
> this same thing, i.e. variable size field depending on another field.
>
> > ++------------------+-----------------------------------------------------------+
> > +
> > +MISC_CONTROL_ACTION
> > +~~~~~~~~~~~~~~~~~~~
> > +
> > +message_id: 0x5
> > +protocol_id: 0x84
> > +
> > ++------------------+-----------------------------------------------------------+
> > +|Parameters |
> > ++------------------+-----------------------------------------------------------+
> > +|Name |Description |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 index |Index of the control |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 action |Action for the control
> |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 numarg |Size of the argument data, max 8
> |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 | |
> > +|arg[0, numarg -1] |Argument data array |
> > ++------------------+-----------------------------------------------------------+
> > +|Return values |
> > ++------------------+-----------------------------------------------------------+
> > +|Name |Description |
> > ++------------------+-----------------------------------------------------------+
> > +|int32 status |SUCCESS: if the action was set successfully.
> |
> > +| |NOT_FOUND: if the index is not valid. |
> > +| |DENIED: if the agent does not have permission to get
> the |
> > +| |control |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 num |Size of the return data in words, max 8
> |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 | |
> > +|val[0:num-1] |value data array |
>
> val[0, num - 1] ... for consistency
>
> > ++------------------+-----------------------------------------------------------+
> > +
> > +MISC_DISCOVER_BUILD_INFO
> > +~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +This function is used to obtain the build commit, data, time, number.
> > +
> > +message_id: 0x6
> > +protocol_id: 0x84
> > +
> > ++------------------+-----------------------------------------------------------+
> > +|Return values |
> > ++------------------+-----------------------------------------------------------+
> > +|Name |Description |
> > ++------------------+-----------------------------------------------------------+
> > +|int32 status |SUCCESS: if the build info was got successfully.
> |
> > +| |NOT_SUPPORTED: if the data is not available. |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 buildnum |Build number |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 buildcommit|Most significant 32 bits of the git commit
> hash |
> > ++------------------+-----------------------------------------------------------+
> > +|uint8 date[16] |Date of build. Null terminated ASCII string of up
> to 16 |
> > +| |bytes in length |
> > ++------------------+-----------------------------------------------------------+
> > +|uint8 time[16] |Time of build. Null terminated ASCII string of up
> to 16 |
> > +| |bytes in length |
> > ++------------------+-----------------------------------------------------------+
> > +
> > +MISC_ROM_PASSOVER_GET
> > +~~~~~~~~~~~~~~~~~~~~~
> > +
> > +ROM passover data is information exported by ROM and could be
> used by others.
> > +It includes boot device, instance, type, mode and etc. This function
> > +is used to obtain the ROM passover data. The returned block of
> words
> > +is structured as defined in the ROM passover section in the SoC RM.
> > +
> > +message_id: 0x7
> > +protocol_id: 0x84
> > +
> > ++------------------+-----------------------------------------------------------+
> > +|Return values |
> > ++------------------+-----------------------------------------------------------+
> > +|Name |Description |
> > ++------------------+-----------------------------------------------------------+
> > +|int32 status |SUCCESS: if the data was got successfully.
> |
> > +| |NOT_SUPPORTED: if the data is not available. |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32 num |Size of the passover data in words, max 13
> |
> > ++------------------+-----------------------------------------------------------+
> > +|uint32_t | |
> > +|data[0:num-1] |Passover data array |
> > ++------------------+-----------------------------------------------------------+
> > +
>
> data[0, num - 1] ... consistency
>
> Thanks,
> Cristian
Powered by blists - more mailing lists