qcacld-3.0: Fix wlan_hdd_driver_ops kernel-doc

Currently not all of the wlan_hdd_driver_ops public APIs have their
documentation in the interface (header) file. Update the files so that
the public interface, not the implementation, is documented.

Change-Id: I68a809c9bc2a844232a0f5d07086f924f8ce1ace
CRs-Fixed: 2024274
This commit is contained in:
Jeff Johnson 2017-03-27 07:26:06 -07:00 • committed by Sandeep Puligilla
commit cb6b3bbe7e
2 changed files with 41 additions and 28 deletions

View file

@ -35,7 +35,27 @@
*
* Functions to register the wlan driver.
*/
/**
* wlan_hdd_register_driver() - Register with platform layer
*
* This function is used to register HDD callbacks with the platform
* layer.
*
* Return: 0 if registration is successful, negative errno if
* registration fails
*/
int wlan_hdd_register_driver(void);
/**
* wlan_hdd_unregister_driver() - Unregister from platform layer
*
* This function is used to unregister HDD callbacks from the platform
* layer.
*
* Return: void
*/
void wlan_hdd_unregister_driver(void);
/**
@ -80,7 +100,28 @@ int wlan_hdd_bus_resume(void);
* Return: 0 for success and negative error code for failure
*/
int wlan_hdd_bus_resume_noirq(void);
/**
* hdd_hif_close() - HIF close helper
* @hif_ctx: HIF context
*
* Helper function to close HIF
*/
void hdd_hif_close(void *hif_ctx);
/**
* hdd_hif_open() - HIF open helper
* @dev: wlan device structure
* @bdev: bus device structure
* @bid: bus identifier for shared busses
* @bus_type: underlying bus type
* @reinit: true if we are reinitializing the driver during recovery phase
*
* This function brings-up HIF layer during load/recovery phase.
*
* Return: 0 on success and errno on failure.
*/
int hdd_hif_open(struct device *dev, void *bdev, const hif_bus_id *bid,
enum qdf_bus_type bus_type, bool reinit);
#endif /* __WLAN_HDD_DRIVER_OPS_H__ */

View file

@ -197,18 +197,6 @@ static enum qdf_bus_type to_bus_type(enum pld_bus_type bus_type)
}
}
/**
* hdd_hif_open() - HIF open helper
* @dev: wlan device structure
* @bdev: bus device structure
* @bid: bus identifier for shared busses
* @bus_type: underlying bus type
* @reinit: true if we are reinitializing the driver during recovery phase
*
* This function brings-up HIF layer during load/recovery phase.
*
* Return: 0 on success and errno on failure.
*/
int hdd_hif_open(struct device *dev, void *bdev, const hif_bus_id *bid,
enum qdf_bus_type bus_type, bool reinit)
{
@ -271,12 +259,6 @@ err_hif_close:
return ret;
}
/**
* hdd_hif_close() - HIF close helper
* @hif_ctx: HIF context
*
* Helper function to close HIF
*/
void hdd_hif_close(void *hif_ctx)
{
if (hif_ctx == NULL)
@ -1325,21 +1307,11 @@ struct pld_driver_ops wlan_drv_ops = {
#endif
};
/**
* wlan_hdd_register_driver() - wlan_hdd_register_driver
*
* Return: int
*/
int wlan_hdd_register_driver(void)
{
return pld_register_driver(&wlan_drv_ops);
}
/**
* wlan_hdd_unregister_driver() - wlan_hdd_unregister_driver
*
* Return: void
*/
void wlan_hdd_unregister_driver(void)
{
pld_unregister_driver();