Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:7 as permitted sender) client-ip=2620:137:e000::3:7;
Message-ID: <7372315b-cec9-b951-daa6-d63dc00b5fe1@amd.com>
Date:   Wed, 18 Oct 2023 10:24:54 +0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Thunderbird/102.15.1
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@vger.kernel.org,
        linux-wireless@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-doc@vger.kernel.org, platform-driver-x86@vger.kernel.org
Subject: Re: [PATCH v12 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: <20231017025358.1773598-1-Jun.Ma2@amd.com>
 <20231017025358.1773598-2-Jun.Ma2@amd.com>
 <f3c89e85-a683-eedf-9c3-ed54173bc12@linux.intel.com>
Content-Language: en-US
From:   "Ma, Jun" <majun@amd.com>
In-Reply-To: <f3c89e85-a683-eedf-9c3-ed54173bc12@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?dFJMb1VmTEMvS3FoR2xWZzdPMjZDcFZibmZ6cDd3OEhwYVg5Ny9RZTVMV01U?=
 =?utf-8?B?YnVxQXJaS1F2Tlp4emx4YXdHWitQZEdJSGFtMC80MmswRURsQjBOaklLUGlZ?=
 =?utf-8?B?QkFBUmhXNVpXMXBsRnlXU1Y4Zk15NTZPVnRxbWxLMVFaaHV4dmdTUkJONy8r?=
 =?utf-8?B?ZW16NjVsVXc3WXl4WU1VY0hZVVdCWWc0a01MMUZ4ckY1UHJManZTZ2xoNFpa?=
 =?utf-8?B?VEF3akxwUk93aUlPNTJ6TTVTbnVSM1BvTlhaWXFHeEphUzkzbEtuMXFubWI0?=
 =?utf-8?B?ODF3dmhOTmNUazNTMFlBclRHbFAvTWx5Wjh3TkRrKzZwcHJySzJHVCtRWS93?=
 =?utf-8?B?SVk3eW5Lb3dhMUo2UDcrN01UbGxDdmNvS1NMY0RKVXhXUmxhQmRqWGMxcjJv?=
 =?utf-8?B?SlNWRTZFSWgrVWNzQ3dhdGJTVmhacGpaaWc0cDlmOXJ0OEFCUS9pdUttRXl5?=
 =?utf-8?B?QkV2YVZPeXFRKzZDQVFDclFHREw0RjZ4UkJhMStMc1FLYVdpVGQ3MTRYNS9v?=
 =?utf-8?B?WXFpUlpKZ096R1JleGM5c3ExSDJmdzkzL3JQK2tuKzF3Q2dWOXBHbHROOHhy?=
 =?utf-8?B?YTBJTkQrTFBPMTZMQUY3cUdBWXByVnl1eXNaV2JUWFYxQmlnb1YrY2ZIdnZ6?=
 =?utf-8?B?QzRTbWRSdTIxK0pyYTZKVlUxeHMrdXVXTGZLZWM4RnNwaU1lZjFvUGIvQnlG?=
 =?utf-8?B?MWxLZjk1UzlBS01Zb3pFQ0R2cDludHdGa0s1Mlkra0gvOGlrS1NiTWV0U3Y0?=
 =?utf-8?B?elBqRDQ2azJmbFZPQ3FVZ3FZakI0Q0d2dFN0ZUtZWGYyLzBDUFU2VXg5MmZI?=
 =?utf-8?B?U3ZzYmkxN21KeTU4MS9HUG5vVTZmMFdJMGtMa1pJZFdEeGJXZjFxRGN5bVFK?=
 =?utf-8?B?NE1OcVRScHpQSkltNVkyYkQyTFRqdUk5UFVsVk1CcDc4OFloZUVSSHpka0N1?=
 =?utf-8?B?UUhWY0ZtK2RiMmVvYlIxVzl5SlQ3M3R2RkZzVkFDWnMzYXhta05maDhFbXZi?=
 =?utf-8?B?M292SEQ5S3l4aHNXWmJ0cURvbTFLNEUzMno3MFVUSjFQK1ptK1kwYVRCYnkr?=
 =?utf-8?B?cm9SQnc0UmJoTzgwTzdEZ3ZoRUQzNDBTZEpYcU8zQjMzUkpMemQyZ2VFekxw?=
 =?utf-8?B?cFE4Y3NUOVR4UTZpYWptUkpuL3VDUTZBWTB1MVJZSEJPVHJOUjcwaGVBYWly?=
 =?utf-8?B?K1M2aUMzSzdKWVpEVGkzbFNxbEdEeHk1MHpIRTFFRlViOXBpZ1pVR2F4TUVo?=
 =?utf-8?B?MDlXd2ZZTXlFbzJyVTNyRVFrNmU4aXdaTzMzTkhMYTFNOUJxU3BvMXlLQjlz?=
 =?utf-8?B?V0hwbllWZkt5OUQzc3hwK0dGb1hOOVpUNDYyNnlBRGNjM3JNc0hWc1ZqTjJJ?=
 =?utf-8?B?czJ5WnBsbTdzM3pUc2pVSUllZjNJWEg4eEVwZHR6UEZCcUppOGw4b3BqT0dk?=
 =?utf-8?B?aXFJb1hBWEhIS2FDeVUwYmZzSjh2UEpuZHVBVjlLQ3l4NS9yV29ncnZEa3Ix?=
 =?utf-8?B?QTlncXZ0aHpNZkdxdXJERGhkZzRFSWdUa3VJaWRtNGxJbDRzc25NeVU5d2I2?=
 =?utf-8?B?WHdaZGZWV0M1S3hjMGhVVzlvNlo5WXdSdTV2M2VEOTdJdVdwVnh6L2hKTGNP?=
 =?utf-8?B?eUxuMmtLNk1FLzZjWFNLblR0YjNFdHNpWlJ3bmJuekprYmxnZDB0WTN6d21F?=
 =?utf-8?B?NW1aeW0rdUN4NnVDYmVvY2VhNmdQaXpyZjh4TEhuejIwQm40YXNnNVpkYzUx?=
 =?utf-8?B?ZHJXZUJha3B3Zk5YS0FRL1ppZFJlYnd2KzY2Q3RrT3NwM0RsK1Z1eG4zbkdr?=
 =?utf-8?B?a09wS3FMV2p6dGdzSmUyaHgrbVN1akhWeVdWRnE3RHo5VjJLYkh4S0ZuV0FP?=
 =?utf-8?B?UHdTWGNVNElyOGZZYStxbnpZQitMcHpHSWtTZXp3ckxlQzN4OFRPL3VMNU5T?=
 =?utf-8?B?RFZ4MGVXWVVwakRzbTNJNjlNbVJmTnVPUFhXNTJoZjQ5S0JwOGlPUnN4bHcw?=
 =?utf-8?B?VGhGUWU0RUtqMGVHOHRUZEQ5eFdZYXN2RFBiZVlrdC9aZHlvSis5Q2Z2NVk1?=
 =?utf-8?B?U2NWTmZMTFNpMEFOVklCcDJ3LzBXczd0dFJBdnE3VTMralVucjZBUFJ4U1ZN?=
 =?utf-8?Q?sGoaHnJfp3/stsKLsXz/c1xiA?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4b21ba89-a14a-4a3d-f768-08dbcf8171c8
X-MS-Exchange-CrossTenant-AuthSource: DM4PR12MB6351.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Oct 2023 02:25:07.1140
 (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: pNuInD5Fkx7d3Hd96T7Sv4z2p7XVS7FcaXzhCcodfRLBggsSB5kaeh3s4F2IUt6p
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR12MB6871
X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        NICE_REPLY_A,RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,
        SPF_NONE autolearn=ham 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-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Tue, 17 Oct 2023 19:25:19 -0700 (PDT)

Hi llpo,

Thanks for these comments on format issues, I'll
fix it in the next version.

Regards,
Ma Jun

On 10/17/2023 5:20 PM, Ilpo Järvinen wrote:
> On Tue, 17 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 | 73 +++++++++++++++++++++++++++++++
>>  1 file changed, 73 insertions(+)
>>  create mode 100644 Documentation/driver-api/wbrf.rst
>>
>> diff --git a/Documentation/driver-api/wbrf.rst b/Documentation/driver-api/wbrf.rst
>> new file mode 100644
>> index 000000000000..8561840263b3
>> --- /dev/null
>> +++ b/Documentation/driver-api/wbrf.rst
>> @@ -0,0 +1,73 @@
>> +.. SPDX-License-Identifier: GPL-2.0-or-later
>> +
>> +=================================
>> +WBRF - Wifi Band RFI Mitigations
>> +=================================
>> +Due to electrical and mechanical constraints in certain platform designs
> 
> Add empty line before starting the content of a section.
> 
>> +there may be likely interference of relatively high-powered harmonics of
>> +the GPU memory clocks with local radio module frequency bands used by
>> +certain Wifi bands.
>> +
>> +To mitigate possible RFI interference producers can advertise the
>> +frequencies in use and consumers can use this information to avoid using
>> +these frequencies for sensitive features.
>> +
>> +When a platform is known to have this issue with any contained devices,
>> +the platform designer will advertise the availability of this feature via
>> +ACPI devices with a device specific method (_DSM).
>> +* Producers with this _DSM will be able to advertise the frequencies in use.
>> +* Consumers with this _DSM will be able to register for notifications of
>> +frequencies in use.
>> +
>> +Some general terms
>> +==================
>> +Producer: such component who can produce high-powered radio frequency
>> +Consumer: such component who can adjust its in-use frequency in
>> +           response to the radio frequencies of other components to
>> +           mitigate the possible RFI.
>> +
>> +To make the mechanism function, those producers should notify active use
>> +of their particular frequencies so that other consumers can make relative
>> +internal adjustments as necessary to avoid this resonance.
>> +
>> +ACPI interface
>> +==============
>> +Although initially used by for wifi + dGPU use cases, the ACPI interface
>> +can be scaled to any type of device that a platform designer discovers
>> +can cause interference.
>> +
>> +The GUID used for the _DSM is 7B7656CF-DC3D-4C1C-83E9-66E721DE3070.
>> +
>> +3 functions are available in this _DSM:
>> +
>> +* 0: discover # of functions available
>> +* 1: record RF bands in use
>> +* 2: retrieve RF bands in use
>> +
>> +Driver programming interface
>> +============================
>> +.. kernel-doc:: drivers/platform/x86/amd/wbrf.c
>> +
>> +Sample Usage
>> +=============
>> +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.
> 
> Align these so that only the numbers start from first column. I think the 
> proper markup for numbered lists is 1. not 1).
> 
>