common/cmd_bmp.c

   1 /*
   2  * (C) Copyright 2002
   3  * Detlev Zundel, DENX Software Engineering, dzu@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 /*
   9  * BMP handling routines
  10  */
  11
  12 #include <common.h>
  13 #include <lcd.h>
  14 #include <bmp_layout.h>
  15 #include <command.h>
  16 #include <asm/byteorder.h>
  17 #include <malloc.h>
  18 #include <splash.h>
  19 #include <video.h>
  20
  21 static int bmp_info (ulong addr);
  22
  23 /*
  24  * Allocate and decompress a BMP image using gunzip().
  25  *
  26  * Returns a pointer to the decompressed image data. This pointer is
  27  * aligned to 32-bit-aligned-address + 2.
  28  * See doc/README.displaying-bmps for explanation.
  29  *
  30  * The allocation address is passed to 'alloc_addr' and must be freed
  31  * by the caller after use.
  32  *
  33  * Returns NULL if decompression failed, or if the decompressed data
  34  * didn't contain a valid BMP signature.
  35  */
  36 #ifdef CONFIG_VIDEO_BMP_GZIP
  37 bmp_image_t *gunzip_bmp(unsigned long addr, unsigned long *lenp,
  38                         void **alloc_addr)
  39 {
  40         void *dst;
  41         unsigned long len;
  42         bmp_image_t *bmp;
  43
  44         /*
  45          * Decompress bmp image
  46          */
  47         len = CONFIG_SYS_VIDEO_LOGO_MAX_SIZE;
  48         /* allocate extra 3 bytes for 32-bit-aligned-address + 2 alignment */
  49         dst = malloc(CONFIG_SYS_VIDEO_LOGO_MAX_SIZE + 3);
  50         if (dst == NULL) {
  51                 puts("Error: malloc in gunzip failed!\n");
  52                 return NULL;
  53         }
  54
  55         bmp = dst;
  56
  57         /* align to 32-bit-aligned-address + 2 */
  58         bmp = (bmp_image_t *)((((unsigned int)dst + 1) & ~3) + 2);
  59
  60         if (gunzip(bmp, CONFIG_SYS_VIDEO_LOGO_MAX_SIZE, (uchar *)addr, &len) != 0) {
  61                 free(dst);
  62                 return NULL;
  63         }
  64         if (len == CONFIG_SYS_VIDEO_LOGO_MAX_SIZE)
  65                 puts("Image could be truncated"
  66                                 " (increase CONFIG_SYS_VIDEO_LOGO_MAX_SIZE)!\n");
  67
  68         /*
  69          * Check for bmp mark 'BM'
  70          */
  71         if (!((bmp->header.signature[0] == 'B') &&
  72               (bmp->header.signature[1] == 'M'))) {
  73                 free(dst);
  74                 return NULL;
  75         }
  76
  77         debug("Gzipped BMP image detected!\n");
  78
  79         *alloc_addr = dst;
  80         return bmp;
  81 }
  82 #else
  83 bmp_image_t *gunzip_bmp(unsigned long addr, unsigned long *lenp,
  84                         void **alloc_addr)
  85 {
  86         return NULL;
  87 }
  88 #endif
  89
  90 static int do_bmp_info(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
  91 {
  92         ulong addr;
  93
  94         switch (argc) {
  95         case 1:         /* use load_addr as default address */
  96                 addr = load_addr;
  97                 break;
  98         case 2:         /* use argument */
  99                 addr = simple_strtoul(argv[1], NULL, 16);
 100                 break;
 101         default:
 102                 return CMD_RET_USAGE;
 103         }
 104
 105         return (bmp_info(addr));
 106 }
 107
 108 static int do_bmp_display(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
 109 {
 110         ulong addr;
 111         int x = 0, y = 0;
 112
 113         splash_get_pos(&x, &y);
 114
 115         switch (argc) {
 116         case 1:         /* use load_addr as default address */
 117                 addr = load_addr;
 118                 break;
 119         case 2:         /* use argument */
 120                 addr = simple_strtoul(argv[1], NULL, 16);
 121                 break;
 122         case 4:
 123                 addr = simple_strtoul(argv[1], NULL, 16);
 124                 x = simple_strtoul(argv[2], NULL, 10);
 125                 y = simple_strtoul(argv[3], NULL, 10);
 126                 break;
 127         default:
 128                 return CMD_RET_USAGE;
 129         }
 130
 131          return (bmp_display(addr, x, y));
 132 }
 133
 134 static cmd_tbl_t cmd_bmp_sub[] = {
 135         U_BOOT_CMD_MKENT(info, 3, 0, do_bmp_info, "", ""),
 136         U_BOOT_CMD_MKENT(display, 5, 0, do_bmp_display, "", ""),
 137 };
 138
 139 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 140 void bmp_reloc(void) {
 141         fixup_cmdtable(cmd_bmp_sub, ARRAY_SIZE(cmd_bmp_sub));
 142 }
 143 #endif
 144
 145 /*
 146  * Subroutine:  do_bmp
 147  *
 148  * Description: Handler for 'bmp' command..
 149  *
 150  * Inputs:      argv[1] contains the subcommand
 151  *
 152  * Return:      None
 153  *
 154  */
 155 static int do_bmp(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 156 {
 157         cmd_tbl_t *c;
 158
 159         /* Strip off leading 'bmp' command argument */
 160         argc--;
 161         argv++;
 162
 163         c = find_cmd_tbl(argv[0], &cmd_bmp_sub[0], ARRAY_SIZE(cmd_bmp_sub));
 164
 165         if (c)
 166                 return  c->cmd(cmdtp, flag, argc, argv);
 167         else
 168                 return CMD_RET_USAGE;
 169 }
 170
 171 U_BOOT_CMD(
 172         bmp,    5,      1,      do_bmp,
 173         "manipulate BMP image data",
 174         "info <imageAddr>          - display image info\n"
 175         "bmp display <imageAddr> [x y] - display image at x,y"
 176 );
 177
 178 /*
 179  * Subroutine:  bmp_info
 180  *
 181  * Description: Show information about bmp file in memory
 182  *
 183  * Inputs:      addr            address of the bmp file
 184  *
 185  * Return:      None
 186  *
 187  */
 188 static int bmp_info(ulong addr)
 189 {
 190         bmp_image_t *bmp=(bmp_image_t *)addr;
 191         void *bmp_alloc_addr = NULL;
 192         unsigned long len;
 193
 194         if (!((bmp->header.signature[0]=='B') &&
 195               (bmp->header.signature[1]=='M')))
 196                 bmp = gunzip_bmp(addr, &len, &bmp_alloc_addr);
 197
 198         if (bmp == NULL) {
 199                 printf("There is no valid bmp file at the given address\n");
 200                 return 1;
 201         }
 202
 203         printf("Image size    : %d x %d\n", le32_to_cpu(bmp->header.width),
 204                le32_to_cpu(bmp->header.height));
 205         printf("Bits per pixel: %d\n", le16_to_cpu(bmp->header.bit_count));
 206         printf("Compression   : %d\n", le32_to_cpu(bmp->header.compression));
 207
 208         if (bmp_alloc_addr)
 209                 free(bmp_alloc_addr);
 210
 211         return(0);
 212 }
 213
 214 /*
 215  * Subroutine:  bmp_display
 216  *
 217  * Description: Display bmp file located in memory
 218  *
 219  * Inputs:      addr            address of the bmp file
 220  *
 221  * Return:      None
 222  *
 223  */
 224 int bmp_display(ulong addr, int x, int y)
 225 {
 226         int ret;
 227         bmp_image_t *bmp = (bmp_image_t *)addr;
 228         void *bmp_alloc_addr = NULL;
 229         unsigned long len;
 230
 231         if (!((bmp->header.signature[0]=='B') &&
 232               (bmp->header.signature[1]=='M')))
 233                 bmp = gunzip_bmp(addr, &len, &bmp_alloc_addr);
 234
 235         if (!bmp) {
 236                 printf("There is no valid bmp file at the given address\n");
 237                 return 1;
 238         }
 239
 240 #if defined(CONFIG_LCD)
 241         ret = lcd_display_bitmap((ulong)bmp, x, y);
 242 #elif defined(CONFIG_VIDEO)
 243         ret = video_display_bitmap((unsigned long)bmp, x, y);
 244 #else
 245 # error bmp_display() requires CONFIG_LCD or CONFIG_VIDEO
 246 #endif
 247
 248         if (bmp_alloc_addr)
 249                 free(bmp_alloc_addr);
 250
 251         return ret;
 252 }