Message-ID: <0d756429-13a5-f894-cf7d-b6f0f04da92c@collabora.com>
Date:   Fri, 10 Mar 2023 10:53:46 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.8.0
Subject: Re: [PATCH v3 2/3] remoteproc: k4: Split out functions common with M4
 driver
Content-Language: en-US
To:     Martyn Welch <martyn.welch@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
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>
From:   AngeloGioacchino Del Regno 
        <angelogioacchino.delregno@collabora.com>
In-Reply-To: <a2a51a0a63b7856794ac8fd6889ebf9fcb23f84e.camel@collabora.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
Precedence: bulk

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