mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Du, Bin" <bin.du@amd.com>
To: Sakari Ailus <sakari.ailus@linux.intel.com>,
	Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: mchehab@kernel.org, hverkuil@xs4all.nl,
	bryan.odonoghue@linaro.org,
	prabhakar.mahadev-lad.rj@bp.renesas.com,
	linux-media@vger.kernel.org, linux-kernel@vger.kernel.org,
	pratap.nirujogi@amd.com, benjamin.chan@amd.com, king.li@amd.com,
	gjorgji.rosikopulos@amd.com, Phil.Jawich@amd.com,
	Dominic.Antony@amd.com,
	Mario Limonciello <mario.limonciello@amd.com>,
	Richard.Gong@amd.com, anson.tsao@amd.com
Subject: Re: [PATCH v2 4/8] media: platform: amd: Add isp4 fw and hw interface
Date: Tue, 12 Aug 2025 18:04:41 +0800	[thread overview]
Message-ID: <b94236b7-3a56-45f8-a085-9ca661b0f43c@amd.com> (raw)
In-Reply-To: <aJr5RuD1lxnVBmed@kekkonen.localdomain>

Hi Sakari Ailus,

On 8/12/2025 4:20 PM, Sakari Ailus wrote:
> Hi Laurent, Bin,
> 
> On Tue, Aug 12, 2025 at 10:34:32AM +0300, Laurent Pinchart wrote:
>> On Tue, Aug 12, 2025 at 11:36:23AM +0800, Du, Bin wrote:
>>> Many thanks Laurent Pinchart for the comments.
>>>
>>> On 8/11/2025 8:31 PM, Laurent Pinchart wrote:
>>>> On Mon, Aug 11, 2025 at 11:46:27AM +0000, Sakari Ailus wrote:
>>>>> On Tue, Jul 29, 2025 at 05:12:03PM +0800, Du, Bin wrote:
>>>>>> On 7/28/2025 3:23 PM, Sakari Ailus wrote:
>>>>>>> On Wed, Jun 18, 2025 at 05:19:55PM +0800, Bin Du wrote:
>>>>>>>> ISP firmware controls ISP HW pipeline using dedicated embedded processor
>>>>>>>> called ccpu.
>>>>>>>> The communication between ISP FW and driver is using commands and
>>>>>>>> response messages sent through the ring buffer. Command buffers support
>>>>>>>> either global setting that is not specific to the steam and support stream
>>>>>>>> specific parameters. Response buffers contains ISP FW notification
>>>>>>>> information such as frame buffer done and command done. IRQ is used for
>>>>>>>> receiving response buffer from ISP firmware, which is handled in the main
>>>>>>>> isp4 media device. ISP ccpu is booted up through the firmware loading
>>>>>>>> helper function prior to stream start.
>>>>>>>> Memory used for command buffer and response buffer needs to be allocated
>>>>>>>> from amdgpu buffer manager because isp4 is a child device of amdgpu.
>>>>>>>
>>>>>>> Please rewrap this, some lines above are quite short.
>>>>>>>
>>>>>> Thanks, the line after the short line is supposed to be a new paragraph?
>>>>>> Should we put all the description in one paragraph?
>>>>>
>>>>> One or more paragraphs work fine, but a new paragraph is separated from the
>>>>> previous one by another newline.
>>>>>
>>>>> ...
>>>>
>>>> Paragraphs are defined as a block of text that convey one idea. They
>>>> should be visually separated by a space. As we can't have fractional
>>>> line spacing in plain text, paragraphs need to be separated by a blank
>>>> line. This is a typography rule that maximizes readability. There should
>>>> be no line break between sentences in a single paragraph.
>>>>
>>>> Whether you write commit messages, formal documentation or comments in
>>>> code, typography is important to give the best experience to readers.
>>>> After all, a block of text that wouldn't focus on the readers would have
>>>> no reason to exist.
>>>>
>>>>
>>>> Now compare the above with
>>>>
>>>>
>>>> Paragraphs are defined as a block of text that convey one idea. They
>>>> should be visually separated by a space.
>>>> As we can't have fractional line spacing in plain text, paragraphs need
>>>> to be separated by a blank line.
>>>> This is a typography rule that maximizes readability. There should be no
>>>> line break between sentences in a single paragraph. Whether you write
>>>> commit messages, formal documentation or comments in code, typography is
>>>> important to give the best experience to readers.
>>>> After all, a block of text that wouldn't focus on the readers would have
>>>> no reason to exist.
>>>
>>> Really appreciate the detailed guide, will follow it. May I summarize
>>> like this? 1 Separate paragraphs by a blank line. 2 Don't add line break
>>> between sentences in a single paragraph, an exception to this is commit
>>> message, because of the 75-character patch check limit, line break can
>>> be added, but it should at the 75-character limit boundary
>>
>> When I wrote "line break", I meant breaking the line after a sentence,
>> before the 75 columns limits. Text blocks should always be wrapped (at
>> 75 columns in commit messages, or 80 in kernel code). What you should
>> avoid is line breaks not related to the columns limit.
>>
>> This is fine:
>>
>> This paragraph has a long sentence that does not hold on a single line
>> of 72 characters and therefore needs to be wrapped. There is no line
>> break otherwise, for instance between the first and second sentence, or
>> within a sentence.
>>
>> This is not right:
>>
>> This paragraph has a long sentence that does not hold on a single line
>> of 72 characters and therefore needs to be wrapped.
>> There is a line break between the first and second sentence,
>> and also a line break in the second sentence, which are not fine.
> 
> I wonder if this should make it to kernel documentation. I've come across
> many new developers recently who would definitely benefit from this.
> 

