Adding some documentation

[Sascha Hauer]

On Tue, Nov 24, 2009 at 10:57:22AM +0100, Juergen Beisert wrote:
> Add some (helpful?) comments about the meaning of 'framebuffer' and
> 'framebuffer_ovl' structure members.
> 
> Signed-off-by: Juergenn Beisert <jbe at pengutronix.de>

Applied

Sascha

> 
> ---
>  arch/arm/mach-imx/include/mach/imxfb.h |    9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> Index: u-boot-v2/arch/arm/mach-imx/include/mach/imxfb.h
> ===================================================================
> --- u-boot-v2.orig/arch/arm/mach-imx/include/mach/imxfb.h
> +++ u-boot-v2/arch/arm/mach-imx/include/mach/imxfb.h
> @@ -55,6 +55,9 @@ struct imx_fb_videomode {
>  	unsigned char	bpp;
>  };
>  
> +/**
> + * Define relevant framebuffer information
> + */
>  struct imx_fb_platform_data {
>  	struct imx_fb_videomode *mode;
>  
> @@ -67,9 +70,15 @@ struct imx_fb_platform_data {
>  	u_int		lscr1;
>  	u_int		dmacr;
>  
> +	/** force a memory area to be used, else NULL for dynamic allocation */
>  	void		*framebuffer;
> +	/** force a memory area to be used, else NULL for dynamic allocation */
>  	void		*framebuffer_ovl;
>  };
>  
>  void set_imx_fb_info(struct imx_fb_platform_data *);
>  
> +/**
> + * @file
> + * @brief i.MX related framebuffer declarations
> + */
> 
> -- 
> Pengutronix e.K.                              | Juergen Beisert             |
> Linux Solutions for Science and Industry      | Phone: +49-8766-939 228     |
> Vertretung Sued/Muenchen, Germany             | Fax:   +49-5121-206917-5555 |
> Amtsgericht Hildesheim, HRA 2686              | http://www.pengutronix.de/  |
> 
> _______________________________________________
> u-boot-v2 mailing list
> u-boot-v2 at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/u-boot-v2
> 

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |