Commit 8058dfa0 authored by Lukas Bulwahn's avatar Lukas Bulwahn Committed by Bjorn Andersson
Browse files

soc: qcom: address kernel-doc warnings 



The command:

  find ./include/linux/soc/qcom/ | xargs ./scripts/kernel-doc -none

reports:

  ./include/linux/soc/qcom/qmi.h:26: warning: cannot understand function prototype: 'struct qmi_header '
  ./include/linux/soc/qcom/qmi.h:101: warning: cannot understand function prototype: 'struct qmi_response_type_v01 '
  ./include/linux/soc/qcom/irq.h:19: warning: expecting prototype for QCOM specific IRQ domain flags that distinguishes the handling of wakeup(). Prototype was for IRQ_DOMAIN_FLAG_QCOM_PDC_WAKEUP() instead
  ./include/linux/soc/qcom/apr.h:126: warning: Function parameter or member '__apr_driver' not described in 'module_apr_driver'
  ./include/linux/soc/qcom/apr.h:126: warning: Excess function parameter '__aprbus_driver' description in 'module_apr_driver'
  ./include/linux/soc/qcom/llcc-qcom.h:43: warning: cannot understand function prototype: 'struct llcc_slice_desc '
  ./include/linux/soc/qcom/llcc-qcom.h:60: warning: cannot understand function prototype: 'struct llcc_edac_reg_data '
  ./include/linux/soc/qcom/llcc-qcom.h:86: warning: cannot understand function prototype: 'struct llcc_drv_data '

Address all those warnings by:
  - prefixing kernel-doc descriptions for structs with the keyword 'struct',
  - turning a kernel-doc comment that does not follow the kernel-doc syntax
  into a normal comment, and
  - correcting a parameter name in a kernel-doc comment.

Signed-off-by: default avatarLukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20210327065642.11969-3-lukas.bulwahn@gmail.com


Signed-off-by: default avatarBjorn Andersson <bjorn.andersson@linaro.org>
parent 99d52c87

include/linux/soc/qcom/apr.h

+1 −1
Original line number Diff line number Diff line
@@ -113,7 +113,7 @@ void apr_driver_unregister(struct apr_driver *drv); 


/**

 * module_apr_driver() - Helper macro for registering a aprbus driver

 * @__aprbus_driver: aprbus_driver struct

 * @__apr_driver: apr_driver struct

 *

 * Helper macro for aprbus drivers which do not do anything special in

 * module init/exit. This eliminates a lot of boilerplate. Each module

include/linux/soc/qcom/irq.h

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ 


#define GPIO_NO_WAKE_IRQ	~0U



/**

/*

 * QCOM specific IRQ domain flags that distinguishes the handling of wakeup

 * capable interrupts by different interrupt controllers.

 *

include/linux/soc/qcom/llcc-qcom.h

+3 −3
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ 
#define LLCC_WRCACHE     31



/**

 * llcc_slice_desc - Cache slice descriptor

 * struct llcc_slice_desc - Cache slice descriptor

 * @slice_id: llcc slice id

 * @slice_size: Size allocated for the llcc slice

 */
@@ -45,7 +45,7 @@ struct llcc_slice_desc { 
};



/**

 * llcc_edac_reg_data - llcc edac registers data for each error type

 * struct llcc_edac_reg_data - llcc edac registers data for each error type

 * @name: Name of the error

 * @synd_reg: Syndrome register address

 * @count_status_reg: Status register address to read the error count
@@ -69,7 +69,7 @@ struct llcc_edac_reg_data { 
};



/**

 * llcc_drv_data - Data associated with the llcc driver

 * struct llcc_drv_data - Data associated with the llcc driver

 * @regmap: regmap associated with the llcc device

 * @bcast_regmap: regmap associated with llcc broadcast offset

 * @cfg: pointer to the data structure for slice configuration

include/linux/soc/qcom/qmi.h

+2 −2
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ 
struct socket;



/**

 * qmi_header - wireformat header of QMI messages

 * struct qmi_header - wireformat header of QMI messages

 * @type:	type of message

 * @txn_id:	transaction id

 * @msg_id:	message id
@@ -93,7 +93,7 @@ struct qmi_elem_info { 
#define QMI_ERR_NOT_SUPPORTED_V01		94



/**

 * qmi_response_type_v01 - common response header (decoded)

 * struct qmi_response_type_v01 - common response header (decoded)

 * @result:	result of the transaction

 * @error:	error value, when @result is QMI_RESULT_FAILURE_V01

 */