[4/4] hw/ufs: ufs descriptor read test implemented

From 936ef0a907bcf16809f9980c2d37e8fcb13697d2 Mon Sep 17 00:00:00 2001
From: Yoochan Jeong <yc01.jeong@samsung.com>
Date: Wed, 21 Aug 2024 09:09:54 +0900
Subject: [PATCH 4/4] hw/ufs: ufs descriptor read test implemented

New test function "ufstest_desc_request" added, which can check one's
virtual UFS device can properly read and its descriptor data.
(Writing descriptors are not implemented yet.)
The testcases attempt to read all kinds of descriptors at least once,
except for configuration descriptors (which are not implemented yet.)
There are some testcases that are intended to make an error caused by
an invalid index value or an invalid selector value.

Based on: 20240802051902epcms2p319bc095a15eaef8de4e6955f6718371d@epcms2p3
Signed-off-by: Yoochan Jeong <yc01.jeong@samsung.com>
---
 tests/qtest/ufs-test.c | 155 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 155 insertions(+)

On 8/22/2024 10:39 AM, Yoochan Jeong wrote:
>  From 936ef0a907bcf16809f9980c2d37e8fcb13697d2 Mon Sep 17 00:00:00 2001
> From: Yoochan Jeong <yc01.jeong@samsung.com>
> Date: Wed, 21 Aug 2024 09:09:54 +0900
> Subject: [PATCH 4/4] hw/ufs: ufs descriptor read test implemented

Remove it.


