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