Received-SPF: pass (google.com: domain of linux-kernel+bounces-26303-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
From: =?UTF-8?q?Micha=C5=82=20Winiarski?= <michal.winiarski@intel.com>
To: <intel-xe@lists.freedesktop.org>, <dri-devel@lists.freedesktop.org>,
	<linux-kernel@vger.kernel.org>
CC: Rodrigo Vivi <rodrigo.vivi@intel.com>, Michal Wajdeczko
	<michal.wajdeczko@intel.com>, Maarten Lankhorst
	<maarten.lankhorst@linux.intel.com>, Maxime Ripard <mripard@kernel.org>,
	Thomas Zimmermann <tzimmermann@suse.de>, David Airlie <airlied@gmail.com>,
	Daniel Vetter <daniel@ffwll.ch>, Javier Martinez Canillas
	<javierm@redhat.com>, =?UTF-8?q?Ma=C3=ADra=20Canal?= <mcanal@igalia.com>,
	=?UTF-8?q?Micha=C5=82=20Winiarski?= <michal.winiarski@intel.com>
Subject: [PATCH v5 3/5] drm/tests: managed: Add comments about test intent
Date: Mon, 15 Jan 2024 18:13:49 +0100
Message-ID: <20240115171351.504264-4-michal.winiarski@intel.com>
In-Reply-To: <20240115171351.504264-1-michal.winiarski@intel.com>
References: <20240115171351.504264-1-michal.winiarski@intel.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 8bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TTdiZEQ0UFdlV1dzR010QTF0VHVjY3VjVXV3c2tIS2k2VkxFbzBEVTRFT2xv?=
 =?utf-8?B?L3pXcVJsazZBYWM4Z1NFeFFzZy9qL3lwTGxBYmVoWjNRMlZ0S1NiYjhKNDBx?=
 =?utf-8?B?UkpoL0w3Z1B4YU8za0FkaGxtcVJ4VXA5Zzc3NW0yNDJUb3pRT2xUMnd2Sjdw?=
 =?utf-8?B?cnQ5TENGU01Qa3JvcFVDMzUxd2MxcE9oN1lEMjNocitEWlFVbytLdE5QVUh0?=
 =?utf-8?B?WmFuWW8yanZHSFZxUVRRSnFUTFpCQzhISHErMmMvS1h1NGZYaHRkVVdpaS9s?=
 =?utf-8?B?WkYwZml4N240dkhsbnJNa2JGbHo4RXFUdjJmOUpSdlgrOUJrclFtcnR5U28y?=
 =?utf-8?B?L1VrUWdvOEc0UG9lTkZPbHFNU0FGU1ExdllONG41NVNVNzZFdlFhV2RvNXgy?=
 =?utf-8?B?RkZnMndFenNpaWphSG80ZEFJK0FFVHArc0VjYmZyNDZHQWFhdTBmU3d4MS9m?=
 =?utf-8?B?TkVmdlNDMEtxZEZvMDczbkprRlg1WUlzMWkzcDV2U0c5Y0p2YXNmTG9mbjBn?=
 =?utf-8?B?VHJsUW9qenpNUnY3OGdVVFl6cUhWN05RUkNUS0w1aklELzBseXYrRktJZ3Av?=
 =?utf-8?B?cjk1ZFc3eHZkQ1AxbWxmOGNyME1hc1hGZkdLZnYxUGVyK3g3OXBBSmJhYTRs?=
 =?utf-8?B?UE5PRzJyWHNnd1ppNXVJK0kwNUNnMWlNZ01UR3l1dzBtSGZjM1dZU1Vvck1B?=
 =?utf-8?B?NlovUUtTL2FXMnpRbmdudnN4azAvUFNpeTZGNkk1bG9YWXY3UUlDUlNnQzlM?=
 =?utf-8?B?bndoclVWWGgyY0VBNmY4U0dMTFpsWUNXUGlwZGFwck11ZDFybzE4YkVMWDF1?=
 =?utf-8?B?NnB0em5rTzZsSElFSlFBT0R2cENyL2tRN3ZGQkZpVXhCa1U0UEJpczJOTzBX?=
 =?utf-8?B?QzVBOXphR3ZHNTUxK2ZJRnlLUnd1dFZteFRPRW9kWjQ0NVRPa0lsUzJYVGxa?=
 =?utf-8?B?ckFlRUc3Nzg0bk1TZmcvUEVFL2poZHVlRWx5QjJnNlRtVmJ6YnFJbWZURFpt?=
 =?utf-8?B?Q2orZm5BUUtpZXdVeDMvcGNBbWlGS2JscDJCVXltMWc0eTBrcDFMNW5qVEJa?=
 =?utf-8?B?Sm5YamdqN2wyeVJ6Ukd3SUVkcmtkZktrSnVEVENqOVZnR0pWZ1hrZmdIWmlK?=
 =?utf-8?B?czh3WGtKbi9LQkJOU0UyUmROd0RsUkdmcmhXdHB2OHZHUlpEKzd0RnpGNy9s?=
 =?utf-8?B?MzFWcmlUaDdzZnV1OUYwZExoRVRERDlabEhLSWtkRTBJeXpOcTRYRFdtdDJQ?=
 =?utf-8?B?d0d0dmZ0eEFMV0J3Z2VVWU5WOWhuZHc5S2F5R1NySE4zYjVHM0dPUFlpUmxJ?=
 =?utf-8?B?QlF2SmkweERrcVU3dDNqbFFNY0RBaTIzSXErRVExQ2txT0tUZHloSkEvNXhJ?=
 =?utf-8?B?VSswbVFYMzVxd3JTVWQzVUs2U2x6a1gxaVhHUVRSWGc1UXZnZ1FoMFE4ckNR?=
 =?utf-8?B?aGF2QnJMNVpoVFpOY0hlNnVRSzlBa2pwc3R4djVOeDB5ODVWTi9TVEFZb1gz?=
 =?utf-8?B?Q2ZBMlkwNUhnRng5a3BJcVd0UVBrakx6OVJpdmZwK3pWQzNiUWlXc1Jkb21C?=
 =?utf-8?B?N09EVHc5UllGU0Z2WldSMjMrdDBwN0dhalk4K3BJc3dHSytud3FsdDU4dTdW?=
 =?utf-8?B?U3pvK0FML0lPOWZpQkd5TThnM1FTaW8zd1dYWHRWQkJZQkQwMmlHQkZuZ2xn?=
 =?utf-8?B?ekZGcW5heWdrVVBlanZRYmowYmJWZ1FaazFUM2doZlJ1czMwTlF2YWlnakdq?=
 =?utf-8?B?bWZhZEhSSnN0d2xZdzRIaXdnM0tkbmYzS3F4bUN3ZVdkbjZIb3pmMjhGOVN5?=
 =?utf-8?B?eXdVcWlNY2pmdS9mUmpyaWRpdGd6RWlHVDN4ZmR3ZTRRTWhwZVcxQTlnbEt2?=
 =?utf-8?B?VHZrU2poRjl2c1hxbnZreTJ0WVdoRVNsaC9xZmNrNDQvcUhrenNjTkRPemFG?=
 =?utf-8?B?cTI2OHhrdk9GQU1QSHRrK3JSMU83blQ4N0NRM241THY0dm13eXNyNFd1Q3NZ?=
 =?utf-8?B?WlNwL0F0TEpwdURrbnFJZ1VmUXNpS0dEeHZQcXB3cXdyNW05bVFMYnYxclJJ?=
 =?utf-8?B?dFBHNjlydFVpYWhvZU1HaTBUNndYNFVoQXgxb2ZBRVFGVERmWHp3a2lPYjc5?=
 =?utf-8?B?S2RQRmkwR2xXakZVckV0QUQ3c3RidFd5TFByMEprR2loTDFsU2RaTGxBMjBB?=
 =?utf-8?B?dHc9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 0a9afb84-5494-468e-d523-08dc15ed6630
X-MS-Exchange-CrossTenant-AuthSource: DM4PR11MB5373.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Jan 2024 17:14:14.6721
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: y7+5XYVt1wlySRf5RpGAJUcmoWB+5Wxqg7LjPPqAO3AKSDu79/7ncg2Aw8yeEDf7OEcDIYt/rALN5mzUYvwkNFdjj6Htz5yiVmMSWA+VCCM=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR11MB6391
X-OriginatorOrg: intel.com

Add comments explaining the intention behind the test and certain
implementation details related to device lifetime.

Signed-off-by: Michał Winiarski <michal.winiarski@intel.com>
---
 drivers/gpu/drm/tests/drm_managed_test.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/drivers/gpu/drm/tests/drm_managed_test.c b/drivers/gpu/drm/tests/drm_managed_test.c
index f85dada4de0a9..b5cf46d9f5cf8 100644
--- a/drivers/gpu/drm/tests/drm_managed_test.c
+++ b/drivers/gpu/drm/tests/drm_managed_test.c
@@ -24,6 +24,10 @@ static void drm_action(struct drm_device *drm, void *ptr)
 	wake_up_interruptible(&priv->action_wq);
 }
 
+/*
+ * The test verifies that the release action is called automatically when the
+ * device is released.
+ */
 static void drm_test_managed_run_action(struct kunit *test)
 {
 	struct managed_test_priv *priv;
@@ -38,6 +42,11 @@ static void drm_test_managed_run_action(struct kunit *test)
 	dev = drm_kunit_helper_alloc_device(test);
 	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, dev);
 
+	/*
+	 * DRM device can't be embedded in priv, since priv->action_done needs
+	 * to remain allocated beyond both parent device and drm_device
+	 * lifetime.
+	 */
 	drm = __drm_kunit_helper_alloc_drm_device(test, dev, sizeof(*drm), 0, DRIVER_MODESET);
 	KUNIT_ASSERT_NOT_ERR_OR_NULL(test, drm);
 
-- 
2.43.0