>
> New test function "ufstest_desc_request" added, which can check one's
> virtual UFS device can properly read and its descriptor data.
> (Writing descriptors are not implemented yet.)
> The testcases attempt to read all kinds of descriptors at least once,
> except for configuration descriptors (which are not implemented yet.)
> There are some testcases that are intended to make an error caused by
> an invalid index value or an invalid selector value.
>
> Based on: 20240802051902epcms2p319bc095a15eaef8de4e6955f6718371d@epcms2p3
> Signed-off-by: Yoochan Jeong <yc01.jeong@samsung.com>
> ---
>   tests/qtest/ufs-test.c | 155 +++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 155 insertions(+)
>
> diff --git a/tests/qtest/ufs-test.c b/tests/qtest/ufs-test.c
> index a8fd2f1acc..f96061f922 100644
> --- a/tests/qtest/ufs-test.c
> +++ b/tests/qtest/ufs-test.c
> @@ -785,6 +785,160 @@ static void ufstest_attr_request(void *obj, void *data, QGuestAllocator *alloc)
>       ufs_exit(ufs, alloc);
>   }
>   
> +static void ufstest_desc_request(void *obj, void *data, QGuestAllocator *alloc)
> +{
> +    QUfs *ufs = obj;
> +
> +    UtpTransferReqDesc utrd;
> +    UtpUpiuRsp rsp_upiu;
> +    ufs_init(ufs, alloc);
> +
> +    /* Write Descriptor is not supported yet */
> +
> +    /* Read Device Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_DEVICE,
> +                   0, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.opcode, ==, UFS_UPIU_QUERY_OPCODE_READ_DESC);
> +    g_assert_cmpuint(rsp_upiu.qr.idn, ==, UFS_QUERY_DESC_IDN_DEVICE);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(DeviceDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_DEVICE);
> +
> +    /* Read Configuration Descriptor is not supported yet*/
> +
> +    /* Read Unit Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_UNIT, 0,
> +                   0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(UnitDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_UNIT);
> +    g_assert_cmpuint(rsp_upiu.qr.data[2], ==, 0);
> +
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_UNIT, 1,
> +                   0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(UnitDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_UNIT);
> +    g_assert_cmpuint(rsp_upiu.qr.data[2], ==, 1);
> +
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_UNIT,
> +                   UFS_UPIU_RPMB_WLUN, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(RpmbUnitDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_UNIT);
> +    g_assert_cmpuint(rsp_upiu.qr.data[2], ==, UFS_UPIU_RPMB_WLUN);
> +
> +    /* Read Interconnect Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC,
> +                   UFS_QUERY_DESC_IDN_INTERCONNECT, 0, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(InterconnectDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_INTERCONNECT);
> +    g_assert_cmpuint(rsp_upiu.qr.data[2], ==, 0x01);

Depending on the ufs version, the unipro version can vary.

Although they are currently 0x180 & 0x410, they should be 0x200 & 0x500 
in ufs v4.0

So I don't think it's a good idea to test these with fixed values. 
Please remove it.

> +    g_assert_cmpuint(rsp_upiu.qr.data[3], ==, 0x80);
> +    g_assert_cmpuint(rsp_upiu.qr.data[4], ==, 0x04);
> +    g_assert_cmpuint(rsp_upiu.qr.data[5], ==, 0x10);
> +
> +    /* Read String Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_STRING,
> +                   0, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, 0x12);
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_STRING);
> +
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_STRING,
> +                   1, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, 0x22);
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_STRING);
> +
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_STRING,
> +                   4, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, 0x0a);
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_STRING);
> +
> +    /* Read Geometry Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_GEOMETRY,
> +                   0, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(GeometryDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_GEOMETRY);
> +
> +    /* Read Power Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_POWER, 0,
> +                   0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==,
> +                     sizeof(PowerParametersDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_POWER);
> +
> +    /* Read Health Descriptor */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_HEALTH,
> +                   0, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==, UFS_OCS_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==, UFS_COMMAND_RESULT_SUCCESS);
> +    g_assert_cmpuint(rsp_upiu.qr.data[0], ==, sizeof(DeviceHealthDescriptor));
> +    g_assert_cmpuint(rsp_upiu.qr.data[1], ==, UFS_QUERY_DESC_IDN_HEALTH);
> +
> +    /* Invalid Index (Intended Failure) */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_UNIT, 4,
> +                   0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==,
> +                     UFS_OCS_INVALID_CMD_TABLE_ATTR);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==,
> +                     UFS_QUERY_RESULT_INVALID_INDEX);
> +
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_STRING,
> +                   5, 0, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==,
> +                     UFS_OCS_INVALID_CMD_TABLE_ATTR);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==,
> +                     UFS_QUERY_RESULT_INVALID_INDEX);
> +
> +    /* Invalid Selector (Intended Failure) */
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_DEVICE,
> +                   0, 1, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==,
> +                     UFS_OCS_INVALID_CMD_TABLE_ATTR);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==,
> +                     UFS_QUERY_RESULT_INVALID_SELECTOR);
> +
> +    ufs_send_query(ufs, 0, UFS_UPIU_QUERY_FUNC_STANDARD_READ_REQUEST,
> +                   UFS_UPIU_QUERY_OPCODE_READ_DESC, UFS_QUERY_DESC_IDN_STRING,
> +                   0, 1, 0, &utrd, &rsp_upiu);
> +    g_assert_cmpuint(le32_to_cpu(utrd.header.dword_2), ==,
> +                     UFS_OCS_INVALID_CMD_TABLE_ATTR);
> +    g_assert_cmpuint(rsp_upiu.header.response, ==,
> +                     UFS_QUERY_RESULT_INVALID_SELECTOR);
> +
> +    ufs_exit(ufs, alloc);
> +}
> +
>   static void drive_destroy(void *path)
>   {
>       unlink(path);
> @@ -854,6 +1008,7 @@ static void ufs_register_nodes(void)
>       qos_add_test("read-write", "ufs", ufstest_read_write, &io_test_opts);
>       qos_add_test("flag read-write", "ufs", ufstest_flag_request, &io_test_opts);
>       qos_add_test("attr read-write", "ufs", ufstest_attr_request, &io_test_opts);
> +    qos_add_test("desc read-write", "ufs", ufstest_desc_request, &io_test_opts);

Why don't we use `ufstest_query_flag_request` & 
`ufstest_query_attr_request` & `ufstest_query_desc_request`?

It looks more clear to me.

>   }
>   
>   libqos_init(ufs_register_nodes);