blob: 7aaa4eabbba0557af34afa2414560efb8b74804b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/drivers/video/console/fbcon.h -- Low level frame buffer based console driver
3 *
4 * Copyright (C) 1997 Geert Uytterhoeven
5 *
6 * This file is subject to the terms and conditions of the GNU General Public
7 * License. See the file COPYING in the main directory of this archive
8 * for more details.
9 */
10
11#ifndef _VIDEO_FBCON_H
12#define _VIDEO_FBCON_H
13
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/types.h>
15#include <linux/vt_buffer.h>
16#include <linux/vt_kern.h>
17
18#include <asm/io.h>
19
Antonino A. Daplas88fb2c62005-09-09 13:10:00 -070020#define FBCON_FLAGS_INIT 1
21#define FBCON_FLAGS_CURSOR_TIMER 2
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23 /*
24 * This is the interface between the low-level console driver and the
25 * low-level frame buffer device
26 */
27
28struct display {
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 /* Filled in by the low-level console driver */
Jan Beulich2f4516d2005-09-13 01:25:44 -070030 const u_char *fontdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031 int userfont; /* != 0 if fontdata kmalloc()ed */
32 u_short scrollmode; /* Scroll Method */
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080033 u_short inverse; /* != 0 text black on white as default */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 short yscroll; /* Hardware scrolling */
35 int vrows; /* number of virtual rows */
36 int cursor_shape;
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080037 int con_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 u32 xres_virtual;
39 u32 yres_virtual;
40 u32 height;
41 u32 width;
42 u32 bits_per_pixel;
43 u32 grayscale;
44 u32 nonstd;
45 u32 accel_flags;
46 u32 rotate;
47 struct fb_bitfield red;
48 struct fb_bitfield green;
49 struct fb_bitfield blue;
50 struct fb_bitfield transp;
Geert Uytterhoeven9791d762007-02-12 00:55:19 -080051 const struct fb_videomode *mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052};
53
54struct fbcon_ops {
55 void (*bmove)(struct vc_data *vc, struct fb_info *info, int sy,
56 int sx, int dy, int dx, int height, int width);
57 void (*clear)(struct vc_data *vc, struct fb_info *info, int sy,
58 int sx, int height, int width);
59 void (*putcs)(struct vc_data *vc, struct fb_info *info,
60 const unsigned short *s, int count, int yy, int xx,
61 int fg, int bg);
62 void (*clear_margins)(struct vc_data *vc, struct fb_info *info,
63 int bottom_only);
Antonino A. Daplasb73deed2006-01-09 20:52:56 -080064 void (*cursor)(struct vc_data *vc, struct fb_info *info, int mode,
65 int softback_lines, int fg, int bg);
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080066 int (*update_start)(struct fb_info *info);
Antonino A. Daplasb73deed2006-01-09 20:52:56 -080067 int (*rotate_font)(struct fb_info *info, struct vc_data *vc);
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080068 struct fb_var_screeninfo var; /* copy of the current fb_var_screeninfo */
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 struct timer_list cursor_timer; /* Cursor timer */
70 struct fb_cursor cursor_state;
Antonino A. Daplasab767202005-11-13 16:06:32 -080071 struct display *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 int currcon; /* Current VC. */
Scot Doyle27a4c822015-03-26 13:56:38 +000073 int cur_blink_jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 int cursor_flash;
75 int cursor_reset;
76 int blank_state;
77 int graphics;
Jesse Barnesd219adc2010-08-02 12:05:41 -070078 int save_graphics; /* for debug enter/leave */
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 int flags;
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080080 int rotate;
81 int cur_rotate;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 char *cursor_data;
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080083 u8 *fontbuffer;
84 u8 *fontdata;
Dave Jonese299dd42006-10-03 01:14:47 -070085 u8 *cursor_src;
86 u32 cursor_size;
Antonino A. Daplase4fc2762005-11-08 21:39:09 -080087 u32 fd_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088};
89 /*
90 * Attribute Decoding
91 */
92
93/* Color */
94#define attr_fgcol(fgshift,s) \
95 (((s) >> (fgshift)) & 0x0f)
96#define attr_bgcol(bgshift,s) \
Linus Torvalds3838f592008-08-11 10:29:11 -070097 (((s) >> (bgshift)) & 0x0f)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
99/* Monochrome */
100#define attr_bold(s) \
101 ((s) & 0x200)
102#define attr_reverse(s) \
103 ((s) & 0x800)
104#define attr_underline(s) \
105 ((s) & 0x400)
106#define attr_blink(s) \
107 ((s) & 0x8000)
108
Harvey Harrison22af89a2008-04-28 02:14:53 -0700109
110static inline int mono_col(const struct fb_info *info)
111{
112 __u32 max_len;
113 max_len = max(info->var.green.length, info->var.red.length);
114 max_len = max(info->var.blue.length, max_len);
David Winn08650862008-10-02 14:50:11 -0700115 return (~(0xfff << max_len)) & 0xff;
Harvey Harrison22af89a2008-04-28 02:14:53 -0700116}
Thomas Pfaff91c43132008-02-06 01:39:45 -0800117
118static inline int attr_col_ec(int shift, struct vc_data *vc,
119 struct fb_info *info, int is_fg)
120{
121 int is_mono01;
122 int col;
123 int fg;
124 int bg;
125
126 if (!vc)
127 return 0;
128
129 if (vc->vc_can_do_color)
130 return is_fg ? attr_fgcol(shift,vc->vc_video_erase_char)
131 : attr_bgcol(shift,vc->vc_video_erase_char);
132
133 if (!info)
134 return 0;
135
136 col = mono_col(info);
137 is_mono01 = info->fix.visual == FB_VISUAL_MONO01;
138
139 if (attr_reverse(vc->vc_video_erase_char)) {
140 fg = is_mono01 ? col : 0;
141 bg = is_mono01 ? 0 : col;
142 }
143 else {
144 fg = is_mono01 ? 0 : col;
145 bg = is_mono01 ? col : 0;
146 }
147
148 return is_fg ? fg : bg;
149}
150
Jan Beulichcba603b2008-07-23 21:31:49 -0700151#define attr_bgcol_ec(bgshift, vc, info) attr_col_ec(bgshift, vc, info, 0)
152#define attr_fgcol_ec(fgshift, vc, info) attr_col_ec(fgshift, vc, info, 1)
Thomas Pfaff91c43132008-02-06 01:39:45 -0800153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154/* Font */
155#define REFCOUNT(fd) (((int *)(fd))[-1])
156#define FNTSIZE(fd) (((int *)(fd))[-2])
157#define FNTCHARCNT(fd) (((int *)(fd))[-3])
158#define FNTSUM(fd) (((int *)(fd))[-4])
159#define FONT_EXTRA_WORDS 4
160
161 /*
162 * Scroll Method
163 */
164
165/* There are several methods fbcon can use to move text around the screen:
166 *
167 * Operation Pan Wrap
168 *---------------------------------------------
169 * SCROLL_MOVE copyarea No No
170 * SCROLL_PAN_MOVE copyarea Yes No
171 * SCROLL_WRAP_MOVE copyarea No Yes
172 * SCROLL_REDRAW imageblit No No
173 * SCROLL_PAN_REDRAW imageblit Yes No
174 * SCROLL_WRAP_REDRAW imageblit No Yes
175 *
176 * (SCROLL_WRAP_REDRAW is not implemented yet)
177 *
178 * In general, fbcon will choose the best scrolling
179 * method based on the rule below:
180 *
181 * Pan/Wrap > accel imageblit > accel copyarea >
182 * soft imageblit > (soft copyarea)
183 *
184 * Exception to the rule: Pan + accel copyarea is
185 * preferred over Pan + accel imageblit.
186 *
187 * The above is typical for PCI/AGP cards. Unless
188 * overridden, fbcon will never use soft copyarea.
189 *
190 * If you need to override the above rule, set the
191 * appropriate flags in fb_info->flags. For example,
192 * to prefer copyarea over imageblit, set
193 * FBINFO_READS_FAST.
194 *
195 * Other notes:
196 * + use the hardware engine to move the text
197 * (hw-accelerated copyarea() and fillrect())
198 * + use hardware-supported panning on a large virtual screen
199 * + amifb can not only pan, but also wrap the display by N lines
200 * (i.e. visible line i = physical line (i+N) % yres).
201 * + read what's already rendered on the screen and
202 * write it in a different place (this is cfb_copyarea())
203 * + re-render the text to the screen
204 *
205 * Whether to use wrapping or panning can only be figured out at
206 * runtime (when we know whether our font height is a multiple
207 * of the pan/wrap step)
208 *
209 */
210
211#define SCROLL_MOVE 0x001
212#define SCROLL_PAN_MOVE 0x002
213#define SCROLL_WRAP_MOVE 0x003
214#define SCROLL_REDRAW 0x004
215#define SCROLL_PAN_REDRAW 0x005
216
217#ifdef CONFIG_FB_TILEBLITTING
Antonino A. Daplasb73deed2006-01-09 20:52:56 -0800218extern void fbcon_set_tileops(struct vc_data *vc, struct fb_info *info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219#endif
220extern void fbcon_set_bitops(struct fbcon_ops *ops);
Antonino A. Daplasc465e052005-11-07 01:00:35 -0800221extern int soft_cursor(struct fb_info *info, struct fb_cursor *cursor);
Antonino A. Daplase4fc2762005-11-08 21:39:09 -0800222
223#define FBCON_ATTRIBUTE_UNDERLINE 1
224#define FBCON_ATTRIBUTE_REVERSE 2
225#define FBCON_ATTRIBUTE_BOLD 4
226
227static inline int real_y(struct display *p, int ypos)
228{
229 int rows = p->vrows;
230
231 ypos += p->yscroll;
232 return ypos < rows ? ypos : ypos - rows;
233}
234
235
236static inline int get_attribute(struct fb_info *info, u16 c)
237{
238 int attribute = 0;
239
240 if (fb_get_color_depth(&info->var, &info->fix) == 1) {
241 if (attr_underline(c))
242 attribute |= FBCON_ATTRIBUTE_UNDERLINE;
243 if (attr_reverse(c))
244 attribute |= FBCON_ATTRIBUTE_REVERSE;
245 if (attr_bold(c))
246 attribute |= FBCON_ATTRIBUTE_BOLD;
247 }
248
249 return attribute;
250}
251
252#define FBCON_SWAP(i,r,v) ({ \
253 typeof(r) _r = (r); \
254 typeof(v) _v = (v); \
255 (void) (&_r == &_v); \
256 (i == FB_ROTATE_UR || i == FB_ROTATE_UD) ? _r : _v; })
257
Antonino A. Daplas6cc50e12005-11-08 21:39:11 -0800258#ifdef CONFIG_FRAMEBUFFER_CONSOLE_ROTATION
259extern void fbcon_set_rotate(struct fbcon_ops *ops);
260#else
Antonino A. Daplase4fc2762005-11-08 21:39:09 -0800261#define fbcon_set_rotate(x) do {} while(0)
Antonino A. Daplas6cc50e12005-11-08 21:39:11 -0800262#endif /* CONFIG_FRAMEBUFFER_CONSOLE_ROTATION */
Antonino A. Daplase4fc2762005-11-08 21:39:09 -0800263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#endif /* _VIDEO_FBCON_H */
Antonino A. Daplase4fc2762005-11-08 21:39:09 -0800265