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