drivers/video/video-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2015 Google, Inc
   4  */
   5
   6 #include <common.h>
   7 #include <console.h>
   8 #include <cpu_func.h>
   9 #include <dm.h>
  10 #include <log.h>
  11 #include <malloc.h>
  12 #include <mapmem.h>
  13 #include <stdio_dev.h>
  14 #include <video.h>
  15 #include <video_console.h>
  16 #include <asm/cache.h>
  17 #include <dm/lists.h>
  18 #include <dm/device-internal.h>
  19 #include <dm/uclass-internal.h>
  20 #ifdef CONFIG_SANDBOX
  21 #include <asm/sdl.h>
  22 #endif
  23
  24 /*
  25  * Theory of operation:
  26  *
  27  * Before relocation each device is bound. The driver for each device must
  28  * set the @align and @size values in struct video_uc_platdata. This
  29  * information represents the requires size and alignment of the frame buffer
  30  * for the device. The values can be an over-estimate but cannot be too
  31  * small. The actual values will be suppled (in the same manner) by the bind()
  32  * method after relocation.
  33  *
  34  * This information is then picked up by video_reserve() which works out how
  35  * much memory is needed for all devices. This is allocated between
  36  * gd->video_bottom and gd->video_top.
  37  *
  38  * After relocation the same process occurs. The driver supplies the same
  39  * @size and @align information and this time video_post_bind() checks that
  40  * the drivers does not overflow the allocated memory.
  41  *
  42  * The frame buffer address is actually set (to plat->base) in
  43  * video_post_probe(). This function also clears the frame buffer and
  44  * allocates a suitable text console device. This can then be used to write
  45  * text to the video device.
  46  */
  47 DECLARE_GLOBAL_DATA_PTR;
  48
  49 /**
  50  * struct video_uc_priv - Information for the video uclass
  51  *
  52  * @video_ptr: Current allocation position of the video framebuffer pointer.
  53  *      While binding devices after relocation, this points to the next
  54  *      available address to use for a device's framebuffer. It starts at
  55  *      gd->video_top and works downwards, running out of space when it hits
  56  *      gd->video_bottom.
  57  */
  58 struct video_uc_priv {
  59         ulong video_ptr;
  60 };
  61
  62 void video_set_flush_dcache(struct udevice *dev, bool flush)
  63 {
  64         struct video_priv *priv = dev_get_uclass_priv(dev);
  65
  66         priv->flush_dcache = flush;
  67 }
  68
  69 static ulong alloc_fb(struct udevice *dev, ulong *addrp)
  70 {
  71         struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
  72         ulong base, align, size;
  73
  74         if (!plat->size)
  75                 return 0;
  76
  77         align = plat->align ? plat->align : 1 << 20;
  78         base = *addrp - plat->size;
  79         base &= ~(align - 1);
  80         plat->base = base;
  81         size = *addrp - base;
  82         *addrp = base;
  83
  84         return size;
  85 }
  86
  87 int video_reserve(ulong *addrp)
  88 {
  89         struct udevice *dev;
  90         ulong size;
  91
  92         gd->video_top = *addrp;
  93         for (uclass_find_first_device(UCLASS_VIDEO, &dev);
  94              dev;
  95              uclass_find_next_device(&dev)) {
  96                 size = alloc_fb(dev, addrp);
  97                 debug("%s: Reserving %lx bytes at %lx for video device '%s'\n",
  98                       __func__, size, *addrp, dev->name);
  99         }
 100         gd->video_bottom = *addrp;
 101         gd->fb_base = *addrp;
 102         debug("Video frame buffers from %lx to %lx\n", gd->video_bottom,
 103               gd->video_top);
 104
 105         return 0;
 106 }
 107
 108 int video_clear(struct udevice *dev)
 109 {
 110         struct video_priv *priv = dev_get_uclass_priv(dev);
 111         int ret;
 112
 113         switch (priv->bpix) {
 114         case VIDEO_BPP16:
 115                 if (IS_ENABLED(CONFIG_VIDEO_BPP16)) {
 116                         u16 *ppix = priv->fb;
 117                         u16 *end = priv->fb + priv->fb_size;
 118
 119                         while (ppix < end)
 120                                 *ppix++ = priv->colour_bg;
 121                         break;
 122                 }
 123         case VIDEO_BPP32:
 124                 if (IS_ENABLED(CONFIG_VIDEO_BPP32)) {
 125                         u32 *ppix = priv->fb;
 126                         u32 *end = priv->fb + priv->fb_size;
 127
 128                         while (ppix < end)
 129                                 *ppix++ = priv->colour_bg;
 130                         break;
 131                 }
 132         default:
 133                 memset(priv->fb, priv->colour_bg, priv->fb_size);
 134                 break;
 135         }
 136         ret = video_sync_copy(dev, priv->fb, priv->fb + priv->fb_size);
 137         if (ret)
 138                 return ret;
 139
 140         return 0;
 141 }
 142
 143 void video_set_default_colors(struct udevice *dev, bool invert)
 144 {
 145         struct video_priv *priv = dev_get_uclass_priv(dev);
 146         int fore, back;
 147
 148         if (CONFIG_IS_ENABLED(SYS_WHITE_ON_BLACK)) {
 149                 /* White is used when switching to bold, use light gray here */
 150                 fore = VID_LIGHT_GRAY;
 151                 back = VID_BLACK;
 152         } else {
 153                 fore = VID_BLACK;
 154                 back = VID_WHITE;
 155         }
 156         if (invert) {
 157                 int temp;
 158
 159                 temp = fore;
 160                 fore = back;
 161                 back = temp;
 162         }
 163         priv->fg_col_idx = fore;
 164         priv->bg_col_idx = back;
 165         priv->colour_fg = vid_console_color(priv, fore);
 166         priv->colour_bg = vid_console_color(priv, back);
 167 }
 168
 169 /* Flush video activity to the caches */
 170 void video_sync(struct udevice *vid, bool force)
 171 {
 172         /*
 173          * flush_dcache_range() is declared in common.h but it seems that some
 174          * architectures do not actually implement it. Is there a way to find
 175          * out whether it exists? For now, ARM is safe.
 176          */
 177 #if defined(CONFIG_ARM) && !CONFIG_IS_ENABLED(SYS_DCACHE_OFF)
 178         struct video_priv *priv = dev_get_uclass_priv(vid);
 179
 180         if (priv->flush_dcache) {
 181                 flush_dcache_range((ulong)priv->fb,
 182                                    ALIGN((ulong)priv->fb + priv->fb_size,
 183                                          CONFIG_SYS_CACHELINE_SIZE));
 184         }
 185 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
 186         struct video_priv *priv = dev_get_uclass_priv(vid);
 187         static ulong last_sync;
 188
 189         if (force || get_timer(last_sync) > 10) {
 190                 sandbox_sdl_sync(priv->fb);
 191                 last_sync = get_timer(0);
 192         }
 193 #endif
 194 }
 195
 196 void video_sync_all(void)
 197 {
 198         struct udevice *dev;
 199
 200         for (uclass_find_first_device(UCLASS_VIDEO, &dev);
 201              dev;
 202              uclass_find_next_device(&dev)) {
 203                 if (device_active(dev))
 204                         video_sync(dev, true);
 205         }
 206 }
 207
 208 int video_get_xsize(struct udevice *dev)
 209 {
 210         struct video_priv *priv = dev_get_uclass_priv(dev);
 211
 212         return priv->xsize;
 213 }
 214
 215 int video_get_ysize(struct udevice *dev)
 216 {
 217         struct video_priv *priv = dev_get_uclass_priv(dev);
 218
 219         return priv->ysize;
 220 }
 221
 222 #ifdef CONFIG_VIDEO_COPY
 223 int video_sync_copy(struct udevice *dev, void *from, void *to)
 224 {
 225         struct video_priv *priv = dev_get_uclass_priv(dev);
 226
 227         if (priv->copy_fb) {
 228                 long offset, size;
 229
 230                 /* Find the offset of the first byte to copy */
 231                 if ((ulong)to > (ulong)from) {
 232                         size = to - from;
 233                         offset = from - priv->fb;
 234                 } else {
 235                         size = from - to;
 236                         offset = to - priv->fb;
 237                 }
 238
 239                 /*
 240                  * Allow a bit of leeway for valid requests somewhere near the
 241                  * frame buffer
 242                  */
 243                 if (offset < -priv->fb_size || offset > 2 * priv->fb_size) {
 244 #ifdef DEBUG
 245                         char str[80];
 246
 247                         snprintf(str, sizeof(str),
 248                                  "[sync_copy fb=%p, from=%p, to=%p, offset=%lx]",
 249                                  priv->fb, from, to, offset);
 250                         console_puts_select_stderr(true, str);
 251 #endif
 252                         return -EFAULT;
 253                 }
 254
 255                 /*
 256                  * Silently crop the memcpy. This allows callers to avoid doing
 257                  * this themselves. It is common for the end pointer to go a
 258                  * few lines after the end of the frame buffer, since most of
 259                  * the update algorithms terminate a line after their last write
 260                  */
 261                 if (offset + size > priv->fb_size) {
 262                         size = priv->fb_size - offset;
 263                 } else if (offset < 0) {
 264                         size += offset;
 265                         offset = 0;
 266                 }
 267
 268                 memcpy(priv->copy_fb + offset, priv->fb + offset, size);
 269         }
 270
 271         return 0;
 272 }
 273 #endif
 274
 275 /* Set up the colour map */
 276 static int video_pre_probe(struct udevice *dev)
 277 {
 278         struct video_priv *priv = dev_get_uclass_priv(dev);
 279
 280         priv->cmap = calloc(256, sizeof(ushort));
 281         if (!priv->cmap)
 282                 return -ENOMEM;
 283
 284         return 0;
 285 }
 286
 287 static int video_pre_remove(struct udevice *dev)
 288 {
 289         struct video_priv *priv = dev_get_uclass_priv(dev);
 290
 291         free(priv->cmap);
 292
 293         return 0;
 294 }
 295
 296 /* Set up the display ready for use */
 297 static int video_post_probe(struct udevice *dev)
 298 {
 299         struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
 300         struct video_priv *priv = dev_get_uclass_priv(dev);
 301         char name[30], drv[15], *str;
 302         const char *drv_name = drv;
 303         struct udevice *cons;
 304         int ret;
 305
 306         /* Set up the line and display size */
 307         priv->fb = map_sysmem(plat->base, plat->size);
 308         if (!priv->line_length)
 309                 priv->line_length = priv->xsize * VNBYTES(priv->bpix);
 310
 311         priv->fb_size = priv->line_length * priv->ysize;
 312
 313         if (IS_ENABLED(CONFIG_VIDEO_COPY) && plat->copy_base)
 314                 priv->copy_fb = map_sysmem(plat->copy_base, plat->size);
 315
 316         /* Set up colors  */
 317         video_set_default_colors(dev, false);
 318
 319         if (!CONFIG_IS_ENABLED(NO_FB_CLEAR))
 320                 video_clear(dev);
 321
 322         /*
 323          * Create a text console device. For now we always do this, although
 324          * it might be useful to support only bitmap drawing on the device
 325          * for boards that don't need to display text. We create a TrueType
 326          * console if enabled, a rotated console if the video driver requests
 327          * it, otherwise a normal console.
 328          *
 329          * The console can be override by setting vidconsole_drv_name before
 330          * probing this video driver, or in the probe() method.
 331          *
 332          * TrueType does not support rotation at present so fall back to the
 333          * rotated console in that case.
 334          */
 335         if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
 336                 snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
 337                 strcpy(drv, "vidconsole_tt");
 338         } else {
 339                 snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
 340                          priv->rot);
 341                 snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
 342         }
 343
 344         str = strdup(name);
 345         if (!str)
 346                 return -ENOMEM;
 347         if (priv->vidconsole_drv_name)
 348                 drv_name = priv->vidconsole_drv_name;
 349         ret = device_bind_driver(dev, drv_name, str, &cons);
 350         if (ret) {
 351                 debug("%s: Cannot bind console driver\n", __func__);
 352                 return ret;
 353         }
 354
 355         ret = device_probe(cons);
 356         if (ret) {
 357                 debug("%s: Cannot probe console driver\n", __func__);
 358                 return ret;
 359         }
 360
 361         return 0;
 362 };
 363
 364 /* Post-relocation, allocate memory for the frame buffer */
 365 static int video_post_bind(struct udevice *dev)
 366 {
 367         struct video_uc_priv *uc_priv;
 368         ulong addr;
 369         ulong size;
 370
 371         /* Before relocation there is nothing to do here */
 372         if (!(gd->flags & GD_FLG_RELOC))
 373                 return 0;
 374
 375         /* Set up the video pointer, if this is the first device */
 376         uc_priv = dev->uclass->priv;
 377         if (!uc_priv->video_ptr)
 378                 uc_priv->video_ptr = gd->video_top;
 379
 380         /* Allocate framebuffer space for this device */
 381         addr = uc_priv->video_ptr;
 382         size = alloc_fb(dev, &addr);
 383         if (addr < gd->video_bottom) {
 384                 /* Device tree node may need the 'u-boot,dm-pre-reloc' or
 385                  * 'u-boot,dm-pre-proper' tag
 386                  */
 387                 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
 388                        dev->name);
 389                 return -ENOSPC;
 390         }
 391         debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
 392               __func__, size, addr, dev->name);
 393         uc_priv->video_ptr = addr;
 394
 395         return 0;
 396 }
 397
 398 UCLASS_DRIVER(video) = {
 399         .id             = UCLASS_VIDEO,
 400         .name           = "video",
 401         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 402         .post_bind      = video_post_bind,
 403         .pre_probe      = video_pre_probe,
 404         .post_probe     = video_post_probe,
 405         .pre_remove     = video_pre_remove,
 406         .priv_auto_alloc_size   = sizeof(struct video_uc_priv),
 407         .per_device_auto_alloc_size     = sizeof(struct video_priv),
 408         .per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),
 409 };