drivers: video: introduce video_bits_per_pixel(pixelformat) helper

This was present in the form of video_pix_fmt_bpp() inside ST and NXP
drivers, and was returning the number of bytes, which does not allow
support for 10-bits, 4-bits or non-byte aligned video formats.
The helper leverages the VIDEO_PIX_FMT_*_BITS macros.

Signed-off-by: Josuah Demangeon <[email protected]>

drivers/video/video_mcux_csi.c

@@ -133,7 +133,7 @@ static inline void video_pix_fmt_convert(struct video_format *fmt, bool isGetFmt
 		break;
 	}
 
-	fmt->pitch = fmt->width * video_pix_fmt_bpp(fmt->pixelformat);
+	fmt->pitch = fmt->width * video_bits_per_pixel(fmt->pixelformat) / 8;
 }
 #endif
 
@@ -142,7 +142,7 @@ static int video_mcux_csi_set_fmt(const struct device *dev, enum video_endpoint_
 {
 	const struct video_mcux_csi_config *config = dev->config;
 	struct video_mcux_csi_data *data = dev->data;
-	unsigned int bpp = video_pix_fmt_bpp(fmt->pixelformat);
+	unsigned int bpp = video_bits_per_pixel(fmt->pixelformat) / 8;
 	status_t ret;
 	struct video_format format = *fmt;
 

drivers/video/video_mcux_mipi_csi2rx.c

@@ -78,7 +78,7 @@ static int mipi_csi2rx_update_settings(const struct device *dev, enum video_endp
 		return -ENOTSUP;
 	}
 
-	bpp = video_pix_fmt_bpp(fmt.pixelformat) * 8;
+	bpp = video_bits_per_pixel(fmt.pixelformat);
 	sensor_byte_clk = sensor_pixel_rate * bpp / drv_data->csi2rxConfig.laneNum / 8;
 
 	ret = clock_control_get_rate(drv_data->clock_dev, drv_data->clock_root, &root_clk_rate);
@@ -229,7 +229,7 @@ static int mipi_csi2rx_get_frmival(const struct device *dev, enum video_endpoint
 
 static uint64_t mipi_csi2rx_cal_frame_size(const struct video_format *fmt)
 {
-	return fmt->height * fmt->width * video_pix_fmt_bpp(fmt->pixelformat) * 8;
+	return fmt->height * fmt->width * video_bits_per_pixel(fmt->pixelformat);
 }
 
 static uint64_t mipi_csi2rx_estimate_pixel_rate(const struct video_frmival *cur_fmival,

drivers/video/video_stm32_dcmi.c

@@ -198,7 +198,7 @@ static int video_stm32_dcmi_set_fmt(const struct device *dev,
 {
 	const struct video_stm32_dcmi_config *config = dev->config;
 	struct video_stm32_dcmi_data *data = dev->data;
-	unsigned int bpp = video_pix_fmt_bpp(fmt->pixelformat);
+	unsigned int bpp = video_bits_per_pixel(fmt->pixelformat) / 8;
 
 	if (bpp == 0 || (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL)) {
 		return -EINVAL;

include/zephyr/drivers/video.h

@@ -753,6 +753,14 @@ struct video_buffer *video_buffer_alloc(size_t size);
  */
 void video_buffer_release(struct video_buffer *buf);
 
+/**
+ * @defgroup video_pixel_formats Video pixel formats
+ * The @c | character separate the pixel, and spaces separate the bytes.
+ * The uppercase letter represents the most significant bit.
+ * The lowercase letters represent the rest of the bits.
+ * @{
+ */
+
 /**
  * @brief Four-character-code uniquely identifying the pixel format
  */
@@ -910,33 +918,42 @@ void video_buffer_release(struct video_buffer *buf);
  */
 
 /**
- * @}
- */
-
-/**
- * @brief Get number of bytes per pixel of a pixel format
+ * @brief Get number of bits per pixel of a pixel format
+ *
+ * @param pixfmt FourCC pixel format value (@ref video_pixel_formats).
  *
- * @param pixfmt FourCC pixel format value (\ref video_pixel_formats).
+ * @retval 0 if the format is unhandled or if it is variable number of bits
+ * @retval bit size of one pixel for this format
  */
-static inline unsigned int video_pix_fmt_bpp(uint32_t pixfmt)
+static inline unsigned int video_bits_per_pixel(uint32_t pixfmt)
 {
 	switch (pixfmt) {
 	case VIDEO_PIX_FMT_BGGR8:
+		return VIDEO_PIX_FMT_BGGR8_BITS;
 	case VIDEO_PIX_FMT_GBRG8:
+		return VIDEO_PIX_FMT_GBRG8_BITS;
 	case VIDEO_PIX_FMT_GRBG8:
+		return VIDEO_PIX_FMT_GRBG8_BITS;
 	case VIDEO_PIX_FMT_RGGB8:
-		return 1;
+		return VIDEO_PIX_FMT_RGGB8_BITS;
 	case VIDEO_PIX_FMT_RGB565:
-	case VIDEO_PIX_FMT_YUYV:
-		return 2;
+		return VIDEO_PIX_FMT_RGB565_BITS;
 	case VIDEO_PIX_FMT_XRGB32:
+		return VIDEO_PIX_FMT_XRGB32_BITS;
+	case VIDEO_PIX_FMT_YUYV:
+		return VIDEO_PIX_FMT_YUYV_BITS;
 	case VIDEO_PIX_FMT_XYUV32:
-		return 4;
+		return VIDEO_PIX_FMT_XYUV32_BITS;
 	default:
+		/* Variable number of bits per pixel or unknown format */
 		return 0;
 	}
 }
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif