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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Jan 25, 2012 at 05:11:11PM +0100, yegorslists@xxxxxxxxxxxxxx wrote:
> From: Yegor Yefremov <yegorslists@xxxxxxxxxxxxxx>
> 
> Add EEPROM usage instructions and example for kernel side.
> dm644x-evm was taken as example.
> 
> Signed-off-by: Yegor Yefremov <yegorslists@xxxxxxxxxxxxxx>
> ---
>  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: signature.asc
Description: Digital signature


[Index of Archives]     [Linux GPIO]     [Linux SPI]     [Linux Hardward Monitoring]     [LM Sensors]     [Linux USB Devel]     [Linux Media]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux