Skip to content

Commit 87ca9f5

Browse files
josuahjosuah
committed
drivers: video: common: add shared implementation for imagers
Imagers, also known as image sensors, have drivers that look very similar. Add common implementation that fits most image sensors, which can be bypassed wherever this does not make the implementation simpler. Signed-off-by: Josuah Demangeon <[email protected]>
1 parent fd3677d commit 87ca9f5

File tree

2 files changed

+316
-0
lines changed

2 files changed

+316
-0
lines changed

‎drivers/video/video_common.c‎

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,3 +301,197 @@ int video_write_cci_multi(const struct i2c_dt_spec *i2c, const struct video_reg
301301

302302
return 0;
303303
}
304+
/* Common implementation for imagers (a.k.a. image sensor) drivers */
305+
306+
int video_imager_set_mode(const struct device *dev, const struct video_imager_mode *mode)
307+
{
308+
const struct video_imager_config *cfg = dev->config;
309+
struct video_imager_data *data = cfg->data;
310+
int ret;
311+
312+
if (data->mode == mode) {
313+
LOG_DBG("%s is arlready in the mode requested", dev->name);
314+
return 0;
315+
}
316+
317+
/* Write each register table to the device */
318+
for (int i = 0; i < ARRAY_SIZE(mode->regs) && mode->regs[i] != NULL; i++) {
319+
ret = cfg->write_multi(&cfg->i2c, mode->regs[i]);
320+
if (ret != 0) {
321+
LOG_ERR("Could not set %s to mode %p, %u FPS", dev->name, mode, mode->fps);
322+
return ret;
323+
}
324+
}
325+
326+
data->mode = mode;
327+
328+
return 0;
329+
}
330+
331+
int video_imager_set_frmival(const struct device *dev, enum video_endpoint_id ep,
332+
struct video_frmival *frmival)
333+
{
334+
const struct video_imager_config *cfg = dev->config;
335+
struct video_imager_data *data = cfg->data;
336+
struct video_frmival_enum fie = {.format = &data->fmt, .discrete = *frmival};
337+
338+
if (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL) {
339+
return -EINVAL;
340+
}
341+
342+
video_closest_frmival(dev, ep, &fie);
343+
344+
return video_imager_set_mode(dev, &cfg->modes[data->fmt_id][fie.index]);
345+
}
346+
347+
int video_imager_get_frmival(const struct device *dev, enum video_endpoint_id ep,
348+
struct video_frmival *frmival)
349+
{
350+
const struct video_imager_config *cfg = dev->config;
351+
struct video_imager_data *data = cfg->data;
352+
353+
if (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL) {
354+
return -EINVAL;
355+
}
356+
357+
frmival->numerator = 1;
358+
frmival->denominator = data->mode->fps;
359+
360+
return 0;
361+
}
362+
363+
int video_imager_enum_frmival(const struct device *dev, enum video_endpoint_id ep,
364+
struct video_frmival_enum *fie)
365+
{
366+
const struct video_imager_config *cfg = dev->config;
367+
const struct video_imager_mode *modes;
368+
size_t fmt_id = 0;
369+
int ret;
370+
371+
if (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL) {
372+
return -EINVAL;
373+
}
374+
375+
ret = video_format_caps_index(cfg->fmts, fie->format, &fmt_id);
376+
if (ret != 0) {
377+
LOG_ERR("Format '%s' %ux%u not found for %s",
378+
VIDEO_FOURCC_TO_STR(fie->format->pixelformat),
379+
fie->format->width, fie->format->height, dev->name);
380+
return ret;
381+
}
382+
383+
modes = cfg->modes[fmt_id];
384+
385+
for (int i = 0;; i++) {
386+
if (modes[i].fps == 0) {
387+
return -EINVAL;
388+
}
389+
390+
if (i == fie->index) {
391+
fie->type = VIDEO_FRMIVAL_TYPE_DISCRETE;
392+
fie->discrete.numerator = 1;
393+
fie->discrete.denominator = modes[i].fps;
394+
break;
395+
}
396+
}
397+
398+
return 0;
399+
}
400+
401+
int video_imager_set_fmt(const struct device *const dev, enum video_endpoint_id ep,
402+
struct video_format *fmt)
403+
{
404+
const struct video_imager_config *cfg = dev->config;
405+
struct video_imager_data *data = cfg->data;
406+
size_t fmt_id;
407+
int ret;
408+
409+
if (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL) {
410+
LOG_ERR("Only the output endpoint is supported for %s", dev->name);
411+
return -EINVAL;
412+
}
413+
414+
ret = video_format_caps_index(cfg->fmts, fmt, &fmt_id);
415+
if (ret != 0) {
416+
LOG_ERR("Format '%s' %ux%u not found for device %s",
417+
VIDEO_FOURCC_TO_STR(fmt->pixelformat), fmt->width, fmt->height, dev->name);
418+
return ret;
419+
}
420+
421+
ret = video_imager_set_mode(dev, &cfg->modes[fmt_id][0]);
422+
if (ret != 0) {
423+
return ret;
424+
}
425+
426+
data->fmt_id = fmt_id;
427+
data->fmt = *fmt;
428+
429+
return 0;
430+
}
431+
432+
int video_imager_get_fmt(const struct device *dev, enum video_endpoint_id ep,
433+
struct video_format *fmt)
434+
{
435+
const struct video_imager_config *cfg = dev->config;
436+
struct video_imager_data *data = cfg->data;
437+
438+
if (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL) {
439+
return -EINVAL;
440+
}
441+
442+
*fmt = data->fmt;
443+
444+
return 0;
445+
}
446+
447+
int video_imager_get_caps(const struct device *dev, enum video_endpoint_id ep,
448+
struct video_caps *caps)
449+
{
450+
const struct video_imager_config *cfg = dev->config;
451+
452+
if (ep != VIDEO_EP_OUT && ep != VIDEO_EP_ALL) {
453+
return -EINVAL;
454+
}
455+
456+
caps->format_caps = cfg->fmts;
457+
458+
return 0;
459+
}
460+
461+
int video_imager_init(const struct device *dev, const struct video_reg *init_regs,
462+
int default_fmt_idx)
463+
{
464+
const struct video_imager_config *cfg = dev->config;
465+
struct video_format fmt;
466+
int ret;
467+
468+
__ASSERT_NO_MSG(cfg->modes != NULL);
469+
__ASSERT_NO_MSG(cfg->fmts != NULL);
470+
471+
if (!device_is_ready(cfg->i2c.bus)) {
472+
LOG_ERR("I2C bus device %s is not ready", cfg->i2c.bus->name);
473+
return -ENODEV;
474+
}
475+
476+
if (init_regs != NULL) {
477+
ret = cfg->write_multi(&cfg->i2c, init_regs);
478+
if (ret != 0) {
479+
LOG_ERR("Could not set %s initial registers", dev->name);
480+
return ret;
481+
}
482+
}
483+
484+
fmt.pixelformat = cfg->fmts[default_fmt_idx].pixelformat;
485+
fmt.width = cfg->fmts[default_fmt_idx].width_max;
486+
fmt.height = cfg->fmts[default_fmt_idx].height_max;
487+
fmt.pitch = fmt.width * video_bits_per_pixel(fmt.pixelformat) / BITS_PER_BYTE;
488+
489+
ret = video_set_format(dev, VIDEO_EP_OUT, &fmt);
490+
if (ret != 0) {
491+
LOG_ERR("Failed to set %s to default format '%s' %ux%u",
492+
dev->name, VIDEO_FOURCC_TO_STR(fmt.pixelformat), fmt.width, fmt.height);
493+
return ret;
494+
}
495+
496+
return 0;
497+
}

