patch-2.4.7 linux/drivers/video/fbcon.c

• Lines: 118
• Date: Wed Jul 4 22:56:00 2001
• Orig file: v2.4.6/linux/drivers/video/fbcon.c
• Orig date: Tue Jul 3 17:08:21 2001

diff -u --recursive --new-file v2.4.6/linux/drivers/video/fbcon.c linux/drivers/video/fbcon.c
@@ -31,6 +31,8 @@
  *
  *  Random hacking by Martin Mares <mj@ucw.cz>
  *
+ *	2001 - Documented with DocBook
+ *	- Brad Douglas <brad@neruo.com>
  *
  *  The low level operations for the various display memory organizations are
  *  now in separate source files.
@@ -239,6 +241,20 @@
       add_timer(&cursor_timer);
 }
 
+
+/**
+ *	PROC_CONSOLE - find the attached tty or visible console
+ *	@info: frame buffer info structure
+ *
+ *	Finds the tty attached to the process or visible console if
+ *	the process is not directly attached to a tty (e.g. remote
+ *	user) for device @info.
+ *
+ *	Returns -1 errno on error, or tty/visible console number
+ *	on success.
+ *
+ */
+
 int PROC_CONSOLE(const struct fb_info *info)
 {
         int fgc;
@@ -261,6 +277,21 @@
         return MINOR(current->tty->device) - 1;
 }
 
+
+/**
+ *	set_all_vcs - set all virtual consoles to match
+ *	@fbidx: frame buffer index (e.g. fb0, fb1, ...)
+ *	@fb: frame buffer ops structure
+ *	@var: frame buffer screen structure to set
+ *	@info: frame buffer info structure
+ *
+ *	Set all virtual consoles to match screen info set in @var
+ *	for device @info.
+ *
+ *	Returns negative errno on error, or zero on success.
+ *
+ */
+
 int set_all_vcs(int fbidx, struct fb_ops *fb, struct fb_var_screeninfo *var,
                 struct fb_info *info)
 {
@@ -277,6 +308,17 @@
     return 0;
 }
 
+
+/**
+ *	set_con2fb_map - map console to frame buffer device
+ *	@unit: virtual console number to map
+ *	@newidx: frame buffer index to map virtual console to
+ *
+ *	Maps a virtual console @unit to a frame buffer device
+ *	@newidx.
+ *
+ */
+
 void set_con2fb_map(int unit, int newidx)
 {
     int oldidx = con2fb_map[unit];
@@ -1124,6 +1166,20 @@
     }
 }
 
+/**
+ *	fbcon_redraw_clear - clear area of the screen
+ *	@conp: stucture pointing to current active virtual console
+ *	@p: display structure
+ *	@sy: starting Y coordinate
+ *	@sx: starting X coordinate
+ *	@height: height of area to clear
+ *	@width: width of area to clear
+ *
+ *	Clears a specified area of the screen.  All dimensions are in
+ *	pixels.
+ *
+ */
+
 void fbcon_redraw_clear(struct vc_data *conp, struct display *p, int sy, int sx,
 		     int height, int width)
 {
@@ -1133,7 +1189,25 @@
 	    fbcon_putc(conp, ' ', sy+y, sx+x);
 }
 
-/* This cannot be used together with ypan or ywrap */
+
+/**
+ *	fbcon_redraw_bmove - copy area of screen to another area
+ *	@p: display structure
+ *	@sy: origin Y coordinate
+ *	@sx: origin X coordinate
+ *	@dy: destination Y coordinate
+ *	@dx: destination X coordinate
+ *	@h: height of area to copy
+ *	@w: width of area to copy
+ *
+ *	Copies an area of the screen to another area of the same screen.
+ *	All dimensions are in pixels.
+ *
+ *	Note that this function cannot be used together with ypan or
+ *	ywrap.
+ *
+ */
+
 void fbcon_redraw_bmove(struct display *p, int sy, int sx, int dy, int dx, int h, int w)
 {
     if (sy != dy)