Video Device Drivers

  • include/nuttx/video/. All structures and APIs needed to work with video drivers are provided in this header file.

max7456

23 March 2019 Bill Gatliff <bgat@billgatliff.com>

The code in drivers/video/max7456.[ch] is a preliminary device driver for the MAX7456 analog on-screen-display generator. This SPI slave chip is a popular feature in many embedded devices due its low cost and power requirements. In particular, you see it a lot on drone flight-management units.

I use the term “preliminary” because at present, only the most rudimentary capabilities of the chip are supported:

  • chip reset and startup

  • read and write low-level chip control registers (DEBUG mode only)

  • write CA (Character Address) data to the chip’s framebuffer memory

Some key missing features are, in no particular order:

  • VSYNC and HSYNC synchronization (prevents flicker)

  • ability to update NVM (define custom character sets)

If you have a factory-fresh chip, then the datasheet shows you what the factory character data set looks like. If you’ve used the chip in other scenarios, i.e. with Betaflight or similar, then your chip will almost certainly have had the factory character data replaced with something application-specific.

Either way, you’ll probably want to update your character set before long. I should probably get that working, unless you want to take a look at it yoruself…

The max7456_register() function starts things rolling. The omnibusf4 target device provides an example (there may be others by the time you read this).

In normal use, the driver creates a set of interfaces under /dev, i.e.:

/dev/osd0/fb
/dev/osd0/raw   (*)
/dev/osd0/vsync (*)
    • not yet implemented

By writing character data to the “fb” interface, you’ll see data appear on the display. NOTE that the data you write is NOT, for example, ASCII text: it is the addresses of the characters in the chip’s onboard character map.

For example, if entry 42 in your onboard character map is a bitmap that looks like “H”, then when you write the ASCII “*” (decimal 42, hex 2a), you’ll see that “H” appear on your screen.

If you build the code with the DEBUG macro defined, you will see a bunch more interfaces:

/dev/osd0/VM0
/dev/osd0/VM1
/dev/osd/DMM
...
...

These are interfaces to the low-level chip registers, which can be read and/or written to help you figure out what’s going on inside the chip. They’re probably more useful for me than you, but there they are in case I’m wrong about that.

b.g.

Depth (time-of-flight) cameras

Multizone and depth time-of-flight sensors produce an image and are V4L2 capture devices; single-zone sensors report one distance through the sensor framework (SENSOR_TYPE_PROXIMITY). The frame is V4L2_PIX_FMT_Z16: one little-endian 16-bit distance in millimetres per pixel, 0 when the pixel has no valid target. The resolutions and the frame rates are V4L2 frame sizes and frame intervals; an interval entry that sets a size or a format only applies to it.

vl53l5cx

ST VL53L5CX multizone time-of-flight sensor (CONFIG_VIDEO_VL53L5CX) on I2C, address 0x29. The driver provides both the imgsensor and imgdata ops; vl53l5cx_register() checks the device ID and registers its own capture device with capture_register(). The one format is V4L2_PIX_FMT_Z16 in the sensor’s zone order:

Size

Frame rate

Default

8x8

1-15 Hz

yes, at 15 Hz

4x4

1-60 Hz

A zone is 0 when its target status is not 5 or 9; in the first frame after a start all zones have status 6 (no wrap-around check yet). A frame that fails the integrity check is returned zeroed with V4L2_BUF_FLAG_ERROR; a frame with no queued buffer is dropped and the sensor keeps ranging. Frame intervals are rounded to whole frames per second. The first VIDIOC_STREAMON boots the sensor and writes its firmware (about 1.1 s at 1 MHz I2C); the last close puts it to sleep. The sensor INT output starts each frame read on the low priority work queue; the board passes the INT handling and the I2C address in struct vl53l5cx_config_s.

The sensor keeps its firmware in RAM. The build downloads the firmware and default data, vl53l5cx_buffers.h from ST’s VL53L5CX Ultra Lite Driver (X-CUBE-TOF1 v3.4.3), to drivers/video/vl53l5cx. It is under the BSD-3-Clause license, so the driver depends on CONFIG_ALLOW_BSD_COMPONENTS.