Yes, totally agree, furthermore, if checkpatch script can be 
strengthened to add this kind of check, developers can even find and fix 
them before submit the patches

> Also, most editors can rewrap paragraphs of text (e.g. Emacs M-q or Joe C-k
> C-j).
> 

-- 
Regards,
Bin


  reply	other threads:[~2025-08-12 10:04 UTC|newest]

Thread overview: 98+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-18  9:19 [PATCH v2 0/8] Add AMD ISP4 driver Bin Du
2025-06-18  9:19 ` [PATCH v2 1/8] media: platform: amd: Introduce amd isp4 capture driver Bin Du
2025-06-18 15:58   ` Mario Limonciello
2025-06-19  7:46     ` Du, Bin
2025-06-19 13:00       ` Mario Limonciello
2025-06-20  3:08         ` Du, Bin
2025-07-28  5:54   ` Sakari Ailus
2025-07-28  9:00     ` Du, Bin
2025-06-18  9:19 ` [PATCH v2 2/8] media: platform: amd: low level support for isp4 firmware Bin Du
2025-06-18 16:00   ` Mario Limonciello
2025-06-19  7:53     ` Du, Bin
2025-07-28  5:57   ` Sakari Ailus
2025-07-28  9:24     ` Du, Bin
2025-06-18  9:19 ` [PATCH v2 3/8] media: platform: amd: Add helpers to configure isp4 mipi phy Bin Du
2025-07-28  6:33   ` Sakari Ailus
2025-08-05  9:53     ` Du, Bin
2025-08-05 10:53       ` Laurent Pinchart
2025-08-06  9:56         ` Du, Bin
2025-08-05 10:39     ` Laurent Pinchart
2025-08-06  9:45       ` Du, Bin
2025-07-28  7:28   ` Sakari Ailus
2025-07-31  9:31     ` Du, Bin
2025-06-18  9:19 ` [PATCH v2 4/8] media: platform: amd: Add isp4 fw and hw interface Bin Du
2025-06-18 16:17   ` Mario Limonciello
2025-06-19  9:58     ` Du, Bin
2025-06-19 15:11       ` Mario Limonciello
2025-06-20  3:32         ` Du, Bin
2025-07-28  7:23   ` Sakari Ailus
2025-07-29  9:12     ` Du, Bin
2025-08-11 11:46       ` Sakari Ailus
2025-08-11 12:31         ` Laurent Pinchart
2025-08-12  3:36           ` Du, Bin
2025-08-12  7:34             ` Laurent Pinchart
2025-08-12  8:08               ` Du, Bin
2025-08-12  8:20               ` Sakari Ailus
2025-08-12 10:04                 ` Du, Bin [this message]
2025-08-12  2:44         ` Du, Bin
2025-06-18  9:19 ` [PATCH v2 5/8] media: platform: amd: isp4 subdev and firmware loading handling added Bin Du
2025-06-18 16:35   ` Mario Limonciello
2025-06-20  9:31     ` Du, Bin
2025-07-06 20:55       ` Mario Limonciello
2025-07-07  6:22         ` Du, Bin
2025-07-25  1:35   ` Sultan Alsawaf
2025-07-25  9:03     ` Du, Bin
2025-06-18  9:19 ` [PATCH v2 6/8] media: platform: amd: isp4 video node and buffers " Bin Du
2025-07-23 17:55   ` Sultan Alsawaf
2025-07-24  5:14     ` Sultan Alsawaf
2025-07-25  9:05       ` Du, Bin
2025-07-25  9:22     ` Du, Bin
2025-07-26 21:41       ` Sultan Alsawaf
2025-07-26 21:50         ` Sultan Alsawaf
2025-07-29  6:12           ` Du, Bin
2025-07-29  6:08         ` Du, Bin
2025-07-28  7:04   ` Sultan Alsawaf
2025-07-29  7:43     ` Du, Bin
2025-07-31  0:34       ` Sultan Alsawaf
2025-07-31  9:45         ` Du, Bin
2025-08-11  6:02         ` Sultan Alsawaf
2025-08-11  9:05           ` Du, Bin
2025-08-12  5:51             ` Sultan Alsawaf
2025-08-12  6:33               ` Du, Bin
2025-08-13  9:42                 ` Du, Bin
2025-08-14  6:37                   ` Sultan Alsawaf
2025-06-18  9:19 ` [PATCH v2 7/8] media: platform: amd: isp4 debug fs logging and more descriptive errors Bin Du
2025-06-18  9:19 ` [PATCH v2 8/8] Documentation: add documentation of AMD isp 4 driver Bin Du
2025-08-05 11:37   ` Laurent Pinchart
2025-08-12  1:36     ` Du, Bin
2025-08-12 13:42       ` Laurent Pinchart
2025-08-22  2:28         ` Du, Bin
2025-08-20 12:42       ` Sakari Ailus
2025-08-22  2:20         ` Du, Bin
2025-09-22  6:24           ` Sakari Ailus
2025-09-22  9:19             ` Du, Bin
2025-07-23 18:12 ` [PATCH v2 0/8] Add AMD ISP4 driver Sultan Alsawaf
2025-07-25 10:22   ` Du, Bin
2025-07-26 22:31     ` Sultan Alsawaf
2025-07-29  3:32       ` Du, Bin
2025-07-29  7:42         ` Sultan Alsawaf
2025-07-29  7:45           ` Sultan Alsawaf
2025-07-29 10:13             ` Du, Bin
2025-07-30  5:38               ` Sultan Alsawaf
2025-07-30  9:53                 ` Du, Bin
2025-07-31  0:30                   ` Sultan Alsawaf
2025-07-31 10:04                     ` Du, Bin
2025-08-04  3:32                       ` Du, Bin
2025-08-04  4:25                         ` Sultan Alsawaf
2025-08-08  9:11                           ` Du, Bin
2025-08-11  5:49                             ` Sultan Alsawaf
2025-08-11  8:35                               ` Du, Bin
2025-08-11 21:48                                 ` Sultan Alsawaf
2025-08-11 22:17                                   ` Sultan Alsawaf
2025-08-12  2:02                                     ` Du, Bin
2025-08-14  6:53 ` Sultan Alsawaf
2025-08-22  2:23   ` Du, Bin
2025-08-22  3:56     ` Sultan Alsawaf
2025-08-27 10:30       ` Du, Bin
2025-08-28  5:50         ` Sultan Alsawaf
2025-09-02  2:08           ` Du, Bin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b94236b7-3a56-45f8-a085-9ca661b0f43c@amd.com \
    --to=bin.du@amd.com \
    --cc=Dominic.Antony@amd.com \
    --cc=Phil.Jawich@amd.com \
    --cc=Richard.Gong@amd.com \
    --cc=anson.tsao@amd.com \
    --cc=benjamin.chan@amd.com \
    --cc=bryan.odonoghue@linaro.org \
    --cc=gjorgji.rosikopulos@amd.com \
    --cc=hverkuil@xs4all.nl \
    --cc=king.li@amd.com \
    --cc=laurent.pinchart@ideasonboard.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mario.limonciello@amd.com \
    --cc=mchehab@kernel.org \
    --cc=prabhakar.mahadev-lad.rj@bp.renesas.com \
    --cc=pratap.nirujogi@amd.com \
    --cc=sakari.ailus@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®