1. 01 Jul, 2020 40 commits
    • Lee Jones's avatar
      misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups · 9afe1839
      Lee Jones authored
      Includes; missing descriptions for function args, the promotion
      of obvious kerneldoc headers and the mis-formatting of existing
      argument descriptions.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/mic/scif/scif_nm.c:19: warning: Function parameter or member 'node' not described in 'scif_invalidate_ep'
       drivers/misc/mic/scif/scif_nm.c:173: warning: Function parameter or member 'node_id' not described in 'scif_disconnect_node'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-23-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      9afe1839
    • Lee Jones's avatar
      misc: mic: scif: scif_nodeqp: Fix a bunch of kerneldoc issues · 5ab3f590
      Lee Jones authored
      Includes; missing function argument documentation, misnamed argument
      tags, the promotion of obvious kerneldoc header candidates and an
      ordering issue (functions must follow the kerneldoc which describes
      them).
      
      Fixes the following W=1 kernel build issues:
      
       drivers/misc/mic/scif/scif_nodeqp.c:452: warning: Function parameter or member 'scifdev' not described in 'scif_node_connect'
       drivers/misc/mic/scif/scif_nodeqp.c:730: warning: Function parameter or member 'unused' not described in 'scif_exit'
       drivers/misc/mic/scif/scif_nodeqp.c:730: warning: Excess function parameter 'msg' description in 'scif_exit'
       drivers/misc/mic/scif/scif_nodeqp.c:748: warning: Function parameter or member 'unused' not described in 'scif_exit_ack'
       drivers/misc/mic/scif/scif_nodeqp.c:748: warning: Excess function parameter 'msg' description in 'scif_exit_ack'
       drivers/misc/mic/scif/scif_nodeqp.c:939: warning: Function parameter or member 'scifdev' not described in 'scif_node_add_nack'
       drivers/misc/mic/scif/scif_nodeqp.c:988: warning: Function parameter or member 'scifdev' not described in 'scif_get_node_info_resp'
       drivers/misc/mic/scif/scif_nodeqp.c:1070: warning: cannot understand function prototype: 'int scif_max_msg_id = SCIF_MAX_MSG; '
       drivers/misc/mic/scif/scif_nodeqp.c:1129: warning: Function parameter or member 'unused' not described in 'scif_loopb_wq_handler'
       drivers/misc/mic/scif/scif_nodeqp.c:1129: warning: Excess function parameter 'work' description in 'scif_loopb_wq_handler'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-22-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      5ab3f590
    • Lee Jones's avatar
      misc: mic: scif: scif_epd: Describe missing 'scifdev' argument(s) · 3e30b9e3
      Lee Jones authored
      For some reason (copy 'n' paste error?) the passed in pointers to
      'struct scif_dev scifdev' weren't described throughout the source
      file.  Change that.
      
      Fixes the following W=1 kernel build warning(s):
      
       drivers/misc/mic/scif/scif_epd.c:120: warning: Function parameter or member 'scifdev' not described in 'scif_cnctreq'
       drivers/misc/mic/scif/scif_epd.c:166: warning: Function parameter or member 'scifdev' not described in 'scif_cnctgnt'
       drivers/misc/mic/scif/scif_epd.c:191: warning: Function parameter or member 'scifdev' not described in 'scif_cnctgnt_ack'
       drivers/misc/mic/scif/scif_epd.c:213: warning: Function parameter or member 'scifdev' not described in 'scif_cnctgnt_nack'
       drivers/misc/mic/scif/scif_epd.c:230: warning: Function parameter or member 'scifdev' not described in 'scif_cnctrej'
       drivers/misc/mic/scif/scif_epd.c:255: warning: Function parameter or member 'scifdev' not described in 'scif_discnct'
       drivers/misc/mic/scif/scif_epd.c:309: warning: Function parameter or member 'scifdev' not described in 'scif_discnt_ack'
       drivers/misc/mic/scif/scif_epd.c:325: warning: Function parameter or member 'scifdev' not described in 'scif_clientsend'
       drivers/misc/mic/scif/scif_epd.c:341: warning: Function parameter or member 'scifdev' not described in 'scif_clientrcvd'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-21-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      3e30b9e3
    • Lee Jones's avatar
      misc: mic: scif: scif_api: Demote scif_accept() function header · 5d137a36
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the header back down to a simple comment.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/mic/scif/scif_api.c:739: warning: Function parameter or member 'epd' not described in 'scif_accept'
       drivers/misc/mic/scif/scif_api.c:739: warning: Function parameter or member 'peer' not described in 'scif_accept'
       drivers/misc/mic/scif/scif_api.c:739: warning: Function parameter or member 'newepd' not described in 'scif_accept'
       drivers/misc/mic/scif/scif_api.c:739: warning: Function parameter or member 'flags' not described in 'scif_accept'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-20-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      5d137a36
    • Lee Jones's avatar
      misc: mic: scif: scif_api: Remove set but unused variable 'read_size' · cf2a06c1
      Lee Jones authored
      'read_size' appears to have been assigned, but never used since the
      SCIF messaging and node enumeration APIs were introduced in 2015.
      Makes sense to simply remove it.
      
      Fixes the following W=1 warning:
      
       drivers/misc/mic/scif/scif_api.c: In function ‘_scif_recv’:
       drivers/misc/mic/scif/scif_api.c:1000:6: warning: variable ‘read_size’ set but not used [-Wunused-but-set-variable]
       1000 | int read_size;
       | ^~~~~~~~~
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-19-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      cf2a06c1
    • Lee Jones's avatar
      misc: mic: cosm: cosm_debugfs: Demote function headers from kerneldoc · a761b8b0
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the header back down to a simple comment.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/mic/cosm/cosm_debugfs.c:25: warning: Function parameter or member 's' not described in 'log_buf_show'
       drivers/misc/mic/cosm/cosm_debugfs.c:25: warning: Function parameter or member 'unused' not described in 'log_buf_show'
       drivers/misc/mic/cosm/cosm_debugfs.c:78: warning: Function parameter or member 's' not described in 'force_reset_show'
       drivers/misc/mic/cosm/cosm_debugfs.c:78: warning: Function parameter or member 'pos' not described in 'force_reset_show'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-18-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      a761b8b0
    • Lee Jones's avatar
      misc: mic: scif: scif_ports: Fix copy 'n' paste error · 887d670e
      Lee Jones authored
      __scif_get_port() has never taken 'port' as an argument since
      its inception back in 2015.  Probably document the proper arguments
      expected 'start' and 'end'.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/mic/scif/scif_ports.c:36: warning: Function parameter or member 'start' not described in '__scif_get_port
       drivers/misc/mic/scif/scif_ports.c:36: warning: Function parameter or member 'end' not described in '__scif_get_port'
       drivers/misc/mic/scif/scif_ports.c:36: warning: Excess function parameter 'port' description in '__scif_get_port'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-17-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      887d670e
    • Lee Jones's avatar
      misc: mic: cosm: cosm_main: Document 'force' function argument · 0cfbe64c
      Lee Jones authored
      Fixes the following W=1 kernel build warning:
      
       drivers/misc/mic/cosm/cosm_main.c:31: warning: Function parameter or member 'force' not described in 'cosm_hw_reset'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-16-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      0cfbe64c
    • Lee Jones's avatar
      misc: mic: host: mic_debugfs: Demote function headers from kerneldoc · 438ad368
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the headers back down to simple comments.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/mic/host/mic_debugfs.c:108: warning: Function parameter or member 'mdev' not described in 'mic_create_debug_dir'
       drivers/misc/mic/host/mic_debugfs.c:131: warning: Function parameter or member 'mdev' not described in 'mic_delete_debug_dir'
      
      Cc: Sudeep Dutt <sudeep.dutt@intel.com>
      Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-15-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      438ad368
    • Lee Jones's avatar
      misc: mic: card: mic_debugfs: Demote function headers from kerneldoc · 49f093f4
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the headers back down to simple comments.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/mic/card/mic_debugfs.c:31: warning: Function parameter or member 's' not described in 'mic_intr_show'
       drivers/misc/mic/card/mic_debugfs.c:31: warning: Function parameter or member 'unused' not described in 'mic_intr_show'
       drivers/misc/mic/card/mic_debugfs.c:53: warning: Function parameter or member 'mdrv' not described in 'mic_create_card_debug_dir'
       drivers/misc/mic/card/mic_debugfs.c:67: warning: Function parameter or member 'mdrv' not described in 'mic_delete_card_debug_dir'
      
      Cc: Sudeep Dutt <sudeep.dutt@intel.com>
      Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-14-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      49f093f4
    • Lee Jones's avatar
      misc: mic: host: mic_x100: Add missing descriptions to kerneldoc headers · 521482b5
      Lee Jones authored
      Fixes the following W=1 warnings:
      
       drivers/misc/mic/host/mic_x100.c:127: warning: Function parameter or member 'doorbell' not described in 'mic_x100_send_sbox_intr'
       drivers/misc/mic/host/mic_x100.c:148: warning: Function parameter or member 'doorbell' not described in 'mic_x100_send_rdmasr_intr'
       drivers/misc/mic/host/mic_x100.c:511: warning: Function parameter or member 'dma_addr' not described in 'mic_x100_smpt_set'
       drivers/misc/mic/host/mic_x100.c:511: warning: Function parameter or member 'index' not described in 'mic_x100_smpt_set'
      
      Cc: Sudeep Dutt <sudeep.dutt@intel.com>
      Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-13-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      521482b5
    • Lee Jones's avatar
      misc: mic: host: mic_intr: Properly document function arguments · f10957db
      Lee Jones authored
      mic_interrupt() and mic_setup_msix() have incomplete documentation.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/mic/host/mic_intr.c:42: warning: Function parameter or member 'irq' not described in 'mic_interrupt'
       drivers/misc/mic/host/mic_intr.c:42: warning: Function parameter or member 'dev' not described in 'mic_interrupt'
       drivers/misc/mic/host/mic_intr.c:188: warning: Function parameter or member 'pdev' not described in 'mic_setup_msix'
      
      Cc: Sudeep Dutt <sudeep.dutt@intel.com>
      Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-12-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      f10957db
    • Lee Jones's avatar
      misc: ibmasm: dot_command: Demote function headers from kerneldoc · 779b961c
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the header back down to a simple comment.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/ibmasm/dot_command.c:18: warning: Function parameter or member 'sp' not described in 'ibmasm_receive_message'
       drivers/misc/ibmasm/dot_command.c:18: warning: Function parameter or member 'message' not described in 'ibmasm_receive_message'
       drivers/misc/ibmasm/dot_command.c:18: warning: Function parameter or member 'message_size' not described in 'ibmasm_receive_message'
       drivers/misc/ibmasm/dot_command.c:55: warning: Function parameter or member 'sp' not described in 'ibmasm_send_driver_vpd'
       drivers/misc/ibmasm/dot_command.c:111: warning: Function parameter or member 'sp' not described in 'ibmasm_send_os_state'
       drivers/misc/ibmasm/dot_command.c:111: warning: Function parameter or member 'os_state' not described in 'ibmasm_send_os_state'
      
      Cc: "Max Asböck" <amax@us.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-11-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      779b961c
    • Lee Jones's avatar
      misc: mic: host: mic_x100: Move declaration of mic_x100_intr_init[] into c-file · 9c03520e
      Lee Jones authored
      mic_x100_intr_init[] is only ever used in mic_x100.c, so instead
      of listing to the compiler complain about unused static arrays
      simply move it into the c-file for direct consumption.  This way
      it can stay 'static'.
      
      Fixes the following W=1 kernel build warning:
      
       In file included from drivers/misc/mic/host/mic_main.c:17:
       drivers/misc/mic/host/mic_x100.h:70:18: warning: ‘mic_x100_intr_init’ defined but not used [-Wunused-const-variable=]
       70 | static const u16 mic_x100_intr_init[] = {
       | ^~~~~~~~~~~~~~~~~~
      
      Cc: Sudeep Dutt <sudeep.dutt@intel.com>
      Cc: Ashutosh Dixit <ashutosh.dixit@intel.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-10-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      9c03520e
    • Lee Jones's avatar
      misc: ibmasm: r_heartbeat: Demote function headers from kerneldoc · e0a6ad87
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the header back down to a simple comment.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/ibmasm/r_heartbeat.c:49: warning: Function parameter or member 'sp' not described in 'ibmasm_start_reverse_heartbeat'
       drivers/misc/ibmasm/r_heartbeat.c:49: warning: Function parameter or member 'rhb' not described in 'ibmasm_start_reverse_heartbeat'
      
      Cc: "Max Asböck" <amax@us.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-9-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      e0a6ad87
    • Lee Jones's avatar
      misc: ibmasm: command: Demote function headers from kerneldoc · b7df87cf
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the header back down to a simple comment.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/ibmasm/command.c:106: warning: Function parameter or member 'sp' not described in 'ibmasm_exec_command'
       drivers/misc/ibmasm/command.c:106: warning: Function parameter or member 'cmd' not described in 'ibmasm_exec_command'
       drivers/misc/ibmasm/command.c:149: warning: Function parameter or member 'cmd' not described in 'ibmasm_wait_for_response'
       drivers/misc/ibmasm/command.c:149: warning: Function parameter or member 'timeout' not described in 'ibmasm_wait_for_response'
       drivers/misc/ibmasm/command.c:162: warning: Function parameter or member 'sp' not described in 'ibmasm_receive_command_response'
       drivers/misc/ibmasm/command.c:162: warning: Function parameter or member 'response' not described in 'ibmasm_receive_command_response'
       drivers/misc/ibmasm/command.c:162: warning: Function parameter or member 'size' not described in 'ibmasm_receive_command_response'
      
      Cc: "Max Asböck" <amax@us.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-7-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      b7df87cf
    • Lee Jones's avatar
      misc: ibmasm: event: Demote function headers from kerneldoc · 63969cf2
      Lee Jones authored
      The correct format is not used and no attempt has been made
      to document the function arguments.  Makes sense to just demote
      the header back down to a simple comment.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/ibmasm/event.c:44: warning: Function parameter or member 'sp' not described in 'ibmasm_receive_event'
       drivers/misc/ibmasm/event.c:44: warning: Function parameter or member 'data' not described in 'ibmasm_receive_event'
       drivers/misc/ibmasm/event.c:44: warning: Function parameter or member 'data_size' not described in 'ibmasm_receive_event'
       drivers/misc/ibmasm/event.c:78: warning: Function parameter or member 'sp' not described in 'ibmasm_get_next_event'
       drivers/misc/ibmasm/event.c:78: warning: Function parameter or member 'reader' not described in 'ibmasm_get_next_event'
      
      Cc: "Max Asböck" <amax@us.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-6-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      63969cf2
    • Lee Jones's avatar
      misc: sgi-xp: xp_main: Staticify local functions xp_init() and xp_exit() · 95ef32cd
      Lee Jones authored
      These functions are not exported and no external prototypes exist
      
      Fixes W=1 kernel build warning(s):
      
       drivers/misc/sgi-xp/xp_main.c:227:1: warning: no previous prototype for ‘xp_init’ [-Wmissing-prototypes]
       227 | xp_init(void)
       | ^~~~~~~
       drivers/misc/sgi-xp/xp_main.c:250:1: warning: no previous prototype for ‘xp_exit’ [-Wmissing-prototypes]
       250 | xp_exit(void)
       | ^~~~~~~
      
      Cc: Cliff Whickman <cpw@sgi.com>
      Cc: Robin Holt <robinmholt@gmail.com>
      Cc: Dean Nelson <dcn@sgi.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-5-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      95ef32cd
    • Lee Jones's avatar
      misc: genwqe: card_debugfs: Demote file header from kerneldoc · f5429c2c
      Lee Jones authored
      Kerneldoc does not understand file headers.  There is therefor
      no reason for them to use the syntax.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/genwqe/card_debugfs.c:30: warning: Function parameter or member 's' not described in 'dbg_uidn_show'
       drivers/misc/genwqe/card_debugfs.c:30: warning: Function parameter or member 'regs' not described in 'dbg_uidn_show'
       drivers/misc/genwqe/card_debugfs.c:30: warning: Function parameter or member 'entries' not described in 'dbg_uidn_show'
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-4-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      f5429c2c
    • Lee Jones's avatar
      misc: genwqe: card_sysfs: Demote function/file headers from kerneldoc · ac36fdb1
      Lee Jones authored
      There has been no attempt to provide documentation for these function's
      arguments, so align with the remainder of the file and just treat
      them as standards function headers.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/genwqe/card_sysfs.c:32: warning: cannot understand function prototype: 'const char * const genwqe_types[] = '
       drivers/misc/genwqe/card_sysfs.c:150: warning: Function parameter or member 'dev' not described in 'curr_bitstream_show'
       drivers/misc/genwqe/card_sysfs.c:150: warning: Function parameter or member 'attr' not described in 'curr_bitstream_show'
       drivers/misc/genwqe/card_sysfs.c:150: warning: Function parameter or member 'buf' not described in 'curr_bitstream_show'
       drivers/misc/genwqe/card_sysfs.c:166: warning: Function parameter or member 'dev' not described in 'next_bitstream_show'
       drivers/misc/genwqe/card_sysfs.c:166: warning: Function parameter or member 'attr' not described in 'next_bitstream_show'
       drivers/misc/genwqe/card_sysfs.c:166: warning: Function parameter or member 'buf' not described in 'next_bitstream_show'
       drivers/misc/genwqe/card_sysfs.c:271: warning: Function parameter or member 'kobj' not described in 'genwqe_is_visible'
       drivers/misc/genwqe/card_sysfs.c:271: warning: Function parameter or member 'attr' not described in 'genwqe_is_visible'
       drivers/misc/genwqe/card_sysfs.c:271: warning: Function parameter or member 'n' not described in 'genwqe_is_visible'
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-3-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      ac36fdb1
    • Lee Jones's avatar
      misc: genwqe: card_ddcb: Fix a variety of kerneldoc issues · 7adb55bd
      Lee Jones authored
      Including; demoting file header from kerneldoc to standard comment/
      header, adding a variety of missing function argument documentation,
      re-ordering of #defines i.e. not placed between kerneldoc headers
      and the functions they are documenting and re-documenting of changed/
      renamed arguments.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/genwqe/card_ddcb.c:83: warning: Function parameter or member 'queue' not described in 'queue_empty'
       drivers/misc/genwqe/card_ddcb.c:262: warning: Excess function parameter 'cd' description in 'RET_DDCB_APPENDED'
       drivers/misc/genwqe/card_ddcb.c:262: warning: Excess function parameter 'queue' description in 'RET_DDCB_APPENDED'
       drivers/misc/genwqe/card_ddcb.c:262: warning: Excess function parameter 'ddcb_no' description in 'RET_DDCB_APPENDED'
       drivers/misc/genwqe/card_ddcb.c:329: warning: Function parameter or member 'req' not described in 'copy_ddcb_results'
       drivers/misc/genwqe/card_ddcb.c:329: warning: Function parameter or member 'ddcb_no' not described in 'copy_ddcb_results'
       drivers/misc/genwqe/card_ddcb.c:364: warning: Function parameter or member 'queue' not described in 'genwqe_check_ddcb_queue'
       drivers/misc/genwqe/card_ddcb.c:565: warning: Function parameter or member 'queue' not described in 'get_next_ddcb'
       drivers/misc/genwqe/card_ddcb.c:565: warning: Function parameter or member 'num' not described in 'get_next_ddcb'
       drivers/misc/genwqe/card_ddcb.c:909: warning: Function parameter or member 'cmd' not described in '__genwqe_execute_raw_ddcb'
       drivers/misc/genwqe/card_ddcb.c:909: warning: Excess function parameter 'req' description in '__genwqe_execute_raw_ddcb'
       drivers/misc/genwqe/card_ddcb.c:972: warning: Function parameter or member 'cd' not described in 'genwqe_next_ddcb_ready'
       drivers/misc/genwqe/card_ddcb.c:1002: warning: Function parameter or member 'cd' not described in 'genwqe_ddcbs_in_flight'
       drivers/misc/genwqe/card_ddcb.c:1181: warning: Function parameter or member 'data' not described in 'genwqe_card_thread'
       drivers/misc/genwqe/card_ddcb.c:1308: warning: Function parameter or member 'cd' not described in 'queue_wake_up_all'
       drivers/misc/genwqe/card_ddcb.c:1333: warning: Function parameter or member 'cd' not described in 'genwqe_finish_queue'
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701083118.45744-2-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      7adb55bd
    • Lee Jones's avatar
      misc: genwqe: card_utils: Whole a plethora of documentation issues · 364b40c0
      Lee Jones authored
      Including; demoting file header from kerneldoc to standard comment/
      header, adding a variety of missing function argument documentation,
      repairing formatting (kerneldoc does not like blank lines) and the
      demotion of a kerneldoc header which shows no interest in providing
      documentation for any of its arguments.
      
      Fixes this the following W=1 issues:
      
       drivers/misc/genwqe/card_utils.c:37: warning: Incorrect use of kernel-doc format:  * __genwqe_writeq() - Write 64-bit register
       drivers/misc/genwqe/card_utils.c:45: warning: Function parameter or member 'cd' not described in '__genwqe_writeq'
       drivers/misc/genwqe/card_utils.c:45: warning: Function parameter or member 'byte_offs' not described in '__genwqe_writeq'
       drivers/misc/genwqe/card_utils.c:45: warning: Function parameter or member 'val' not described in '__genwqe_writeq'
       drivers/misc/genwqe/card_utils.c:136: warning: Function parameter or member 'cd' not described in 'genwqe_read_app_id'
       drivers/misc/genwqe/card_utils.c:136: warning: Function parameter or member 'app_name' not described in 'genwqe_read_app_id'
       drivers/misc/genwqe/card_utils.c:136: warning: Function parameter or member 'len' not described in 'genwqe_read_app_id'
       drivers/misc/genwqe/card_utils.c:186: warning: bad line:
       drivers/misc/genwqe/card_utils.c:290: warning: Function parameter or member 'cd' not described in 'genwqe_alloc_sync_sgl'
       drivers/misc/genwqe/card_utils.c:290: warning: Function parameter or member 'sgl' not described in 'genwqe_alloc_sync_sgl'
       drivers/misc/genwqe/card_utils.c:290: warning: Function parameter or member 'user_addr' not described in 'genwqe_alloc_sync_sgl'
       drivers/misc/genwqe/card_utils.c:290: warning: Function parameter or member 'user_size' not described in 'genwqe_alloc_sync_sgl'
       drivers/misc/genwqe/card_utils.c:290: warning: Function parameter or member 'write' not described in 'genwqe_alloc_sync_sgl'
       drivers/misc/genwqe/card_utils.c:469: warning: Function parameter or member 'cd' not described in 'genwqe_free_sync_sgl'
       drivers/misc/genwqe/card_utils.c:469: warning: Function parameter or member 'sgl' not described in 'genwqe_free_sync_sgl'
       drivers/misc/genwqe/card_utils.c:716: warning: Function parameter or member 'count' not described in 'genwqe_set_interrupt_capability'
       drivers/misc/genwqe/card_utils.c:747: warning: Function parameter or member 'idx' not described in 'set_reg_idx'
       drivers/misc/genwqe/card_utils.c:747: warning: Excess function parameter 'index' description in 'set_reg_idx'
       drivers/misc/genwqe/card_utils.c:823: warning: Function parameter or member 'cd' not described in 'genwqe_ffdc_buff_size'
       drivers/misc/genwqe/card_utils.c:823: warning: Function parameter or member 'uid' not described in 'genwqe_ffdc_buff_size'
       drivers/misc/genwqe/card_utils.c:877: warning: Function parameter or member 'cd' not described in 'genwqe_ffdc_buff_read'
       drivers/misc/genwqe/card_utils.c:877: warning: Function parameter or member 'uid' not described in 'genwqe_ffdc_buff_read'
       drivers/misc/genwqe/card_utils.c:877: warning: Function parameter or member 'regs' not described in 'genwqe_ffdc_buff_read'
       drivers/misc/genwqe/card_utils.c:877: warning: Function parameter or member 'max_regs' not described in 'genwqe_ffdc_buff_read'
       drivers/misc/genwqe/card_utils.c:964: warning: Function parameter or member 'cd' not described in 'genwqe_write_vreg'
       drivers/misc/genwqe/card_utils.c:964: warning: Function parameter or member 'reg' not described in 'genwqe_write_vreg'
       drivers/misc/genwqe/card_utils.c:964: warning: Function parameter or member 'val' not described in 'genwqe_write_vreg'
       drivers/misc/genwqe/card_utils.c:964: warning: Function parameter or member 'func' not described in 'genwqe_write_vreg'
       drivers/misc/genwqe/card_utils.c:977: warning: Function parameter or member 'cd' not described in 'genwqe_read_vreg'
       drivers/misc/genwqe/card_utils.c:977: warning: Function parameter or member 'reg' not described in 'genwqe_read_vreg'
       drivers/misc/genwqe/card_utils.c:977: warning: Function parameter or member 'func' not described in 'genwqe_read_vreg'
       drivers/misc/genwqe/card_utils.c:995: warning: Function parameter or member 'cd' not described in 'genwqe_base_clock_frequency'
       drivers/misc/genwqe/card_utils.c:1012: warning: Function parameter or member 'cd' not described in 'genwqe_stop_traps'
       drivers/misc/genwqe/card_utils.c:1022: warning: Function parameter or member 'cd' not described in 'genwqe_start_traps'
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarFrank Haverkamp <haver@linux.ibm.com>
       # Please enter the commit message for your changes. Lines starting
       # with '#' will be ignored, and an empty message aborts the commit.
       #
       # Date:      Mon Jun 29 10:30:56 2020 +0100
       #
       # On branch tb-mfd-fix-warnings
       # Changes to be committed:
       #	modified:   drivers/misc/genwqe/card_utils.c
       #
       # Untracked files:
       #	qemu-i2c-devs.txt
       #
      Link: https://lore.kernel.org/r/20200701085853.164358-21-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      364b40c0
    • Lee Jones's avatar
      misc: genwqe: card_dev: Whole host of kerneldoc fixes · 807062fc
      Lee Jones authored
      Including; add missing documentation for function arguments, re-ordering
      of #defines i.e. not placed between kerneldoc headers and the functions
      they are documenting, demotion of file header/comment from kerneldoc
      format and removal of documentation for non-existent args.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/genwqe/card_dev.c:33: warning: Function parameter or member 'cd' not described in 'genwqe_open_files'
       drivers/misc/genwqe/card_dev.c:98: warning: Function parameter or member 'virt_addr' not described in 'genwqe_search_pin'
       drivers/misc/genwqe/card_dev.c:98: warning: Excess function parameter 'dma_addr' description in 'genwqe_search_pin'
       drivers/misc/genwqe/card_dev.c:154: warning: Function parameter or member 'virt_addr' not described in '__genwqe_search_mapping'
       drivers/misc/genwqe/card_dev.c:256: warning: Function parameter or member 'cd' not described in 'genwqe_kill_fasync'
       drivers/misc/genwqe/card_dev.c:256: warning: Function parameter or member 'sig' not described in 'genwqe_kill_fasync'
       drivers/misc/genwqe/card_dev.c:387: warning: Function parameter or member 'vma' not described in 'genwqe_vma_close'
       drivers/misc/genwqe/card_dev.c:430: warning: Function parameter or member 'filp' not described in 'genwqe_mmap'
       drivers/misc/genwqe/card_dev.c:430: warning: Function parameter or member 'vma' not described in 'genwqe_mmap'
       drivers/misc/genwqe/card_dev.c:495: warning: Excess function parameter 'cd' description in 'FLASH_BLOCK'
       drivers/misc/genwqe/card_dev.c:495: warning: Excess function parameter 'load' description in 'FLASH_BLOCK'
       drivers/misc/genwqe/card_dev.c:827: warning: Function parameter or member 'cfile' not described in 'ddcb_cmd_cleanup'
       drivers/misc/genwqe/card_dev.c:827: warning: Function parameter or member 'req' not described in 'ddcb_cmd_cleanup'
       drivers/misc/genwqe/card_dev.c:854: warning: Function parameter or member 'cfile' not described in 'ddcb_cmd_fixups'
       drivers/misc/genwqe/card_dev.c:854: warning: Function parameter or member 'req' not described in 'ddcb_cmd_fixups'
       drivers/misc/genwqe/card_dev.c:984: warning: Function parameter or member 'cfile' not described in 'genwqe_execute_ddcb'
       drivers/misc/genwqe/card_dev.c:984: warning: Function parameter or member 'cmd' not described in 'genwqe_execute_ddcb'
       drivers/misc/genwqe/card_dev.c:1350: warning: Function parameter or member 'cd' not described in 'genwqe_device_remove'
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarFrank Haverkamp <haver@linux.ibm.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-20-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      807062fc
    • Lee Jones's avatar
      misc: genwqe: card_base: Whole host of kerneldoc fixes · a562c0c3
      Lee Jones authored
      >From missing documentation for function arguments, to promotion
      obvious kerneldoc headers and incorrectly named arguments.
      
      Fixes the following W=1 warnings:
      
       drivers/misc/genwqe/card_base.c:175: warning: Function parameter or member 'cd' not described in 'genwqe_bus_reset'
       drivers/misc/genwqe/card_base.c:272: warning: Function parameter or member 'cd' not described in 'genwqe_recovery_on_fatal_gfir_required'
       drivers/misc/genwqe/card_base.c:293: warning: Function parameter or member 'cd' not described in 'genwqe_T_psec'
       drivers/misc/genwqe/card_base.c:314: warning: Function parameter or member 'cd' not described in 'genwqe_setup_pf_jtimer'
       drivers/misc/genwqe/card_base.c:334: warning: Function parameter or member 'cd' not described in 'genwqe_setup_vf_jtimer'
       drivers/misc/genwqe/card_base.c:557: warning: Function parameter or member 'cd' not described in 'genwqe_stop'
       drivers/misc/genwqe/card_base.c:617: warning: Function parameter or member 'cd' not described in 'genwqe_fir_checking'
       drivers/misc/genwqe/card_base.c:760: warning: Function parameter or member 'pci_dev' not described in 'genwqe_pci_fundamental_reset'
       drivers/misc/genwqe/card_base.c:889: warning: Function parameter or member 'data' not described in 'genwqe_health_thread'
       drivers/misc/genwqe/card_base.c:1046: warning: Function parameter or member 'cd' not described in 'genwqe_pci_setup'
       drivers/misc/genwqe/card_base.c:1131: warning: Function parameter or member 'cd' not described in 'genwqe_pci_remove'
       drivers/misc/genwqe/card_base.c:1151: warning: Function parameter or member 'pci_dev' not described in 'genwqe_probe'
       drivers/misc/genwqe/card_base.c:1151: warning: Function parameter or member 'id' not described in 'genwqe_probe'
       drivers/misc/genwqe/card_base.c:1151: warning: Excess function parameter 'pdev' description in 'genwqe_probe'
       drivers/misc/genwqe/card_base.c:1207: warning: Function parameter or member 'pci_dev' not described in 'genwqe_remove'
       drivers/misc/genwqe/card_base.c:1336: warning: Function parameter or member 'dev' not described in 'genwqe_devnode'
       drivers/misc/genwqe/card_base.c:1336: warning: Function parameter or member 'mode' not described in 'genwqe_devnode'
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarFrank Haverkamp <haver@linux.ibm.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-19-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      a562c0c3
    • Lee Jones's avatar
      misc: genwqe: card_base: Provide documentation for genwqe_recover_card()'s args · f5721c7a
      Lee Jones authored
      genwqe_recover_card()'s function arguments were missing from its
      kerneldoc header.  Provide descriptions for 'cd' and 'fatal_err'.
      
      Fixes the following kernel build W=1 warning:
      
       drivers/misc/genwqe/card_base.c:588: warning: Function parameter or member 'cd' not described in 'genwqe_recover_card'
       drivers/misc/genwqe/card_base.c:588: warning: Function parameter or member 'fatal_err' not described in 'genwqe_recover_card'
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarFrank Haverkamp <haver@linux.ibm.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-18-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      f5721c7a
    • Lee Jones's avatar
      misc: genwqe: card_base: Remove set but unused variable 'rc' · f33e92e5
      Lee Jones authored
      Variable 'rc' hasn't been checked since the driver's inception
      in 2013.  If it hasn't caused any issues since then, it's unlikely
      to in the future.  Let's take it out for now.
      
      Fixes the following W=1 kernel build warning(s):
      
       drivers/misc/genwqe/card_base.c: In function ‘genwqe_health_check_stop’:
       /home/lee/projects/linux/kernel/drivers/misc/genwqe/card_base.c:1046:6: warning: variable ‘rc’ set but not used [-Wunused-but-set-variable]
       1046 | int rc;
       | ^~
      
      Cc: Michael Jung <mijung@gmx.net>
      Cc: Michael Ruettger <michael@ibmra.de>
      Cc: Frank Haverkamp <haver@linux.ibm.com>
      Cc: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarFrank Haverkamp <haver@linux.ibm.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-17-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      f33e92e5
    • Lee Jones's avatar
      misc: enclosure: Update enclosure_remove_device() documentation to match reality · 6a57251c
      Lee Jones authored
      enclosure_remove_device() hasn't taken an 'int component for over a decade.
      Instead use kerneldoc to describe the 'struct device' actually passed in.
      
      Fixes the following W=1 kernel build warning(s):
      
       drivers/misc/enclosure.c:400: warning: Function parameter or member 'dev' not described in 'enclosure_remove_device'
       drivers/misc/enclosure.c:400: warning: Excess function parameter 'num' description in 'enclosure_remove_device'
      
      Cc: James Bottomley <James.Bottomley@HansenPartnership.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701085853.164358-16-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      6a57251c
    • Lee Jones's avatar
      misc: pch_phub: Remove superfluous descriptions to non-existent args 'offset_address' · 7b411871
      Lee Jones authored
      Probably a copy 'n' paste error, 'offset_address' has never been
      part of the pch_phub_{read,write}_gbe_mac_addr() functions.
      
      Squashes the following W=1 warnings:
      
       drivers/misc/pch_phub.c:450: warning: Excess function parameter 'offset_address' description in 'pch_phub_read_gbe_mac_addr'
       drivers/misc/pch_phub.c:462: warning: Excess function parameter 'offset_address' description in 'pch_phub_write_gbe_mac_addr'
      
      Cc: Masayuki Ohtak <masa-korg@dsn.okisemi.com>
      Cc: Tomoya MORINAGA <tomoya-linux@dsn.okisemi.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701085853.164358-15-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      7b411871
    • Lee Jones's avatar
      misc: pch_phub: Provide descriptions for 'chip' argument · 0f8ab9bd
      Lee Jones authored
      For some reason (probably copy 'n' paste) kerneldoc descriptions
      were missing for all instances of 'chip'.  Providing them squashes
      the following W=1 kernel build warnings:
      
       drivers/misc/pch_phub.c:145: warning: Function parameter or member 'chip' not described in 'pch_phub_read_modify_write_reg'
       drivers/misc/pch_phub.c:282: warning: Function parameter or member 'chip' not described in 'pch_phub_read_serial_rom'
       drivers/misc/pch_phub.c:296: warning: Function parameter or member 'chip' not described in 'pch_phub_write_serial_rom'
       drivers/misc/pch_phub.c:334: warning: Function parameter or member 'chip' not described in 'pch_phub_read_serial_rom_val'
       drivers/misc/pch_phub.c:350: warning: Function parameter or member 'chip' not described in 'pch_phub_write_serial_rom_val'
       drivers/misc/pch_phub.c:450: warning: Function parameter or member 'chip' not described in 'pch_phub_read_gbe_mac_addr'
       drivers/misc/pch_phub.c:462: warning: Function parameter or member 'chip' not described in 'pch_phub_write_gbe_mac_addr'
      
      Cc: Masayuki Ohtak <masa-korg@dsn.okisemi.com>
      Cc: Tomoya MORINAGA <tomoya-linux@dsn.okisemi.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701085853.164358-14-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      0f8ab9bd
    • Lee Jones's avatar
      misc: lattice-ecp3-config: Remove set but clearly unused variable 'ret' · 8bc056e8
      Lee Jones authored
      It's odd for the return value to be assigned to a variable so many
      times, but never actually checked, but this has been the case since
      the driver's inception in 2012.  If it hasn't caused any issues by
      now, it's probably unlikely to.  Let's take it out, at least until
      someone finds a reason to start using it.
      
      Fixes the following W=1 kernel build warning:
      
       drivers/misc/lattice-ecp3-config.c: In function ‘firmware_load’:
       drivers/misc/lattice-ecp3-config.c:70:6: warning: variable ‘ret’ set but not used [-Wunused-but-set-variable]
       70 | int ret;
       | ^~~
      
      Cc: Stefan Roese <sr@denx.de>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701085853.164358-13-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      8bc056e8
    • Lee Jones's avatar
      misc: enclosure: Fix some kerneldoc anomalies · 82f5b473
      Lee Jones authored
      Firstly some missing function argument documentation, then some
      whch are present, but are incorrectly named.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/enclosure.c:115: warning: Function parameter or member 'name' not described in 'enclosure_register'
       drivers/misc/enclosure.c:115: warning: Function parameter or member 'cb' not described in 'enclosure_register'
       drivers/misc/enclosure.c:283: warning: Function parameter or member 'number' not described in 'enclosure_component_alloc'
       drivers/misc/enclosure.c:283: warning: Excess function parameter 'num' description in 'enclosure_component_alloc'
       drivers/misc/enclosure.c:363: warning: Function parameter or member 'component' not described in 'enclosure_add_device'
       drivers/misc/enclosure.c:363: warning: Excess function parameter 'num' description in 'enclosure_add_device'
       drivers/misc/enclosure.c:398: warning: Function parameter or member 'dev' not described in 'enclosure_remove_device'
       drivers/misc/enclosure.c:398: warning: Excess function parameter 'num' description in 'enclosure_remove_device'
      
      Cc: James Bottomley <James.Bottomley@HansenPartnership.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701085853.164358-12-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      82f5b473
    • Lee Jones's avatar
      misc: habanalabs: gaudi: gaudi_security: Repair incorrectly named function arg · 14395c6f
      Lee Jones authored
      gaudi_pb_set_block()'s argument 'base' was incorrectly named 'block' in
      its function header.
      
      Fixes the following W=1 kernel build warning(s):
      
       drivers/misc/habanalabs/gaudi/gaudi_security.c:454: warning: Function parameter or member 'base' not described in 'gaudi_pb_set_block'
       drivers/misc/habanalabs/gaudi/gaudi_security.c:454: warning: Excess function parameter 'block' description in 'gaudi_pb_set_block'
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-11-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      14395c6f
    • Lee Jones's avatar
      misc: habanalabs: gaudi: Remove ill placed asterisk from kerneldoc header · f7d227c3
      Lee Jones authored
      W=1 kernel builds report a lack of description of gaudi_set_asic_funcs()'s
      'hdev' argument.  In reality it is documented, but the formatting
      was not as expected '@.*:'.  Instead, there was a misplaced asterisk
      which was confusing the kerneldoc validator.
      
      Squashes the following W=1 warning:
      
       drivers/misc/habanalabs/gaudi/gaudi.c:6746: warning: Function parameter or member 'hdev' not described in 'gaudi_set_asic_funcs'
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-10-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      f7d227c3
    • Lee Jones's avatar
      misc: habanalabs: goya: goya_coresight: Remove set but unused variable 'val' · 67db05ce
      Lee Jones authored
      No attempt to check the return value of RREG32() has been made
      since the call was introduced a year ago.
      
      Fixes W=1 kernel build warning:
      
       drivers/misc/habanalabs/goya/goya_coresight.c: In function ‘goya_debug_coresight’:
       drivers/misc/habanalabs/goya/goya_coresight.c:643:6: warning: variable ‘val’ set but not used [-Wunused-but-set-variable]
       643 | u32 val;
       | ^~~
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-9-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      67db05ce
    • Lee Jones's avatar
      misc: habanalabs: pci: Scrub documentation for non-present function argument · e0712c60
      Lee Jones authored
      'dma_mask' is not passed directly into hl_pci_set_dma_mask() as
      an argument.  Instead, it is pulled from struct hl_device *hdev.
      
      Fixed the following W=1 warning:
      
       drivers/misc/habanalabs/pci.c:328: warning: Excess function parameter 'dma_mask' description in 'hl_pci_set_dma_mask
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-8-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      e0712c60
    • Lee Jones's avatar
      misc: habanalabs: goya: Omit pointless check ensuring addr is >=0 · 2557f27f
      Lee Jones authored
      Seeing as 'addr' is unsigned, it would be impossible for the assigned
      value to be anything other than zero or positive.
      
      Squashes the following W=1 warnings:
      
       drivers/misc/habanalabs/goya/goya.c: In function ‘goya_debugfs_read32’:
       drivers/misc/habanalabs/goya/goya.c:3945:19: warning: comparison of unsigned expression >= 0 is always true [-Wtype-limits]
       3945 | } else if ((addr >= DRAM_PHYS_BASE) &&
       | ^~
       drivers/misc/habanalabs/goya/goya.c: In function ‘goya_debugfs_write32’:
       drivers/misc/habanalabs/goya/goya.c:4002:19: warning: comparison of unsigned expression >= 0 is always true [-Wtype-limits]
       4002 | } else if ((addr >= DRAM_PHYS_BASE) &&
       | ^~
       drivers/misc/habanalabs/goya/goya.c: In function ‘goya_debugfs_read64’:
       drivers/misc/habanalabs/goya/goya.c:4047:19: warning: comparison of unsigned expression >= 0 is always true [-Wtype-limits]
       4047 | } else if ((addr >= DRAM_PHYS_BASE) &&
       | ^~
       drivers/misc/habanalabs/goya/goya.c: In function ‘goya_debugfs_write64’:
       drivers/misc/habanalabs/goya/goya.c:4091:19: warning: comparison of unsigned expression >= 0 is always true [-Wtype-limits]
       4091 | } else if ((addr >= DRAM_PHYS_BASE) &&
       | ^~
       drivers/misc/habanalabs/pci.c:328: warning: Excess function parameter 'dma_mask' description in 'hl_pci_set_dma_mask'
       drivers/misc/habanalabs/goya/goya_coresight.c: In function ‘goya_debug_coresight’:
       drivers/misc/habanalabs/goya/goya_coresight.c:643:6: warning: variable ‘val’ set but not used [-Wunused-but-set-variable]
       643 | u32 val;
       | ^~~
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-7-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      2557f27f
    • Lee Jones's avatar
      misc: habanalabs: irq: Repair kerneldoc formatting issues · 3db99f00
      Lee Jones authored
      W=1 kernel builds report a lack of descriptions for various
      function arguments.  In reality they are documented, but the
      formatting was not as expected '@.*:'.  Instead, '-'s were
      used as separators.
      
      While we're here, the headers for functions various functions
      were written in kerneldoc format, but lack the kerneldoc
      identifier '/**'.  Let's promote them so they can gain access
      to the checker.
      
      This change fixes the following W=1 warnings:
      
       drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_work' not described in 'hl_eqe_work'
       drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'hdev' not described in 'hl_eqe_work'
       drivers/misc/habanalabs/irq.c:24: warning: Function parameter or member 'eq_entry' not described in 'hl_eqe_work'
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-6-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      3db99f00
    • Lee Jones's avatar
      misc: habanalabs: pci: Fix a variety of kerneldoc issues · df123c9d
      Lee Jones authored
      hl_pci_bars_map() has a miss-typed argument name in the function
      description.  hl_pci_elbi_write() was missing documented arguments.
      The headers for functions hl_pci_bars_unmap(), hl_pci_elbi_write()
      and hl_pci_reset_link_through_bridge() were written in kerneldoc
      format, but lack the kerneldoc identifier '/**'.  Let's promote
      them so they can gain access to the checker.
      
      These changes fix the following W=1 kernel build warnings:
      
       drivers/misc/habanalabs/pci.c:27: warning: Function parameter or member 'name' not described in 'hl_pci_bars_map'
       drivers/misc/habanalabs/pci.c:27: warning: Excess function parameter 'bar_name' description in 'hl_pci_bars_map'
       drivers/misc/habanalabs/pci.c:147: warning: Function parameter or member 'addr' not described in 'hl_pci_iatu_write'
       drivers/misc/habanalabs/pci.c:147: warning: Function parameter or member 'data' not described in 'hl_pci_iatu_write'
       drivers/misc/habanalabs/pci.c:324: warning: Excess function parameter 'dma_mask' description in 'hl_pci_set_dma_mask'
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-5-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      df123c9d
    • Lee Jones's avatar
      misc: habanalabs: firmware_if: Add missing 'fw_name' and 'dst' entries to function header · a0c11b3c
      Lee Jones authored
      Looks as though documentation for these function arguments have
      been missing since the driver's inception last year.
      
      Fixes the following W=1 kernel build warnings:
      
       drivers/misc/habanalabs/firmware_if.c:26: warning: Function parameter or member 'fw_name' not described in 'hl_fw_load_fw_to_device'
       drivers/misc/habanalabs/firmware_if.c:26: warning: Function parameter or member 'dst' not described in 'hl_fw_load_fw_to_device'
      
      Cc: Oded Gabbay <oded.gabbay@gmail.com>
      Cc: Tomer Tayar <ttayar@habana.ai>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Reviewed-by: default avatarOded Gabbay <oded.gabbay@gmail.com>
      Link: https://lore.kernel.org/r/20200701085853.164358-4-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      a0c11b3c
    • Lee Jones's avatar
      misc: pti: Remove unparsable empty line in function header · 6e47fc8a
      Lee Jones authored
      The kerneldoc tooling/parsers/validators get confused if non-
      standard formatting is used.  The first line after the kerneldoc
      identifier '/**' must not be blank else the following warnings
      will be issued:
      
       drivers/misc/pti.c:902: warning: Cannot understand  *
       on line 902 - I thought it was a doc line
      
      Cc: J Freyensee <james_p_freyensee@linux.intel.com>
      Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
      Link: https://lore.kernel.org/r/20200701085853.164358-3-lee.jones@linaro.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
      6e47fc8a