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