Hi Paull, On Fri, Oct 7, 2011 at 4:53 AM, Paul Walmsley <paul@xxxxxxxxx> wrote: > Hi > > a comment: > > On Wed, 21 Sep 2011, jean.pihet@xxxxxxxxxxxxxx wrote: > >> From: Jean Pihet <j-pihet@xxxxxx> >> >> Hwmod is queried from the OMAP_PM layer to manage the power domains >> wake-up latency constraints. Hwmod retrieves the correct power domain >> and if it exists it calls the corresponding power domain function. >> >> Tested on OMAP3 Beagleboard and OMAP4 Pandaboard in RET/OFF using wake-up >> latency constraints on MPU, CORE and PER. >> >> Signed-off-by: Jean Pihet <j-pihet@xxxxxx> >> --- >> arch/arm/mach-omap2/omap_hwmod.c | 26 +++++++++++++++++++++++++- >> arch/arm/plat-omap/include/plat/omap_hwmod.h | 2 ++ >> 2 files changed, 27 insertions(+), 1 deletions(-) >> >> diff --git a/arch/arm/mach-omap2/omap_hwmod.c b/arch/arm/mach-omap2/omap_hwmod.c >> index 84cc0bd..c6b1cc9 100644 >> --- a/arch/arm/mach-omap2/omap_hwmod.c >> +++ b/arch/arm/mach-omap2/omap_hwmod.c >> @@ -2618,11 +2619,34 @@ ohsps_unlock: >> return ret; >> } >> >> +/* >> + * omap_hwmod_set_wkup_constraint- set/release a wake-up latency constraint >> + * >> + * @oh: struct omap_hwmod* to which the target device belongs to. >> + * @cookie: identifier of the constraints list for @oh. >> + * @min_latency: the minimum allowed wake-up latency for @oh. >> + * >> + * Returns 0 upon success. >> + */ > > It's good that there is some documentation here, but it would be better if > it were kerneldoc-style documentation. Please see > Documentation/kernel-doc-nano-HOWTO.txt. > Also it would be good to have a bit more documentation here beyond simply > "Returns 0 upon success." For example, how should a caller remove a > wakeup latency constraint? Also, this function can return -EINVAL, not > counting whatever pwrdm_set_wkup_lat_constraint() can return, so that > should be documented above also. > > This applies to the function comments in the rest of the patches too. > Some of them have quite good kerneldoc comments, such as > pwrdm_wakeuplat_update_pwrst(); others need some work, like > pwrdm_set_wkup_lat_constraint(). Not all functions have kernel doc comments, i.e. this one does not (no /** at the start of the header). The intention is to document the functions from the API and the ones that implement the core service (pwrdm_set_wkup_lat_constraint()), and not the pure pass-through functions (omap_hwmod_set_wkup_constraint). In any case I will review the comments and resubmit. Thanks, Jean > > - Paul > -- To unsubscribe from this list: send the line "unsubscribe linux-omap" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
