[1/3] pwm: atmel: Add link to reference manual
diff mbox series

Message ID 20190815214133.11134-1-uwe@kleine-koenig.org
State New
Headers show
Series
  • [1/3] pwm: atmel: Add link to reference manual
Related show

Commit Message

Uwe Kleine-König Aug. 15, 2019, 9:41 p.m. UTC
The reference manual for at least one of the supported variants is
publicly available. Add a link to it at the top of the driver.

Signed-off-by: Uwe Kleine-König <uwe@kleine-koenig.org>
---
 drivers/pwm/pwm-atmel.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Claudiu Beznea Aug. 19, 2019, 9:26 a.m. UTC | #1
On 16.08.2019 00:41, Uwe Kleine-König wrote:
> The reference manual for at least one of the supported variants is
> publicly available. Add a link to it at the top of the driver.
> 
> Signed-off-by: Uwe Kleine-König <uwe@kleine-koenig.org>
> ---
>  drivers/pwm/pwm-atmel.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/pwm/pwm-atmel.c b/drivers/pwm/pwm-atmel.c
> index e5e1eaf372fa..ac3d7a200b9e 100644
> --- a/drivers/pwm/pwm-atmel.c
> +++ b/drivers/pwm/pwm-atmel.c
> @@ -4,6 +4,9 @@
>   *
>   * Copyright (C) 2013 Atmel Corporation
>   *		 Bo Shen <voice.shen@atmel.com>
> + *
> + * Reference manual for "atmel,at91sam9rl-pwm":
> + *   http://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-11032-32-bit-ARM926EJ-S-Microcontroller-SAM9G25_Datasheet.pdf

Even SAM9G25 PWM have almost the same registers with AT91SAM9RL, the
datasheet for AT91SAM9RL is located at:
http://ww1.microchip.com/downloads/en/DeviceDoc/doc6289.pdf
Maybe we should use this one.

I'm not familiar with having reference manuals in this part of the driver
but if we are doing so would it be feasible to also have links for the rest
SoCs that introduces new PWM versions? I'm thinking here at all the
compatibles from atmel_pwm_dt_ids[]:
- atmel,sama5d3-pwm
- atmel,sama5d2-pwm
- microchip,sam9x60-pwm

Although the last one is not already public.

>   */
>  
>  #include <linux/clk.h>
>
Nicolas Ferre Aug. 19, 2019, 9:46 a.m. UTC | #2
On 19/08/2019 at 11:26, Claudiu Beznea - M18063 wrote:
> 
> 
> On 16.08.2019 00:41, Uwe Kleine-König wrote:
>> The reference manual for at least one of the supported variants is
>> publicly available. Add a link to it at the top of the driver.
>>
>> Signed-off-by: Uwe Kleine-König <uwe@kleine-koenig.org>
>> ---
>>   drivers/pwm/pwm-atmel.c | 3 +++
>>   1 file changed, 3 insertions(+)
>>
>> diff --git a/drivers/pwm/pwm-atmel.c b/drivers/pwm/pwm-atmel.c
>> index e5e1eaf372fa..ac3d7a200b9e 100644
>> --- a/drivers/pwm/pwm-atmel.c
>> +++ b/drivers/pwm/pwm-atmel.c
>> @@ -4,6 +4,9 @@
>>    *
>>    * Copyright (C) 2013 Atmel Corporation
>>    *		 Bo Shen <voice.shen@atmel.com>
>> + *
>> + * Reference manual for "atmel,at91sam9rl-pwm":
>> + *   http://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-11032-32-bit-ARM926EJ-S-Microcontroller-SAM9G25_Datasheet.pdf
> 
> Even SAM9G25 PWM have almost the same registers with AT91SAM9RL, the
> datasheet for AT91SAM9RL is located at:
> http://ww1.microchip.com/downloads/en/DeviceDoc/doc6289.pdf
> Maybe we should use this one.
> 
> I'm not familiar with having reference manuals in this part of the driver
> but if we are doing so would it be feasible to also have links for the rest
> SoCs that introduces new PWM versions? I'm thinking here at all the
> compatibles from atmel_pwm_dt_ids[]:
> - atmel,sama5d3-pwm
> - atmel,sama5d2-pwm

These documents are listed here:
Documentation/arm/microchip.rst
and must be maintained if URL are out of date. I don't believe that we 
should add another reference to them in this driver (and other source code).
Referring to the datasheet pointed out by the microchip.rst file is 
certainly the way to go...

Regards,
   Nicolas


> - microchip,sam9x60-pwm
> 
> Although the last one is not already public.
> 
>>    */
>>   
>>   #include <linux/clk.h>
>>

Patch
diff mbox series

diff --git a/drivers/pwm/pwm-atmel.c b/drivers/pwm/pwm-atmel.c
index e5e1eaf372fa..ac3d7a200b9e 100644
--- a/drivers/pwm/pwm-atmel.c
+++ b/drivers/pwm/pwm-atmel.c
@@ -4,6 +4,9 @@ 
  *
  * Copyright (C) 2013 Atmel Corporation
  *		 Bo Shen <voice.shen@atmel.com>
+ *
+ * Reference manual for "atmel,at91sam9rl-pwm":
+ *   http://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-11032-32-bit-ARM926EJ-S-Microcontroller-SAM9G25_Datasheet.pdf
  */
 
 #include <linux/clk.h>