‎drivers/video/video_common.h‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,4 +135,126 @@ int video_read_cci_reg(const struct i2c_dt_spec *i2c, uint32_t reg_addr, uint32_
135135
*/
136136
int video_write_cci_multi(const struct i2c_dt_spec *i2c, const struct video_reg *regs);
137137

138+
/** @} */
139+
140+
/**
141+
* @defgroup video_imager Video Imager (image sensor) shared implementation
142+
*
143+
* This API is targeting image sensor driver developers.
144+
*
145+
* It provides a common implementation that only requires implementing a table of
146+
* @ref video_imager_mode that lists the various resolution, frame rates and associated I2C
147+
* configuration registers.
148+
*
149+
* The @c video_imager_... functions can be submitted directly to the @rev video_api.
150+
* If a driver also needs to do extra work before or after applying a mode, it is possible
151+
* to provide a custom wrapper or skip these default implementation altogether.
152+
*
153+
* @{
154+
*/
155+
156+
/**
157+
* @brief Table entry for an imaging mode of the sensor device.
158+
*
159+
* AA mode can be applied to an imager to configure a particular framerate, resolution, and pixel
160+
* format. The index of the table of modes is meant to match the index of the table of formats.
161+
*/
162+
struct video_imager_mode {
163+
/* FPS for this mode */
164+
uint16_t fps;
165+
/* Multiple lists of registers to allow sharing common sets of registers across modes. */
166+
const struct video_reg *regs[3];
167+
};
168+
169+
/**
170+
* @brief A video imager device is expected to have dev->data point to this structure.
171+
*
172+
* In order to support custom data structure, it is possible to store an extra pointer
173+
* in the dev->config struct. See existing drivers for an example.
174+
*/
175+
struct video_imager_config {
176+
/** List of all formats supported by this sensor */
177+
const struct video_format_cap *fmts;
178+
/** Array of modes tables, one table per format cap lislted by "fmts" */
179+
const struct video_imager_mode **modes;
180+
/** I2C device to write the registers to */
181+
struct i2c_dt_spec i2c;
182+
/** Write a table of registers onto the device */
183+
int (*write_multi)(const struct i2c_dt_spec *i2c, const struct video_reg *regs);
184+
/** Reference to a ; */
185+
struct video_imager_data *data;
186+
};
187+
188+
/**
189+
* @brief A video imager device is expected to have dev->data point to this structure.
190+
*
191+
* In order to support custom data structure, it is possible to store an extra pointer
192+
* in the dev->config struct. See existing drivers for an example.
193+
*/
194+
struct video_imager_data {
195+
/** Index of the currently active format in both modes[] and fmts[] */
196+
int fmt_id;
197+
/** Currently active video format */
198+
struct video_format fmt;
199+
/** Currently active operating mode as defined above */
200+
const struct video_imager_mode *mode;
201+
};
202+
203+
/**
204+
* @brief Initialize one row of a @struct video_format_cap with fixed width and height.
205+
*
206+
* The minimum and maximum are the same for both width and height fields.
207+
* @param
208+
*/
209+
#define VIDEO_IMAGER_FORMAT_CAP(pixfmt, width, height) \
210+
{ \
211+
.width_min = (width), .width_max = (width), .width_step = 0, \
212+
.height_min = (height), .height_max = (height), .height_step = 0, \
213+
.pixelformat = (pixfmt), \
214+
}
215+
216+
/**
217+
* @brief Set the operating mode of the imager as defined in @ref video_imager_mode.
218+
*
219+
* If the default immplementation for the video API are used, there is no need to explicitly call
220+
* this function in the image sensor driver.
221+
*
222+
* @param dev Device that has a struct video_imager in @c dev->data.
223+
* @param mode The mode to apply to the image sensor.
224+
* @return 0 if successful, or negative error number otherwise.
225+
*/
226+
int video_imager_set_mode(const struct device *dev, const struct video_imager_mode *mode);
227+
228+
/** @brief Default implementation for image drivers frame interval selection */
229+
int video_imager_set_frmival(const struct device *dev, enum video_endpoint_id ep,
230+
struct video_frmival *frmival);
231+
/** @brief Default implementation for image drivers frame interval query */
232+
int video_imager_get_frmival(const struct device *dev, enum video_endpoint_id ep,
233+
struct video_frmival *frmival);
234+
/** @brief Default implementation for image drivers frame interval enumeration */
235+
int video_imager_enum_frmival(const struct device *dev, enum video_endpoint_id ep,
236+
struct video_frmival_enum *fie);
237+
/** @brief Default implementation for image drivers format selection */
238+
int video_imager_set_fmt(const struct device *const dev, enum video_endpoint_id ep,
239+
struct video_format *fmt);
240+
/** @brief Default implementation for image drivers format query */
241+
int video_imager_get_fmt(const struct device *dev, enum video_endpoint_id ep,
242+
struct video_format *fmt);
243+
/** @brief Default implementation for image drivers format capabilities */
244+
int video_imager_get_caps(const struct device *dev, enum video_endpoint_id ep,
245+
struct video_caps *caps);
246+
247+
/**
248+
* Initialize an imager by loading init_regs onto the device, and setting the default format.
249+
*
250+
* @param dev Device that has a struct video_imager in @c dev->data.
251+
* @param init_regs If non-NULL, table of registers to configure at init.
252+
* @param default_fmt_idx Default format index to apply at init.
253+
* @return 0 if successful, or negative error number otherwise.
254+
*/
255+
int video_imager_init(const struct device *dev, const struct video_reg *init_regs,
256+
int default_fmt_idx);
257+
258+
/** @} */
259+
138260
#endif /* ZEPHYR_DRIVERS_VIDEO_COMMON_H_ */

0 commit comments

Comments
 (0)