From nobody Tue Dec 2 01:26:45 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 418442F745B; Mon, 24 Nov 2025 09:57:56 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763978276; cv=none; b=nggaabpP96PB+KHxgYP9YrDRdE/sdsf+NcUtbp4ptmi6aQGhwIiKeIFkIz1C8bZ7Ggi/sVwczuwKAgCWDierQjNC+3I4XMCNcfomicDGBqfjrRF8JGWl0kf/38CceXG6utz0vO8uDqnmYjg25y/t4gCar4LmxXXFq/ayj2UTaTU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1763978276; c=relaxed/simple; bh=Ik0bwiscH39XA81eEpRwbrxBFIfeeaIoMwR5sWLhRX0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=BEYgnnhBCMCxvlUElnZUxSBqd+IwEczsqeDHMZj3aFIGz9AqWVxKnJ3KpOecsqF43VuQ0NS0rqslg+jaOdppB0d3y1wNCfJSF7ZzMHJgbMrEjp7FxoGYicAW6j3VeFKtG6nd7uaz6Z4Yj4OTK8R8TCZkVI9lQq8CYFCZBuPloP0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=HCn1FAer; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="HCn1FAer" Received: by smtp.kernel.org (Postfix) with ESMTPSA id EAA92C19421; Mon, 24 Nov 2025 09:57:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1763978276; bh=Ik0bwiscH39XA81eEpRwbrxBFIfeeaIoMwR5sWLhRX0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=HCn1FAeracqS4C5RHH3gtIyy1o4+mdfUbxdO5ZGnc8l6dh9Y3LGt8kBTnHoFH51fF qPhDuAsobF8jmLaz9Ove1jV/2HyPEb722xX6psuwr/j+Ap3du3JQmvuz08f2s5PLC5 TVzBN4Sy5o8K9HFCGhHJ7lw+GDgpLky33+sV2Y/xGfqjdqXp7pAUNW4P7jvoGbE7v6 KTZb0nPbFgxH60KjiH0pPdqMKvX8wq7rmCavaUdT7A41n1dhkkN5kEru6RLNhP4ei8 E2vTR7mDr0iMoWyWcTChcqw025mvusNdDvsjnwM6AjqjEjoXFXnijN5NaJu6efmcSr 4DuL+z2/+IJrA== Received: from mchehab by mail.kernel.org with local (Exim 4.99) (envelope-from ) id 1vNTKU-000000013c8-0kV4; Mon, 24 Nov 2025 10:57:54 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , "Jonathan Corbet" Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , "Randy Dunlap" , linux-kernel@vger.kernel.org, linux-media@vger.kernel.org Subject: [PATCH v5 3/5] docs: media: v4l2-ioctl.h: document two global variables Date: Mon, 24 Nov 2025 10:57:44 +0100 Message-ID: <8a834e98624795aa02070752d3d49a9ba40a86e7.1763978209.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.51.1 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" The media kAPI has two global variables at v4l2-ioctl.h. Document them. Signed-off-by: Mauro Carvalho Chehab Acked-by: Randy Dunlap Tested-by: Randy Dunlap --- include/media/v4l2-ioctl.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/include/media/v4l2-ioctl.h b/include/media/v4l2-ioctl.h index 6f7a58350441..54c83b18d555 100644 --- a/include/media/v4l2-ioctl.h +++ b/include/media/v4l2-ioctl.h @@ -663,7 +663,22 @@ void v4l_printk_ioctl(const char *prefix, unsigned int= cmd); struct video_device; =20 /* names for fancy debug output */ + +/** + * var v4l2_field_names - Helper array mapping ``V4L2_FIELD_*`` to strings. + * + * Specially when printing debug messages, it is interesting to output + * the field order at the V4L2 buffers. This array associates all possible + * values of field pix format from V4L2 API into a string. + */ extern const char *v4l2_field_names[]; + +/** + * var v4l2_type_names - Helper array mapping ``V4L2_BUF_TYPE_*`` to strin= gs. + * + * When printing debug messages, it is interesting to output the V4L2 buff= er + * type number with a name that represents its content. + */ extern const char *v4l2_type_names[]; =20 #ifdef CONFIG_COMPAT --=20 2.51.1