[v4,2/4] media: vsp1: Document partition algorithm in code header
Commit Message
The image partition algorithm operates on the image dimensions as input
into the WPF entity. Document this in the code block header.
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>
---
drivers/media/platform/vsp1/vsp1_video.c | 8 ++++++++
1 file changed, 8 insertions(+)
@@ -173,6 +173,14 @@ static int __vsp1_video_try_format(struct vsp1_video *video,
/* -----------------------------------------------------------------------------
* VSP1 Partition Algorithm support
+ *
+ * VSP hardware can have restrictions on image width depending on the hardware
+ * configuration of the pipeline. Adapting for these restrictions is implemented
+ * via the partition algorithm.
+ *
+ * The partition windows and sizes are based on the output size of the WPF
+ * before rotation, which is represented by the input parameters to the WPF
+ * entity in our pipeline.
*/
/**