fbsplash.c 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570
  1. /* vi: set sw=4 ts=4: */
  2. /*
  3. * Copyright (C) 2008 Michele Sanges <michele.sanges@gmail.com>
  4. *
  5. * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  6. *
  7. * Usage:
  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] &
  11. * -c: hide cursor
  12. * -d /dev/fbN: framebuffer device (if not /dev/fb0)
  13. * -s path_to_image_file (can be "-" for stdin)
  14. * -i path_to_cfg_file
  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.
  22. */
  23. //config:config FBSPLASH
  24. //config: bool "fbsplash (26 kb)"
  25. //config: default y
  26. //config: select PLATFORM_LINUX
  27. //config: help
  28. //config: Shows splash image and progress bar on framebuffer device.
  29. //config: Can be used during boot phase of an embedded device.
  30. //config: Usage:
  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
  44. //applet:IF_FBSPLASH(APPLET(fbsplash, BB_DIR_SBIN, BB_SUID_DROP))
  45. //kbuild:lib-$(CONFIG_FBSPLASH) += fbsplash.o
  46. //usage:#define fbsplash_trivial_usage
  47. //usage: "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]"
  48. //usage:#define fbsplash_full_usage "\n\n"
  49. //usage: " -s Image"
  50. //usage: "\n -c Hide cursor"
  51. //usage: "\n -d Framebuffer device (default /dev/fb0)"
  52. //usage: "\n -i Config file (var=value):"
  53. //usage: "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT"
  54. //usage: "\n BAR_R,BAR_G,BAR_B,IMG_LEFT,IMG_TOP"
  55. //usage: "\n -f Control pipe (else exit after drawing image)"
  56. //usage: "\n commands: 'NN' (% for progress bar) or 'exit'"
  57. #include "libbb.h"
  58. #include "common_bufsiz.h"
  59. #include <linux/fb.h>
  60. /* If you want logging messages on /tmp/fbsplash.log... */
  61. #define DEBUG 0
  62. #define ESC "\033"
  63. struct globals {
  64. #if DEBUG
  65. bool bdebug_messages; // enable/disable logging
  66. FILE *logfile_fd; // log file
  67. #endif
  68. unsigned char *addr; // pointer to framebuffer memory
  69. unsigned ns[9]; // n-parameters
  70. const char *image_filename;
  71. struct fb_var_screeninfo scr_var;
  72. struct fb_fix_screeninfo scr_fix;
  73. unsigned bytes_per_pixel;
  74. // cached (8 - scr_var.COLOR.length):
  75. unsigned red_shift;
  76. unsigned green_shift;
  77. unsigned blue_shift;
  78. };
  79. #define G (*ptr_to_globals)
  80. #define INIT_G() do { \
  81. SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
  82. } while (0)
  83. #define nbar_width ns[0] // progress bar width
  84. #define nbar_height ns[1] // progress bar height
  85. #define nbar_posx ns[2] // progress bar horizontal position
  86. #define nbar_posy ns[3] // progress bar vertical position
  87. #define nbar_colr ns[4] // progress bar color red component
  88. #define nbar_colg ns[5] // progress bar color green component
  89. #define nbar_colb ns[6] // progress bar color blue component
  90. #define img_posx ns[7] // image horizontal position
  91. #define img_posy ns[8] // image vertical position
  92. #if DEBUG
  93. #define DEBUG_MESSAGE(strMessage, args...) \
  94. if (G.bdebug_messages) { \
  95. fprintf(G.logfile_fd, "[%s][%s] - %s\n", \
  96. __FILE__, __FUNCTION__, strMessage); \
  97. }
  98. #else
  99. #define DEBUG_MESSAGE(...) ((void)0)
  100. #endif
  101. /**
  102. * Configure palette for RGB:332
  103. */
  104. static void fb_setpal(int fd)
  105. {
  106. struct fb_cmap cmap;
  107. /* fb colors are 16 bit */
  108. unsigned short red[256], green[256], blue[256];
  109. unsigned i;
  110. /* RGB:332 */
  111. for (i = 0; i < 256; i++) {
  112. /* Color is encoded in pixel value as rrrgggbb.
  113. * 3-bit color is mapped to 16-bit one as:
  114. * 000 -> 00000000 00000000
  115. * 001 -> 00100100 10010010
  116. * ...
  117. * 011 -> 01101101 10110110
  118. * 100 -> 10010010 01001001
  119. * ...
  120. * 111 -> 11111111 11111111
  121. */
  122. red[i] = (( i >> 5 ) * 0x9249) >> 2; // rrr * 00 10010010 01001001 >> 2
  123. green[i] = (((i >> 2) & 0x7) * 0x9249) >> 2; // ggg * 00 10010010 01001001 >> 2
  124. /* 2-bit color is easier: */
  125. blue[i] = ( i & 0x3) * 0x5555; // bb * 01010101 01010101
  126. }
  127. cmap.start = 0;
  128. cmap.len = 256;
  129. cmap.red = red;
  130. cmap.green = green;
  131. cmap.blue = blue;
  132. cmap.transp = 0;
  133. xioctl(fd, FBIOPUTCMAP, &cmap);
  134. }
  135. /**
  136. * Open and initialize the framebuffer device
  137. * \param *strfb_device pointer to framebuffer device
  138. */
  139. static void fb_open(const char *strfb_device)
  140. {
  141. int fbfd = xopen(strfb_device, O_RDWR);
  142. // framebuffer properties
  143. xioctl(fbfd, FBIOGET_VSCREENINFO, &G.scr_var);
  144. xioctl(fbfd, FBIOGET_FSCREENINFO, &G.scr_fix);
  145. switch (G.scr_var.bits_per_pixel) {
  146. case 8:
  147. fb_setpal(fbfd);
  148. break;
  149. case 16:
  150. case 24:
  151. case 32:
  152. break;
  153. default:
  154. bb_error_msg_and_die("unsupported %u bpp", (int)G.scr_var.bits_per_pixel);
  155. break;
  156. }
  157. G.red_shift = 8 - G.scr_var.red.length;
  158. G.green_shift = 8 - G.scr_var.green.length;
  159. G.blue_shift = 8 - G.scr_var.blue.length;
  160. G.bytes_per_pixel = (G.scr_var.bits_per_pixel + 7) >> 3;
  161. // map the device in memory
  162. G.addr = mmap(NULL,
  163. (G.scr_var.yres_virtual ?: G.scr_var.yres) * G.scr_fix.line_length,
  164. PROT_WRITE, MAP_SHARED, fbfd, 0);
  165. if (G.addr == MAP_FAILED)
  166. bb_perror_msg_and_die("mmap");
  167. // point to the start of the visible screen
  168. G.addr += G.scr_var.yoffset * G.scr_fix.line_length + G.scr_var.xoffset * G.bytes_per_pixel;
  169. close(fbfd);
  170. }
  171. /**
  172. * Return pixel value of the passed RGB color.
  173. * This is performance critical fn.
  174. */
  175. static unsigned fb_pixel_value(unsigned r, unsigned g, unsigned b)
  176. {
  177. /* We assume that the r,g,b values are <= 255 */
  178. if (G.bytes_per_pixel == 1) {
  179. r = r & 0xe0; // 3-bit red
  180. g = (g >> 3) & 0x1c; // 3-bit green
  181. b = b >> 6; // 2-bit blue
  182. return r + g + b;
  183. }
  184. if (G.bytes_per_pixel == 2) {
  185. // ARM PL110 on Integrator/CP has RGBA5551 bit arrangement.
  186. // We want to support bit locations like that.
  187. //
  188. // First shift out unused bits
  189. r = r >> G.red_shift;
  190. g = g >> G.green_shift;
  191. b = b >> G.blue_shift;
  192. // Then shift the remaining bits to their offset
  193. return (r << G.scr_var.red.offset) +
  194. (g << G.scr_var.green.offset) +
  195. (b << G.scr_var.blue.offset);
  196. }
  197. // RGB 888
  198. return b + (g << 8) + (r << 16);
  199. }
  200. /**
  201. * Draw pixel on framebuffer
  202. */
  203. static void fb_write_pixel(unsigned char *addr, unsigned pixel)
  204. {
  205. switch (G.bytes_per_pixel) {
  206. case 1:
  207. *addr = pixel;
  208. break;
  209. case 2:
  210. *(uint16_t *)addr = pixel;
  211. break;
  212. case 4:
  213. *(uint32_t *)addr = pixel;
  214. break;
  215. default: // 24 bits per pixel
  216. addr[0] = pixel;
  217. addr[1] = pixel >> 8;
  218. addr[2] = pixel >> 16;
  219. }
  220. }
  221. /**
  222. * Draw hollow rectangle on framebuffer
  223. */
  224. static void fb_drawrectangle(void)
  225. {
  226. int cnt;
  227. unsigned thispix;
  228. unsigned char *ptr1, *ptr2;
  229. unsigned char nred = G.nbar_colr/2;
  230. unsigned char ngreen = G.nbar_colg/2;
  231. unsigned char nblue = G.nbar_colb/2;
  232. thispix = fb_pixel_value(nred, ngreen, nblue);
  233. // horizontal lines
  234. ptr1 = G.addr + G.nbar_posy * G.scr_fix.line_length + G.nbar_posx * G.bytes_per_pixel;
  235. ptr2 = G.addr + (G.nbar_posy + G.nbar_height - 1) * G.scr_fix.line_length + G.nbar_posx * G.bytes_per_pixel;
  236. cnt = G.nbar_width - 1;
  237. do {
  238. fb_write_pixel(ptr1, thispix);
  239. fb_write_pixel(ptr2, thispix);
  240. ptr1 += G.bytes_per_pixel;
  241. ptr2 += G.bytes_per_pixel;
  242. } while (--cnt >= 0);
  243. // vertical lines
  244. ptr1 = G.addr + G.nbar_posy * G.scr_fix.line_length + G.nbar_posx * G.bytes_per_pixel;
  245. ptr2 = G.addr + G.nbar_posy * G.scr_fix.line_length + (G.nbar_posx + G.nbar_width - 1) * G.bytes_per_pixel;
  246. cnt = G.nbar_height - 1;
  247. do {
  248. fb_write_pixel(ptr1, thispix);
  249. fb_write_pixel(ptr2, thispix);
  250. ptr1 += G.scr_fix.line_length;
  251. ptr2 += G.scr_fix.line_length;
  252. } while (--cnt >= 0);
  253. }
  254. /**
  255. * Draw filled rectangle on framebuffer
  256. * \param nx1pos,ny1pos upper left position
  257. * \param nx2pos,ny2pos down right position
  258. * \param nred,ngreen,nblue rgb color
  259. */
  260. static void fb_drawfullrectangle(int nx1pos, int ny1pos, int nx2pos, int ny2pos,
  261. unsigned char nred, unsigned char ngreen, unsigned char nblue)
  262. {
  263. int cnt1, cnt2, nypos;
  264. unsigned thispix;
  265. unsigned char *ptr;
  266. thispix = fb_pixel_value(nred, ngreen, nblue);
  267. cnt1 = ny2pos - ny1pos;
  268. nypos = ny1pos;
  269. do {
  270. ptr = G.addr + nypos * G.scr_fix.line_length + nx1pos * G.bytes_per_pixel;
  271. cnt2 = nx2pos - nx1pos;
  272. do {
  273. fb_write_pixel(ptr, thispix);
  274. ptr += G.bytes_per_pixel;
  275. } while (--cnt2 >= 0);
  276. nypos++;
  277. } while (--cnt1 >= 0);
  278. }
  279. /**
  280. * Draw a progress bar on framebuffer
  281. * \param percent percentage of loading
  282. */
  283. static void fb_drawprogressbar(unsigned percent)
  284. {
  285. int left_x, top_y, pos_x;
  286. unsigned width, height;
  287. // outer box
  288. left_x = G.nbar_posx;
  289. top_y = G.nbar_posy;
  290. width = G.nbar_width - 1;
  291. height = G.nbar_height - 1;
  292. if ((int)(height | width) < 0)
  293. return;
  294. // NB: "width" of 1 actually makes rect with width of 2!
  295. fb_drawrectangle();
  296. // inner "empty" rectangle
  297. left_x++;
  298. top_y++;
  299. width -= 2;
  300. height -= 2;
  301. if ((int)(height | width) < 0)
  302. return;
  303. pos_x = left_x;
  304. if (percent > 0) {
  305. int i, y;
  306. // actual progress bar
  307. pos_x += (unsigned)(width * percent) / 100;
  308. y = top_y;
  309. i = height;
  310. if (height == 0)
  311. height++; // divide by 0 is bad
  312. while (i >= 0) {
  313. // draw one-line thick "rectangle"
  314. // top line will have gray lvl 200, bottom one 100
  315. unsigned gray_level = 100 + (unsigned)i*100 / height;
  316. fb_drawfullrectangle(
  317. left_x, y, pos_x, y,
  318. gray_level, gray_level, gray_level);
  319. y++;
  320. i--;
  321. }
  322. }
  323. fb_drawfullrectangle(
  324. pos_x, top_y,
  325. left_x + width, top_y + height,
  326. G.nbar_colr, G.nbar_colg, G.nbar_colb);
  327. }
  328. /**
  329. * Draw image from PPM file
  330. */
  331. static void fb_drawimage(void)
  332. {
  333. FILE *theme_file;
  334. char *read_ptr;
  335. unsigned char *pixline;
  336. unsigned i, j, width, height, line_size;
  337. if (LONE_DASH(G.image_filename)) {
  338. theme_file = stdin;
  339. } else {
  340. int fd = open_zipped(G.image_filename, /*fail_if_not_compressed:*/ 0);
  341. if (fd < 0)
  342. bb_simple_perror_msg_and_die(G.image_filename);
  343. theme_file = xfdopen_for_read(fd);
  344. }
  345. /* Parse ppm header:
  346. * - Magic: two characters "P6".
  347. * - Whitespace (blanks, TABs, CRs, LFs).
  348. * - A width, formatted as ASCII characters in decimal.
  349. * - Whitespace.
  350. * - A height, ASCII decimal.
  351. * - Whitespace.
  352. * - The maximum color value, ASCII decimal, in 0..65535
  353. * - Newline or other single whitespace character.
  354. * (we support newline only)
  355. * - A raster of Width * Height pixels in triplets of rgb
  356. * in pure binary by 1 or 2 bytes. (we support only 1 byte)
  357. */
  358. #define concat_buf bb_common_bufsiz1
  359. setup_common_bufsiz();
  360. read_ptr = concat_buf;
  361. while (1) {
  362. int w, h, max_color_val;
  363. int rem = concat_buf + COMMON_BUFSIZE - read_ptr;
  364. if (rem < 2
  365. || fgets(read_ptr, rem, theme_file) == NULL
  366. ) {
  367. bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
  368. }
  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
  373. ) {
  374. width = w; /* w is on stack, width may be in register */
  375. height = h;
  376. break;
  377. }
  378. }
  379. line_size = width*3;
  380. pixline = xmalloc(line_size);
  381. if ((width + G.img_posx) > G.scr_var.xres)
  382. width = G.scr_var.xres - G.img_posx;
  383. if ((height + G.img_posy) > G.scr_var.yres)
  384. height = G.scr_var.yres - G.img_posy;
  385. for (j = 0; j < height; j++) {
  386. unsigned char *pixel;
  387. unsigned char *src;
  388. if (fread(pixline, 1, line_size, theme_file) != line_size)
  389. bb_error_msg_and_die("bad PPM file '%s'", G.image_filename);
  390. pixel = pixline;
  391. src = G.addr + (G.img_posy + j) * G.scr_fix.line_length + G.img_posx * G.bytes_per_pixel;
  392. for (i = 0; i < width; i++) {
  393. unsigned thispix = fb_pixel_value(pixel[0], pixel[1], pixel[2]);
  394. fb_write_pixel(src, thispix);
  395. src += G.bytes_per_pixel;
  396. pixel += 3;
  397. }
  398. }
  399. free(pixline);
  400. fclose(theme_file);
  401. }
  402. /**
  403. * Parse configuration file
  404. * \param *cfg_filename name of the configuration file
  405. */
  406. static void init(const char *cfg_filename)
  407. {
  408. static const char param_names[] ALIGN1 =
  409. "BAR_WIDTH\0" "BAR_HEIGHT\0"
  410. "BAR_LEFT\0" "BAR_TOP\0"
  411. "BAR_R\0" "BAR_G\0" "BAR_B\0"
  412. "IMG_LEFT\0" "IMG_TOP\0"
  413. #if DEBUG
  414. "DEBUG\0"
  415. #endif
  416. ;
  417. char *token[2];
  418. parser_t *parser = config_open2(cfg_filename, xfopen_stdin);
  419. while (config_read(parser, token, 2, 2, "#=",
  420. (PARSE_NORMAL | PARSE_MIN_DIE) & ~(PARSE_TRIM | PARSE_COLLAPSE))) {
  421. unsigned val = xatoi_positive(token[1]);
  422. int i = index_in_strings(param_names, token[0]);
  423. if (i < 0)
  424. bb_error_msg_and_die("syntax error: %s", token[0]);
  425. if (i >= 0 && i < 9)
  426. G.ns[i] = val;
  427. #if DEBUG
  428. if (i == 9) {
  429. G.bdebug_messages = val;
  430. if (G.bdebug_messages)
  431. G.logfile_fd = xfopen_for_write("/tmp/fbsplash.log");
  432. }
  433. #endif
  434. }
  435. config_close(parser);
  436. }
  437. int fbsplash_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  438. int fbsplash_main(int argc UNUSED_PARAM, char **argv)
  439. {
  440. const char *fb_device, *cfg_filename, *fifo_filename;
  441. FILE *fp = fp; // for compiler
  442. char *num_buf;
  443. unsigned num;
  444. bool bCursorOff;
  445. INIT_G();
  446. // parse command line options
  447. fb_device = "/dev/fb0";
  448. cfg_filename = NULL;
  449. fifo_filename = NULL;
  450. bCursorOff = 1 & getopt32(argv, "cs:d:i:f:",
  451. &G.image_filename, &fb_device, &cfg_filename, &fifo_filename);
  452. // parse configuration file
  453. if (cfg_filename)
  454. init(cfg_filename);
  455. // We must have -s IMG
  456. if (!G.image_filename)
  457. bb_show_usage();
  458. fb_open(fb_device);
  459. if (fifo_filename && bCursorOff) {
  460. // hide cursor (BEFORE any fb ops)
  461. full_write(STDOUT_FILENO, ESC"[?25l", 6);
  462. }
  463. fb_drawimage();
  464. if (!fifo_filename)
  465. return EXIT_SUCCESS;
  466. fp = xfopen_stdin(fifo_filename);
  467. if (fp != stdin) {
  468. // For named pipes, we want to support this:
  469. // mkfifo cmd_pipe
  470. // fbsplash -f cmd_pipe .... &
  471. // ...
  472. // echo 33 >cmd_pipe
  473. // ...
  474. // echo 66 >cmd_pipe
  475. // This means that we don't want fbsplash to get EOF
  476. // when last writer closes input end.
  477. // The simplest way is to open fifo for writing too
  478. // and become an additional writer :)
  479. open(fifo_filename, O_WRONLY); // errors are ignored
  480. }
  481. fb_drawprogressbar(0);
  482. // Block on read, waiting for some input.
  483. // Use of <stdio.h> style I/O allows to correctly
  484. // handle a case when we have many buffered lines
  485. // already in the pipe
  486. while ((num_buf = xmalloc_fgetline(fp)) != NULL) {
  487. if (is_prefixed_with(num_buf, "exit")) {
  488. DEBUG_MESSAGE("exit");
  489. break;
  490. }
  491. num = atoi(num_buf);
  492. if (isdigit(num_buf[0]) && (num <= 100)) {
  493. #if DEBUG
  494. DEBUG_MESSAGE(itoa(num));
  495. #endif
  496. fb_drawprogressbar(num);
  497. }
  498. free(num_buf);
  499. }
  500. if (bCursorOff) // restore cursor
  501. full_write(STDOUT_FILENO, ESC"[?25h", 6);
  502. return EXIT_SUCCESS;
  503. }