[PATCH] at24: add kernel side usage description

[PATCH] at24: add kernel side usage description

[yegorslists-gM/Ye1E23mwN+BqQ9rBEUg]

From: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>

Add EEPROM usage instructions and example for kernel side.
dm644x-evm was taken as example.

Signed-off-by: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
---
 drivers/misc/eeprom/at24.c |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

diff --git a/drivers/misc/eeprom/at24.c b/drivers/misc/eeprom/at24.c
index ab1ad41..49494ad 100644
--- a/drivers/misc/eeprom/at24.c
+++ b/drivers/misc/eeprom/at24.c
@@ -438,6 +438,15 @@ static ssize_t at24_bin_write(struct file *filp, struct kobject *kobj,
  * This lets other kernel code access the eeprom data. For example, it
  * might hold a board's Ethernet address, or board-specific calibration
  * data generated on the manufacturing floor.
+ *
+ * struct at24_platform_data provides special hook .setup, that can
+ * invoke at24_macc_read()/at24_macc_write() through memory_accessor:
+ * 
+ * void		(*setup)(struct memory_accessor *, void *context);
+ *
+ * setup hook (if provided) will be executed at the end of at24_probe().
+ *
+ * See arch/arm/mach-davinci/board-dm644x-evm.c for details.
  */
 
 static ssize_t at24_macc_read(struct memory_accessor *macc, char *buf,
-- 
1.7.1.1

Re: [PATCH] at24: add kernel side usage description

[Jean Delvare]

On Wed, 25 Jan 2012 17:11:11 +0100, yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org wrote:
> From: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
> 
> Add EEPROM usage instructions and example for kernel side.
> dm644x-evm was taken as example.
> 
> Signed-off-by: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
> ---
>  drivers/misc/eeprom/at24.c |    9 +++++++++
>  1 files changed, 9 insertions(+), 0 deletions(-)
> 
> diff --git a/drivers/misc/eeprom/at24.c b/drivers/misc/eeprom/at24.c
> index ab1ad41..49494ad 100644
> --- a/drivers/misc/eeprom/at24.c
> +++ b/drivers/misc/eeprom/at24.c
> @@ -438,6 +438,15 @@ static ssize_t at24_bin_write(struct file *filp, struct kobject *kobj,
>   * This lets other kernel code access the eeprom data. For example, it
>   * might hold a board's Ethernet address, or board-specific calibration
>   * data generated on the manufacturing floor.
> + *
> + * struct at24_platform_data provides special hook .setup, that can
> + * invoke at24_macc_read()/at24_macc_write() through memory_accessor:
> + * 
> + * void		(*setup)(struct memory_accessor *, void *context);
> + *
> + * setup hook (if provided) will be executed at the end of at24_probe().
> + *
> + * See arch/arm/mach-davinci/board-dm644x-evm.c for details.
>   */
>  
>  static ssize_t at24_macc_read(struct memory_accessor *macc, char *buf,

Good idea.

Acked-by: Jean Delvare <khali-PUYAD+kWke1g9hUCZPvPmw@public.gmane.org>

I believe Wolfram will pick this as the maintainer of the at24 driver.

-- 
Jean Delvare

Re: [PATCH] at24: add kernel side usage description

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 1910 bytes --]

On Wed, Jan 25, 2012 at 05:11:11PM +0100, yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org wrote:
> From: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
> 
> Add EEPROM usage instructions and example for kernel side.
> dm644x-evm was taken as example.
> 
> Signed-off-by: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
> ---
>  drivers/misc/eeprom/at24.c |    9 +++++++++
>  1 files changed, 9 insertions(+), 0 deletions(-)
> 
> diff --git a/drivers/misc/eeprom/at24.c b/drivers/misc/eeprom/at24.c
> index ab1ad41..49494ad 100644
> --- a/drivers/misc/eeprom/at24.c
> +++ b/drivers/misc/eeprom/at24.c
> @@ -438,6 +438,15 @@ static ssize_t at24_bin_write(struct file *filp, struct kobject *kobj,
>   * This lets other kernel code access the eeprom data. For example, it
>   * might hold a board's Ethernet address, or board-specific calibration
>   * data generated on the manufacturing floor.
> + *
> + * struct at24_platform_data provides special hook .setup, that can
> + * invoke at24_macc_read()/at24_macc_write() through memory_accessor:
> + * 
> + * void		(*setup)(struct memory_accessor *, void *context);
> + *
> + * setup hook (if provided) will be executed at the end of at24_probe().
> + *
> + * See arch/arm/mach-davinci/board-dm644x-evm.c for details.

I think a reference to some board code is not good, since the code might change
for whatever reason. I know that I suggested to place the comment there, but
meanwhile I think at24_platform_data really needs to get proper kernel-doc
annotations, also including your suggestion. I won't force that on you and will
do it in the next days, unless you are eager to do it, of course :)

Thanks,

   Wolfram

-- 
Pengutronix e.K.                           | Wolfram Sang                |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [PATCH] at24: add kernel side usage description

[Yegor Yefremov]

On Sat, Jan 28, 2012 at 11:53 PM, Wolfram Sang <w.sang-bIcnvbaLZ9MEGnE8C9+IrQ@public.gmane.org> wrote:
> On Wed, Jan 25, 2012 at 05:11:11PM +0100, yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org wrote:
>> From: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
>>
>> Add EEPROM usage instructions and example for kernel side.
>> dm644x-evm was taken as example.
>>
>> Signed-off-by: Yegor Yefremov <yegorslists-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
>> ---
>>  drivers/misc/eeprom/at24.c |    9 +++++++++
>>  1 files changed, 9 insertions(+), 0 deletions(-)
>>
>> diff --git a/drivers/misc/eeprom/at24.c b/drivers/misc/eeprom/at24.c
>> index ab1ad41..49494ad 100644
>> --- a/drivers/misc/eeprom/at24.c
>> +++ b/drivers/misc/eeprom/at24.c
>> @@ -438,6 +438,15 @@ static ssize_t at24_bin_write(struct file *filp, struct kobject *kobj,
>>   * This lets other kernel code access the eeprom data. For example, it
>>   * might hold a board's Ethernet address, or board-specific calibration
>>   * data generated on the manufacturing floor.
>> + *
>> + * struct at24_platform_data provides special hook .setup, that can
>> + * invoke at24_macc_read()/at24_macc_write() through memory_accessor:
>> + *
>> + * void              (*setup)(struct memory_accessor *, void *context);
>> + *
>> + * setup hook (if provided) will be executed at the end of at24_probe().
>> + *
>> + * See arch/arm/mach-davinci/board-dm644x-evm.c for details.
>
> I think a reference to some board code is not good, since the code might change
> for whatever reason. I know that I suggested to place the comment there, but
> meanwhile I think at24_platform_data really needs to get proper kernel-doc
> annotations, also including your suggestion. I won't force that on you and will
> do it in the next days, unless you are eager to do it, of course :)

I think you're the best man to do the job :-) Since you have more
experience in this area.

Yegor