Re: [PATCH v3 2/3] remoteproc: k4: Split out functions common with M4 driver

[AngeloGioacchino Del Regno]

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 {
> > > +       struct device *dev;
> > > +       struct rproc *rproc;
> > > +       struct k3_rproc_mem *mem;
> > > +       int num_mems;
> > > +       struct k3_rproc_mem *rmem;
> > > +       int num_rmems;
> > > +       struct reset_control *reset;
> > > +       const struct k3_rproc_dev_data *data;
> > > +       struct ti_sci_proc *tsp;
> > > +       const struct ti_sci_handle *ti_sci;
> > > +       u32 ti_sci_id;
> > > +       struct mbox_chan *mbox;
> > > +       struct mbox_client client;
> > > +};
> > > +
> > "ipc_only" mode element is missing in the structure.
>
> That's added with the M4F driver in the next patch - it's not part of
> the structure in the DSP driver.

Martyn, I get that it's added later, but the point here is that you are
documenting something that is missing! :-)

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.

Cheers,
Angelo