Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

media: docs: ipu3.rst: rely at automarkup extension

There are several :c:type: definitions there, in order to
do cross-references with the driver's documentation.

Those are broken when docs are built with Sphinx 3.x, as
it would require :c:struct: instead.

For Sphinx < 3.x, the automarkup.py extension is able to do the
replacement already, and a future improvement on it should make
it also work with Sphinx 3.x.

So, get rid of the usage of the :c:type: macro there.

Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

+19 -19
+19 -19
Documentation/admin-guide/media/ipu3.rst
··· 488 488 Optical Black Correction Optical Black Correction block subtracts a pre-defined 489 489 value from the respective pixel values to obtain better 490 490 image quality. 491 - Defined in :c:type:`ipu3_uapi_obgrid_param`. 491 + Defined in struct ipu3_uapi_obgrid_param. 492 492 Linearization This algo block uses linearization parameters to 493 493 address non-linearity sensor effects. The Lookup table 494 494 table is defined in 495 - :c:type:`ipu3_uapi_isp_lin_vmem_params`. 495 + struct ipu3_uapi_isp_lin_vmem_params. 496 496 SHD Lens shading correction is used to correct spatial 497 497 non-uniformity of the pixel response due to optical 498 498 lens shading. This is done by applying a different gain 499 499 for each pixel. The gain, black level etc are 500 - configured in :c:type:`ipu3_uapi_shd_config_static`. 500 + configured in struct ipu3_uapi_shd_config_static. 501 501 BNR Bayer noise reduction block removes image noise by 502 502 applying a bilateral filter. 503 - See :c:type:`ipu3_uapi_bnr_static_config` for details. 503 + See struct ipu3_uapi_bnr_static_config for details. 504 504 ANR Advanced Noise Reduction is a block based algorithm 505 505 that performs noise reduction in the Bayer domain. The 506 506 convolution matrix etc can be found in 507 - :c:type:`ipu3_uapi_anr_config`. 507 + struct ipu3_uapi_anr_config. 508 508 DM Demosaicing converts raw sensor data in Bayer format 509 509 into RGB (Red, Green, Blue) presentation. Then add 510 510 outputs of estimation of Y channel for following stream 511 511 processing by Firmware. The struct is defined as 512 - :c:type:`ipu3_uapi_dm_config`. 512 + struct ipu3_uapi_dm_config. 513 513 Color Correction Color Correction algo transforms sensor specific color 514 514 space to the standard "sRGB" color space. This is done 515 515 by applying 3x3 matrix defined in 516 - :c:type:`ipu3_uapi_ccm_mat_config`. 517 - Gamma correction Gamma correction :c:type:`ipu3_uapi_gamma_config` is a 516 + struct ipu3_uapi_ccm_mat_config. 517 + Gamma correction Gamma correction struct ipu3_uapi_gamma_config is a 518 518 basic non-linear tone mapping correction that is 519 519 applied per pixel for each pixel component. 520 520 CSC Color space conversion transforms each pixel from the 521 521 RGB primary presentation to YUV (Y: brightness, 522 522 UV: Luminance) presentation. This is done by applying 523 523 a 3x3 matrix defined in 524 - :c:type:`ipu3_uapi_csc_mat_config` 524 + struct ipu3_uapi_csc_mat_config 525 525 CDS Chroma down sampling 526 526 After the CSC is performed, the Chroma Down Sampling 527 527 is applied for a UV plane down sampling by a factor 528 528 of 2 in each direction for YUV 4:2:0 using a 4x2 529 - configurable filter :c:type:`ipu3_uapi_cds_params`. 529 + configurable filter struct ipu3_uapi_cds_params. 530 530 CHNR Chroma noise reduction 531 531 This block processes only the chrominance pixels and 532 532 performs noise reduction by cleaning the high 533 533 frequency noise. 534 - See struct :c:type:`ipu3_uapi_yuvp1_chnr_config`. 534 + See struct struct ipu3_uapi_yuvp1_chnr_config. 535 535 TCC Total color correction as defined in struct 536 - :c:type:`ipu3_uapi_yuvp2_tcc_static_config`. 536 + struct ipu3_uapi_yuvp2_tcc_static_config. 537 537 XNR3 eXtreme Noise Reduction V3 is the third revision of 538 538 noise reduction algorithm used to improve image 539 539 quality. This removes the low frequency noise in the 540 540 captured image. Two related structs are being defined, 541 - :c:type:`ipu3_uapi_isp_xnr3_params` for ISP data memory 542 - and :c:type:`ipu3_uapi_isp_xnr3_vmem_params` for vector 541 + struct ipu3_uapi_isp_xnr3_params for ISP data memory 542 + and struct ipu3_uapi_isp_xnr3_vmem_params for vector 543 543 memory. 544 544 TNR Temporal Noise Reduction block compares successive 545 545 frames in time to remove anomalies / noise in pixel 546 - values. :c:type:`ipu3_uapi_isp_tnr3_vmem_params` and 547 - :c:type:`ipu3_uapi_isp_tnr3_params` are defined for ISP 546 + values. struct ipu3_uapi_isp_tnr3_vmem_params and 547 + struct ipu3_uapi_isp_tnr3_params are defined for ISP 548 548 vector and data memory respectively. 549 549 ======================== ======================================================= 550 550 ··· 576 576 called accelerator cluster (ACC) to crunch pixel data and produce statistics. 577 577 578 578 ACC parameters of individual algorithms, as defined by 579 - :c:type:`ipu3_uapi_acc_param`, can be chosen to be applied by the user 580 - space through struct :c:type:`ipu3_uapi_flags` embedded in 581 - :c:type:`ipu3_uapi_params` structure. For parameters that are configured as 579 + struct ipu3_uapi_acc_param, can be chosen to be applied by the user 580 + space through struct struct ipu3_uapi_flags embedded in 581 + struct ipu3_uapi_params structure. For parameters that are configured as 582 582 not enabled by the user space, the corresponding structs are ignored by the 583 583 driver, in which case the existing configuration of the algorithm will be 584 584 preserved.