[01/12] platform/x86: ISST: Fix kernel documentation warnings

Message ID 20230211063257.311746-2-srinivas.pandruvada@linux.intel.com
State New
Headers
Series platform/x86: ISST: Use TPMI interface |

Commit Message

srinivas pandruvada Feb. 11, 2023, 6:32 a.m. UTC
  Fix warning displayed for "make W=1" for kernel documentation.

Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
---
 drivers/platform/x86/intel/speed_select_if/isst_if_common.c | 3 ++-
 drivers/platform/x86/intel/speed_select_if/isst_if_common.h | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)
  

Comments

Hans de Goede March 1, 2023, 2:23 p.m. UTC | #1
Hi,

On 2/11/23 07:32, Srinivas Pandruvada wrote:
> Fix warning displayed for "make W=1" for kernel documentation.
> 
> Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>

Thanks, I've applied this patch to my review-hans branch:
https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans

I'll rebase that branch once 6.3-rc1 is out and then push the rebased
patch to the fixes branch and include it in my next 6.3 fixes pull-req
to Linus.

Regards,

Hans





> ---
>  drivers/platform/x86/intel/speed_select_if/isst_if_common.c | 3 ++-
>  drivers/platform/x86/intel/speed_select_if/isst_if_common.h | 1 +
>  2 files changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> index a7e02b24a87a..63d49fe17a16 100644
> --- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> +++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> @@ -112,6 +112,7 @@ static void isst_delete_hash(void)
>   * isst_store_cmd() - Store command to a hash table
>   * @cmd: Mailbox command.
>   * @sub_cmd: Mailbox sub-command or MSR id.
> + * @cpu: Target CPU for the command
>   * @mbox_cmd_type: Mailbox or MSR command.
>   * @param: Mailbox parameter.
>   * @data: Mailbox request data or MSR data.
> @@ -363,7 +364,7 @@ static struct pci_dev *_isst_if_get_pci_dev(int cpu, int bus_no, int dev, int fn
>  /**
>   * isst_if_get_pci_dev() - Get the PCI device instance for a CPU
>   * @cpu: Logical CPU number.
> - * @bus_number: The bus number assigned by the hardware.
> + * @bus_no: The bus number assigned by the hardware.
>   * @dev: The device number assigned by the hardware.
>   * @fn: The function number assigned by the hardware.
>   *
> diff --git a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> index fdecdae248d7..35ff506b402e 100644
> --- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> +++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> @@ -40,6 +40,7 @@
>   * @offset:	Offset to the first valid member in command structure.
>   *		This will be the offset of the start of the command
>   *		after command count field
> + * @owner:	Registered module owner
>   * @cmd_callback: Callback function to handle IOCTL. The callback has the
>   *		command pointer with data for command. There is a pointer
>   *		called write_only, which when set, will not copy the
  
srinivas pandruvada March 1, 2023, 2:48 p.m. UTC | #2
Hi Hans,

Since some patches you are adding to your review branch,
shall I exclude those from new series by rebasing on 
your review-hans branch?
?

Thanks,
Srinivas

On Wed, 2023-03-01 at 15:23 +0100, Hans de Goede wrote:
> Hi,
> 
> On 2/11/23 07:32, Srinivas Pandruvada wrote:
> > Fix warning displayed for "make W=1" for kernel documentation.
> > 
> > Signed-off-by: Srinivas Pandruvada
> > <srinivas.pandruvada@linux.intel.com>
> 
> Thanks, I've applied this patch to my review-hans branch:
> https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans
> 
> I'll rebase that branch once 6.3-rc1 is out and then push the rebased
> patch to the fixes branch and include it in my next 6.3 fixes pull-
> req
> to Linus.
> 
> Regards,
> 
> Hans
> 
> 
> 
> 
> 
> > ---
> >  drivers/platform/x86/intel/speed_select_if/isst_if_common.c | 3
> > ++-
> >  drivers/platform/x86/intel/speed_select_if/isst_if_common.h | 1 +
> >  2 files changed, 3 insertions(+), 1 deletion(-)
> > 
> > diff --git
> > a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> > b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> > index a7e02b24a87a..63d49fe17a16 100644
> > --- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> > +++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
> > @@ -112,6 +112,7 @@ static void isst_delete_hash(void)
> >   * isst_store_cmd() - Store command to a hash table
> >   * @cmd: Mailbox command.
> >   * @sub_cmd: Mailbox sub-command or MSR id.
> > + * @cpu: Target CPU for the command
> >   * @mbox_cmd_type: Mailbox or MSR command.
> >   * @param: Mailbox parameter.
> >   * @data: Mailbox request data or MSR data.
> > @@ -363,7 +364,7 @@ static struct pci_dev *_isst_if_get_pci_dev(int
> > cpu, int bus_no, int dev, int fn
> >  /**
> >   * isst_if_get_pci_dev() - Get the PCI device instance for a CPU
> >   * @cpu: Logical CPU number.
> > - * @bus_number: The bus number assigned by the hardware.
> > + * @bus_no: The bus number assigned by the hardware.
> >   * @dev: The device number assigned by the hardware.
> >   * @fn: The function number assigned by the hardware.
> >   *
> > diff --git
> > a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> > b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> > index fdecdae248d7..35ff506b402e 100644
> > --- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> > +++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
> > @@ -40,6 +40,7 @@
> >   * @offset:    Offset to the first valid member in command
> > structure.
> >   *             This will be the offset of the start of the command
> >   *             after command count field
> > + * @owner:     Registered module owner
> >   * @cmd_callback: Callback function to handle IOCTL. The callback
> > has the
> >   *             command pointer with data for command. There is a
> > pointer
> >   *             called write_only, which when set, will not copy
> > the
>
  
Hans de Goede March 1, 2023, 2:48 p.m. UTC | #3
Hi,

On 3/1/23 15:48, srinivas pandruvada wrote:
> Hi Hans,
> 
> Since some patches you are adding to your review branch,
> shall I exclude those from new series by rebasing on 
> your review-hans branch?
> ?

Yes please rebase on my review-hans branch.

Regards,

Hans



> On Wed, 2023-03-01 at 15:23 +0100, Hans de Goede wrote:
>> Hi,
>>
>> On 2/11/23 07:32, Srinivas Pandruvada wrote:
>>> Fix warning displayed for "make W=1" for kernel documentation.
>>>
>>> Signed-off-by: Srinivas Pandruvada
>>> <srinivas.pandruvada@linux.intel.com>
>>
>> Thanks, I've applied this patch to my review-hans branch:
>> https://git.kernel.org/pub/scm/linux/kernel/git/pdx86/platform-drivers-x86.git/log/?h=review-hans
>>
>> I'll rebase that branch once 6.3-rc1 is out and then push the rebased
>> patch to the fixes branch and include it in my next 6.3 fixes pull-
>> req
>> to Linus.
>>
>> Regards,
>>
>> Hans
>>
>>
>>
>>
>>
>>> ---
>>>  drivers/platform/x86/intel/speed_select_if/isst_if_common.c | 3
>>> ++-
>>>  drivers/platform/x86/intel/speed_select_if/isst_if_common.h | 1 +
>>>  2 files changed, 3 insertions(+), 1 deletion(-)
>>>
>>> diff --git
>>> a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
>>> b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
>>> index a7e02b24a87a..63d49fe17a16 100644
>>> --- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
>>> +++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
>>> @@ -112,6 +112,7 @@ static void isst_delete_hash(void)
>>>   * isst_store_cmd() - Store command to a hash table
>>>   * @cmd: Mailbox command.
>>>   * @sub_cmd: Mailbox sub-command or MSR id.
>>> + * @cpu: Target CPU for the command
>>>   * @mbox_cmd_type: Mailbox or MSR command.
>>>   * @param: Mailbox parameter.
>>>   * @data: Mailbox request data or MSR data.
>>> @@ -363,7 +364,7 @@ static struct pci_dev *_isst_if_get_pci_dev(int
>>> cpu, int bus_no, int dev, int fn
>>>  /**
>>>   * isst_if_get_pci_dev() - Get the PCI device instance for a CPU
>>>   * @cpu: Logical CPU number.
>>> - * @bus_number: The bus number assigned by the hardware.
>>> + * @bus_no: The bus number assigned by the hardware.
>>>   * @dev: The device number assigned by the hardware.
>>>   * @fn: The function number assigned by the hardware.
>>>   *
>>> diff --git
>>> a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
>>> b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
>>> index fdecdae248d7..35ff506b402e 100644
>>> --- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
>>> +++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
>>> @@ -40,6 +40,7 @@
>>>   * @offset:    Offset to the first valid member in command
>>> structure.
>>>   *             This will be the offset of the start of the command
>>>   *             after command count field
>>> + * @owner:     Registered module owner
>>>   * @cmd_callback: Callback function to handle IOCTL. The callback
>>> has the
>>>   *             command pointer with data for command. There is a
>>> pointer
>>>   *             called write_only, which when set, will not copy
>>> the
>>
>
  

Patch

diff --git a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
index a7e02b24a87a..63d49fe17a16 100644
--- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
+++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.c
@@ -112,6 +112,7 @@  static void isst_delete_hash(void)
  * isst_store_cmd() - Store command to a hash table
  * @cmd: Mailbox command.
  * @sub_cmd: Mailbox sub-command or MSR id.
+ * @cpu: Target CPU for the command
  * @mbox_cmd_type: Mailbox or MSR command.
  * @param: Mailbox parameter.
  * @data: Mailbox request data or MSR data.
@@ -363,7 +364,7 @@  static struct pci_dev *_isst_if_get_pci_dev(int cpu, int bus_no, int dev, int fn
 /**
  * isst_if_get_pci_dev() - Get the PCI device instance for a CPU
  * @cpu: Logical CPU number.
- * @bus_number: The bus number assigned by the hardware.
+ * @bus_no: The bus number assigned by the hardware.
  * @dev: The device number assigned by the hardware.
  * @fn: The function number assigned by the hardware.
  *
diff --git a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
index fdecdae248d7..35ff506b402e 100644
--- a/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
+++ b/drivers/platform/x86/intel/speed_select_if/isst_if_common.h
@@ -40,6 +40,7 @@ 
  * @offset:	Offset to the first valid member in command structure.
  *		This will be the offset of the start of the command
  *		after command count field
+ * @owner:	Registered module owner
  * @cmd_callback: Callback function to handle IOCTL. The callback has the
  *		command pointer with data for command. There is a pointer
  *		called write_only, which when set, will not copy the