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