Merge tag 'v2025.01-rc6' into next

[J-u-boot.git] / include / video.h

diff --git a/include/video.h b/include/video.h
index 03434a81234f692f54495b33c558085bfca45ffa..4ec71ab16da884023e70c8b61aa6e1e4e25c9c37 100644 (file)
--- a/include/video.h
+++ b/include/video.h
@@ -21,9 +21,12 @@ struct udevice;
  * @align: Frame-buffer alignment, indicating the memory boundary the frame
  *     buffer should start on. If 0, 1MB is assumed
  * @size: Frame-buffer size, in bytes
- * @base: Base address of frame buffer, 0 if not yet known
- * @copy_base: Base address of a hardware copy of the frame buffer. See
- *     CONFIG_VIDEO_COPY.
+ * @base: Base address of frame buffer, 0 if not yet known. If CONFIG_VIDEO_COPY
+ *     is enabled, this is the software copy, so writes to this will not be
+ *     visible until vidconsole_sync_copy() is called. If CONFIG_VIDEO_COPY is
+ *     disabled, this is the hardware framebuffer.
+ * @copy_base: Base address of a hardware copy of the frame buffer. If
+ *     CONFIG_VIDEO_COPY is disabled, this is not used.
  * @copy_size: Size of copy framebuffer, used if @size is 0
  * @hide_logo: Hide the logo (used for testing)
  */
@@ -54,12 +57,8 @@ enum video_log2_bpp {
        VIDEO_BPP32,
 };
 
-/*
- * Convert enum video_log2_bpp to bytes and bits. Note we omit the outer
- * brackets to allow multiplication by fractional pixels.
- */
-#define VNBYTES(bpix)  (1 << (bpix)) / 8
-
+/* Convert enum video_log2_bpp to bytes and bits */
+#define VNBYTES(bpix)  ((1 << (bpix)) / 8)
 #define VNBITS(bpix)   (1 << (bpix))
 
 enum video_format {
@@ -75,7 +74,8 @@ enum video_format {
  *
  * @xsize:     Number of pixel columns (e.g. 1366)
  * @ysize:     Number of pixels rows (e.g.. 768)
- * @rot:       Display rotation (0=none, 1=90 degrees clockwise, etc.)
+ * @rot:       Display rotation (0=none, 1=90 degrees clockwise, etc.). THis
+ *             does not affect @xsize and @ysize
  * @bpix:      Encoded bits per pixel (enum video_log2_bpp)
  * @format:    Pixel format (enum video_format)
  * @vidconsole_drv_name:       Driver to use for the text console, NULL to
@@ -94,6 +94,7 @@ enum video_format {
  *             the LCD is updated
  * @fg_col_idx:        Foreground color code (bit 3 = bold, bit 0-2 = color)
  * @bg_col_idx:        Background color code (bit 3 = bold, bit 0-2 = color)
+ * @last_sync: Monotonic time of last video sync
  */
 struct video_priv {
        /* Things set up by the driver: */
@@ -118,6 +119,7 @@ struct video_priv {
        bool flush_dcache;
        u8 fg_col_idx;
        u8 bg_col_idx;
+       ulong last_sync;
 };
 
 /**
@@ -134,6 +136,30 @@ struct video_ops {
 
 #define video_get_ops(dev)        ((struct video_ops *)(dev)->driver->ops)
 
+/**
+ * struct video_handoff - video information passed from SPL
+ *
+ * This is used when video is set up by SPL, to provide the details to U-Boot
+ * proper.
+ *
+ * @fb: Base address of frame buffer, 0 if not yet known
+ * @size: Frame-buffer size, in bytes
+ * @xsize:     Number of pixel columns (e.g. 1366)
+ * @ysize:     Number of pixels rows (e.g.. 768)
+ * @line_length:       Length of each frame buffer line, in bytes. This can be
+ *             set by the driver, but if not, the uclass will set it after
+ *             probing
+ * @bpix:      Encoded bits per pixel (enum video_log2_bpp)
+ */
+struct video_handoff {
+       u64 fb;
+       u32 size;
+       u16 xsize;
+       u16 ysize;
+       u32 line_length;
+       u8 bpix;
+};
+
 /** enum colour_idx - the 16 colors supported by consoles */
 enum colour_idx {
        VID_BLACK = 0,
@@ -152,6 +178,7 @@ enum colour_idx {
        VID_LIGHT_MAGENTA,
        VID_LIGHT_CYAN,
        VID_WHITE,
+       VID_DARK_GREY,
 
        VID_COLOUR_COUNT
 };
@@ -163,11 +190,11 @@ enum colour_idx {
  * The caller has to guarantee that the color index is less than
  * VID_COLOR_COUNT.
  *
- * @priv       private data of the console device
- * @idx                color index
+ * @priv       private data of the video device (UCLASS_VIDEO)
+ * @idx                color index (e.g. VID_YELLOW)
  * Return:     color value
  */
-u32 video_index_to_colour(struct video_priv *priv, unsigned int idx);
+u32 video_index_to_colour(struct video_priv *priv, enum colour_idx idx);
 
 /**
  * video_reserve() - Reserve frame-buffer memory for video devices
@@ -204,6 +231,22 @@ int video_clear(struct udevice *dev);
  */
 int video_fill(struct udevice *dev, u32 colour);
 
+/**
+ * video_fill_part() - Erase a region
+ *
+ * Erase a rectangle of the display within the given bounds.
+ *
+ * @dev:       Device to update
+ * @xstart:    X start position in pixels from the left
+ * @ystart:    Y start position in pixels from the top
+ * @xend:      X end position in pixels from the left
+ * @yend:      Y end position  in pixels from the top
+ * @colour:    Value to write
+ * Return: 0 if OK, -ENOSYS if the display depth is not supported
+ */
+int video_fill_part(struct udevice *dev, int xstart, int ystart, int xend,
+                   int yend, u32 colour);
+
 /**
  * video_sync() - Sync a device's frame buffer with its hardware
  *
@@ -220,7 +263,7 @@ int video_fill(struct udevice *dev, u32 colour);
 int video_sync(struct udevice *vid, bool force);
 
 /**
- * video_sync_all() - Sync all devices' frame buffers with there hardware
+ * video_sync_all() - Sync all devices' frame buffers with their hardware
  *
  * This calls video_sync() on all active video devices.
  */
@@ -366,4 +409,24 @@ int bmp_display(ulong addr, int x, int y);
  */
 int bmp_info(ulong addr);
 
+/*
+ * video_reserve_from_bloblist()- Reserve frame-buffer memory for video devices
+ * using blobs.
+ *
+ * @ho: video information passed from SPL
+ * Returns: 0 (always)
+ */
+int video_reserve_from_bloblist(struct video_handoff *ho);
+
+/**
+ * video_get_fb() - Get the first framebuffer address
+ *
+ * This function does not probe video devices, so can only be used after a video
+ * device has been activated.
+ *
+ * Return: address of the framebuffer of the first video device found, or 0 if
+ * there is no device
+ */
+ulong video_get_fb(void);
+
 #endif