[jic23-iio:testing 6/16] drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'

[jic23-iio:testing 6/16] drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git testing
head:   383e66c0de06c77c053a899a9cbc4a9f0c9a5f65
commit: 600b6de8062fe195d936971170fd9a57b6fcb57e [6/16] iio: core: Add iio_read_acpi_mount_matrix() helper function
config: riscv-defconfig (https://download.01.org/0day-ci/archive/20240429/202404290216.Uf6waaF1-lkp@intel.com/config)
compiler: clang version 19.0.0git (https://github.com/llvm/llvm-project 5ef5eb66fb428aaf61fb51b709f065c069c11242)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240429/202404290216.Uf6waaF1-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@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202404290216.Uf6waaF1-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'
>> drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'acpi_method' not described in 'iio_read_acpi_mount_matrix'
>> drivers/iio/industrialio-acpi.c:29: warning: Excess function parameter 'matrix' description in 'iio_read_acpi_mount_matrix'
>> drivers/iio/industrialio-acpi.c:29: warning: Excess function parameter 'method_name' description in 'iio_read_acpi_mount_matrix'


vim +29 drivers/iio/industrialio-acpi.c

     8	
     9	/**
    10	 * iio_read_acpi_mount_matrix() - Read accelerometer mount matrix info from ACPI
    11	 * @dev:		Device structure
    12	 * @matrix: 		iio_mount_matrix struct to fill
    13	 * @method_name:	ACPI method name to read the matrix from, usually "ROTM"
    14	 *
    15	 * Try to read the mount-matrix by calling the specified method on the device's
    16	 * ACPI firmware-node. If the device has no ACPI firmware-node; or the method
    17	 * does not exist then this will fail silently. This expects the method to
    18	 * return data in the ACPI "ROTM" format defined by Microsoft:
    19	 * https://learn.microsoft.com/en-us/windows-hardware/drivers/sensors/sensors-acpi-entries
    20	 * This is a Microsoft extension and not part of the official ACPI spec.
    21	 * The method name is configurable because some dual-accel setups define 2 mount
    22	 * matrices in a single ACPI device using separate "ROMK" and "ROMS" methods.
    23	 *
    24	 * Returns: true if the matrix was successfully, false otherwise.
    25	 */
    26	bool iio_read_acpi_mount_matrix(struct device *dev,
    27					struct iio_mount_matrix *orientation,
    28					char *acpi_method)
  > 29	{

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

Re: [jic23-iio:testing 6/16] drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'

[Jonathan Cameron]

On Mon, 29 Apr 2024 02:53:19 +0800
kernel test robot <lkp@intel.com> wrote:

> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git testing
> head:   383e66c0de06c77c053a899a9cbc4a9f0c9a5f65
> commit: 600b6de8062fe195d936971170fd9a57b6fcb57e [6/16] iio: core: Add iio_read_acpi_mount_matrix() helper function
> config: riscv-defconfig (https://download.01.org/0day-ci/archive/20240429/202404290216.Uf6waaF1-lkp@intel.com/config)
> compiler: clang version 19.0.0git (https://github.com/llvm/llvm-project 5ef5eb66fb428aaf61fb51b709f065c069c11242)
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240429/202404290216.Uf6waaF1-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@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202404290216.Uf6waaF1-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
> >> drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'
> >> drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'acpi_method' not described in 'iio_read_acpi_mount_matrix'
> >> drivers/iio/industrialio-acpi.c:29: warning: Excess function parameter 'matrix' description in 'iio_read_acpi_mount_matrix'
> >> drivers/iio/industrialio-acpi.c:29: warning: Excess function parameter 'method_name' description in 'iio_read_acpi_mount_matrix'  
> 
> 
> vim +29 drivers/iio/industrialio-acpi.c

I'll fix these up when I'm next on the right computer.

Thanks,

Jonathan


> 
>      8	
>      9	/**
>     10	 * iio_read_acpi_mount_matrix() - Read accelerometer mount matrix info from ACPI
>     11	 * @dev:		Device structure
>     12	 * @matrix: 		iio_mount_matrix struct to fill
>     13	 * @method_name:	ACPI method name to read the matrix from, usually "ROTM"
>     14	 *
>     15	 * Try to read the mount-matrix by calling the specified method on the device's
>     16	 * ACPI firmware-node. If the device has no ACPI firmware-node; or the method
>     17	 * does not exist then this will fail silently. This expects the method to
>     18	 * return data in the ACPI "ROTM" format defined by Microsoft:
>     19	 * https://learn.microsoft.com/en-us/windows-hardware/drivers/sensors/sensors-acpi-entries
>     20	 * This is a Microsoft extension and not part of the official ACPI spec.
>     21	 * The method name is configurable because some dual-accel setups define 2 mount
>     22	 * matrices in a single ACPI device using separate "ROMK" and "ROMS" methods.
>     23	 *
>     24	 * Returns: true if the matrix was successfully, false otherwise.
>     25	 */
>     26	bool iio_read_acpi_mount_matrix(struct device *dev,
>     27					struct iio_mount_matrix *orientation,
>     28					char *acpi_method)
>   > 29	{  
> 

Re: [jic23-iio:testing 6/16] drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'

[Hans de Goede]

Hi,

On 4/29/24 10:40 AM, Jonathan Cameron wrote:
> On Mon, 29 Apr 2024 02:53:19 +0800
> kernel test robot <lkp@intel.com> wrote:
> 
>> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git testing
>> head:   383e66c0de06c77c053a899a9cbc4a9f0c9a5f65
>> commit: 600b6de8062fe195d936971170fd9a57b6fcb57e [6/16] iio: core: Add iio_read_acpi_mount_matrix() helper function
>> config: riscv-defconfig (https://download.01.org/0day-ci/archive/20240429/202404290216.Uf6waaF1-lkp@intel.com/config)
>> compiler: clang version 19.0.0git (https://github.com/llvm/llvm-project 5ef5eb66fb428aaf61fb51b709f065c069c11242)
>> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240429/202404290216.Uf6waaF1-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@intel.com>
>> | Closes: https://lore.kernel.org/oe-kbuild-all/202404290216.Uf6waaF1-lkp@intel.com/
>>
>> All warnings (new ones prefixed by >>):
>>
>>>> drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'orientation' not described in 'iio_read_acpi_mount_matrix'
>>>> drivers/iio/industrialio-acpi.c:29: warning: Function parameter or struct member 'acpi_method' not described in 'iio_read_acpi_mount_matrix'
>>>> drivers/iio/industrialio-acpi.c:29: warning: Excess function parameter 'matrix' description in 'iio_read_acpi_mount_matrix'
>>>> drivers/iio/industrialio-acpi.c:29: warning: Excess function parameter 'method_name' description in 'iio_read_acpi_mount_matrix'  
>>
>>
>> vim +29 drivers/iio/industrialio-acpi.c
> 
> I'll fix these up when I'm next on the right computer.

Thanks. I did test-build the docs, but I did not notice this my bad.

Regards,

Hans



>>      8	
>>      9	/**
>>     10	 * iio_read_acpi_mount_matrix() - Read accelerometer mount matrix info from ACPI
>>     11	 * @dev:		Device structure
>>     12	 * @matrix: 		iio_mount_matrix struct to fill
>>     13	 * @method_name:	ACPI method name to read the matrix from, usually "ROTM"
>>     14	 *
>>     15	 * Try to read the mount-matrix by calling the specified method on the device's
>>     16	 * ACPI firmware-node. If the device has no ACPI firmware-node; or the method
>>     17	 * does not exist then this will fail silently. This expects the method to
>>     18	 * return data in the ACPI "ROTM" format defined by Microsoft:
>>     19	 * https://learn.microsoft.com/en-us/windows-hardware/drivers/sensors/sensors-acpi-entries
>>     20	 * This is a Microsoft extension and not part of the official ACPI spec.
>>     21	 * The method name is configurable because some dual-accel setups define 2 mount
>>     22	 * matrices in a single ACPI device using separate "ROMK" and "ROMS" methods.
>>     23	 *
>>     24	 * Returns: true if the matrix was successfully, false otherwise.
>>     25	 */
>>     26	bool iio_read_acpi_mount_matrix(struct device *dev,
>>     27					struct iio_mount_matrix *orientation,
>>     28					char *acpi_method)
>>   > 29	{  
>>
>