Received-SPF: pass (google.com: domain of linux-wireless-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Message-ID: <9608a9aa-26d2-4d27-b9b7-31f643307d2d@amd.com>
Date:   Wed, 22 Nov 2023 16:36:47 +0800
User-Agent: Mozilla Thunderbird
Cc:     majun@amd.com, amd-gfx@lists.freedesktop.org, lenb@kernel.org,
        johannes@sipsolutions.net, davem@davemloft.net,
        edumazet@google.com, kuba@kernel.org, pabeni@redhat.com,
        alexander.deucher@amd.com, Lijo.Lazar@amd.com,
        mario.limonciello@amd.com, Netdev <netdev@vger.kernel.org>,
        linux-wireless@vger.kernel.org,
        LKML <linux-kernel@vger.kernel.org>, linux-doc@vger.kernel.org,
        platform-driver-x86@vger.kernel.org
Subject: Re: [Patch v13 1/9] Documentation/driver-api: Add document about WBRF
 mechanism
To:     =?UTF-8?Q?Ilpo_J=C3=A4rvinen?= <ilpo.jarvinen@linux.intel.com>,
        Ma Jun <Jun.Ma2@amd.com>
References: <20231030071832.2217118-1-Jun.Ma2@amd.com>
 <20231030071832.2217118-2-Jun.Ma2@amd.com>
 <3e18c716-4c1b-ea3-ede3-5a67555f5e72@linux.intel.com>
Content-Language: en-US
From:   "Ma, Jun" <majun@amd.com>
In-Reply-To: <3e18c716-4c1b-ea3-ede3-5a67555f5e72@linux.intel.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?c3loc2JSeDFuVEI3VlhwT0hLSnIzTmswRWhOcEx3SndJdk1EckVIaWlERUNv?=
 =?utf-8?B?RWtWU0tyVGQ4Zmo2Zm1mcTZzcUpLZE1rcCt3bnRFSlF5ajEvL252clUxdFR6?=
 =?utf-8?B?RjN5TTc3R0tQaUVuVzlnZDg3VndGRUlpS1FvZkVVd05SMG1IUmlCL0JnZjNZ?=
 =?utf-8?B?WkFPUnpxSnIxamVMUUg4WjY1Ym5XL2Q1WXlwc0JaaEFjMGJUWDZMek1tc01r?=
 =?utf-8?B?SHRxYjR0TjNBdjFkOEVLTjMvak84eldMT2ZKd3BRejM5eGhOa1Z6L2lGTUJR?=
 =?utf-8?B?YjFVaVlYa1NaUmMyWi9LdUR2QnkvWTd6ZVZyL1NQTURQS1NYTklHVjN1bm1U?=
 =?utf-8?B?enVwR3IvS1JHTUo4ZS9KUWdEU2phd08zTkNYaGZjV014NHVXRzFhK2tQek8x?=
 =?utf-8?B?eTdaMmFDdUh6OVRYeUc0VnYvMXBhSnpLNUNLLzlkdFBvdTJWVGVNVzRLY2hP?=
 =?utf-8?B?cFhDUXYySUxOeS9YSHF1aDZxcjFZTEZkY0cvTy9lM3BOVW1kTGtvZ3VxVnFD?=
 =?utf-8?B?ZWdQcTFkWXVhaDdQRzlmRDVRdFBYNU5CTm80MUlPYkltTW1RMU1yeVlGOXE0?=
 =?utf-8?B?RXBVRVNCQlRxWThYbEFaSW4zTmY3bVgzeTJCdXBDZFpOcTE1ejdFeXdablY5?=
 =?utf-8?B?dHlCdjRxSkFjRjdncXYrRXdiQ1hORjd2bGtsR3ZsUys3dnB3TDR4aDhFa1ly?=
 =?utf-8?B?RzVLQ2pwZEhSR1BjNmw5Qm4veW9vZllLR1JEMnJBL2Nmb2E1aW8yNU9mSkVm?=
 =?utf-8?B?SVZWZ2ZtVXlaMCtvUENXSHQwV2VNT0szOHpWZjlCWjE4alA5bkVGbmpSN0hY?=
 =?utf-8?B?Yk9OR0FCUCsrQTIyRmhqQk9OdHh2SzZCNFRHbGxUWVh2NzB1OTVwZG03S2ZE?=
 =?utf-8?B?RHB1cEJVOWh1SkVqRXNabXA2ODZiRk1OSlQrczhsb3V1S0hvY1c3UEJoVTZ1?=
 =?utf-8?B?UkpCenV5TUFZejJJcVVRc2lpUGxwTDdtOHp6OUx2SDlmdWk1cWZVeXRCeTd4?=
 =?utf-8?B?K2RLYlo3TkFhdHRmcmRWTmNTNTBNUHRKZFc1TCtqWUxpTyt2Z25YS0g2VUgz?=
 =?utf-8?B?ZE9qa0NhQSsvNGlQRjJ2NFhWOUFpd0FCTWVnNm01WXlGMnNNVzhlVDN6d0Np?=
 =?utf-8?B?YWxFVS82cTFkNzEwWXZxQ0hmZExlYjJrOERJandSZE1rK0p0NVdzcVVOQ0pu?=
 =?utf-8?B?VkdYQWhjazRmbnVySE9PcUttYVRzS3BMQTNLRHFTWG1OdlVYTHIzUXhPRzJo?=
 =?utf-8?B?OER3c2o2QjZYQjVSa2dQUWVQT3RvdkwvYyszZW4yV3laTTVrTVJWN2tNQ1B5?=
 =?utf-8?B?WTZNZVNic2IxWW5qaHRJMEtYMGNqUlZ3ZXZIYkFJWmhITVhXSGlKczJVYzJE?=
 =?utf-8?B?Q0ppazY3OXlsUUJtTGhKbURldlZaL0diR3cvcmVLdWN6cFpFZ3V4dGJRSFNv?=
 =?utf-8?B?L1dOcXh4WERLTTJkUHdROEYwNXdVdnh3RHJJL2h3aGdQUFpXNFlCSkV1NGpG?=
 =?utf-8?B?NlNTNE5PY0RlUWI4elMxWkRyejdUSUI3RFZsQ3RnS2RJSU5lSDBrWWRxV3cv?=
 =?utf-8?B?bXBqZThuaUxWZ3lBWWxPak5iZ2QxQlF3THpTeURGMWZQbHRUQlYwV3hyOEFv?=
 =?utf-8?B?NU1ydGo2Y1pIaEVIOWNJV0RvcVFqbTE2TlJobWNvdkZuWDkraUZZWDFzUEtu?=
 =?utf-8?B?V2EwM1h2ZXg4K0s2MmtheW1qNE04UFQ0ckpLVXhzQUpCOVEzZjlvZ1hrc00x?=
 =?utf-8?B?RmFSYkw4dG16T1ZjTFNIUjhCci8zU1FuTHV1RElTSm5XSUhvaDRBYm1VWG5k?=
 =?utf-8?B?UldaK3I0aWpvRy93WDgxUEJPL1RnbUNNQ3hyYWxXN25GamhacjU2T1VXL2Ri?=
 =?utf-8?B?QUMvK1EvaG9tZW5nQmEwRkZDTGhySXgrSnFiWkxsODFMOW40cVd3bDY4QzV0?=
 =?utf-8?B?aFJ0a1V1WjhHV2xGZHJHSDNxZ0YwNEVaNVB4MlA4dlNHMDY3T3N1NjJJMWY4?=
 =?utf-8?B?bmVjbUQ3bWVBSm9tMTdvR2M5T09qYndLY0pjajNXSW5RamdiSUpiYVFMRkxh?=
 =?utf-8?B?WllzZDNsS0E2TzUxU1NSWlc1OUVKanA5Z2gwYXVnbEE2TzM2WnIyUTNiSEox?=
 =?utf-8?Q?dA3E3d2TnkTDQHlAmFQeMrljn?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: f67f7244-989b-48a4-95b3-08dbeb363390
X-MS-Exchange-CrossTenant-AuthSource: DM4PR12MB6351.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Nov 2023 08:37:03.2815
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: agl4SkjmmP/r/Hela79FNAXVgg8PKMqBFbv0SAoKVStV+/02cZSmItJSnePaYPqt
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR12MB4957
X-Spam-Status: No, score=-1.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-wireless.vger.kernel.org>
X-Mailing-List: linux-wireless@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Wed, 22 Nov 2023 00:37:14 -0800 (PST)

Hi llpo,

Thanks for review, I'll fix the format issue in
the next version.

Regards,
Ma Jun

On 11/20/2023 7:59 PM, Ilpo Järvinen wrote:
> On Mon, 30 Oct 2023, Ma Jun wrote:
> 
>> Add documentation about AMD's Wifi band RFI mitigation (WBRF) mechanism
>> explaining the theory and how it is used.
>>
>> Signed-off-by: Ma Jun <Jun.Ma2@amd.com>
>> ---
>>  Documentation/driver-api/wbrf.rst | 76 +++++++++++++++++++++++++++++++
>>  1 file changed, 76 insertions(+)
>>  create mode 100644 Documentation/driver-api/wbrf.rst
>>
>> +Driver programming interface
>> +============================
>> +.. kernel-doc:: drivers/platform/x86/amd/wbrf.c
>> +
>> +Sample Usage
>> +=============
> 
> A lot better but you missed adding newlines here for this and previous 
> section title.
> 
>> +The expected flow for the producers:
>> +1). During probe, call `acpi_amd_wbrf_supported_producer` to check if WBRF
>> +    can be enabled for the device.
>> +2). On using some frequency band, call `acpi_amd_wbrf_add_remove` with 'add'
>> +    param to get other consumers properly notified.
>> +3). Or on stopping using some frequency band, call
>> +    `acpi_amd_wbrf_add_remove` with 'remove' param to get other consumers notified.
>> +
>> +The expected flow for the consumers:
>> +1). During probe, call `acpi_amd_wbrf_supported_consumer` to check if WBRF
>> +    can be enabled for the device.
>> +2). Call `amd_wbrf_register_notifier` to register for notification
>> +    of frequency band change(add or remove) from other producers.
>> +3). Call the `amd_wbrf_retrieve_freq_band` intentionally to retrieve
>> +    current active frequency bands considering some producers may broadcast
>> +    such information before the consumer is up.
>> +4). On receiving a notification for frequency band change, run
>> +    `amd_wbrf_retrieve_freq_band` again to retrieve the latest
>> +    active frequency bands.
>> +5). During driver cleanup, call `amd_wbrf_unregister_notifier` to
>> +    unregister the notifier.
> 
> The correct kerneldoc format should be without the closing parenthesis:
> 
> 1. Text here that
>    spills to second line.
> 2. Second entry.
>