Commit 7b6560b4 authored by Ben Dooks (Codethink)'s avatar Ben Dooks (Codethink) Committed by Tony Lindgren

OMAP2: fixup doc comments in omap_device

The documentation comments in this file are out of
date with the code, so fix this to avoid the
following warnings:

arch/arm/mach-omap2/omap_device.c:133: warning: Function parameter or member 'pdev' not described in 'omap_device_build_from_dt'
arch/arm/mach-omap2/omap_device.c:133: warning: Excess function parameter 'pdev_name' description in 'omap_device_build_from_dt'
arch/arm/mach-omap2/omap_device.c:133: warning: Excess function parameter 'pdev_id' description in 'omap_device_build_from_dt'
arch/arm/mach-omap2/omap_device.c:133: warning: Excess function parameter 'oh' description in 'omap_device_build_from_dt'
arch/arm/mach-omap2/omap_device.c:133: warning: Excess function parameter 'pdata' description in 'omap_device_build_from_dt'
arch/arm/mach-omap2/omap_device.c:133: warning: Excess function parameter 'pdata_len' description in 'omap_device_build_from_dt'
arch/arm/mach-omap2/omap_device.c:309: warning: Function parameter or member 'pdev' not described in 'omap_device_get_context_loss_count'
arch/arm/mach-omap2/omap_device.c:309: warning: Excess function parameter 'od' description in 'omap_device_get_context_loss_count'
arch/arm/mach-omap2/omap_device.c:335: warning: Function parameter or member 'ohs' not described in 'omap_device_alloc'
arch/arm/mach-omap2/omap_device.c:335: warning: Function parameter or member 'oh_cnt' not described in 'omap_device_alloc'
arch/arm/mach-omap2/omap_device.c:335: warning: Excess function parameter 'oh' description in 'omap_device_alloc'
arch/arm/mach-omap2/omap_device.c:335: warning: Excess function parameter 'pdata' description in 'omap_device_alloc'
arch/arm/mach-omap2/omap_device.c:335: warning: Excess function parameter 'pdata_len' description in 'omap_device_alloc'
arch/arm/mach-omap2/omap_device.c:659: warning: Function parameter or member 'pdev' not described in 'omap_device_register'
arch/arm/mach-omap2/omap_device.c:659: warning: Excess function parameter 'od' description in 'omap_device_register'
arch/arm/mach-omap2/omap_device.c:682: warning: Function parameter or member 'pdev' not described in 'omap_device_enable'
arch/arm/mach-omap2/omap_device.c:682: warning: Excess function parameter 'od' description in 'omap_device_enable'
arch/arm/mach-omap2/omap_device.c:713: warning: Function parameter or member 'pdev' not described in 'omap_device_idle'
arch/arm/mach-omap2/omap_device.c:713: warning: Excess function parameter 'od' description in 'omap_device_idle'
Signed-off-by: default avatarBen Dooks (Codethink) <ben.dooks@codethink.co.uk>
Signed-off-by: default avatarTony Lindgren <tony@atomide.com>
parent f87a2537
...@@ -119,11 +119,7 @@ static void _add_hwmod_clocks_clkdev(struct omap_device *od, ...@@ -119,11 +119,7 @@ static void _add_hwmod_clocks_clkdev(struct omap_device *od,
/** /**
* omap_device_build_from_dt - build an omap_device with multiple hwmods * omap_device_build_from_dt - build an omap_device with multiple hwmods
* @pdev_name: name of the platform_device driver to use * @pdev: The platform device to update.
* @pdev_id: this platform_device's connection ID
* @oh: ptr to the single omap_hwmod that backs this omap_device
* @pdata: platform_data ptr to associate with the platform_device
* @pdata_len: amount of memory pointed to by @pdata
* *
* Function for building an omap_device already registered from device-tree * Function for building an omap_device already registered from device-tree
* *
...@@ -292,7 +288,7 @@ static int _omap_device_idle_hwmods(struct omap_device *od) ...@@ -292,7 +288,7 @@ static int _omap_device_idle_hwmods(struct omap_device *od)
/** /**
* omap_device_get_context_loss_count - get lost context count * omap_device_get_context_loss_count - get lost context count
* @od: struct omap_device * * @pdev: The platform device to update.
* *
* Using the primary hwmod, query the context loss count for this * Using the primary hwmod, query the context loss count for this
* device. * device.
...@@ -321,9 +317,8 @@ int omap_device_get_context_loss_count(struct platform_device *pdev) ...@@ -321,9 +317,8 @@ int omap_device_get_context_loss_count(struct platform_device *pdev)
/** /**
* omap_device_alloc - allocate an omap_device * omap_device_alloc - allocate an omap_device
* @pdev: platform_device that will be included in this omap_device * @pdev: platform_device that will be included in this omap_device
* @oh: ptr to the single omap_hwmod that backs this omap_device * @ohs: ptr to the omap_hwmod for this omap_device
* @pdata: platform_data ptr to associate with the platform_device * @oh_cnt: the size of the ohs list
* @pdata_len: amount of memory pointed to by @pdata
* *
* Convenience function for allocating an omap_device structure and filling * Convenience function for allocating an omap_device structure and filling
* hwmods, and resources. * hwmods, and resources.
...@@ -649,7 +644,7 @@ struct dev_pm_domain omap_device_pm_domain = { ...@@ -649,7 +644,7 @@ struct dev_pm_domain omap_device_pm_domain = {
/** /**
* omap_device_register - register an omap_device with one omap_hwmod * omap_device_register - register an omap_device with one omap_hwmod
* @od: struct omap_device * to register * @pdev: the platform device (omap_device) to register.
* *
* Register the omap_device structure. This currently just calls * Register the omap_device structure. This currently just calls
* platform_device_register() on the underlying platform_device. * platform_device_register() on the underlying platform_device.
...@@ -668,7 +663,7 @@ int omap_device_register(struct platform_device *pdev) ...@@ -668,7 +663,7 @@ int omap_device_register(struct platform_device *pdev)
/** /**
* omap_device_enable - fully activate an omap_device * omap_device_enable - fully activate an omap_device
* @od: struct omap_device * to activate * @pdev: the platform device to activate
* *
* Do whatever is necessary for the hwmods underlying omap_device @od * Do whatever is necessary for the hwmods underlying omap_device @od
* to be accessible and ready to operate. This generally involves * to be accessible and ready to operate. This generally involves
...@@ -702,7 +697,7 @@ int omap_device_enable(struct platform_device *pdev) ...@@ -702,7 +697,7 @@ int omap_device_enable(struct platform_device *pdev)
/** /**
* omap_device_idle - idle an omap_device * omap_device_idle - idle an omap_device
* @od: struct omap_device * to idle * @pdev: The platform_device (omap_device) to idle
* *
* Idle omap_device @od. Device drivers call this function indirectly * Idle omap_device @od. Device drivers call this function indirectly
* via pm_runtime_put*(). Returns -EINVAL if the omap_device is not * via pm_runtime_put*(). Returns -EINVAL if the omap_device is not
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment