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.
23 //config:config FBSPLASH
24 //config: bool "fbsplash (27 kb)"
26 //config: select PLATFORM_LINUX
28 //config: Shows splash image and progress bar on framebuffer device.
29 //config: Can be used during boot phase of an embedded device.
31 //config: - use kernel option 'vga=xxx' or otherwise enable fb device.
32 //config: - put somewhere fbsplash.cfg file and an image in .ppm format.
33 //config: - $ setsid fbsplash [params] &
34 //config: -c: hide cursor
35 //config: -d /dev/fbN: framebuffer device (if not /dev/fb0)
36 //config: -s path_to_image_file (can be "-" for stdin)
37 //config: -i path_to_cfg_file (can be "-" for stdin)
38 //config: -f path_to_fifo (can be "-" for stdin)
39 //config: - if you want to run it only in presence of kernel parameter:
40 //config: grep -q "fbsplash=on" </proc/cmdline && setsid fbsplash [params] &
41 //config: - commands for fifo:
42 //config: "NN" (ASCII decimal number) - percentage to show on progress bar
43 //config: "exit" - well you guessed it
45 //applet:IF_FBSPLASH(APPLET(fbsplash, BB_DIR_SBIN, BB_SUID_DROP))
47 //kbuild:lib-$(CONFIG_FBSPLASH) += fbsplash.o
49 //usage:#define fbsplash_trivial_usage
50 //usage: "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
51 //usage:#define fbsplash_full_usage "\n\n"
53 //usage: "\n -c Hide cursor"
54 //usage: "\n -d Framebuffer device (default /dev/fb0)"
55 //usage: "\n -i Config file (var=value):"
56 //usage: "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT"
57 //usage: "\n BAR_R,BAR_G,BAR_B"
58 //usage: "\n -f Control pipe (else exit after drawing image)"
59 //usage: "\n commands: 'NN' (% for progress bar) or 'exit'"
62 #include "common_bufsiz.h"
65 /* If you want logging messages on /tmp/fbsplash.log... */
72 bool bdebug_messages; // enable/disable logging
73 FILE *logfile_fd; // log file
75 unsigned char *addr; // pointer to framebuffer memory
76 unsigned ns[7]; // n-parameters
77 const char *image_filename;
78 struct fb_var_screeninfo scr_var;
79 struct fb_fix_screeninfo scr_fix;
80 unsigned bytes_per_pixel;
81 // cached (8 - scr_var.COLOR.length):
86 #define G (*ptr_to_globals)
87 #define INIT_G() do { \
88 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
91 #define nbar_width ns[0] // progress bar width
92 #define nbar_height ns[1] // progress bar height
93 #define nbar_posx ns[2] // progress bar horizontal position
94 #define nbar_posy ns[3] // progress bar vertical position
95 #define nbar_colr ns[4] // progress bar color red component
96 #define nbar_colg ns[5] // progress bar color green component
97 #define nbar_colb ns[6] // progress bar color blue component
100 #define DEBUG_MESSAGE(strMessage, args...) \
101 if (G.bdebug_messages) { \
102 fprintf(G.logfile_fd, "[%s][%s] - %s\n", \
103 __FILE__, __FUNCTION__, strMessage); \
106 #define DEBUG_MESSAGE(...) ((void)0)
110 * Configure palette for RGB:332
112 static void fb_setpal(int fd)
115 /* fb colors are 16 bit */
116 unsigned short red[256], green[256], blue[256];
120 for (i = 0; i < 256; i++) {
121 /* Color is encoded in pixel value as rrrgggbb.
122 * 3-bit color is mapped to 16-bit one as:
123 * 000 -> 00000000 00000000
124 * 001 -> 00100100 10010010
126 * 011 -> 01101101 10110110
127 * 100 -> 10010010 01001001
129 * 111 -> 11111111 11111111
131 red[i] = (( i >> 5 ) * 0x9249) >> 2; // rrr * 00 10010010 01001001 >> 2
132 green[i] = (((i >> 2) & 0x7) * 0x9249) >> 2; // ggg * 00 10010010 01001001 >> 2
133 /* 2-bit color is easier: */
134 blue[i] = ( i & 0x3) * 0x5555; // bb * 01010101 01010101
144 xioctl(fd, FBIOPUTCMAP, &cmap);
148 * Open and initialize the framebuffer device
149 * \param *strfb_device pointer to framebuffer device
151 static void fb_open(const char *strfb_device)
153 int fbfd = xopen(strfb_device, O_RDWR);
155 // framebuffer properties
156 xioctl(fbfd, FBIOGET_VSCREENINFO, &G.scr_var);
157 xioctl(fbfd, FBIOGET_FSCREENINFO, &G.scr_fix);
159 switch (G.scr_var.bits_per_pixel) {
170 bb_error_msg_and_die("unsupported %u bpp", (int)G.scr_var.bits_per_pixel);
174 G.red_shift = 8 - G.scr_var.red.length;
175 G.green_shift = 8 - G.scr_var.green.length;
176 G.blue_shift = 8 - G.scr_var.blue.length;
177 G.bytes_per_pixel = (G.scr_var.bits_per_pixel + 7) >> 3;
179 // map the device in memory
181 (G.scr_var.yres_virtual ?: G.scr_var.yres) * G.scr_fix.line_length,
182 PROT_WRITE, MAP_SHARED, fbfd, 0);
183 if (G.addr == MAP_FAILED)
184 bb_perror_msg_and_die("mmap");
186 // point to the start of the visible screen
187 G.addr += G.scr_var.yoffset * G.scr_fix.line_length + G.scr_var.xoffset * G.bytes_per_pixel;
193 * Return pixel value of the passed RGB color.
194 * This is performance critical fn.
196 static unsigned fb_pixel_value(unsigned r, unsigned g, unsigned b)
198 /* We assume that the r,g,b values are <= 255 */
200 if (G.bytes_per_pixel == 1) {
201 r = r & 0xe0; // 3-bit red
202 g = (g >> 3) & 0x1c; // 3-bit green
203 b = b >> 6; // 2-bit blue
206 if (G.bytes_per_pixel == 2) {
207 // ARM PL110 on Integrator/CP has RGBA5551 bit arrangement.
208 // We want to support bit locations like that.
210 // First shift out unused bits
211 r = r >> G.red_shift;
212 g = g >> G.green_shift;
213 b = b >> G.blue_shift;
214 // Then shift the remaining bits to their offset
215 return (r << G.scr_var.red.offset) +
216 (g << G.scr_var.green.offset) +
217 (b << G.scr_var.blue.offset);
220 return b + (g << 8) + (r << 16);
224 * Draw pixel on framebuffer
226 static void fb_write_pixel(unsigned char *addr, unsigned pixel)
228 switch (G.bytes_per_pixel) {
233 *(uint16_t *)addr = pixel;
236 *(uint32_t *)addr = pixel;
238 default: // 24 bits per pixel
240 addr[1] = pixel >> 8;
241 addr[2] = pixel >> 16;
247 * Draw hollow rectangle on framebuffer
249 static void fb_drawrectangle(void)
253 unsigned char *ptr1, *ptr2;
254 unsigned char nred = G.nbar_colr/2;
255 unsigned char ngreen = G.nbar_colg/2;
256 unsigned char nblue = G.nbar_colb/2;
258 thispix = fb_pixel_value(nred, ngreen, nblue);
261 ptr1 = G.addr + G.nbar_posy * G.scr_fix.line_length + G.nbar_posx * G.bytes_per_pixel;
262 ptr2 = G.addr + (G.nbar_posy + G.nbar_height - 1) * G.scr_fix.line_length + G.nbar_posx * G.bytes_per_pixel;
263 cnt = G.nbar_width - 1;
265 fb_write_pixel(ptr1, thispix);
266 fb_write_pixel(ptr2, thispix);
267 ptr1 += G.bytes_per_pixel;
268 ptr2 += G.bytes_per_pixel;
269 } while (--cnt >= 0);
272 ptr1 = G.addr + G.nbar_posy * G.scr_fix.line_length + G.nbar_posx * G.bytes_per_pixel;
273 ptr2 = G.addr + G.nbar_posy * G.scr_fix.line_length + (G.nbar_posx + G.nbar_width - 1) * G.bytes_per_pixel;
274 cnt = G.nbar_height - 1;
276 fb_write_pixel(ptr1, thispix);
277 fb_write_pixel(ptr2, thispix);
278 ptr1 += G.scr_fix.line_length;
279 ptr2 += G.scr_fix.line_length;
280 } while (--cnt >= 0);
285 * Draw filled rectangle on framebuffer
286 * \param nx1pos,ny1pos upper left position
287 * \param nx2pos,ny2pos down right position
288 * \param nred,ngreen,nblue rgb color
290 static void fb_drawfullrectangle(int nx1pos, int ny1pos, int nx2pos, int ny2pos,
291 unsigned char nred, unsigned char ngreen, unsigned char nblue)
293 int cnt1, cnt2, nypos;
297 thispix = fb_pixel_value(nred, ngreen, nblue);
299 cnt1 = ny2pos - ny1pos;
302 ptr = G.addr + nypos * G.scr_fix.line_length + nx1pos * G.bytes_per_pixel;
303 cnt2 = nx2pos - nx1pos;
305 fb_write_pixel(ptr, thispix);
306 ptr += G.bytes_per_pixel;
307 } while (--cnt2 >= 0);
310 } while (--cnt1 >= 0);
315 * Draw a progress bar on framebuffer
316 * \param percent percentage of loading
318 static void fb_drawprogressbar(unsigned percent)
320 int left_x, top_y, pos_x;
321 unsigned width, height;
324 left_x = G.nbar_posx;
326 width = G.nbar_width - 1;
327 height = G.nbar_height - 1;
328 if ((int)(height | width) < 0)
330 // NB: "width" of 1 actually makes rect with width of 2!
333 // inner "empty" rectangle
338 if ((int)(height | width) < 0)
345 // actual progress bar
346 pos_x += (unsigned)(width * percent) / 100;
351 height++; // divide by 0 is bad
353 // draw one-line thick "rectangle"
354 // top line will have gray lvl 200, bottom one 100
355 unsigned gray_level = 100 + (unsigned)i*100 / height;
356 fb_drawfullrectangle(
358 gray_level, gray_level, gray_level);
364 fb_drawfullrectangle(
366 left_x + width, top_y + height,
367 G.nbar_colr, G.nbar_colg, G.nbar_colb);
372 * Draw image from PPM file
374 static void fb_drawimage(void)
378 unsigned char *pixline;
379 unsigned i, j, width, height, line_size;
381 if (LONE_DASH(G.image_filename)) {
384 int fd = open_zipped(G.image_filename, /*fail_if_not_compressed:*/ 0);
386 bb_simple_perror_msg_and_die(G.image_filename);
387 theme_file = xfdopen_for_read(fd);
391 * - Magic: two characters "P6".
392 * - Whitespace (blanks, TABs, CRs, LFs).
393 * - A width, formatted as ASCII characters in decimal.
395 * - A height, ASCII decimal.
397 * - The maximum color value, ASCII decimal, in 0..65535
398 * - Newline or other single whitespace character.
399 * (we support newline only)
400 * - A raster of Width * Height pixels in triplets of rgb
401 * in pure binary by 1 or 2 bytes. (we support only 1 byte)
403 #define concat_buf bb_common_bufsiz1
404 setup_common_bufsiz();
406 read_ptr = concat_buf;
408 int w, h, max_color_val;
409 int rem = concat_buf + COMMON_BUFSIZE - read_ptr;
411 || fgets(read_ptr, rem, theme_file) == NULL
413 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
415 read_ptr = strchrnul(read_ptr, '#');
416 *read_ptr = '\0'; /* ignore #comments */
417 if (sscanf(concat_buf, "P6 %u %u %u", &w, &h, &max_color_val) == 3
418 && max_color_val <= 255
420 width = w; /* w is on stack, width may be in register */
427 pixline = xmalloc(line_size);
429 if (width > G.scr_var.xres)
430 width = G.scr_var.xres;
431 if (height > G.scr_var.yres)
432 height = G.scr_var.yres;
433 for (j = 0; j < height; j++) {
434 unsigned char *pixel;
437 if (fread(pixline, 1, line_size, theme_file) != line_size)
438 bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
440 src = G.addr + j * G.scr_fix.line_length;
441 for (i = 0; i < width; i++) {
442 unsigned thispix = fb_pixel_value(pixel[0], pixel[1], pixel[2]);
443 fb_write_pixel(src, thispix);
444 src += G.bytes_per_pixel;
454 * Parse configuration file
455 * \param *cfg_filename name of the configuration file
457 static void init(const char *cfg_filename)
459 static const char param_names[] ALIGN1 =
460 "BAR_WIDTH\0" "BAR_HEIGHT\0"
461 "BAR_LEFT\0" "BAR_TOP\0"
462 "BAR_R\0" "BAR_G\0" "BAR_B\0"
468 parser_t *parser = config_open2(cfg_filename, xfopen_stdin);
469 while (config_read(parser, token, 2, 2, "#=",
470 (PARSE_NORMAL | PARSE_MIN_DIE) & ~(PARSE_TRIM | PARSE_COLLAPSE))) {
471 unsigned val = xatoi_positive(token[1]);
472 int i = index_in_strings(param_names, token[0]);
474 bb_error_msg_and_die("syntax error: %s", token[0]);
479 G.bdebug_messages = val;
480 if (G.bdebug_messages)
481 G.logfile_fd = xfopen_for_write("/tmp/fbsplash.log");
485 config_close(parser);
489 int fbsplash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
490 int fbsplash_main(int argc UNUSED_PARAM, char **argv)
492 const char *fb_device, *cfg_filename, *fifo_filename;
493 FILE *fp = fp; // for compiler
500 // parse command line options
501 fb_device = "/dev/fb0";
503 fifo_filename = NULL;
504 bCursorOff = 1 & getopt32(argv, "cs:d:i:f:",
505 &G.image_filename, &fb_device, &cfg_filename, &fifo_filename);
507 // parse configuration file
511 // We must have -s IMG
512 if (!G.image_filename)
517 if (fifo_filename && bCursorOff) {
518 // hide cursor (BEFORE any fb ops)
519 full_write(STDOUT_FILENO, ESC"[?25l", 6);
527 fp = xfopen_stdin(fifo_filename);
529 // For named pipes, we want to support this:
531 // fbsplash -f cmd_pipe .... &
536 // This means that we don't want fbsplash to get EOF
537 // when last writer closes input end.
538 // The simplest way is to open fifo for writing too
539 // and become an additional writer :)
540 open(fifo_filename, O_WRONLY); // errors are ignored
543 fb_drawprogressbar(0);
544 // Block on read, waiting for some input.
545 // Use of <stdio.h> style I/O allows to correctly
546 // handle a case when we have many buffered lines
547 // already in the pipe
548 while ((num_buf = xmalloc_fgetline(fp)) != NULL) {
549 if (is_prefixed_with(num_buf, "exit")) {
550 DEBUG_MESSAGE("exit");
554 if (isdigit(num_buf[0]) && (num <= 100)) {
556 DEBUG_MESSAGE(itoa(num));
558 fb_drawprogressbar(num);
563 if (bCursorOff) // restore cursor
564 full_write(STDOUT_FILENO, ESC"[?25h", 6);