drivers/video/video-uclass.c

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