Message-ID: <0b5ea25e40cad98b2a4f7b098dfa837fcc49e478.camel@collabora.com>
Subject: Re: [PATCH v3 2/3] remoteproc: k4: Split out functions common with
 M4 driver
From:   Martyn Welch <martyn.welch@collabora.com>
To:     AngeloGioacchino Del Regno 
        <angelogioacchino.delregno@collabora.com>,
        Hari Nagalla <hnagalla@ti.com>,
        Bjorn Andersson <andersson@kernel.org>,
        Mathieu Poirier <mathieu.poirier@linaro.org>,
        Philipp Zabel <p.zabel@pengutronix.de>
Cc:     kernel@collabora.com, linux-kernel@vger.kernel.org,
        linux-remoteproc@vger.kernel.org
Date:   Fri, 10 Mar 2023 13:55:03 +0000
In-Reply-To: <0d756429-13a5-f894-cf7d-b6f0f04da92c@collabora.com>
References: <20230302171450.1598576-1-martyn.welch@collabora.com>
         <20230302171450.1598576-3-martyn.welch@collabora.com>
         <400ab507-ff2f-cad8-19c6-66818407bf6d@ti.com>
         <a2a51a0a63b7856794ac8fd6889ebf9fcb23f84e.camel@collabora.com>
         <0d756429-13a5-f894-cf7d-b6f0f04da92c@collabora.com>
Organization: Collabora Ltd.
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.46.4-1 
MIME-Version: 1.0
Precedence: bulk

On Fri, 2023-03-10 at 10:53 +0100, AngeloGioacchino Del Regno wrote:
> Il 10/03/23 10:46, Martyn Welch ha scritto:
> > On Thu, 2023-03-09 at 12:04 -0600, Hari Nagalla wrote:
> > > On 3/2/23 11:14, Martyn Welch wrote:
> > > > + * @ti_sci_id: TI-SCI device identifier
> > > > + * @mbox: mailbox channel handle
> > > > + * @client: mailbox client to request the mailbox channel
> > > > + * @ipc_only: flag to indicate IPC-only mode
> > > > + */
> > > > +struct k3_rproc {
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct device *dev;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct rproc *rproc;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct k3_rproc_mem *mem=
;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0int num_mems;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct k3_rproc_mem *rme=
m;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0int num_rmems;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct reset_control *re=
set;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0const struct k3_rproc_de=
v_data *data;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct ti_sci_proc *tsp;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0const struct ti_sci_hand=
le *ti_sci;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0u32 ti_sci_id;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct mbox_chan *mbox;
> > > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0struct mbox_client clien=
t;
> > > > +};
> > > > +
> > > "ipc_only" mode element is missing in the structure.
> >=20
> > That's added with the M4F driver in the next patch - it's not part
> > of
> > the structure in the DSP driver.
>=20
> Martyn, I get that it's added later, but the point here is that you
> are
> documenting something that is missing! :-)
>=20
> You should add the kerneldoc for @ipc_only: xxxx when you actually
> introduce
> the new element... otherwise, this commit alone would trigger a
> kerneldoc warning.
>=20

Ah! Thanks. I'd missed that I'd left the comment in there. Yep, that
needs to be added in the next patch rather than here... :-)

Martyn

> Cheers,
> Angelo