linux-kernel - Re: [PATCH v15 1/9] Documentation/driver-api: Add document about WBRF mechanism

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <202312071941.JXQXsK1C-lkp@intel.com>
Date:   Thu, 7 Dec 2023 20:01:34 +0800
From:   kernel test robot <lkp@...el.com>
To:     Ma Jun <Jun.Ma2@....com>, amd-gfx@...ts.freedesktop.org,
        lenb@...nel.org, hdegoede@...hat.com, johannes@...solutions.net,
        davem@...emloft.net, edumazet@...gle.com, kuba@...nel.org,
        pabeni@...hat.com, alexander.deucher@....com, Lijo.Lazar@....com,
        mario.limonciello@....com, netdev@...r.kernel.org,
        linux-wireless@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org, platform-driver-x86@...r.kernel.org
Cc:     oe-kbuild-all@...ts.linux.dev, majun@....com,
        Ma Jun <Jun.Ma2@....com>
Subject: Re: [PATCH v15 1/9] Documentation/driver-api: Add document about
 WBRF mechanism

Hi Ma,

kernel test robot noticed the following build warnings:

[auto build test WARNING on linus/master]
[also build test WARNING on v6.7-rc4 next-20231207]
[cannot apply to drm-misc/drm-misc-next wireless-next/main wireless/main]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Ma-Jun/Documentation-driver-api-Add-document-about-WBRF-mechanism/20231206-153327
base:   linus/master
patch link:    https://lore.kernel.org/r/20231206072947.1331729-2-Jun.Ma2%40amd.com
patch subject: [PATCH v15 1/9] Documentation/driver-api: Add document about WBRF mechanism
reproduce: (https://download.01.org/0day-ci/archive/20231207/202312071941.JXQXsK1C-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@...el.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202312071941.JXQXsK1C-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> Documentation/driver-api/wbrf.rst:28: WARNING: Unexpected indentation.
>> Documentation/driver-api/wbrf.rst:61: WARNING: Block quote ends without a blank line; unexpected unindent.
>> Documentation/driver-api/wbrf.rst: WARNING: document isn't included in any toctree

vim +28 Documentation/driver-api/wbrf.rst

    25	
    26	Producer: such component who can produce high-powered radio frequency
    27	Consumer: such component who can adjust its in-use frequency in
  > 28	           response to the radio frequencies of other components to
    29	           mitigate the possible RFI.
    30	
    31	To make the mechanism function, those producers should notify active use
    32	of their particular frequencies so that other consumers can make relative
    33	internal adjustments as necessary to avoid this resonance.
    34	
    35	ACPI interface
    36	==============
    37	
    38	Although initially used by for wifi + dGPU use cases, the ACPI interface
    39	can be scaled to any type of device that a platform designer discovers
    40	can cause interference.
    41	
    42	The GUID used for the _DSM is 7B7656CF-DC3D-4C1C-83E9-66E721DE3070.
    43	
    44	3 functions are available in this _DSM:
    45	
    46	* 0: discover # of functions available
    47	* 1: record RF bands in use
    48	* 2: retrieve RF bands in use
    49	
    50	Driver programming interface
    51	============================
    52	
    53	.. kernel-doc:: drivers/platform/x86/amd/wbrf.c
    54	
    55	Sample Usage
    56	=============
    57	
    58	The expected flow for the producers:
    59	1. During probe, call `acpi_amd_wbrf_supported_producer` to check if WBRF
    60	   can be enabled for the device.
  > 61	2. On using some frequency band, call `acpi_amd_wbrf_add_remove` with 'add'
    62	   param to get other consumers properly notified.
    63	3. Or on stopping using some frequency band, call
    64	   `acpi_amd_wbrf_add_remove` with 'remove' param to get other consumers notified.
    65	

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki