Skip to content

V4L2 kAPI cleanups and documentation improvements part 2

Mauro Carvalho Chehab linux-media linux-renesas-soc 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest24 patches 31 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/24media: v4l2-dev.h: add kernel-doc to two macrosinclude/media/v4l2-dev.h+15 -31 reply
2/24media: v4l2-flash-led-class.h: add kernel-doc to two ancillary funcsinclude/media/v4l2-flash-led-class.h+12 -01 reply
3/24media: v4l2-mediabus: use BIT() macro for flagsinclude/media/v4l2-mediabus.h+26 -241 reply
4/24media: v4l2-mediabus: convert flags to enums and document themdrivers/media/i2c/adv7180.c drivers/media/i2c/ml86v7667.c drivers/media/i2c/mt9m111.c +24 more+217 -1333 replies
5/24media: v4l2-dev: convert VFL_TYPE_* into an enumDocumentation/media/kapi/v4l2-dev.rst drivers/media/pci/cx88/cx88-blackbird.c drivers/media/pci/cx88/cx88-video.c +8 more+98 -434 replies
6/24media: i2c-addr.h: get rid of now unused definesinclude/media/i2c-addr.h+0 -71 reply
7/24media: get rid of i2c-addr.hdrivers/media/i2c/tda7432.c drivers/media/i2c/tvaudio.c drivers/media/pci/bt8xx/bttv-cards.c +5 more+23 -421 reply
8/24media: v4l2-dev: document VFL_DIR_* direction definesinclude/media/v4l2-dev.h+16 -61 reply
9/24media: v4l2-dev: document video_device flagsinclude/media/v4l2-dev.h+18 -71 reply
10/24media: v4l2-subdev: use kernel-doc markups to document subdev flagsinclude/media/v4l2-subdev.h+20 -161 reply
11/24media: v4l2-subdev: create cross-references for ioctlsinclude/media/v4l2-subdev.h+34 -310 replies
12/24media: v4l2-subdev: fix description of tuner.s_radio opsinclude/media/v4l2-subdev.h+20 -10 replies
13/24media: v4l2-subdev: better document IO pin configuration flagsinclude/media/v4l2-subdev.h+21 -120 replies
14/24media: v4l2-subdev: convert frame description to enuminclude/media/v4l2-subdev.h+19 -120 replies
15/24media: v4l2-subdev: get rid of __V4L2_SUBDEV_MK_GET_TRY() macroinclude/media/v4l2-subdev.h+25 -125 replies
16/24media: v4l2-subdev: document remaining undocumented functionsinclude/media/v4l2-subdev.h+65 -51 reply
17/24media: v4l2-subdev: fix a typoinclude/media/v4l2-subdev.h+1 -11 reply
18/24media: vb2-core: use bitops for bitsinclude/media/videobuf2-core.h+6 -51 reply
19/24media: vb2-core: Improve kernel-doc markupsinclude/media/videobuf2-core.h+204 -1722 replies
20/24media: vb2-core: document remaining functionsinclude/media/videobuf2-core.h+53 -10 replies
21/24media: vb2-core: fix descriptions for VB2-only functionsinclude/media/videobuf2-core.h+46 -401 reply
22/24media: vb2: add cross references at memops and v4l2 kernel-doc markupsinclude/media/videobuf2-memops.h include/media/videobuf2-v4l2.h+63 -571 reply
23/24media: v4l2-tpg*.h: move headers to include/media/tpg and merge themdrivers/media/common/v4l2-tpg/v4l2-tpg-colors.c drivers/media/common/v4l2-tpg/v4l2-tpg-core.c drivers/media/platform/vimc/vimc-sensor.c +3 more+48 -731 reply
24/24media: v4l2-tpg.h: rename color structsdrivers/media/common/v4l2-tpg/v4l2-tpg-colors.c include/media/tpg/v4l2-tpg.h+7 -71 reply

Reviews trailers per patch

18 of 24 patches have a Reviewed-by or Acked-by.

PatchHans VerkuilSakari AilusMike Isely
1/24A-b
2/24A-b
3/24A-b
4/24A-b A-b
5/24A-b A-b
6/24A-b
7/24A-b
8/24A-b
9/24A-b
10/24A-b
11/24
12/24
13/24
14/24
15/24A-b
16/24A-b
17/24A-b
18/24A-b
19/24
20/24
21/24A-b
22/24A-b
23/24A-b
24/24A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v1 thread

Cover letter [PATCH 00/24] V4L2 kAPI cleanups and documentation improvements part 2

That's the second part of my V4L2 kAPI documentation improvements. It is meant to reduce the gap between the kAPI media headers and documentation, at least with regards to kernel-doc markups.

We should likely write more things at the ReST files under Documentation/ to better describe some of those APIs (VB2 being likely the first candidate), but at least let's be sure that all V4L2 bits have kernel-doc markups.

