On 07/10/2020 12:35, Ezequiel Garcia wrote:
> To avoid potentially overflowing the kernel logs in the case
> of corrupted streams, this commit replaces an error log with
log -> message
> a per-stream counter to be read through a driver-specific
> control.
>
> Applications can read the per-stream accumulated
> error macroblocks count.
>
> The error message is moved to the driver-specific debug log,
> and rate-limitting is added to make sure it doesn't
> spam the log.
This is a confusing sentence. I'd write:
"The old error message is replaced by a rate-limited debug message."
>
> Signed-off-by: Ezequiel Garcia <ezequiel@xxxxxxxxxxxxx>
> ---
> MAINTAINERS | 1 +
> drivers/media/platform/coda/coda-bit.c | 9 +++--
> drivers/media/platform/coda/coda-common.c | 42 +++++++++++++++++++++++
> drivers/media/platform/coda/coda.h | 4 +++
> include/media/drv-intf/coda.h | 13 +++++++
> include/uapi/linux/v4l2-controls.h | 4 +++
> 6 files changed, 70 insertions(+), 3 deletions(-)
> create mode 100644 include/media/drv-intf/coda.h
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index ba5eb1dff9c2..4c7a59a4dda3 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -4334,6 +4334,7 @@ L: linux-media@xxxxxxxxxxxxxxx
> S: Maintained
> F: Documentation/devicetree/bindings/media/coda.txt
> F: drivers/media/platform/coda/
> +F: include/media/drv-intf/coda.h
>
> CODE OF CONDUCT
> M: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> diff --git a/drivers/media/platform/coda/coda-bit.c b/drivers/media/platform/coda/coda-bit.c
> index 919b36d753ec..dca6d1ee5744 100644
> --- a/drivers/media/platform/coda/coda-bit.c
> +++ b/drivers/media/platform/coda/coda-bit.c
> @@ -13,6 +13,7 @@
> #include <linux/kernel.h>
> #include <linux/log2.h>
> #include <linux/platform_device.h>
> +#include <linux/ratelimit.h>
> #include <linux/reset.h>
> #include <linux/slab.h>
> #include <linux/videodev2.h>
> @@ -2369,9 +2370,11 @@ static void coda_finish_decode(struct coda_ctx *ctx)
> }
>
> err_mb = coda_read(dev, CODA_RET_DEC_PIC_ERR_MB);
> - if (err_mb > 0)
> - v4l2_err(&dev->v4l2_dev,
> - "errors in %d macroblocks\n", err_mb);
> + if (err_mb > 0) {
> + if (__ratelimit(&dev->err_mb_rs))
> + coda_dbg(1, ctx, "errors in %d macroblocks\n", err_mb);
> + ctx->err_mb += err_mb;
Use v4l2_ctrl_s_ctrl.
> + }
>
> if (dev->devtype->product == CODA_HX4 ||
> dev->devtype->product == CODA_7541) {
> diff --git a/drivers/media/platform/coda/coda-common.c b/drivers/media/platform/coda/coda-common.c
> index 487dd653b24a..498563bc9a66 100644
> --- a/drivers/media/platform/coda/coda-common.c
> +++ b/drivers/media/platform/coda/coda-common.c
> @@ -26,8 +26,10 @@
> #include <linux/videodev2.h>
> #include <linux/of.h>
> #include <linux/platform_data/media/coda.h>
> +#include <linux/ratelimit.h>
> #include <linux/reset.h>
>
> +#include <media/drv-intf/coda.h>
> #include <media/v4l2-ctrls.h>
> #include <media/v4l2-device.h>
> #include <media/v4l2-event.h>
> @@ -2062,6 +2064,7 @@ static int coda_start_streaming(struct vb2_queue *q, unsigned int count)
> if (q_data_dst->fourcc == V4L2_PIX_FMT_JPEG)
> ctx->params.gop_size = 1;
> ctx->gopcounter = ctx->params.gop_size - 1;
> + ctx->err_mb = 0;
Ditto.
>
> ret = ctx->ops->start_streaming(ctx);
> if (ctx->inst_type == CODA_INST_DECODER) {
> @@ -2162,6 +2165,22 @@ static const struct vb2_ops coda_qops = {
> .wait_finish = vb2_ops_wait_finish,
> };
>
> +static int coda_g_ctrl(struct v4l2_ctrl *ctrl)
> +{
> + struct coda_ctx *ctx =
> + container_of(ctrl->handler, struct coda_ctx, ctrls);
> + switch (ctrl->id) {
> + case V4L2_CID_CODA_ERR_MB:
> + ctrl->val = ctx->err_mb;
> + break;
> + default:
> + coda_dbg(1, ctx, "Invalid control, id=%d, val=%d\n",
> + ctrl->id, ctrl->val);
Just drop this message, you can't actually get in the default case.
> + return -EINVAL;
> + }
> + return 0;
> +}
> +
> static int coda_s_ctrl(struct v4l2_ctrl *ctrl)
> {
> const char * const *val_names = v4l2_ctrl_get_menu(ctrl->id);
> @@ -2291,6 +2310,10 @@ static int coda_s_ctrl(struct v4l2_ctrl *ctrl)
> return 0;
> }
>
> +static const struct v4l2_ctrl_ops coda_err_mb_ctrl_ops = {
> + .g_volatile_ctrl = coda_g_ctrl,
> +};
This control isn't a volatile control at all. Just use v4l2_ctrl_s_ctrl to
set it.
> +
> static const struct v4l2_ctrl_ops coda_ctrl_ops = {
> .s_ctrl = coda_s_ctrl,
> };
> @@ -2462,6 +2485,16 @@ static void coda_decode_ctrls(struct coda_ctx *ctx)
> ctx->mpeg4_level_ctrl->flags |= V4L2_CTRL_FLAG_READ_ONLY;
> }
>
> +static const struct v4l2_ctrl_config coda_err_mb_ctrl_config = {
> + .ops = &coda_err_mb_ctrl_ops,
> + .id = V4L2_CID_CODA_ERR_MB,
Call it V4L2_CID_CODA_MB_ERR_CNT to clearly signal that this is a counter.
Rename related variables as well (e.g. coda_mb_err_cnt_ctrl_config).
> + .name = "Error macroblocks count",
"Macroblocks Error Count"
> + .type = V4L2_CTRL_TYPE_INTEGER,
> + .min = 0,
> + .max = 0xffffffff,
This is a s32, so max should be 0x7fffffff.
> + .step = 1,
> +};
> +
> static int coda_ctrls_setup(struct coda_ctx *ctx)
> {
> v4l2_ctrl_handler_init(&ctx->ctrls, 2);
> @@ -2484,6 +2517,14 @@ static int coda_ctrls_setup(struct coda_ctx *ctx)
> 1, 1, 1, 1);
> if (ctx->cvd->src_formats[0] == V4L2_PIX_FMT_H264)
> coda_decode_ctrls(ctx);
> +
> + ctx->err_mb_ctrl = v4l2_ctrl_new_custom(&ctx->ctrls,
> + &coda_err_mb_ctrl_config,
> + NULL);
> + if (ctx->err_mb_ctrl)
> + ctx->err_mb_ctrl->flags |=
> + V4L2_CTRL_FLAG_READ_ONLY |
> + V4L2_CTRL_FLAG_VOLATILE;
Drop volatile.
> }
>
> if (ctx->ctrls.error) {
> @@ -3202,6 +3243,7 @@ static int coda_probe(struct platform_device *pdev)
> if (ret)
> return ret;
>
> + ratelimit_default_init(&dev->err_mb_rs);
> mutex_init(&dev->dev_mutex);
> mutex_init(&dev->coda_mutex);
> ida_init(&dev->ida);
> diff --git a/drivers/media/platform/coda/coda.h b/drivers/media/platform/coda/coda.h
> index e53f7a65d532..517c47e6e1b3 100644
> --- a/drivers/media/platform/coda/coda.h
> +++ b/drivers/media/platform/coda/coda.h
> @@ -17,6 +17,7 @@
> #include <linux/mutex.h>
> #include <linux/kfifo.h>
> #include <linux/videodev2.h>
> +#include <linux/ratelimit.h>
>
> #include <media/v4l2-ctrls.h>
> #include <media/v4l2-device.h>
> @@ -92,6 +93,7 @@ struct coda_dev {
> struct v4l2_m2m_dev *m2m_dev;
> struct ida ida;
> struct dentry *debugfs_root;
> + struct ratelimit_state err_mb_rs;
> };
>
> struct coda_codec {
> @@ -242,6 +244,7 @@ struct coda_ctx {
> struct v4l2_ctrl *mpeg2_level_ctrl;
> struct v4l2_ctrl *mpeg4_profile_ctrl;
> struct v4l2_ctrl *mpeg4_level_ctrl;
> + struct v4l2_ctrl *err_mb_ctrl;
> struct v4l2_fh fh;
> int gopcounter;
> int runcounter;
> @@ -274,6 +277,7 @@ struct coda_ctx {
> struct dentry *debugfs_entry;
> bool use_bit;
> bool use_vdoa;
> + unsigned int err_mb;
> struct vdoa_ctx *vdoa;
> /*
> * wakeup mutex used to serialize encoder stop command and finish_run,
> diff --git a/include/media/drv-intf/coda.h b/include/media/drv-intf/coda.h
Why here? This is not a public header. It should either be in include/uapi/linux
or just keep it in the driver.
> new file mode 100644
> index 000000000000..1d767bec4c4a
> --- /dev/null
> +++ b/include/media/drv-intf/coda.h
> @@ -0,0 +1,13 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */
> +
> +#ifndef VIDEO_CODA_INTF_H
> +#define VIDEO_CODA_INTF_H
> +
> +#include <linux/types.h>
> +#include <linux/videodev2.h>
> +
> +enum coda_ctrl_id {
> + V4L2_CID_CODA_ERR_MB = (V4L2_CID_USER_CODA_BASE + 0),
> +};
Just use #define.
You must document this control here.
> +
> +#endif /* VIDEO_CODA_INTF_H */
> diff --git a/include/uapi/linux/v4l2-controls.h b/include/uapi/linux/v4l2-controls.h
> index a184c4939438..b4481d9579e7 100644
> --- a/include/uapi/linux/v4l2-controls.h
> +++ b/include/uapi/linux/v4l2-controls.h
> @@ -198,6 +198,10 @@ enum v4l2_colorfx {
> */
> #define V4L2_CID_USER_ATMEL_ISC_BASE (V4L2_CID_USER_BASE + 0x10c0)
>
> +/* The base for the CODA driver controls.
> + * We reserve 16 controls for this driver. */
> +#define V4L2_CID_USER_CODA_BASE (V4L2_CID_USER_BASE + 0x10e0)
> +
> /* MPEG-class control IDs */
> /* The MPEG controls are applicable to all codec controls
> * and the 'MPEG' part of the define is historical */
>
Regards,
Hans
