qcacld-3.0: Fix core/pld documentation

There are quite a few documentation issues in core/pld:
- Documentation of implementations instead of interfaces
- Duplicate documentation
- Syntatically incorrect kernel-doc

Fix all of these issues.

Change-Id: Ia6ef2fda239e9021c879bc4672c9e80ec5c93921
CRs-Fixed: 3386837

core/pld/inc/pld_common.h

@@ -118,6 +118,7 @@ enum pld_bus_type {
  * @PLD_BUS_WIDTH_VERY_HIGH: vote for very high bus bandwidth
  * @PLD_BUS_WIDTH_ULTRA_HIGH: vote for ultra high bus bandwidth
  * @PLD_BUS_WIDTH_LOW_LATENCY: vote for low latency bus bandwidth
+ * @PLD_BUS_WIDTH_MAX:
  */
 enum pld_bus_width_type {
 	PLD_BUS_WIDTH_NONE,
@@ -134,7 +135,7 @@ enum pld_bus_width_type {
 #define PLD_MAX_FILE_NAME NAME_MAX
 
 /**
- * struct pld_fw_file - WLAN FW file names
+ * struct pld_fw_files - WLAN FW file names
  * @image_file: WLAN FW image file
  * @board_data: WLAN FW board data file
  * @otp_data: WLAN FW OTP file
@@ -143,6 +144,7 @@ enum pld_bus_width_type {
  * @epping_file: WLAN FW EPPING mode file
  * @evicted_data: WLAN FW evicted file
  * @setup_file: WLAN FW setup file
+ * @ibss_image_file: WLAN FW IBSS mode file
  *
  * pld_fw_files is used to store WLAN FW file names
  */
@@ -198,6 +200,7 @@ struct pld_platform_cap {
  * @PLD_FW_RECOVERY_START: firmware is starting recovery
  * @PLD_FW_HANG_EVENT: firmware update hang event
  * @PLD_BUS_EVENT: update bus/link event
+ * @PLD_SMMU_FAULT: SMMU fault
  */
 enum pld_uevent {
 	PLD_FW_DOWN,
@@ -223,7 +226,7 @@ enum pld_bus_event {
 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 19, 0))
 /**
  * enum pld_device_config - Get PLD device config
- * @PLD_IPA_DISABLD: IPA is disabled
+ * @PLD_IPA_DISABLED: IPA is disabled
  */
 enum pld_device_config {
 	PLD_IPA_DISABLED,
@@ -235,7 +238,7 @@ enum pld_device_config {
  * @uevent: uevent type
  * @fw_down: FW down info
  * @hang_data: FW hang data
- * @bus_event: bus related data
+ * @bus_data: bus related data
  */
 struct pld_uevent_data {
 	enum pld_uevent uevent;
@@ -320,7 +323,7 @@ struct pld_shadow_reg_v3_cfg {
 #endif
 
 /**
- * struct pld_rri_over_ddr_cfg_s - rri_over_ddr configuration
+ * struct pld_rri_over_ddr_cfg - rri_over_ddr configuration
  * @base_addr_low: lower 32bit
  * @base_addr_high: higher 32bit
  *
@@ -344,6 +347,8 @@ struct pld_rri_over_ddr_cfg {
  * @shadow_reg_v2_cfg: shadow register version 2 configuration
  * @rri_over_ddr_cfg_valid: valid flag for rri_over_ddr config
  * @rri_over_ddr_cfg: rri over ddr config
+ * @num_shadow_reg_v3_cfg: number of shadow register version 3 configuration
+ * @shadow_reg_v3_cfg: shadow register version 3 configuration
  *
  * pld_wlan_enable_cfg stores WLAN FW configurations. It will be
  * passed to WLAN FW when WLAN host driver calls wlan_enable.
@@ -430,6 +435,7 @@ struct pld_dev_mem_info {
  * @fw_build_timestamp: FW build timestamp
  * @device_version: WLAN device version info
  * @dev_mem_info: WLAN device memory info
+ * @fw_build_id: Firmware build identifier
  *
  * pld_soc_info is used to store WLAN SOC information.
  */
@@ -509,10 +515,14 @@ struct pld_ch_avoid_ind_type {
  *           is enabled
  * @resume: required operation, will be called for power management
  *          is enabled
+ * @reset_resume: required operation, will be called for power management
+ *                is enabled
  * @modem_status: optional operation, will be called when platform driver
  *                sending modem power status to WLAN FW
  * @uevent: optional operation, will be called when platform driver
  *                 updating driver status
+ * @collect_driver_dump: optional operation, will be called during SSR to
+ *                       collect driver memory dump
  * @runtime_suspend: optional operation, prepare the device for a condition
  *                   in which it won't be able to communicate with the CPU(s)
  *                   and RAM due to power management.
@@ -575,7 +585,19 @@ struct pld_driver_ops {
 					 int mon_id);
 };
 
+/**
+ * pld_init() - Initialize PLD module
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_init(void);
+
+/**
+ * pld_deinit() - Uninitialize PLD module
+ *
+ * Return: void
+ */
 void pld_deinit(void);
 
 /**
@@ -587,18 +609,115 @@ void pld_deinit(void);
  */
 int pld_set_mode(u8 mode);
 
+/**
+ * pld_register_driver() - Register driver to kernel
+ * @ops: Callback functions that will be registered to kernel
+ *
+ * This function should be called when other modules want to
+ * register platform driver callback functions to kernel. The
+ * probe() is expected to be called after registration if the
+ * device is online.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_register_driver(struct pld_driver_ops *ops);
+
+/**
+ * pld_unregister_driver() - Unregister driver to kernel
+ *
+ * This function should be called when other modules want to
+ * unregister callback functions from kernel. The remove() is
+ * expected to be called after registration.
+ *
+ * Return: void
+ */
 void pld_unregister_driver(void);
 
+/**
+ * pld_wlan_enable() - Enable WLAN
+ * @dev: device
+ * @config: WLAN configuration data
+ * @mode: WLAN mode
+ *
+ * This function enables WLAN FW. It passed WLAN configuration data,
+ * WLAN mode and host software version to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 		    enum pld_driver_mode mode);
+
+/**
+ * pld_wlan_disable() - Disable WLAN
+ * @dev: device
+ * @mode: WLAN mode
+ *
+ * This function disables WLAN FW. It passes WLAN mode to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_wlan_disable(struct device *dev, enum pld_driver_mode mode);
+
+/**
+ * pld_set_fw_log_mode() - Set FW debug log mode
+ * @dev: device
+ * @fw_log_mode: 0 for No log, 1 for WMI, 2 for DIAG
+ *
+ * Switch Fw debug log mode between DIAG logging and WMI logging.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_set_fw_log_mode(struct device *dev, u8 fw_log_mode);
+
+/**
+ * pld_get_default_fw_files() - Get default FW file names
+ * @pfw_files: buffer for FW file names
+ *
+ * Return default FW file names to the buffer.
+ *
+ * Return: void
+ */
 void pld_get_default_fw_files(struct pld_fw_files *pfw_files);
+
+/**
+ * pld_get_fw_files_for_target() - Get FW file names
+ * @dev: device
+ * @pfw_files: buffer for FW file names
+ * @target_type: target type
+ * @target_version: target version
+ *
+ * Return target specific FW file names to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_get_fw_files_for_target(struct device *dev,
 				struct pld_fw_files *pfw_files,
 				u32 target_type, u32 target_version);
+
+/**
+ * pld_prevent_l1() - Prevent PCIe enter L1 state
+ * @dev: device
+ *
+ * Prevent PCIe enter L1 and L1ss states
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_prevent_l1(struct device *dev);
+
+/**
+ * pld_allow_l1() - Allow PCIe enter L1 state
+ * @dev: device
+ *
+ * Allow PCIe enter L1 and L1ss states
+ *
+ * Return: void
+ */
 void pld_allow_l1(struct device *dev);
 
 /**
@@ -612,13 +731,66 @@ void pld_allow_l1(struct device *dev);
  */
 int pld_set_pcie_gen_speed(struct device *dev, u8 pcie_gen_speed);
 
+/**
+ * pld_is_pci_link_down() - Notification for pci link down event
+ * @dev: device
+ *
+ * Notify platform that pci link is down.
+ *
+ * Return: void
+ */
 void pld_is_pci_link_down(struct device *dev);
+
+/**
+ * pld_get_bus_reg_dump() - Get bus reg dump
+ * @dev: device
+ * @buf: buffer for hang data
+ * @len: len of hang data
+ *
+ * Get pci reg dump for hang data.
+ *
+ * Return: void
+ */
 void pld_get_bus_reg_dump(struct device *dev, uint8_t *buf, uint32_t len);
+
 int pld_shadow_control(struct device *dev, bool enable);
+
+/**
+ * pld_schedule_recovery_work() - Schedule recovery work
+ * @dev: device
+ * @reason: recovery reason
+ *
+ * Schedule a system self recovery work.
+ *
+ * Return: void
+ */
 void pld_schedule_recovery_work(struct device *dev,
 				enum pld_recovery_reason reason);
+
+/**
+ * pld_wlan_hw_enable() - Enable WLAN HW
+ *
+ * This function enables WLAN HW. If WLAN is secured disabled at boot all wlan
+ * boot time activities are deferred. This is used to run deferred activities
+ * after wlan is enabled.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_wlan_hw_enable(void);
+
 #ifdef FEATURE_WLAN_TIME_SYNC_FTM
+/**
+ * pld_get_audio_wlan_timestamp() - Get audio timestamp
+ * @dev: device pointer
+ * @type: trigger type
+ * @ts: audio timestamp
+ *
+ * This API can be used to get audio timestamp.
+ *
+ * Return: 0 if trigger to get audio timestamp is successful
+ *         Non zero failure code for errors
+ */
 int pld_get_audio_wlan_timestamp(struct device *dev,
 				 enum pld_wlan_time_sync_trigger_type type,
 				 uint64_t *ts);
@@ -822,7 +994,28 @@ static inline int pld_get_driver_load_cnt(struct device *dev)
 	return -EINVAL;
 }
 #endif
+
+/**
+ * pld_wlan_pm_control() - WLAN PM control on PCIE
+ * @dev: device
+ * @vote: 0 for enable PCIE PC, 1 for disable PCIE PC
+ *
+ * This is for PCIE power collaps control during suspend/resume.
+ * When PCIE power collaps is disabled, WLAN FW can access memory
+ * through PCIE when system is suspended.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_wlan_pm_control(struct device *dev, bool vote);
+
+/**
+ * pld_get_virt_ramdump_mem() - Get virtual ramdump memory
+ * @dev: device
+ * @size: buffer to virtual memory size
+ *
+ * Return: virtual ramdump memory address
+ */
 void *pld_get_virt_ramdump_mem(struct device *dev, unsigned long *size);
 
 /**
@@ -833,19 +1026,132 @@ void *pld_get_virt_ramdump_mem(struct device *dev, unsigned long *size);
  * Return: void
  */
 void pld_release_virt_ramdump_mem(struct device *dev, void *address);
+
+/**
+ * pld_device_crashed() - Notification for device crash event
+ * @dev: device
+ *
+ * Notify subsystem a device crashed event. A subsystem restart
+ * is expected to happen after calling this function.
+ *
+ * Return: void
+ */
 void pld_device_crashed(struct device *dev);
+
+/**
+ * pld_device_self_recovery() - Device self recovery
+ * @dev: device
+ * @reason: recovery reason
+ *
+ * Return: void
+ */
 void pld_device_self_recovery(struct device *dev,
 			      enum pld_recovery_reason reason);
+
+/**
+ * pld_intr_notify_q6() - Notify Q6 FW interrupts
+ * @dev: device
+ *
+ * Notify Q6 that a FW interrupt is triggered.
+ *
+ * Return: void
+ */
 void pld_intr_notify_q6(struct device *dev);
+
+/**
+ * pld_request_pm_qos() - Request system PM
+ * @dev: device
+ * @qos_val: request value
+ *
+ * It votes for the value of aggregate QoS expectations.
+ *
+ * Return: void
+ */
 void pld_request_pm_qos(struct device *dev, u32 qos_val);
+
+/**
+ * pld_remove_pm_qos() - Remove system PM
+ * @dev: device
+ *
+ * Remove the vote request for Qos expectations.
+ *
+ * Return: void
+ */
 void pld_remove_pm_qos(struct device *dev);
+
+/**
+ * pld_request_bus_bandwidth() - Request bus bandwidth
+ * @dev: device
+ * @bandwidth: bus bandwidth
+ *
+ * Votes for HIGH/MEDIUM/LOW bus bandwidth.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_request_bus_bandwidth(struct device *dev, int bandwidth);
+
+/**
+ * pld_get_platform_cap() - Get platform capabilities
+ * @dev: device
+ * @cap: buffer to the capabilities
+ *
+ * Return capabilities to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_get_platform_cap(struct device *dev, struct pld_platform_cap *cap);
+
+/**
+ * pld_get_sha_hash() - Get sha hash number
+ * @dev: device
+ * @data: input data
+ * @data_len: data length
+ * @hash_idx: hash index
+ * @out:  output buffer
+ *
+ * Return computed hash to the out buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_get_sha_hash(struct device *dev, const u8 *data,
 		     u32 data_len, u8 *hash_idx, u8 *out);
+
+/**
+ * pld_get_fw_ptr() - Get secure FW memory address
+ * @dev: device
+ *
+ * Return: secure memory address
+ */
 void *pld_get_fw_ptr(struct device *dev);
+
+/**
+ * pld_auto_suspend() - Auto suspend
+ * @dev: device
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_auto_suspend(struct device *dev);
+
+/**
+ * pld_auto_resume() - Auto resume
+ * @dev: device
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_auto_resume(struct device *dev);
+
+/**
+ * pld_force_wake_request() - Request vote to assert WAKE register
+ * @dev: device
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_force_wake_request(struct device *dev);
 
 /**
@@ -876,35 +1182,228 @@ int pld_force_wake_request_sync(struct device *dev, int timeout_us);
  *         Non zero failure code for errors
  */
 int pld_exit_power_save(struct device *dev);
+
+/**
+ * pld_is_device_awake() - Check if it's ready to access MMIO registers
+ * @dev: device
+ *
+ * Return: True for device awake
+ *         False for device not awake
+ *         Negative failure code for errors
+ */
 int pld_is_device_awake(struct device *dev);
+
+/**
+ * pld_force_wake_release() - Release vote to assert WAKE register
+ * @dev: device
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_force_wake_release(struct device *dev);
+
+/**
+ * pld_ce_request_irq() - Register IRQ for CE
+ * @dev: device
+ * @ce_id: CE number
+ * @handler: IRQ callback function
+ * @flags: IRQ flags
+ * @name: IRQ name
+ * @ctx: IRQ context
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_ce_request_irq(struct device *dev, unsigned int ce_id,
 		       irqreturn_t (*handler)(int, void *),
 		       unsigned long flags, const char *name, void *ctx);
+
+/**
+ * pld_ce_free_irq() - Free IRQ for CE
+ * @dev: device
+ * @ce_id: CE number
+ * @ctx: IRQ context
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_ce_free_irq(struct device *dev, unsigned int ce_id, void *ctx);
+
+/**
+ * pld_enable_irq() - Enable IRQ for CE
+ * @dev: device
+ * @ce_id: CE number
+ *
+ * Return: void
+ */
 void pld_enable_irq(struct device *dev, unsigned int ce_id);
+
+/**
+ * pld_disable_irq() - Disable IRQ for CE
+ * @dev: device
+ * @ce_id: CE number
+ *
+ * Return: void
+ */
 void pld_disable_irq(struct device *dev, unsigned int ce_id);
+
+/**
+ * pld_get_soc_info() - Get SOC information
+ * @dev: device
+ * @info: buffer to SOC information
+ *
+ * Return SOC info to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_get_soc_info(struct device *dev, struct pld_soc_info *info);
+
+/**
+ * pld_get_mhi_state() - Get MHI state Info
+ * @dev: device
+ *
+ * MHI state can be determined by reading this address.
+ *
+ * Return: MHI state
+ */
 int pld_get_mhi_state(struct device *dev);
+
+/**
+ * pld_is_pci_ep_awake() - Check if PCI EP is L0 state
+ * @dev: device
+ *
+ * Return: True for PCI EP awake
+ *         False for PCI EP not awake
+ *         Negative failure code for errors
+ */
 int pld_is_pci_ep_awake(struct device *dev);
+
+/**
+ * pld_get_ce_id() - Get CE number for the provided IRQ
+ * @dev: device
+ * @irq: IRQ number
+ *
+ * Return: CE number
+ */
 int pld_get_ce_id(struct device *dev, int irq);
+
+/**
+ * pld_get_irq() - Get IRQ number for given CE ID
+ * @dev: device
+ * @ce_id: CE ID
+ *
+ * Return: IRQ number
+ */
 int pld_get_irq(struct device *dev, int ce_id);
+
+/**
+ * pld_lock_reg_window() - Lock register window spinlock
+ * @dev: device pointer
+ * @flags: variable pointer to save CPU states
+ *
+ * It uses spinlock_bh so avoid calling in top half context.
+ *
+ * Return: void
+ */
 void pld_lock_reg_window(struct device *dev, unsigned long *flags);
+
+/**
+ * pld_unlock_reg_window() - Unlock register window spinlock
+ * @dev: device pointer
+ * @flags: variable pointer to save CPU states
+ *
+ * It uses spinlock_bh so avoid calling in top half context.
+ *
+ * Return: void
+ */
 void pld_unlock_reg_window(struct device *dev, unsigned long *flags);
+
+/**
+ * pld_get_pci_slot() - Get PCI slot of attached device
+ * @dev: device
+ *
+ * Return: pci slot
+ */
 int pld_get_pci_slot(struct device *dev);
+
+/**
+ * pld_power_on() - Power on WLAN hardware
+ * @dev: device
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_power_on(struct device *dev);
+
+/**
+ * pld_power_off() - Power off WLAN hardware
+ * @dev: device
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_power_off(struct device *dev);
+
+/**
+ * pld_athdiag_read() - Read data from WLAN FW
+ * @dev: device
+ * @offset: address offset
+ * @memtype: memory type
+ * @datalen: data length
+ * @output: output buffer
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_athdiag_read(struct device *dev, uint32_t offset, uint32_t memtype,
 		     uint32_t datalen, uint8_t *output);
+
+/**
+ * pld_athdiag_write() - Write data to WLAN FW
+ * @dev: device
+ * @offset: address offset
+ * @memtype: memory type
+ * @datalen: data length
+ * @input: input buffer
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_athdiag_write(struct device *dev, uint32_t offset, uint32_t memtype,
 		      uint32_t datalen, uint8_t *input);
+
 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4, 19, 0))
+/**
+ * pld_smmu_get_domain() - Get SMMU domain
+ * @dev: device
+ *
+ * Return: Pointer to the domain
+ */
 void *pld_smmu_get_domain(struct device *dev);
 #else
+/**
+ * pld_smmu_get_mapping() - Get SMMU mapping context
+ * @dev: device
+ *
+ * Return: Pointer to the mapping context
+ */
 void *pld_smmu_get_mapping(struct device *dev);
 #endif
+
+/**
+ * pld_smmu_map() - Map SMMU
+ * @dev: device
+ * @paddr: physical address that needs to map to
+ * @iova_addr: IOVA address
+ * @size: size to be mapped
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_smmu_map(struct device *dev, phys_addr_t paddr,
 		 uint32_t *iova_addr, size_t size);
+
 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(5, 15, 0))
 struct kobject *pld_get_wifi_kobj(struct device *dev);
 #else
@@ -913,6 +1412,16 @@ static inline struct kobject *pld_get_wifi_kobj(struct device *dev)
 	return NULL;
 }
 #endif
+
+/**
+ * pld_smmu_unmap() - Unmap SMMU
+ * @dev: device
+ * @iova_addr: IOVA address to be unmapped
+ * @size: size to be unmapped
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 #ifdef CONFIG_SMMU_S1_UNMAP
 int pld_smmu_unmap(struct device *dev,
 		   uint32_t iova_addr, size_t size);
@@ -923,25 +1432,182 @@ static inline int pld_smmu_unmap(struct device *dev,
 	return 0;
 }
 #endif
+
+/**
+ * pld_get_user_msi_assignment() - Get MSI assignment information
+ * @dev: device structure
+ * @user_name: name of the user who requests the MSI assignment
+ * @num_vectors: number of the MSI vectors assigned for the user
+ * @user_base_data: MSI base data assigned for the user, this equals to
+ *                  endpoint base data from config space plus base vector
+ * @base_vector: base MSI vector (offset) number assigned for the user
+ *
+ * Return: 0 for success
+ *         Negative failure code for errors
+ */
 int pld_get_user_msi_assignment(struct device *dev, char *user_name,
 				int *num_vectors, uint32_t *user_base_data,
 				uint32_t *base_vector);
+
+/**
+ * pld_get_msi_irq() - Get MSI IRQ number used for request_irq()
+ * @dev: device structure
+ * @vector: MSI vector (offset) number
+ *
+ * Return: Positive IRQ number for success
+ *         Negative failure code for errors
+ */
 int pld_get_msi_irq(struct device *dev, unsigned int vector);
+
+/**
+ * pld_get_msi_address() - Get the MSI address
+ * @dev: device structure
+ * @msi_addr_low: lower 32-bit of the address
+ * @msi_addr_high: higher 32-bit of the address
+ *
+ * Return: Void
+ */
 void pld_get_msi_address(struct device *dev, uint32_t *msi_addr_low,
 			 uint32_t *msi_addr_high);
+
+/**
+ * pld_is_drv_connected() - Check if DRV subsystem is connected
+ * @dev: device structure
+ *
+ *  Return: 1 DRV is connected
+ *          0 DRV is not connected
+ *          Non zero failure code for errors
+ */
 int pld_is_drv_connected(struct device *dev);
+
+/**
+ * pld_socinfo_get_serial_number() - Get SOC serial number
+ * @dev: device
+ *
+ * Return: SOC serial number
+ */
 unsigned int pld_socinfo_get_serial_number(struct device *dev);
+
+/**
+ * pld_is_qmi_disable() - Check QMI support is present or not
+ * @dev: device
+ *
+ *  Return: 1 QMI is not supported
+ *          0 QMI is supported
+ *          Non zero failure code for errors
+ */
 int pld_is_qmi_disable(struct device *dev);
+
+/**
+ * pld_is_fw_down() - Check WLAN fw is down or not
+ *
+ * @dev: device
+ *
+ * This API will be called to check if WLAN FW is down or not.
+ *
+ *  Return: 0 FW is not down
+ *          Otherwise FW is down
+ *          Always return 0 for unsupported bus type
+ */
 int pld_is_fw_down(struct device *dev);
+
+/**
+ * pld_force_assert_target() - Send a force assert request to FW.
+ * @dev: device pointer
+ *
+ * This can use various sideband requests available at platform driver to
+ * initiate a FW assert.
+ *
+ * Context: Any context
+ * Return:
+ * 0 - force assert of FW is triggered successfully.
+ * -EOPNOTSUPP - force assert is not supported.
+ * Other non-zero codes - other failures or errors
+ */
 int pld_force_assert_target(struct device *dev);
+
+/**
+ * pld_force_collect_target_dump() - Collect FW dump after asserting FW.
+ * @dev: device pointer
+ *
+ * This API will send force assert request to FW and wait till FW dump has
+ * been collected.
+ *
+ * Context: Process context only since this is a blocking call.
+ * Return:
+ * 0 - FW dump is collected successfully.
+ * -EOPNOTSUPP - forcing assert and collecting FW dump is not supported.
+ * -ETIMEDOUT - FW dump collection is timed out for any reason.
+ * Other non-zero codes - other failures or errors
+ */
 int pld_force_collect_target_dump(struct device *dev);
+
+/**
+ * pld_qmi_send_get() - Indicate certain data to be sent over QMI
+ * @dev: device pointer
+ *
+ * This API can be used to indicate certain data to be sent over QMI.
+ * pld_qmi_send() is expected to be called later.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_qmi_send_get(struct device *dev);
+
+/**
+ * pld_qmi_send_put() - Indicate response sent over QMI has been processed
+ * @dev: device pointer
+ *
+ * This API can be used to indicate response of the data sent over QMI has
+ * been processed.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_qmi_send_put(struct device *dev);
+
+/**
+ * pld_qmi_send() - Send data request over QMI
+ * @dev: device pointer
+ * @type: type of the send data operation
+ * @cmd: buffer pointer of send data request command
+ * @cmd_len: size of the command buffer
+ * @cb_ctx: context pointer if any to pass back in callback
+ * @cb: callback pointer to pass response back
+ *
+ * This API can be used to send data request over QMI.
+ *
+ * Return: 0 if data request sends successfully
+ *         Non zero failure code for errors
+ */
 int pld_qmi_send(struct device *dev, int type, void *cmd,
 		 int cmd_len, void *cb_ctx,
 		 int (*cb)(void *ctx, void *event, int event_len));
+
+/**
+ * pld_is_fw_dump_skipped() - get fw dump skipped status.
+ * @dev: device
+ *
+ * The subsys ssr status help the driver to decide whether to skip
+ * the FW memory dump when FW assert.
+ * For SDIO case, the memory dump progress takes 1 minutes to
+ * complete, which is not acceptable in SSR enabled.
+ *
+ * Return: true if need to skip FW dump.
+ */
 bool pld_is_fw_dump_skipped(struct device *dev);
 
+/**
+ * pld_is_low_power_mode() - Check WLAN fw is in low power
+ * @dev: device
+ *
+ * This API will be called to check if WLAN FW is in low power or not.
+ * Low power means either Deep Sleep or Hibernate state.
+ *
+ * Return: 0 FW is not in low power mode
+ *         Otherwise FW is low power mode
+ *         Always return 0 for unsupported bus type
+ */
 #ifdef CONFIG_ENABLE_LOW_POWER_MODE
 int pld_is_low_power_mode(struct device *dev);
 #else
@@ -953,6 +1619,7 @@ static inline int pld_is_low_power_mode(struct device *dev)
 
 /**
  * pld_is_pdr() - Check WLAN PD is Restarted
+ * @dev: device
  *
  * Help the driver decide whether FW down is due to
  * WLAN PD Restart.
@@ -964,6 +1631,7 @@ int pld_is_pdr(struct device *dev);
 
 /**
  * pld_is_fw_rejuvenate() - Check WLAN fw is rejuvenating
+ * @dev: device
  *
  * Help the driver decide whether FW down is due to
  * SSR or FW rejuvenate.
@@ -1175,7 +1843,8 @@ int pld_get_thermal_state(struct device *dev, unsigned long *thermal_state,
  */
 int pld_is_ipa_offload_disabled(struct device *dev);
 #else
-int pld_is_ipa_offload_disabled(struct device *dev);
+static inline
+int pld_is_ipa_offload_disabled(struct device *dev)
 {
 	return 0;
 }

core/pld/src/pld_internal.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2018-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -37,10 +37,34 @@ struct pld_context {
 	uint8_t mode;
 };
 
+/**
+ * pld_get_global_context() - Get global context of PLD
+ *
+ * Return: PLD global context
+ */
 struct pld_context *pld_get_global_context(void);
+
+/**
+ * pld_add_dev() - Add dev node to global context
+ * @pld_context: PLD global context
+ * @dev: device
+ * @ifdev: interface device
+ * @type: Bus type
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_add_dev(struct pld_context *pld_context,
 		struct device *dev, struct device *ifdev,
 		enum pld_bus_type type);
+
+/**
+ * pld_del_dev() - Delete dev node from global context
+ * @pld_context: PLD global context
+ * @dev: device
+ *
+ * Return: void
+ */
 void pld_del_dev(struct pld_context *pld_context,
 		 struct device *dev);
 

core/pld/src/pld_ipci.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -182,7 +182,7 @@ static int pld_ipci_pm_suspend(struct device *dev)
 
 /**
  * pld_ipci_pm_resume() - PM resume callback function for power management
- * @pdev: device
+ * @dev: device
  *
  * This function is to resume the platform device when power management
  * is enabled.
@@ -224,7 +224,7 @@ static int pld_ipci_suspend_noirq(struct device *dev)
 
 /**
  * pld_ipci_resume_noirq() - Prepare for the execution of resume()
- * @pdev: device
+ * @dev: device
  *
  * Prepare for the execution of resume() by carrying out any
  * operations required for resuming the device that might be racing with
@@ -274,7 +274,7 @@ static int pld_ipci_runtime_suspend(struct device *dev)
 
 /**
  * pld_ipci_runtime_resume() - Runtime resume callback for power management
- * @pdev: device
+ * @dev: device
  *
  * This function is to runtime resume the platform device when power management
  * is enabled.
@@ -399,7 +399,7 @@ out:
 
 /**
  * pld_ipci_idle_restart_cb() - Perform idle restart
- * @pdev: platform device
+ * @dev: platform device
  *
  * This function will be called if there is an idle restart request
  *
@@ -423,8 +423,7 @@ static int pld_ipci_idle_restart_cb(struct device *dev)
 
 /**
  * pld_ipci_idle_shutdown_cb() - Perform idle shutdown
- * @pdev: PCIE device
- * @id: PCIE device ID
+ * @dev: PCIE device
  *
  * This function will be called if there is an idle shutdown request
  *
@@ -511,40 +510,16 @@ struct icnss_driver_ops pld_ipci_ops = {
 	.set_therm_cdev_state = pld_ipci_set_thermal_state,
 };
 
-/**
- * pld_ipci_register_driver() - Register platform device callback functions
- *
- * Return: int
- */
 int pld_ipci_register_driver(void)
 {
 	return icnss_register_driver(&pld_ipci_ops);
 }
 
-/**
- * pld_ipci_unregister_driver() - Unregister platform device callback functions
- *
- * Return: void
- */
 void pld_ipci_unregister_driver(void)
 {
 	icnss_unregister_driver(&pld_ipci_ops);
 }
 
-/**
- * pld_ipci_wlan_enable() - Enable WLAN
- * @dev: device
- * @config: WLAN configuration data
- * @mode: WLAN mode
- * @host_version: host software version
- *
- * This function enables WLAN FW. It passed WLAN configuration data,
- * WLAN mode and host software version to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
-
 int pld_ipci_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version)
 {
@@ -589,16 +564,6 @@ int pld_ipci_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 	return icnss_wlan_enable(dev, &cfg, icnss_mode, host_version);
 }
 
-/**
- * pld_ipci_wlan_disable() - Disable WLAN
- * @dev: device
- * @mode: WLAN mode
- *
- * This function disables WLAN FW. It passes WLAN mode to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_ipci_wlan_disable(struct device *dev, enum pld_driver_mode mode)
 {
 	if (!dev)
@@ -607,16 +572,6 @@ int pld_ipci_wlan_disable(struct device *dev, enum pld_driver_mode mode)
 	return icnss_wlan_disable(dev, ICNSS_OFF);
 }
 
-/**
- * pld_ipci_get_soc_info() - Get SOC information
- * @dev: device
- * @info: buffer to SOC information
- *
- * Return SOC info to the buffer.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_ipci_get_soc_info(struct device *dev, struct pld_soc_info *info)
 {
 	int errno;

core/pld/src/pld_ipci.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -211,12 +211,59 @@ static inline int pld_ipci_is_pci_ep_awake(struct device *dev)
 	return 0;
 }
 #else
+/**
+ * pld_ipci_register_driver() - Register platform device callback functions
+ *
+ * Return: int
+ */
 int pld_ipci_register_driver(void);
+
+/**
+ * pld_ipci_unregister_driver() - Unregister platform device callback functions
+ *
+ * Return: void
+ */
 void pld_ipci_unregister_driver(void);
+
+/**
+ * pld_ipci_wlan_enable() - Enable WLAN
+ * @dev: device
+ * @config: WLAN configuration data
+ * @mode: WLAN mode
+ * @host_version: host software version
+ *
+ * This function enables WLAN FW. It passed WLAN configuration data,
+ * WLAN mode and host software version to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_ipci_wlan_enable(struct device *dev,
 			 struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version);
+
+/**
+ * pld_ipci_wlan_disable() - Disable WLAN
+ * @dev: device
+ * @mode: WLAN mode
+ *
+ * This function disables WLAN FW. It passes WLAN mode to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_ipci_wlan_disable(struct device *dev, enum pld_driver_mode mode);
+
+/**
+ * pld_ipci_get_soc_info() - Get SOC information
+ * @dev: device
+ * @info: buffer to SOC information
+ *
+ * Return SOC info to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_ipci_get_soc_info(struct device *dev, struct pld_soc_info *info);
 
 static inline int pld_ipci_power_on(struct device *dev)

core/pld/src/pld_pcie.c

@@ -146,7 +146,6 @@ static int pld_pcie_idle_restart_cb(struct pci_dev *pdev,
 /**
  * pld_pcie_idle_shutdown_cb() - Perform idle shutdown
  * @pdev: PCIE device
- * @id: PCIE device ID
  *
  * This function will be called if there is an idle shutdown request
  *
@@ -244,7 +243,7 @@ static void pld_pcie_notify_handler(struct pci_dev *pdev, int state)
 /**
  * pld_pcie_uevent() - update wlan driver status callback function
  * @pdev: PCIE device
- * @status driver uevent status
+ * @status: driver uevent status
  *
  * This function will be called when platform driver wants to update wlan
  * driver's status.
@@ -330,7 +329,7 @@ enum pld_bus_event pld_bus_event_type_convert(enum cnss_bus_event_type etype)
 /**
  * pld_pcie_update_event() - update wlan driver status callback function
  * @pdev: PCIE device
- * @cnss_uevent_data: driver uevent data
+ * @uevent_data: driver uevent data
  *
  * This function will be called when platform driver wants to update wlan
  * driver's status.
@@ -728,21 +727,11 @@ struct cnss_wlan_driver pld_pcie_ops = {
 #endif
 };
 
-/**
- * pld_pcie_register_driver() - Register PCIE device callback functions
- *
- * Return: int
- */
 int pld_pcie_register_driver(void)
 {
 	return cnss_wlan_register_driver(&pld_pcie_ops);
 }
 
-/**
- * pld_pcie_unregister_driver() - Unregister PCIE device callback functions
- *
- * Return: void
- */
 void pld_pcie_unregister_driver(void)
 {
 	cnss_wlan_unregister_driver(&pld_pcie_ops);
@@ -779,13 +768,6 @@ void pld_pcie_unregister_driver(void)
 }
 #endif
 
-/**
- * pld_pcie_get_ce_id() - Get CE number for the provided IRQ
- * @dev: device
- * @irq: IRQ number
- *
- * Return: CE number
- */
 int pld_pcie_get_ce_id(struct device *dev, int irq)
 {
 	int ce_id = irq - 100;
@@ -813,19 +795,6 @@ pld_pcie_populate_shadow_v3_cfg(struct cnss_wlan_enable_cfg *cfg,
 {
 }
 #endif
-/**
- * pld_pcie_wlan_enable() - Enable WLAN
- * @dev: device
- * @config: WLAN configuration data
- * @mode: WLAN mode
- * @host_version: host software version
- *
- * This function enables WLAN FW. It passed WLAN configuration data,
- * WLAN mode and host software version to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_pcie_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version)
 {
@@ -868,33 +837,11 @@ int pld_pcie_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 	return cnss_wlan_enable(dev, &cfg, cnss_mode, host_version);
 }
 
-/**
- * pld_pcie_wlan_disable() - Disable WLAN
- * @dev: device
- * @mode: WLAN mode
- *
- * This function disables WLAN FW. It passes WLAN mode to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_pcie_wlan_disable(struct device *dev, enum pld_driver_mode mode)
 {
 	return cnss_wlan_disable(dev, CNSS_OFF);
 }
 
-/**
- * pld_pcie_get_fw_files_for_target() - Get FW file names
- * @dev: device
- * @pfw_files: buffer for FW file names
- * @target_type: target type
- * @target_version: target version
- *
- * Return target specific FW file names to the buffer.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_pcie_get_fw_files_for_target(struct device *dev,
 				     struct pld_fw_files *pfw_files,
 				     u32 target_type, u32 target_version)
@@ -930,16 +877,6 @@ int pld_pcie_get_fw_files_for_target(struct device *dev,
 	return 0;
 }
 
-/**
- * pld_pcie_get_platform_cap() - Get platform capabilities
- * @dev: device
- * @cap: buffer to the capabilities
- *
- * Return capabilities to the buffer.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_pcie_get_platform_cap(struct device *dev, struct pld_platform_cap *cap)
 {
 	int ret = 0;
@@ -956,16 +893,6 @@ int pld_pcie_get_platform_cap(struct device *dev, struct pld_platform_cap *cap)
 	return 0;
 }
 
-/**
- * pld_pcie_get_soc_info() - Get SOC information
- * @dev: device
- * @info: buffer to SOC information
- *
- * Return SOC info to the buffer.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_pcie_get_soc_info(struct device *dev, struct pld_soc_info *info)
 {
 	int ret = 0, i;
@@ -1005,13 +932,6 @@ int pld_pcie_get_soc_info(struct device *dev, struct pld_soc_info *info)
 	return 0;
 }
 
-/**
- * pld_pcie_schedule_recovery_work() - schedule recovery work
- * @dev: device
- * @reason: recovery reason
- *
- * Return: void
- */
 void pld_pcie_schedule_recovery_work(struct device *dev,
 				     enum pld_recovery_reason reason)
 {
@@ -1028,13 +948,6 @@ void pld_pcie_schedule_recovery_work(struct device *dev,
 	cnss_schedule_recovery(dev, cnss_reason);
 }
 
-/**
- * pld_pcie_device_self_recovery() - device self recovery
- * @dev: device
- * @reason: recovery reason
- *
- * Return: void
- */
 void pld_pcie_device_self_recovery(struct device *dev,
 				   enum pld_recovery_reason reason)
 {

core/pld/src/pld_pcie.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -57,8 +57,27 @@ static inline int pld_pcie_get_ce_id(struct device *dev, int irq)
 	return 0;
 }
 #else
+/**
+ * pld_pcie_register_driver() - Register PCIE device callback functions
+ *
+ * Return: int
+ */
 int pld_pcie_register_driver(void);
+
+/**
+ * pld_pcie_unregister_driver() - Unregister PCIE device callback functions
+ *
+ * Return: void
+ */
 void pld_pcie_unregister_driver(void);
+
+/**
+ * pld_pcie_get_ce_id() - Get CE number for the provided IRQ
+ * @dev: device
+ * @irq: IRQ number
+ *
+ * Return: CE number
+ */
 int pld_pcie_get_ce_id(struct device *dev, int irq);
 #endif
 
@@ -83,9 +102,35 @@ static inline int pld_pcie_wlan_hw_enable(void)
 }
 
 #else
+
+/**
+ * pld_pcie_wlan_enable() - Enable WLAN
+ * @dev: device
+ * @config: WLAN configuration data
+ * @mode: WLAN mode
+ * @host_version: host software version
+ *
+ * This function enables WLAN FW. It passed WLAN configuration data,
+ * WLAN mode and host software version to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_pcie_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version);
+
+/**
+ * pld_pcie_wlan_disable() - Disable WLAN
+ * @dev: device
+ * @mode: WLAN mode
+ *
+ * This function disables WLAN FW. It passes WLAN mode to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_pcie_wlan_disable(struct device *dev, enum pld_driver_mode mode);
+
 #ifdef FEATURE_CNSS_HW_SECURE_DISABLE
 static inline int pld_pcie_wlan_hw_enable(void)
 {
@@ -468,13 +513,63 @@ static inline int pld_pcie_set_wfc_mode(struct device *dev,
 }
 #endif
 
+/**
+ * pld_pcie_get_fw_files_for_target() - Get FW file names
+ * @dev: device
+ * @pfw_files: buffer for FW file names
+ * @target_type: target type
+ * @target_version: target version
+ *
+ * Return target specific FW file names to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_pcie_get_fw_files_for_target(struct device *dev,
 				     struct pld_fw_files *pfw_files,
 				     u32 target_type, u32 target_version);
+
+/**
+ * pld_pcie_get_platform_cap() - Get platform capabilities
+ * @dev: device
+ * @cap: buffer to the capabilities
+ *
+ * Return capabilities to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_pcie_get_platform_cap(struct device *dev, struct pld_platform_cap *cap);
+
+/**
+ * pld_pcie_get_soc_info() - Get SOC information
+ * @dev: device
+ * @info: buffer to SOC information
+ *
+ * Return SOC info to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_pcie_get_soc_info(struct device *dev, struct pld_soc_info *info);
+
+/**
+ * pld_pcie_schedule_recovery_work() - schedule recovery work
+ * @dev: device
+ * @reason: recovery reason
+ *
+ * Return: void
+ */
 void pld_pcie_schedule_recovery_work(struct device *dev,
 				     enum pld_recovery_reason reason);
+
+/**
+ * pld_pcie_device_self_recovery() - device self recovery
+ * @dev: device
+ * @reason: recovery reason
+ *
+ * Return: void
+ */
 void pld_pcie_device_self_recovery(struct device *dev,
 				   enum pld_recovery_reason reason);
 static inline int pld_pcie_collect_rddm(struct device *dev)

core/pld/src/pld_pcie_fw_sim.c

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -129,7 +130,6 @@ static int pld_pcie_fw_sim_idle_restart_cb(struct pci_dev *pdev,
 /**
  * pld_pcie_fw_sim_idle_shutdown_cb() - Perform idle shutdown
  * @pdev: PCIE device
- * @id: PCIE device ID
  *
  * This function will be called if there is an idle shutdown request
  *
@@ -229,7 +229,7 @@ static void pld_pcie_fw_sim_notify_handler(struct pci_dev *pdev, int state)
 /**
  * pld_pcie_fw_sim_uevent() - update wlan driver status callback function
  * @pdev: PCIE device
- * @status driver uevent status
+ * @status: driver uevent status
  *
  * This function will be called when platform driver wants to update wlan
  * driver's status.
@@ -405,7 +405,6 @@ static int pld_pcie_fw_sim_idle_restart_cb(struct pci_dev *pdev,
 /**
  * pld_pcie_fw_sim_idle_shutdown_cb() - Perform idle shutdown
  * @pdev: PCIE device
- * @id: PCIE device ID
  *
  * This function will be called if there is an idle shutdown request
  *
@@ -505,7 +504,7 @@ static void pld_pcie_fw_sim_notify_handler(struct pci_dev *pdev, int state)
 /**
  * pld_pcie_fw_sim_uevent() - update wlan driver status callback function
  * @pdev: PCIE device
- * @status driver uevent status
+ * @status: driver uevent status
  *
  * This function will be called when platform driver wants to update wlan
  * driver's status.

core/pld/src/pld_sdio.c

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -66,7 +67,7 @@ static const struct pld_fw_files fw_files_default = {
 
 /**
  * pld_sdio_probe() - Probe function for SDIO platform driver
- * sdio_func: pointer to sdio device function
+ * @sdio_func: pointer to sdio device function
  * @id: SDIO device ID table
  *
  * The probe function will be called when SDIO device provided
@@ -377,39 +378,16 @@ struct cnss_sdio_wlan_driver pld_sdio_ops = {
 #endif
 };
 
-/**
- * pld_sdio_register_driver() - Register SDIO device callback functions
- *
- * Return: int
- */
 int pld_sdio_register_driver(void)
 {
 	return cnss_sdio_wlan_register_driver(&pld_sdio_ops);
 }
 
-/**
- * pld_sdio_unregister_driver() - Unregister SDIO device callback functions
- *
- * Return: void
- */
 void pld_sdio_unregister_driver(void)
 {
 	cnss_sdio_wlan_unregister_driver(&pld_sdio_ops);
 }
 
-/**
- * pld_sdio_wlan_enable() - Enable WLAN
- * @dev: device
- * @config: NA
- * @mode: WLAN mode
- * @host_version: host software version
- *
- * This function enables WLAN FW. It passed
- * WLAN mode and host software version to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_sdio_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version)
 {
@@ -475,17 +453,6 @@ static inline int pld_sdio_is_tufello_dual_fw_supported(void)
 #endif
 }
 
-/**
- * pld_sdio_get_fw_files_for_target() - Get FW file names
- * @pfw_files: buffer for FW file names
- * @target_type: target type
- * @target_version: target version
- *
- * Return target specific FW file names to the buffer.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_sdio_get_fw_files_for_target(struct pld_fw_files *pfw_files,
 				     u32 target_type, u32 target_version)
 {

core/pld/src/pld_sdio.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2019 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -76,8 +77,31 @@ static inline uint8_t *pld_sdio_get_wlan_mac_address(struct device *dev,
 	return NULL;
 }
 #else
+/**
+ * pld_sdio_register_driver() - Register SDIO device callback functions
+ *
+ * Return: int
+ */
 int pld_sdio_register_driver(void);
+
+/**
+ * pld_sdio_unregister_driver() - Unregister SDIO device callback functions
+ *
+ * Return: void
+ */
 void pld_sdio_unregister_driver(void);
+
+/**
+ * pld_sdio_get_fw_files_for_target() - Get FW file names
+ * @pfw_files: buffer for FW file names
+ * @target_type: target type
+ * @target_version: target version
+ *
+ * Return target specific FW file names to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_sdio_get_fw_files_for_target(struct pld_fw_files *pfw_files,
 				     u32 target_type, u32 target_version);
 #ifdef CONFIG_CNSS
@@ -245,6 +269,19 @@ struct sdio_al_channel_handle *ch_handle
 	cnss_sdio_wlan_unregister_sdio_al_channel(ch_handle);
 }
 
+/**
+ * pld_sdio_wlan_enable() - Enable WLAN
+ * @dev: device
+ * @config: NA
+ * @mode: WLAN mode
+ * @host_version: host software version
+ *
+ * This function enables WLAN FW. It passed
+ * WLAN mode and host software version to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_sdio_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version);
 #else

core/pld/src/pld_snoc.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -50,7 +50,7 @@
 
 /**
  * pld_snoc_idle_restart_cb() - Perform idle restart
- * @pdev: platform device
+ * @dev: platform device
  *
  * This function will be called if there is an idle restart request
  *
@@ -69,8 +69,7 @@ static int pld_snoc_idle_restart_cb(struct device *dev)
 
 /**
  * pld_snoc_idle_shutdown_cb() - Perform idle shutdown
- * @pdev: PCIE device
- * @id: PCIE device ID
+ * @dev: PCIE device
  *
  * This function will be called if there is an idle shutdown request
  *
@@ -231,7 +230,7 @@ static int pld_snoc_pm_suspend(struct device *dev)
 
 /**
  * pld_snoc_pm_resume() - PM resume callback function for power management
- * @pdev: device
+ * @dev: device
  *
  * This function is to resume the platform device when power management
  * is enabled.
@@ -273,7 +272,7 @@ static int pld_snoc_suspend_noirq(struct device *dev)
 
 /**
  * pld_snoc_resume_noirq() - Prepare for the execution of resume()
- * @pdev: device
+ * @dev: device
  *
  * Prepare for the execution of resume() by carrying out any
  * operations required for resuming the device that might be racing with
@@ -424,40 +423,16 @@ struct icnss_driver_ops pld_snoc_ops = {
 	.idle_shutdown = pld_snoc_idle_shutdown_cb,
 };
 
-/**
- * pld_snoc_register_driver() - Register platform device callback functions
- *
- * Return: int
- */
 int pld_snoc_register_driver(void)
 {
 	return icnss_register_driver(&pld_snoc_ops);
 }
 
-/**
- * pld_snoc_unregister_driver() - Unregister platform device callback functions
- *
- * Return: void
- */
 void pld_snoc_unregister_driver(void)
 {
 	icnss_unregister_driver(&pld_snoc_ops);
 }
 
-/**
- * pld_snoc_wlan_enable() - Enable WLAN
- * @dev: device
- * @config: WLAN configuration data
- * @mode: WLAN mode
- * @host_version: host software version
- *
- * This function enables WLAN FW. It passed WLAN configuration data,
- * WLAN mode and host software version to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
-
 int pld_snoc_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version)
 {
@@ -492,16 +467,6 @@ int pld_snoc_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 	return icnss_wlan_enable(dev, &cfg, icnss_mode, host_version);
 }
 
-/**
- * pld_snoc_wlan_disable() - Disable WLAN
- * @dev: device
- * @mode: WLAN mode
- *
- * This function disables WLAN FW. It passes WLAN mode to FW.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_snoc_wlan_disable(struct device *dev, enum pld_driver_mode mode)
 {
 	if (!dev)
@@ -510,16 +475,6 @@ int pld_snoc_wlan_disable(struct device *dev, enum pld_driver_mode mode)
 	return icnss_wlan_disable(dev, ICNSS_OFF);
 }
 
-/**
- * pld_snoc_get_soc_info() - Get SOC information
- * @dev: device
- * @info: buffer to SOC information
- *
- * Return SOC info to the buffer.
- *
- * Return: 0 for success
- *         Non zero failure code for errors
- */
 int pld_snoc_get_soc_info(struct device *dev, struct pld_soc_info *info)
 {
 	int errno;

core/pld/src/pld_snoc.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -206,12 +206,59 @@ pld_snoc_get_audio_wlan_timestamp(struct device *dev,
 #endif /* FEATURE_WLAN_TIME_SYNC_FTM */
 
 #else
+/**
+ * pld_snoc_register_driver() - Register platform device callback functions
+ *
+ * Return: int
+ */
 int pld_snoc_register_driver(void);
+
+/**
+ * pld_snoc_unregister_driver() - Unregister platform device callback functions
+ *
+ * Return: void
+ */
 void pld_snoc_unregister_driver(void);
+
+/**
+ * pld_snoc_wlan_enable() - Enable WLAN
+ * @dev: device
+ * @config: WLAN configuration data
+ * @mode: WLAN mode
+ * @host_version: host software version
+ *
+ * This function enables WLAN FW. It passed WLAN configuration data,
+ * WLAN mode and host software version to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_snoc_wlan_enable(struct device *dev,
 			 struct pld_wlan_enable_cfg *config,
 			 enum pld_driver_mode mode, const char *host_version);
+
+/**
+ * pld_snoc_wlan_disable() - Disable WLAN
+ * @dev: device
+ * @mode: WLAN mode
+ *
+ * This function disables WLAN FW. It passes WLAN mode to FW.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_snoc_wlan_disable(struct device *dev, enum pld_driver_mode mode);
+
+/**
+ * pld_snoc_get_soc_info() - Get SOC information
+ * @dev: device
+ * @info: buffer to SOC information
+ *
+ * Return SOC info to the buffer.
+ *
+ * Return: 0 for success
+ *         Non zero failure code for errors
+ */
 int pld_snoc_get_soc_info(struct device *dev, struct pld_soc_info *info);
 
 #ifdef FEATURE_WLAN_TIME_SYNC_FTM

core/pld/src/pld_snoc_fw_sim.c

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -156,7 +157,7 @@ static int pld_snoc_fw_sim_pm_suspend(struct device *dev)
 
 /**
  * pld_snoc_fw_sim_pm_resume() -PM resume callback function for power management
- * @pdev: device
+ * @dev: device
  *
  * This function is to resume the platform device when power management
  * is enabled.
@@ -199,7 +200,7 @@ static int pld_snoc_fw_sim_suspend_noirq(struct device *dev)
 
 /**
  * pld_snoc_fw_sim_resume_noirq() - Prepare for the execution of resume()
- * @pdev: device
+ * @dev: device
  *
  * Prepare for the execution of resume() by carrying out any
  * operations required for resuming the device that might be racing with

core/pld/src/pld_snoc_fw_sim.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2019 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the

core/pld/src/pld_usb.c

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -45,7 +46,7 @@ atomic_t pld_usb_reg_done;
  * pld_usb_probe() - pld_usb_probe
  * @interface: pointer to usb_interface structure
  * @id: pointer to usb_device_id obtained from the enumerated device
-
+ *
  * Return: int 0 on success and errno on failure.
  */
 static int pld_usb_probe(struct usb_interface *interface,
@@ -215,7 +216,7 @@ static void pld_usb_shutdown(struct usb_interface *interface)
 /**
  * pld_usb_uevent() - update wlan driver status callback function
  * @interface: USB interface
- * @status driver uevent status
+ * @status: driver uevent status
  *
  * This function will be called when platform driver wants to update wlan
  * driver's status.
@@ -264,22 +265,12 @@ struct cnss_usb_wlan_driver pld_usb_ops = {
 #endif
 };
 
-/**
- * pld_usb_register_driver() - registration routine for wlan usb drive
- *
- * Return: int negative error code on failure and 0 on success
- */
 int pld_usb_register_driver(void)
 {
 	pr_info("%s usb_register\n", __func__);
 	return cnss_usb_wlan_register_driver(&pld_usb_ops);
 }
 
-/**
- * pld_usb_unregister_driver() - de-registration routine for wlan usb driver
- *
- * Return: void
- */
 void pld_usb_unregister_driver(void)
 {
 	cnss_usb_wlan_unregister_driver(&pld_usb_ops);
@@ -340,11 +331,6 @@ struct usb_driver pld_usb_ops = {
 	.supports_autosuspend = true,
 };
 
-/**
- * pld_usb_register_driver() - registration routine for wlan usb driver
- *
- * Return: int negative error code on failure and 0 on success
- */
 int pld_usb_register_driver(void)
 {
 	int status;
@@ -364,11 +350,6 @@ int pld_usb_register_driver(void)
 	return status;
 }
 
-/**
- * pld_usb_unregister_driver() - de-registration routine for wlan usb driver
- *
- * Return: void
- */
 void pld_usb_unregister_driver(void)
 {
 	struct pld_context *pld_context;

core/pld/src/pld_usb.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  *
  * Permission to use, copy, modify, and/or distribute this software for
  * any purpose with or without fee is hereby granted, provided that the
@@ -21,12 +22,25 @@
 #include "pld_common.h"
 
 #ifdef HIF_USB
+/**
+ * pld_usb_register_driver() - registration routine for wlan usb drive
+ *
+ * Return: int negative error code on failure and 0 on success
+ */
 int pld_usb_register_driver(void);
+
+/**
+ * pld_usb_unregister_driver() - de-registration routine for wlan usb driver
+ *
+ * Return: void
+ */
 void pld_usb_unregister_driver(void);
+
 int pld_usb_get_ce_id(int irq);
 int pld_usb_wlan_enable(struct device *dev, struct pld_wlan_enable_cfg *config,
 			enum pld_driver_mode mode, const char *host_version);
 int pld_usb_is_fw_down(struct device *dev);
+
 /**
  * pld_usb_athdiag_read() - Read data from WLAN FW through USB interface
  * @dev: pointer of device
@@ -41,13 +55,14 @@ int pld_usb_is_fw_down(struct device *dev);
 int pld_usb_athdiag_read(struct device *dev, uint32_t offset,
 			 uint32_t memtype, uint32_t datalen,
 			 uint8_t *output);
+
 /**
  * pld_usb_athdiag_write() - Write data to WLAN FW through USB interface
  * @dev: pointer of device
  * @offset: address offset
  * @memtype: memory type
  * @datalen: data length
- * @output: pointer of input buffer
+ * @input: pointer of input buffer
  *
  * Return: 0 for success
  *         Non zero failure code for errors