Mauro Carvalho Chehab (24):
media: v4l2-dev.h: add kernel-doc to two macros
media: v4l2-flash-led-class.h: add kernel-doc to two ancillary funcs
media: v4l2-mediabus: use BIT() macro for flags
media: v4l2-mediabus: convert flags to enums and document them
media: v4l2-dev: convert VFL_TYPE_* into an enum
media: i2c-addr.h: get rid of now unused defines
media: get rid of i2c-addr.h
media: v4l2-dev: document VFL_DIR_* direction defines
media: v4l2-dev: document video_device flags
media: v4l2-subdev: use kernel-doc markups to document subdev flags
media: v4l2-subdev: create cross-references for ioctls
media: v4l2-subdev: fix description of tuner.s_radio ops
media: v4l2-subdev: better document IO pin configuration flags
media: v4l2-subdev: convert frame description to enum
media: v4l2-subdev: get rid of __V4L2_SUBDEV_MK_GET_TRY() macro
media: v4l2-subdev: document remaining undocumented functions
media: v4l2-subdev: fix a typo
media: vb2-core: use bitops for bits
media: vb2-core: Improve kernel-doc markups
media: vb2-core: document remaining functions
media: vb2-core: fix descriptions for VB2-only functions
media: vb2: add cross references at memops and v4l2 kernel-doc markups
media: v4l2-tpg*.h: move headers to include/media/tpg and merge them
media: v4l2-tpg.h: rename color structs

 Documentation/media/kapi/v4l2-dev.rst              |  17 +-
 drivers/media/common/v4l2-tpg/v4l2-tpg-colors.c    |   8 +-
 drivers/media/common/v4l2-tpg/v4l2-tpg-core.c      |   2 +-
 drivers/media/i2c/adv7180.c                        |  10 +-
 drivers/media/i2c/ml86v7667.c                      |   5 +-
 drivers/media/i2c/mt9m111.c                        |   8 +-
 drivers/media/i2c/ov6650.c                         |  19 +-
 drivers/media/i2c/soc_camera/imx074.c              |   6 +-
 drivers/media/i2c/soc_camera/mt9m001.c             |  10 +-
 drivers/media/i2c/soc_camera/mt9t031.c             |  11 +-
 drivers/media/i2c/soc_camera/mt9t112.c             |  11 +-
 drivers/media/i2c/soc_camera/mt9v022.c             |  16 +-
 drivers/media/i2c/soc_camera/ov5642.c              |   5 +-
 drivers/media/i2c/soc_camera/ov772x.c              |  10 +-
 drivers/media/i2c/soc_camera/ov9640.c              |  10 +-
 drivers/media/i2c/soc_camera/ov9740.c              |  10 +-
 drivers/media/i2c/soc_camera/rj54n1cb0c.c          |  12 +-
 drivers/media/i2c/soc_camera/tw9910.c              |  13 +-
 drivers/media/i2c/tc358743.c                       |  10 +-
 drivers/media/i2c/tda7432.c                        |   1 -
 drivers/media/i2c/tvaudio.c                        |   2 -
 drivers/media/i2c/tvp5150.c                        |   6 +-
 drivers/media/pci/bt8xx/bttv-cards.c               |   7 +
 drivers/media/pci/bt8xx/bttv.h                     |   1 -
 drivers/media/pci/cx88/cx88-blackbird.c            |   3 +-
 drivers/media/pci/cx88/cx88-video.c                |  10 +-
 drivers/media/pci/cx88/cx88.h                      |   4 +-
 drivers/media/pci/saa7134/saa7134-video.c          |   2 +
 drivers/media/platform/pxa_camera.c                |   8 +-
 drivers/media/platform/rcar-vin/rcar-core.c        |   4 +-
 drivers/media/platform/rcar-vin/rcar-dma.c         |   4 +-
 .../platform/soc_camera/sh_mobile_ceu_camera.c     |   2 +-
 drivers/media/platform/soc_camera/soc_camera.c     |   3 +-
 .../platform/soc_camera/soc_camera_platform.c      |   2 +-
 drivers/media/platform/soc_camera/soc_mediabus.c   |   2 +-
 drivers/media/platform/vimc/vimc-sensor.c          |   2 +-
 drivers/media/platform/vivid/vivid-core.h          |   2 +-
 drivers/media/usb/cx231xx/cx231xx-video.c          |   2 +
 drivers/media/usb/em28xx/em28xx-cards.c            |   1 -
 drivers/media/usb/pvrusb2/pvrusb2-v4l2.c           |   2 +
 drivers/media/usb/tm6000/tm6000-cards.c            |   1 -
 drivers/media/usb/tm6000/tm6000-video.c            |   2 +
 drivers/media/v4l2-core/v4l2-dev.c                 |  10 +-
 drivers/media/v4l2-core/v4l2-fwnode.c              |   5 +-
 include/media/i2c-addr.h                           |  42 --
 include/media/i2c/tvaudio.h                        |  17 +-
 include/media/{ => tpg}/v4l2-tpg.h                 |  45 +-
 include/media/v4l2-dev.h                           | 124 ++++--
 include/media/v4l2-flash-led-class.h               |  12 +
 include/media/v4l2-fwnode.h                        |   4 +-
 include/media/v4l2-mediabus.h                      | 176 ++++++--
 include/media/v4l2-subdev.h                        | 293 +++++++++----
 include/media/v4l2-tpg-colors.h                    |  68 ---
 include/media/videobuf2-core.h                     | 483 ++++++++++++---------
 include/media/videobuf2-memops.h                   |   8 +-
 include/media/videobuf2-v4l2.h                     | 112 ++---
 56 files changed, 1006 insertions(+), 659 deletions(-)
 delete mode 100644 include/media/i2c-addr.h
 rename include/media/{ => tpg}/v4l2-tpg.h (93%)
 delete mode 100644 include/media/v4l2-tpg-colors.h
Signature · 1 line
2.13.6