1 /* vi: set sw=4 ts=4: */
3 * Copyright (C) 2008 Michele Sanges <michele.sanges@gmail.com>
5 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
8 * - use kernel option 'vga=xxx' or otherwise enable framebuffer device.
9 * - put somewhere fbsplash.cfg file and an image in .ppm format.
10 * - run applet: $ setsid fbsplash [params] &
12 * -d /dev/fbN: framebuffer device (if not /dev/fb0)
13 * -s path_to_image_file (can be "-" for stdin)
15 * -f path_to_fifo (can be "-" for stdin)
16 * - if you want to run it only in presence of a kernel parameter
17 * (for example fbsplash=on), use:
18 * grep -q "fbsplash=on" </proc/cmdline && setsid fbsplash [params]
19 * - commands for fifo:
20 * "NN" (ASCII decimal number) - percentage to show on progress bar.
21 * "exit" (or just close fifo) - well you guessed it.
24 //usage:#define fbsplash_trivial_usage
25 //usage: "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
26 //usage:#define fbsplash_full_usage "\n\n"
28 //usage: "\n -c Hide cursor"
29 //usage: "\n -d Framebuffer device (default /dev/fb0)"
30 //usage: "\n -i Config file (var=value):"
31 //usage: "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT"
32 //usage: "\n BAR_R,BAR_G,BAR_B"
33 //usage: "\n -f Control pipe (else exit after drawing image)"
34 //usage: "\n commands: 'NN' (% for progress bar) or 'exit'"
39 /* If you want logging messages on /tmp/fbsplash.log... */
44 bool bdebug_messages
; // enable/disable logging
45 FILE *logfile_fd
; // log file
47 unsigned char *addr
; // pointer to framebuffer memory
48 unsigned ns
[7]; // n-parameters
49 const char *image_filename
;
50 struct fb_var_screeninfo scr_var
;
51 struct fb_fix_screeninfo scr_fix
;
52 unsigned bytes_per_pixel
;
54 #define G (*ptr_to_globals)
55 #define INIT_G() do { \
56 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
59 #define nbar_width ns[0] // progress bar width
60 #define nbar_height ns[1] // progress bar height
61 #define nbar_posx ns[2] // progress bar horizontal position
62 #define nbar_posy ns[3] // progress bar vertical position
63 #define nbar_colr ns[4] // progress bar color red component
64 #define nbar_colg ns[5] // progress bar color green component
65 #define nbar_colb ns[6] // progress bar color blue component
68 #define DEBUG_MESSAGE(strMessage, args...) \
69 if (G.bdebug_messages) { \
70 fprintf(G.logfile_fd, "[%s][%s] - %s\n", \
71 __FILE__, __FUNCTION__, strMessage); \
74 #define DEBUG_MESSAGE(...) ((void)0)
78 * Configure palette for RGB:332
80 static void fb_setpal(int fd
)
83 /* fb colors are 16 bit */
84 unsigned short red
[256], green
[256], blue
[256];
88 for (i
= 0; i
< 256; i
++) {
89 /* Color is encoded in pixel value as rrrgggbb.
90 * 3-bit color is mapped to 16-bit one as:
91 * 000 -> 00000000 00000000
92 * 001 -> 00100100 10010010
94 * 011 -> 01101101 10110110
95 * 100 -> 10010010 01001001
97 * 111 -> 11111111 11111111
99 red
[i
] = (( i
>> 5 ) * 0x9249) >> 2; // rrr * 00 10010010 01001001 >> 2
100 green
[i
] = (((i
>> 2) & 0x7) * 0x9249) >> 2; // ggg * 00 10010010 01001001 >> 2
101 /* 2-bit color is easier: */
102 blue
[i
] = ( i
& 0x3) * 0x5555; // bb * 01010101 01010101
112 xioctl(fd
, FBIOPUTCMAP
, &cmap
);
116 * Open and initialize the framebuffer device
117 * \param *strfb_device pointer to framebuffer device
119 static void fb_open(const char *strfb_device
)
121 int fbfd
= xopen(strfb_device
, O_RDWR
);
123 // framebuffer properties
124 xioctl(fbfd
, FBIOGET_VSCREENINFO
, &G
.scr_var
);
125 xioctl(fbfd
, FBIOGET_FSCREENINFO
, &G
.scr_fix
);
127 switch (G
.scr_var
.bits_per_pixel
) {
138 bb_error_msg_and_die("unsupported %u bpp", (int)G
.scr_var
.bits_per_pixel
);
142 G
.bytes_per_pixel
= (G
.scr_var
.bits_per_pixel
+ 7) >> 3;
144 // map the device in memory
146 G
.scr_var
.yres
* G
.scr_fix
.line_length
,
147 PROT_WRITE
, MAP_SHARED
, fbfd
, 0);
148 if (G
.addr
== MAP_FAILED
)
149 bb_perror_msg_and_die("mmap");
151 // point to the start of the visible screen
152 G
.addr
+= G
.scr_var
.yoffset
* G
.scr_fix
.line_length
+ G
.scr_var
.xoffset
* G
.bytes_per_pixel
;
158 * Return pixel value of the passed RGB color
160 static unsigned fb_pixel_value(unsigned r
, unsigned g
, unsigned b
)
162 if (G
.bytes_per_pixel
== 1) {
163 r
= r
& 0xe0; // 3-bit red
164 g
= (g
>> 3) & 0x1c; // 3-bit green
165 b
= b
>> 6; // 2-bit blue
168 if (G
.bytes_per_pixel
== 2) {
169 r
= (r
& 0xf8) << 8; // 5-bit red
170 g
= (g
& 0xfc) << 3; // 6-bit green
171 b
= b
>> 3; // 5-bit blue
175 return b
+ (g
<< 8) + (r
<< 16);
179 * Draw pixel on framebuffer
181 static void fb_write_pixel(unsigned char *addr
, unsigned pixel
)
183 switch (G
.bytes_per_pixel
) {
188 *(uint16_t *)addr
= pixel
;
191 *(uint32_t *)addr
= pixel
;
193 default: // 24 bits per pixel
195 addr
[1] = pixel
>> 8;
196 addr
[2] = pixel
>> 16;
202 * Draw hollow rectangle on framebuffer
204 static void fb_drawrectangle(void)
208 unsigned char *ptr1
, *ptr2
;
209 unsigned char nred
= G
.nbar_colr
/2;
210 unsigned char ngreen
= G
.nbar_colg
/2;
211 unsigned char nblue
= G
.nbar_colb
/2;
213 thispix
= fb_pixel_value(nred
, ngreen
, nblue
);
216 ptr1
= G
.addr
+ G
.nbar_posy
* G
.scr_fix
.line_length
+ G
.nbar_posx
* G
.bytes_per_pixel
;
217 ptr2
= G
.addr
+ (G
.nbar_posy
+ G
.nbar_height
- 1) * G
.scr_fix
.line_length
+ G
.nbar_posx
* G
.bytes_per_pixel
;
218 cnt
= G
.nbar_width
- 1;
220 fb_write_pixel(ptr1
, thispix
);
221 fb_write_pixel(ptr2
, thispix
);
222 ptr1
+= G
.bytes_per_pixel
;
223 ptr2
+= G
.bytes_per_pixel
;
224 } while (--cnt
>= 0);
227 ptr1
= G
.addr
+ G
.nbar_posy
* G
.scr_fix
.line_length
+ G
.nbar_posx
* G
.bytes_per_pixel
;
228 ptr2
= G
.addr
+ G
.nbar_posy
* G
.scr_fix
.line_length
+ (G
.nbar_posx
+ G
.nbar_width
- 1) * G
.bytes_per_pixel
;
229 cnt
= G
.nbar_height
- 1;
231 fb_write_pixel(ptr1
, thispix
);
232 fb_write_pixel(ptr2
, thispix
);
233 ptr1
+= G
.scr_fix
.line_length
;
234 ptr2
+= G
.scr_fix
.line_length
;
235 } while (--cnt
>= 0);
240 * Draw filled rectangle on framebuffer
241 * \param nx1pos,ny1pos upper left position
242 * \param nx2pos,ny2pos down right position
243 * \param nred,ngreen,nblue rgb color
245 static void fb_drawfullrectangle(int nx1pos
, int ny1pos
, int nx2pos
, int ny2pos
,
246 unsigned char nred
, unsigned char ngreen
, unsigned char nblue
)
248 int cnt1
, cnt2
, nypos
;
252 thispix
= fb_pixel_value(nred
, ngreen
, nblue
);
254 cnt1
= ny2pos
- ny1pos
;
257 ptr
= G
.addr
+ nypos
* G
.scr_fix
.line_length
+ nx1pos
* G
.bytes_per_pixel
;
258 cnt2
= nx2pos
- nx1pos
;
260 fb_write_pixel(ptr
, thispix
);
261 ptr
+= G
.bytes_per_pixel
;
262 } while (--cnt2
>= 0);
265 } while (--cnt1
>= 0);
270 * Draw a progress bar on framebuffer
271 * \param percent percentage of loading
273 static void fb_drawprogressbar(unsigned percent
)
275 int left_x
, top_y
, pos_x
;
276 unsigned width
, height
;
279 left_x
= G
.nbar_posx
;
281 width
= G
.nbar_width
- 1;
282 height
= G
.nbar_height
- 1;
283 if ((int)(height
| width
) < 0)
285 // NB: "width" of 1 actually makes rect with width of 2!
288 // inner "empty" rectangle
293 if ((int)(height
| width
) < 0)
301 // actual progress bar
302 pos_x
+= (unsigned)(width
* percent
) / 100;
307 height
++; // divide by 0 is bad
309 // draw one-line thick "rectangle"
310 // top line will have gray lvl 200, bottom one 100
311 unsigned gray_level
= 100 + i
*100 / height
;
312 fb_drawfullrectangle(
314 gray_level
, gray_level
, gray_level
);
320 fb_drawfullrectangle(
322 left_x
+ width
, top_y
+ height
,
323 G
.nbar_colr
, G
.nbar_colg
, G
.nbar_colb
);
328 * Draw image from PPM file
330 static void fb_drawimage(void)
334 unsigned char *pixline
;
335 unsigned i
, j
, width
, height
, line_size
;
337 if (LONE_DASH(G
.image_filename
)) {
340 int fd
= open_zipped(G
.image_filename
);
342 bb_simple_perror_msg_and_die(G
.image_filename
);
343 theme_file
= xfdopen_for_read(fd
);
347 * - Magic: two characters "P6".
348 * - Whitespace (blanks, TABs, CRs, LFs).
349 * - A width, formatted as ASCII characters in decimal.
351 * - A height, ASCII decimal.
353 * - The maximum color value, ASCII decimal, in 0..65535
354 * - Newline or other single whitespace character.
355 * (we support newline only)
356 * - A raster of Width * Height pixels in triplets of rgb
357 * in pure binary by 1 or 2 bytes. (we support only 1 byte)
359 #define concat_buf bb_common_bufsiz1
360 read_ptr
= concat_buf
;
362 int w
, h
, max_color_val
;
363 int rem
= concat_buf
+ sizeof(concat_buf
) - read_ptr
;
365 || fgets(read_ptr
, rem
, theme_file
) == NULL
367 bb_error_msg_and_die("bad PPM file '%s'", G
.image_filename
);
369 read_ptr
= strchrnul(read_ptr
, '#');
370 *read_ptr
= '\0'; /* ignore #comments */
371 if (sscanf(concat_buf
, "P6 %u %u %u", &w
, &h
, &max_color_val
) == 3
372 && max_color_val
<= 255
374 width
= w
; /* w is on stack, width may be in register */
381 pixline
= xmalloc(line_size
);
383 if (width
> G
.scr_var
.xres
)
384 width
= G
.scr_var
.xres
;
385 if (height
> G
.scr_var
.yres
)
386 height
= G
.scr_var
.yres
;
387 for (j
= 0; j
< height
; j
++) {
388 unsigned char *pixel
;
391 if (fread(pixline
, 1, line_size
, theme_file
) != line_size
)
392 bb_error_msg_and_die("bad PPM file '%s'", G
.image_filename
);
394 src
= G
.addr
+ j
* G
.scr_fix
.line_length
;
395 for (i
= 0; i
< width
; i
++) {
396 unsigned thispix
= fb_pixel_value(pixel
[0], pixel
[1], pixel
[2]);
397 fb_write_pixel(src
, thispix
);
398 src
+= G
.bytes_per_pixel
;
408 * Parse configuration file
409 * \param *cfg_filename name of the configuration file
411 static void init(const char *cfg_filename
)
413 static const char param_names
[] ALIGN1
=
414 "BAR_WIDTH\0" "BAR_HEIGHT\0"
415 "BAR_LEFT\0" "BAR_TOP\0"
416 "BAR_R\0" "BAR_G\0" "BAR_B\0"
422 parser_t
*parser
= config_open2(cfg_filename
, xfopen_stdin
);
423 while (config_read(parser
, token
, 2, 2, "#=",
424 (PARSE_NORMAL
| PARSE_MIN_DIE
) & ~(PARSE_TRIM
| PARSE_COLLAPSE
))) {
425 unsigned val
= xatoi_positive(token
[1]);
426 int i
= index_in_strings(param_names
, token
[0]);
428 bb_error_msg_and_die("syntax error: %s", token
[0]);
433 G
.bdebug_messages
= val
;
434 if (G
.bdebug_messages
)
435 G
.logfile_fd
= xfopen_for_write("/tmp/fbsplash.log");
439 config_close(parser
);
443 int fbsplash_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
444 int fbsplash_main(int argc UNUSED_PARAM
, char **argv
)
446 const char *fb_device
, *cfg_filename
, *fifo_filename
;
447 FILE *fp
= fp
; // for compiler
454 // parse command line options
455 fb_device
= "/dev/fb0";
457 fifo_filename
= NULL
;
458 bCursorOff
= 1 & getopt32(argv
, "cs:d:i:f:",
459 &G
.image_filename
, &fb_device
, &cfg_filename
, &fifo_filename
);
461 // parse configuration file
465 // We must have -s IMG
466 if (!G
.image_filename
)
471 if (fifo_filename
&& bCursorOff
) {
472 // hide cursor (BEFORE any fb ops)
473 full_write(STDOUT_FILENO
, "\033[?25l", 6);
481 fp
= xfopen_stdin(fifo_filename
);
483 // For named pipes, we want to support this:
485 // fbsplash -f cmd_pipe .... &
490 // This means that we don't want fbsplash to get EOF
491 // when last writer closes input end.
492 // The simplest way is to open fifo for writing too
493 // and become an additional writer :)
494 open(fifo_filename
, O_WRONLY
); // errors are ignored
497 fb_drawprogressbar(0);
498 // Block on read, waiting for some input.
499 // Use of <stdio.h> style I/O allows to correctly
500 // handle a case when we have many buffered lines
501 // already in the pipe
502 while ((num_buf
= xmalloc_fgetline(fp
)) != NULL
) {
503 if (strncmp(num_buf
, "exit", 4) == 0) {
504 DEBUG_MESSAGE("exit");
508 if (isdigit(num_buf
[0]) && (num
<= 100)) {
510 DEBUG_MESSAGE(itoa(num
));
512 fb_drawprogressbar(num
);
517 if (bCursorOff
) // restore cursor
518 full_write(STDOUT_FILENO
, "\033[?25h", 6);