patch-2.4.3 linux/drivers/video/fbgen.c

• Lines: 265
• Date: Fri Mar 2 18:38:39 2001
• Orig file: v2.4.2/linux/drivers/video/fbgen.c
• Orig date: Wed Jul 26 11:08:41 2000

diff -u --recursive --new-file v2.4.2/linux/drivers/video/fbgen.c linux/drivers/video/fbgen.c
@@ -3,6 +3,9 @@
  *
  *  Created 3 Jan 1998 by Geert Uytterhoeven
  *
+ *	2001 - Documented with DocBook
+ *	- Brad Douglas <brad@neruo.com>
+ *
  * This file is subject to the terms and conditions of the GNU General Public
  * License.  See the file COPYING in the main directory of this archive
  * for more details.
@@ -25,9 +28,18 @@
 /* ---- `Generic' versions of the frame buffer device operations ----------- */
 
 
-    /*
-     *  Get the Fixed Part of the Display
-     */
+/**
+ *	fbgen_get_fix - get fixed part of display
+ *	@fix: fb_fix_screeninfo structure
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Get the fixed information part of the display and place it
+ *	into @fix for virtual console @con on device @info.
+ *
+ *	Returns negative errno on error, or zero on success.
+ *
+ */
 
 int fbgen_get_fix(struct fb_fix_screeninfo *fix, int con, struct fb_info *info)
 {
@@ -48,9 +60,18 @@
 }
 
 
-    /*
-     *  Get the User Defined Part of the Display
-     */
+/**
+ *	fbgen_get_var - get user defined part of display
+ *	@var: fb_var_screeninfo structure
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Get the user defined part of the display and place it into @var
+ *	for virtual console @con on device @info.
+ *
+ *	Returns negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_get_var(struct fb_var_screeninfo *var, int con, struct fb_info *info)
 {
@@ -67,9 +88,18 @@
 }
 
 
-    /*
-     *  Set the User Defined Part of the Display
-     */
+/**
+ *	fbgen_set_var - set the user defined part of display
+ *	@var: fb_var_screeninfo user defined part of the display
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Set the user defined part of the display as dictated by @var
+ *	for virtual console @con on device @info.
+ *
+ *	Returns negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_set_var(struct fb_var_screeninfo *var, int con, struct fb_info *info)
 {
@@ -105,9 +135,19 @@
 }
 
 
-    /*
-     *  Get the Colormap
-     */
+/**
+ *	fbgen_get_cmap - get the colormap
+ *	@cmap: frame buffer colormap structure
+ *	@kspc: boolean, 0 copy local, 1 put_user() function
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Gets the colormap for virtual console @con and places it into
+ *	@cmap for device @info.
+ *
+ *	Returns negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_get_cmap(struct fb_cmap *cmap, int kspc, int con,
 		   struct fb_info *info)
@@ -128,9 +168,19 @@
 }
 
 
-    /*
-     *  Set the Colormap
-     */
+/**
+ *	fbgen_set_cmap - set the colormap
+ *	@cmap: frame buffer colormap structure
+ *	@kspc: boolean, 0 copy local, 1 get_user() function
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Sets the colormap @cmap for virtual console @con on
+ *	device @info.
+ *
+ *	Returns negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_set_cmap(struct fb_cmap *cmap, int kspc, int con,
 		   struct fb_info *info)
@@ -152,11 +202,20 @@
 }
 
 
-    /*
-     *  Pan or Wrap the Display
-     *
-     *  This call looks only at xoffset, yoffset and the FB_VMODE_YWRAP flag
-     */
+/**
+ *	fbgen_pan_display - pan or wrap the display
+ *	@var: frame buffer user defined part of display
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Pan or wrap virtual console @con for device @info.
+ *
+ *	This call looks only at xoffset, yoffset and the
+ *	FB_VMODE_YWRAP flag in @var.
+ *
+ *	Returns negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_pan_display(struct fb_var_screeninfo *var, int con,
 		      struct fb_info *info)
@@ -193,9 +252,18 @@
 /* ---- Helper functions --------------------------------------------------- */
 
 
-    /*
-     *  Change the video mode
-     */
+/**
+ *	fbgen_do_set_var - change the video mode
+ *	@var: frame buffer user defined part of display
+ *	@isactive: boolean, 0 inactive, 1 active
+ *	@info: generic frame buffer info structure
+ *
+ *	Change the video mode settings for device @info.  If @isactive
+ *	is non-zero, the changes will be activated immediately.
+ *
+ *	Return negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_do_set_var(struct fb_var_screeninfo *var, int isactive,
 		     struct fb_info_gen *info)
@@ -215,6 +283,15 @@
 }
 
 
+/**
+ *	fbgen_set_disp - set generic display
+ *	@con: virtual console number
+ *	@info: generic frame buffer info structure
+ *
+ *	Sets a display on virtual console @con for device @info.
+ *
+ */
+
 void fbgen_set_disp(int con, struct fb_info_gen *info)
 {
     struct fbgen_hwswitch *fbhw = info->fbhw;
@@ -254,9 +331,15 @@
 }
 
 
-    /*
-     *  Install the current colormap
-     */
+/**
+ *	fbgen_install_cmap - install the current colormap
+ *	@con: virtual console number
+ *	@info: generic frame buffer info structure
+ *
+ *	Installs the current colormap for virtual console @con on
+ *	device @info.
+ *
+ */
 
 void fbgen_install_cmap(int con, struct fb_info_gen *info)
 {
@@ -272,9 +355,18 @@
 }
 
 
-    /*
-     *  Update the `var' structure (called by fbcon.c)
-     */
+/**
+ *	fbgen_update_var - update user defined part of display
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Updates the user defined part of the display ('var'
+ *	structure) on virtual console @con for device @info.
+ *	This function is called by fbcon.c.
+ *
+ *	Returns negative errno on error, or zero for success.
+ *
+ */
 
 int fbgen_update_var(int con, struct fb_info *info)
 {
@@ -290,9 +382,16 @@
 }
 
 
-    /*
-     *  Switch to a different virtual console
-     */
+/**
+ *	fbgen_switch - switch to a different virtual console.
+ *	@con: virtual console number
+ *	@info: frame buffer info structure
+ *
+ *	Switch to virtuall console @con on device @info.
+ *
+ *	Returns zero.
+ *
+ */
 
 int fbgen_switch(int con, struct fb_info *info)
 {
@@ -311,9 +410,14 @@
 }
 
 
-    /*
-     *  Blank the screen
-     */
+/**
+ *	fbgen_blank - blank the screen
+ *	@blank: boolean, 0 unblank, 1 blank
+ *	@info: frame buffer info structure
+ *
+ *	Blank the screen on device @info.
+ *
+ */
 
 void fbgen_blank(int blank, struct fb_info *info)
 {