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 video_priv *priv)
 119 {
 120 #ifdef CONFIG_SYS_WHITE_ON_BLACK
 121         /* White is used when switching to bold, use light gray here */
 122         priv->fg_col_idx = VID_LIGHT_GRAY;
 123         priv->colour_fg = vid_console_color(priv, VID_LIGHT_GRAY);
 124         priv->colour_bg = vid_console_color(priv, VID_BLACK);
 125 #else
 126         priv->fg_col_idx = VID_BLACK;
 127         priv->colour_fg = vid_console_color(priv, VID_BLACK);
 128         priv->colour_bg = vid_console_color(priv, VID_WHITE);
 129 #endif
 130 }
 131
 132 /* Flush video activity to the caches */
 133 void video_sync(struct udevice *vid, bool force)
 134 {
 135         /*
 136          * flush_dcache_range() is declared in common.h but it seems that some
 137          * architectures do not actually implement it. Is there a way to find
 138          * out whether it exists? For now, ARM is safe.
 139          */
 140 #if defined(CONFIG_ARM) && !defined(CONFIG_SYS_DCACHE_OFF)
 141         struct video_priv *priv = dev_get_uclass_priv(vid);
 142
 143         if (priv->flush_dcache) {
 144                 flush_dcache_range((ulong)priv->fb,
 145                                    ALIGN((ulong)priv->fb + priv->fb_size,
 146                                          CONFIG_SYS_CACHELINE_SIZE));
 147         }
 148 #elif defined(CONFIG_VIDEO_SANDBOX_SDL)
 149         struct video_priv *priv = dev_get_uclass_priv(vid);
 150         static ulong last_sync;
 151
 152         if (force || get_timer(last_sync) > 10) {
 153                 sandbox_sdl_sync(priv->fb);
 154                 last_sync = get_timer(0);
 155         }
 156 #endif
 157 }
 158
 159 void video_sync_all(void)
 160 {
 161         struct udevice *dev;
 162
 163         for (uclass_find_first_device(UCLASS_VIDEO, &dev);
 164              dev;
 165              uclass_find_next_device(&dev)) {
 166                 if (device_active(dev))
 167                         video_sync(dev, true);
 168         }
 169 }
 170
 171 int video_get_xsize(struct udevice *dev)
 172 {
 173         struct video_priv *priv = dev_get_uclass_priv(dev);
 174
 175         return priv->xsize;
 176 }
 177
 178 int video_get_ysize(struct udevice *dev)
 179 {
 180         struct video_priv *priv = dev_get_uclass_priv(dev);
 181
 182         return priv->ysize;
 183 }
 184
 185 /* Set up the colour map */
 186 static int video_pre_probe(struct udevice *dev)
 187 {
 188         struct video_priv *priv = dev_get_uclass_priv(dev);
 189
 190         priv->cmap = calloc(256, sizeof(ushort));
 191         if (!priv->cmap)
 192                 return -ENOMEM;
 193
 194         return 0;
 195 }
 196
 197 static int video_pre_remove(struct udevice *dev)
 198 {
 199         struct video_priv *priv = dev_get_uclass_priv(dev);
 200
 201         free(priv->cmap);
 202
 203         return 0;
 204 }
 205
 206 /* Set up the display ready for use */
 207 static int video_post_probe(struct udevice *dev)
 208 {
 209         struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
 210         struct video_priv *priv = dev_get_uclass_priv(dev);
 211         char name[30], drv[15], *str;
 212         const char *drv_name = drv;
 213         struct udevice *cons;
 214         int ret;
 215
 216         /* Set up the line and display size */
 217         priv->fb = map_sysmem(plat->base, plat->size);
 218         priv->line_length = priv->xsize * VNBYTES(priv->bpix);
 219         priv->fb_size = priv->line_length * priv->ysize;
 220
 221         /* Set up colors  */
 222         video_set_default_colors(priv);
 223
 224         if (!CONFIG_IS_ENABLED(NO_FB_CLEAR))
 225                 video_clear(dev);
 226
 227         /*
 228          * Create a text console device. For now we always do this, although
 229          * it might be useful to support only bitmap drawing on the device
 230          * for boards that don't need to display text. We create a TrueType
 231          * console if enabled, a rotated console if the video driver requests
 232          * it, otherwise a normal console.
 233          *
 234          * The console can be override by setting vidconsole_drv_name before
 235          * probing this video driver, or in the probe() method.
 236          *
 237          * TrueType does not support rotation at present so fall back to the
 238          * rotated console in that case.
 239          */
 240         if (!priv->rot && IS_ENABLED(CONFIG_CONSOLE_TRUETYPE)) {
 241                 snprintf(name, sizeof(name), "%s.vidconsole_tt", dev->name);
 242                 strcpy(drv, "vidconsole_tt");
 243         } else {
 244                 snprintf(name, sizeof(name), "%s.vidconsole%d", dev->name,
 245                          priv->rot);
 246                 snprintf(drv, sizeof(drv), "vidconsole%d", priv->rot);
 247         }
 248
 249         str = strdup(name);
 250         if (!str)
 251                 return -ENOMEM;
 252         if (priv->vidconsole_drv_name)
 253                 drv_name = priv->vidconsole_drv_name;
 254         ret = device_bind_driver(dev, drv_name, str, &cons);
 255         if (ret) {
 256                 debug("%s: Cannot bind console driver\n", __func__);
 257                 return ret;
 258         }
 259
 260         ret = device_probe(cons);
 261         if (ret) {
 262                 debug("%s: Cannot probe console driver\n", __func__);
 263                 return ret;
 264         }
 265
 266         return 0;
 267 };
 268
 269 /* Post-relocation, allocate memory for the frame buffer */
 270 static int video_post_bind(struct udevice *dev)
 271 {
 272         ulong addr = gd->video_top;
 273         ulong size;
 274
 275         /* Before relocation there is nothing to do here */
 276         if (!(gd->flags & GD_FLG_RELOC))
 277                 return 0;
 278         size = alloc_fb(dev, &addr);
 279         if (addr < gd->video_bottom) {
 280                 /* Device tree node may need the 'u-boot,dm-pre-reloc' tag */
 281                 printf("Video device '%s' cannot allocate frame buffer memory -ensure the device is set up before relocation\n",
 282                        dev->name);
 283                 return -ENOSPC;
 284         }
 285         debug("%s: Claiming %lx bytes at %lx for video device '%s'\n",
 286               __func__, size, addr, dev->name);
 287         gd->video_bottom = addr;
 288
 289         return 0;
 290 }
 291
 292 UCLASS_DRIVER(video) = {
 293         .id             = UCLASS_VIDEO,
 294         .name           = "video",
 295         .flags          = DM_UC_FLAG_SEQ_ALIAS,
 296         .post_bind      = video_post_bind,
 297         .pre_probe      = video_pre_probe,
 298         .post_probe     = video_post_probe,
 299         .pre_remove     = video_pre_remove,
 300         .per_device_auto_alloc_size     = sizeof(struct video_priv),
 301         .per_device_platdata_auto_alloc_size = sizeof(struct video_uc_platdata),
 302 };