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