From: Eduardo Valentin <eduardo.valentin@ti.com>
To: Nishanth Menon <nm@ti.com>
Cc: gregkh@linuxfoundation.org, devel@driverdev.osuosl.org,
linux-omap@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-pm@vger.kernel.org
Subject: Re: [PATCHv2 09/12] staging: ti-soc-thermal: fix several kernel-doc warnings and error
Date: Wed, 20 Mar 2013 07:56:18 -0400 [thread overview]
Message-ID: <5149A3E2.2030505@ti.com> (raw)
In-Reply-To: <20130319192212.GA5610@kahuna>
Hello Nishanth,
On 19-03-2013 15:22, Nishanth Menon wrote:
> On 10:54-20130319, Eduardo Valentin wrote:
<cut>
>> * @adc_start_val: ADC conversion table starting value
> You may still want to fix warnings generated by:
> ./scripts/kernel-doc -v drivers/staging/ti-soc-thermal/ti-bandgap.c>/dev/null
> For example - the following changes are required for proper error return
> documentation (following diff is just an hint):
Although I think the above is a good thing to be done, I don't think it
is considered mandatory, and for this reason, I don't believe the above
should block this patch. Basically because, after this patch, at least
kernel-doc runs successfully.
Besides, there is very few evidence that ppl out there care much about
"-v". A quick grep+awk would inform you this. If you consider the
population of C files (around 35.4K files) inside the tree (simple find
* | grep .*\\.[c,h]$ in your tree), only around 12.0% has structured
comments. Out of the files that have structured comments, only about
11.0% has 0 warnings (including 0 warnings with -v), that's something
like ~500 files. A considerable amount don't care about "-v" (34% out of
the files with structured comments). Actually most of them don't care
about warnings (89% out of the files with structured comments) at all. :-)
That said, I am going to send a separate patch to fix the "-v" later on.
Including your chunks below.
Thanks for reviewing.
>
> diff --git a/drivers/staging/ti-soc-thermal/ti-bandgap.c b/drivers/staging/ti-soc-thermal/ti-bandgap.c
> index d479e50..0adae05 100644
> --- a/drivers/staging/ti-soc-thermal/ti-bandgap.c
> +++ b/drivers/staging/ti-soc-thermal/ti-bandgap.c
> @@ -50,7 +50,7 @@
> * @reg: desired register (offset) to be read
> *
> * Helper function to read bandgap registers. It uses the io remapped area.
> - * Returns the register value.
> + * Return: the register value.
> */
> static u32 ti_bandgap_readl(struct ti_bandgap *bgp, u32 reg)
> {
> @@ -97,6 +97,8 @@ do { \
> *
> * Used to power on/off a bandgap device instance. Only used on those
> * that features tempsoff bit.
> + *
> + * Return: 0
> */
> static int ti_bandgap_power(struct ti_bandgap *bgp, bool on)
> {
> @@ -122,6 +124,8 @@ exit:
> * This function is desired because, depending on bandgap device version,
> * it might be needed to freeze the bandgap state machine, before fetching
> * the register value.
> + *
> + * Return: temperature in ...
> */
> static u32 ti_bandgap_read_temp(struct ti_bandgap *bgp, int id)
> {
> @@ -162,6 +166,8 @@ static u32 ti_bandgap_read_temp(struct ti_bandgap *bgp, int id)
> * conditions and acts accordingly. In case there are events pending,
> * it will reset the event mask to wait for the opposite event (next event).
> * Every time there is a new event, it will be reported to thermal layer.
> + *
> + * Return: IRQ_HANDLED
> */
> static irqreturn_t ti_bandgap_talert_irq_handler(int irq, void *data)
> {
> @@ -222,6 +228,8 @@ static irqreturn_t ti_bandgap_talert_irq_handler(int irq, void *data)
> * This is the Tshut handler. Use it only if bandgap device features
> * HAS(TSHUT). If any sensor fires the Tshut signal, we simply shutdown
> * the system.
> + *
> + * Return: IRQ_HANDLED
> */
> static irqreturn_t ti_bandgap_tshut_irq_handler(int irq, void *data)
> {
> @@ -244,6 +252,8 @@ static irqreturn_t ti_bandgap_tshut_irq_handler(int irq, void *data)
> * Simple conversion from ADC representation to mCelsius. In case the ADC value
> * is out of the ADC conv table range, it returns -ERANGE, 0 on success.
> * The conversion table is indexed by the ADC values.
> + *
> + * Return: 0 if converstion was successful, else -ERANGE if out of range
> */
> static
> int ti_bandgap_adc_to_mcelsius(struct ti_bandgap *bgp, int adc_val, int *t)
> @@ -272,6 +282,8 @@ exit:
> * Simple conversion from mCelsius to ADC values. In case the temp value
> * is out of the ADC conv table range, it returns -ERANGE, 0 on success.
> * The conversion table is indexed by the ADC values.
> + *
> + * Return: 0 if converstion was successful, else -ERANGE if out of range
> */
> static
> int ti_bandgap_mcelsius_to_adc(struct ti_bandgap *bgp, long temp, int *adc)
> @@ -311,7 +323,8 @@ exit:
> * @sum: address where to write the resulting temperature (in ADC scale)
> *
> * Adds an hysteresis value (in mCelsius) to a ADC temperature value.
> - * Returns 0 on success, -ERANGE otherwise.
> + *
> + * Return: 0 on success, -ERANGE otherwise.
> */
> static
> int ti_bandgap_add_hyst(struct ti_bandgap *bgp, int adc_val, int hyst_val,
> @@ -384,6 +397,8 @@ static void ti_bandgap_unmask_interrupts(struct ti_bandgap *bgp, int id,
> * It checks the resulting t_hot and t_cold values, based on the new passed @val
> * and configures the thresholds so that t_hot is always greater than t_cold.
> * Call this function only if bandgap features HAS(TALERT).
> + *
> + * Return: 0 if no error, else corresponding error
> */
> static int ti_bandgap_update_alert_threshold(struct ti_bandgap *bgp, int id,
> int val, bool hot)
> @@ -442,6 +457,8 @@ exit:
> *
> * Checks if the bandgap pointer is valid and if the sensor id is also
> * applicable.
> + *
> + * Return: 0 if no errors, -EINVAL for bad parameter or -ERANGE if out of range
> */
> static inline int ti_bandgap_validate(struct ti_bandgap *bgp, int id)
> {
> @@ -475,6 +492,8 @@ exit:
> * This function can be used to update t_hot or t_cold, depending on @hot value.
> * Validates the mCelsius range and update the requested threshold.
> * Call this function only if bandgap features HAS(TALERT).
> + *
> + * Return: 0 if no error, else corresponding error value.
> */
> static int _ti_bandgap_write_threshold(struct ti_bandgap *bgp, int id, int val,
> bool hot)
> @@ -529,6 +548,8 @@ exit:
> * It will fetch the required thresholds (hot and cold) for TALERT signal.
> * This function can be used to read t_hot or t_cold, depending on @hot value.
> * Call this function only if bandgap features HAS(TALERT).
> + *
> + * Return: 0 if no error, if it has no TALERT support, returns -ENOTSUPP....
> */
> static int _ti_bandgap_read_threshold(struct ti_bandgap *bgp, int id,
> int *val, bool hot)
> @@ -575,7 +596,7 @@ exit:
> * @id: sensor id
> * @thot: resulting current thot value
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_read_thot(struct ti_bandgap *bgp, int id, int *thot)
> {
> @@ -588,7 +609,7 @@ int ti_bandgap_read_thot(struct ti_bandgap *bgp, int id, int *thot)
> * @id: sensor id
> * @val: desired thot value
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_write_thot(struct ti_bandgap *bgp, int id, int val)
> {
> @@ -601,7 +622,7 @@ int ti_bandgap_write_thot(struct ti_bandgap *bgp, int id, int val)
> * @id: sensor id
> * @tcold: resulting current tcold value
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_read_tcold(struct ti_bandgap *bgp, int id, int *tcold)
> {
> @@ -614,7 +635,7 @@ int ti_bandgap_read_tcold(struct ti_bandgap *bgp, int id, int *tcold)
> * @id: sensor id
> * @val: desired tcold value
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_write_tcold(struct ti_bandgap *bgp, int id, int val)
> {
> @@ -627,7 +648,7 @@ int ti_bandgap_write_tcold(struct ti_bandgap *bgp, int id, int val)
> * @id: sensor id
> * @interval: resulting update interval in miliseconds
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_read_update_interval(struct ti_bandgap *bgp, int id,
> int *interval)
> @@ -659,7 +680,7 @@ int ti_bandgap_read_update_interval(struct ti_bandgap *bgp, int id,
> * @id: sensor id
> * @interval: desired update interval in miliseconds
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_write_update_interval(struct ti_bandgap *bgp,
> int id, u32 interval)
> @@ -685,7 +706,7 @@ int ti_bandgap_write_update_interval(struct ti_bandgap *bgp,
> * @id: sensor id
> * @temperature: resulting temperature
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_read_temperature(struct ti_bandgap *bgp, int id,
> int *temperature)
> @@ -717,7 +738,7 @@ int ti_bandgap_read_temperature(struct ti_bandgap *bgp, int id,
> * @id: sensor id
> * @data: thermal framework related data to be stored
> *
> - * returns 0 on success or the proper error code
> + * Return: 0 on success or the proper error code
> */
> int ti_bandgap_set_sensor_data(struct ti_bandgap *bgp, int id, void *data)
> {
> @@ -736,7 +757,7 @@ int ti_bandgap_set_sensor_data(struct ti_bandgap *bgp, int id, void *data)
> * @bgp: pointer to bandgap instance
> * @id: sensor id
> *
> - * returns data stored by set function with sensor id on success or NULL
> + * Return: data stored by set function with sensor id on success or NULL
> */
> void *ti_bandgap_get_sensor_data(struct ti_bandgap *bgp, int id)
> {
> @@ -756,6 +777,8 @@ void *ti_bandgap_get_sensor_data(struct ti_bandgap *bgp, int id)
> *
> * Used to initialize the conversion state machine and set it to a valid
> * state. Called during device initialization and context restore events.
> + *
> + * Return: 0
> */
> static int
> ti_bandgap_force_single_read(struct ti_bandgap *bgp, int id)
> @@ -789,6 +812,8 @@ ti_bandgap_force_single_read(struct ti_bandgap *bgp, int id)
> * be used for junction temperature monitoring, it is desirable that the
> * sensors are operational all the time, so that alerts are generated
> * properly.
> + *
> + * Return: 0
> */
> static int ti_bandgap_set_continuous_mode(struct ti_bandgap *bgp)
> {
> @@ -814,6 +839,8 @@ static int ti_bandgap_set_continuous_mode(struct ti_bandgap *bgp)
> * to specify which GPIO line is used. TSHUT IRQ is fired anytime
> * one of the bandgap sensors violates the TSHUT high/hot threshold.
> * And in that case, the system must go off.
> + *
> + * Return: 0 if no error, else error status
> */
> static int ti_bandgap_tshut_init(struct ti_bandgap *bgp,
> struct platform_device *pdev)
> @@ -853,6 +880,8 @@ static int ti_bandgap_tshut_init(struct ti_bandgap *bgp,
> * TALERT is a normal IRQ and it is fired any time thresholds (hot or cold)
> * are violated. In these situation, the driver must reprogram the thresholds,
> * accordingly to specified policy.
> + *
> + * Return: 0 if no error, else return corresponding error.
> */
> static int ti_bandgap_talert_init(struct ti_bandgap *bgp,
> struct platform_device *pdev)
> @@ -884,6 +913,9 @@ static const struct of_device_id of_ti_bandgap_match[];
> * Used to read the device tree properties accordingly to the bandgap
> * matching version. Based on bandgap version and its capabilities it
> * will build a struct ti_bandgap out of the required DT entries.
> + *
> + * Return: valid bandgap structure if successful, else returns ERR_PTR
> + * return value must be verified with IS_ERR.
> */
> static struct ti_bandgap *ti_bandgap_build(struct platform_device *pdev)
> {
>
next prev parent reply other threads:[~2013-03-20 11:56 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-03-19 14:54 [PATCHv2 00/12] staging: [omap,ti-soc]-thermal: fixes and renaming Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 01/12] staging: omap-thermal: fix return value Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 02/12] staging: omap-thermal: rename bg_ptr to bgp Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 03/12] staging: rename omap-thermal driver to ti-soc-thermal Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 04/12] staging: ti-soc-thermal: rename Kconfig options Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 05/12] staging: ti-soc-thermal: rename symbols to use better prefix Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 06/12] staging: ti-soc-thermal: make unexported functions local Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 07/12] staging: ti-soc-thermal: split writable data from readonly data Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 08/12] stating: ti-soc-thermal: use sizeof(*pointer) while allocating Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 09/12] staging: ti-soc-thermal: fix several kernel-doc warnings and error Eduardo Valentin
2013-03-19 19:22 ` Nishanth Menon
2013-03-20 11:56 ` Eduardo Valentin [this message]
2013-03-20 12:50 ` Nishanth Menon
2013-03-25 18:22 ` Greg KH
2013-03-26 0:24 ` Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 10/12] staging: ti-soc-thermal: fix condition to apply hyst Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 11/12] staging: ti-soc-thermal: fix bitfield writing while updating thresholds Eduardo Valentin
2013-03-19 14:54 ` [PATCHv2 12/12] staging: ti-soc-thermal: propagate error code Eduardo Valentin
2013-03-20 9:15 ` [PATCHv2 00/12] staging: [omap,ti-soc]-thermal: fixes and renaming Dan Carpenter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=5149A3E2.2030505@ti.com \
--to=eduardo.valentin@ti.com \
--cc=devel@driverdev.osuosl.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-omap@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=nm@ti.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).