linux/drivers/media/platform/vimc/vimc-streamer.h
André Almeida 959f9c841b media: vimc: stream: fix style of argument description
As in "Function parameters" at doc-guide/kernel-doc.rst, "the
continuation of the description should start at the same column as the
previous line". Make the @producer_pixfmt comply with that.

Signed-off-by: André Almeida <andrealmeid@collabora.com>
Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2019-07-23 11:53:45 -04:00

53 lines
1.7 KiB
C

/* SPDX-License-Identifier: GPL-2.0+ */
/*
* vimc-streamer.h Virtual Media Controller Driver
*
* Copyright (C) 2018 Lucas A. M. Magalhães <lucmaga@gmail.com>
*
*/
#ifndef _VIMC_STREAMER_H_
#define _VIMC_STREAMER_H_
#include <media/media-device.h>
#include "vimc-common.h"
#define VIMC_STREAMER_PIPELINE_MAX_SIZE 16
/**
* struct vimc_stream - struct that represents a stream in the pipeline
*
* @pipe: the media pipeline object associated with this stream
* @ved_pipeline: array containing all the entities participating in the
* stream. The order is from a video device (usually a capture device) where
* stream_on was called, to the entity generating the first base image to be
* processed in the pipeline.
* @pipe_size: size of @ved_pipeline
* @kthread: thread that generates the frames of the stream.
* @producer_pixfmt: the pixel format requested from the pipeline. This must
* be set just before calling
* vimc_streamer_s_stream(ent, 1). This value is propagated
* up to the source of the base image (usually a sensor
* node) and can be modified by entities during s_stream
* callback to request a differentformat from rest of
* the pipeline.
*
* When the user call stream_on in a video device, struct vimc_stream is
* used to keep track of all entities and subdevices that generates and
* process frames for the stream.
*/
struct vimc_stream {
struct media_pipeline pipe;
struct vimc_ent_device *ved_pipeline[VIMC_STREAMER_PIPELINE_MAX_SIZE];
unsigned int pipe_size;
struct task_struct *kthread;
u32 producer_pixfmt;
};
int vimc_streamer_s_stream(struct vimc_stream *stream,
struct vimc_ent_device *ved,
int enable);
#endif //_VIMC_STREAMER_H_