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@xxxxxxx> >> --- >> 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. >
