Video 4 Zephyr - Video API, Drivers and Samples

CODEOWNERS

@@ -177,6 +177,7 @@
 /drivers/timer/cc13x2_cc26x2_rtc_timer.c  @vanti
 /drivers/usb/                             @jfischer-phytec-iot @finikorg
 /drivers/usb/device/usb_dc_stm32.c        @ydamigos @loicpoulain
+/drivers/video/                           @loicpoulain
 /drivers/i2c/i2c_ll_stm32*                @ldts @ydamigos
 /drivers/i2c/i2c_rv32m1_lpi2c*            @henrikbrixandersen
 /drivers/i2c/*sam0*                       @Sizurka

boards/arm/mimxrt1064_evk/mimxrt1064_evk.dts

@@ -84,6 +84,19 @@ arduino_i2c: &i2c1 {};
 
 &i2c1 {
 	status = "okay";
+
+	mt9m114@48 {
+		compatible = "aptina,mt9m114";
+		reg = <0x48>;
+		label = "MT9M114";
+		status = "okay";
+
+		port {
+			mt9m114_ep_out: endpoint {
+				remote-endpoint = <&csi_ep_in>;
+			};
+		};
+	};
 };
 
 &uart1 {
@@ -101,3 +114,14 @@ arduino_i2c: &i2c1 {};
 &usbd1 {
 	status = "okay";
 };
+
+&csi {
+	status = "okay";
+	sensor-label = "MT9M114";
+
+	port {
+		csi_ep_in: endpoint {
+			remote-endpoint = <&mt9m114_ep_out>;
+		};
+	};
+};

boards/arm/mimxrt1064_evk/mimxrt1064_evk.yaml

@@ -22,3 +22,4 @@ supported:
   - pwm
   - usb_device
   - counter
+  - video

boards/arm/mimxrt1064_evk/pinmux.c

@@ -173,6 +173,22 @@ static int mimxrt1064_evk_init(struct device *dev)
 	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B0_09_FLEXPWM2_PWMA03, 0);
 #endif
 
+#ifdef CONFIG_VIDEO_MCUX_CSI
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B0_04_GPIO1_IO04, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_04_CSI_PIXCLK, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_05_CSI_MCLK, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_06_CSI_VSYNC, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_07_CSI_HSYNC, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_08_CSI_DATA09, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_09_CSI_DATA08, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_10_CSI_DATA07, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_11_CSI_DATA06, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_12_CSI_DATA05, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_13_CSI_DATA04, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_14_CSI_DATA03, 0);
+	IOMUXC_SetPinMux(IOMUXC_GPIO_AD_B1_15_CSI_DATA02, 0);
+#endif
+
 	return 0;
 }
 

doc/reference/peripherals/index.rst

@@ -24,3 +24,4 @@ Peripherals
    spi.rst
    uart.rst
    watchdog.rst
+   video.rst

doc/reference/peripherals/video.rst

@@ -0,0 +1,60 @@
+.. _video:
+
+
+Video
+#####
+
+The video driver API offers a generic interface to video devices.
+
+Basic Operation
+***************
+
+Video Device
+============
+
+A video device is the abstraction of a hardware or software video function,
+which can produce, process, consume or transform video data. The video API is
+designed to offer flexible way to create, handle and combine various video
+devices.
+
+Endpoint
+========
+
+Each video device can have one or more endpoints. Output endpoints configure
+video output function and generate data. Input endpoints configure video input
+function and consume data.
+
+Video Buffer
+============
+
+A video buffer provides the transport mechanism for the data. There is no
+particular requirement on the content. The requirement for the content is
+defined by the endpoint format. A video buffer can be queued to a device
+endpoint for filling (input ep) or consuming (output ep) operation, once
+the operation is achieved, buffer can be dequeued for post-processing,
+release or reuse.
+
+Controls
+========
+
+A video control is accessed and identified by a CID (control identifier). It
+represents a video control property. Different devices will have different
+controls available which can be generic, related to a device class or vendor
+specific. The set/get control functions provide a generic scalable interface
+to handle and create controls.
+
+Configuration Options
+*********************
+
+Related configuration options:
+
+* :option:`CONFIG_VIDEO`
+
+API Reference
+*************
+
+.. doxygengroup:: video_interface
+   :project: Zephyr
+
+.. doxygengroup:: video_controls
+   :project: Zephyr

drivers/CMakeLists.txt

@@ -35,6 +35,7 @@ add_subdirectory_if_kconfig(hwinfo)
 add_subdirectory_if_kconfig(espi)
 add_subdirectory_if_kconfig(ps2)
 add_subdirectory_if_kconfig(kscan)
+add_subdirectory_if_kconfig(video)
 
 add_subdirectory_ifdef(CONFIG_FLASH_HAS_DRIVER_ENABLED flash)
 add_subdirectory_ifdef(CONFIG_SERIAL_HAS_DRIVER serial)

drivers/Kconfig

@@ -89,4 +89,6 @@ source "drivers/ps2/Kconfig"
 
 source "drivers/kscan/Kconfig"
 
+source "drivers/video/Kconfig"
+
 endmenu

drivers/video/CMakeLists.txt

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: Apache-2.0
+
+zephyr_library()
+
+zephyr_library_sources(video_common.c)
+
+zephyr_library_sources_ifdef(CONFIG_VIDEO_MCUX_CSI	video_mcux_csi.c)
+zephyr_library_sources_ifdef(CONFIG_VIDEO_SW_GENERATOR	video_sw_generator.c)
+zephyr_library_sources_ifdef(CONFIG_VIDEO_MT9M114	mt9m114.c)

drivers/video/Kconfig

@@ -0,0 +1,37 @@
+# Kconfig - VIDEO driver configuration options
+
+#
+# Copyright (c) 2019 Linaro Limited
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+#
+# VIDEO Drivers
+#
+menuconfig VIDEO
+	bool "VIDEO hardware support"
+	help
+	  Enable support for the VIDEO.
+
+if VIDEO
+
+config VIDEO_BUFFER_POOL_SZ_MAX
+	int "Size of the largest buffer in the video pool"
+	default 1048576
+
+config VIDEO_BUFFER_POOL_NUM_MAX
+	int "Number of maximum sized buffer in the video pool"
+	default 2
+
+config VIDEO_BUFFER_POOL_ALIGN
+	int "Alignment of the video pool’s buffer"
+	default 64
+
+source "drivers/video/Kconfig.mcux_csi"
+
+source "drivers/video/Kconfig.sw_generator"
+
+source "drivers/video/Kconfig.mt9m114"
+
+endif # VIDEO

drivers/video/Kconfig.mcux_csi

@@ -0,0 +1,11 @@
+# Kconfig - NXP MCUX CSI driver configuration options
+
+#
+# Copyright (c) 2019, Linaro Limited
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+menuconfig VIDEO_MCUX_CSI
+	bool "NXP MCUX CMOS Sensor Interface (CSI) driver"
+	depends on HAS_MCUX_CSI

drivers/video/Kconfig.mt9m114

@@ -0,0 +1,13 @@
+# Kconfig - MT9m114
+
+#
+# Copyright (c) 2016 Linaro Limited
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+menuconfig VIDEO_MT9M114
+        bool "MT9M114 Aptina CMOS digital image sensor"
+        depends on I2C
+        help
+          Enable driver for MT9M114 CMOS digital image sensor device.

drivers/video/Kconfig.sw_generator

@@ -0,0 +1,12 @@
+# Kconfig - MT9m114
+
+#
+# Copyright (c) 2016 Linaro Limited
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+menuconfig VIDEO_SW_GENERATOR
+        bool "Video Software Generator"
+        help
+          Enable video pattern generator (for testing purpose).