[PATCH v2 4/5] misc: pci_endpoint_test: Add doorbell test case

[Kishon Vijay Abraham I]

Hi Frank,

On 9/12/2023 3:39 AM, Frank Li wrote:
> Using bit 0..7 of magic as version number in pci_endpoint_test struct to
> support older driver versions. Save to 'version' field of struct
> pci_endpoint_test to prevent reading non-existent address.
> 
> Add three registers: PCIE_ENDPOINT_TEST_DB_BAR, PCIE_ENDPOINT_TEST_DB_ADDR,
> PCIE_ENDPOINT_TEST_DB_DATA.
> 
> Write data from PCI_ENDPOINT_TEST_DB_DATA to address from
> PCI_ENDPOINT_TEST_DB_ADDR to trigger doorbell and wait for endpoint
> feedback.
> 
> Signed-off-by: Frank Li <Frank.Li at nxp.com>
> ---
>   drivers/misc/pci_endpoint_test.c | 48 ++++++++++++++++++++++++++++++++
>   include/uapi/linux/pcitest.h     |  1 +
>   2 files changed, 49 insertions(+)
> 
> diff --git a/drivers/misc/pci_endpoint_test.c b/drivers/misc/pci_endpoint_test.c
> index ed4d0ef5e5c31..ed0b025132d17 100644
> --- a/drivers/misc/pci_endpoint_test.c
> +++ b/drivers/misc/pci_endpoint_test.c
> @@ -33,6 +33,8 @@
>   #define IRQ_TYPE_MSIX				2
>   
>   #define PCI_ENDPOINT_TEST_MAGIC			0x0
> +#define PCI_MAGIC_VERSION_MASK			GENMASK(7, 0)
> +#define PCI_ENDPOINT_TEST_V1			0x1
>   
>   #define PCI_ENDPOINT_TEST_COMMAND		0x4
>   #define COMMAND_RAISE_LEGACY_IRQ		BIT(0)
> @@ -52,6 +54,7 @@
>   #define STATUS_IRQ_RAISED			BIT(6)
>   #define STATUS_SRC_ADDR_INVALID			BIT(7)
>   #define STATUS_DST_ADDR_INVALID			BIT(8)
> +#define STATUS_DOORBELL_SUCCESS			BIT(9)
>   
>   #define PCI_ENDPOINT_TEST_LOWER_SRC_ADDR	0x0c
>   #define PCI_ENDPOINT_TEST_UPPER_SRC_ADDR	0x10
> @@ -66,7 +69,12 @@
>   #define PCI_ENDPOINT_TEST_IRQ_NUMBER		0x28
>   
>   #define PCI_ENDPOINT_TEST_FLAGS			0x2c
> +#define PCI_ENDPOINT_TEST_DB_BAR		0x30
> +#define PCI_ENDPOINT_TEST_DB_ADDR		0x34
> +#define PCI_ENDPOINT_TEST_DB_DATA		0x38
> +
>   #define FLAG_USE_DMA				BIT(0)
> +#define FLAG_SUPPORT_DOORBELL			BIT(1)
>   
>   #define PCI_DEVICE_ID_TI_AM654			0xb00c
>   #define PCI_DEVICE_ID_TI_J7200			0xb00f
> @@ -102,6 +110,7 @@ enum pci_barno {
>   	BAR_3,
>   	BAR_4,
>   	BAR_5,
> +	NO_BAR = -1,
>   };
>   
>   struct pci_endpoint_test {
> @@ -118,6 +127,7 @@ struct pci_endpoint_test {
>   	enum pci_barno test_reg_bar;
>   	size_t alignment;
>   	const char *name;
> +	u8 version;
>   };
>   
>   struct pci_endpoint_test_data {
> @@ -713,6 +723,38 @@ static bool pci_endpoint_test_set_irq(struct pci_endpoint_test *test,
>   	return false;
>   }
>   
> +static bool pci_endpoint_test_doorbell(struct pci_endpoint_test *test)
> +{
> +	enum pci_barno bar;
> +	u32 data, status;
> +	u32 addr;
> +
> +	if (test->version < PCI_ENDPOINT_TEST_V1)
> +		return false;
> +
> +	bar = pci_endpoint_test_readl(test, PCI_ENDPOINT_TEST_DB_BAR);
> +	if (bar == NO_BAR)
> +		return false;
> +
> +	data = pci_endpoint_test_readl(test, PCI_ENDPOINT_TEST_DB_DATA);
> +	addr = pci_endpoint_test_readl(test, PCI_ENDPOINT_TEST_DB_ADDR);
> +	bar = pci_endpoint_test_readl(test, PCI_ENDPOINT_TEST_DB_BAR);
> +
> +	pci_endpoint_test_writel(test, PCI_ENDPOINT_TEST_IRQ_TYPE, irq_type);
> +	pci_endpoint_test_writel(test, PCI_ENDPOINT_TEST_IRQ_NUMBER, 1);
> +
> +	pci_endpoint_test_writel(test, PCI_ENDPOINT_TEST_STATUS, 0);
> +	pci_endpoint_test_bar_writel(test, bar, addr, data);
> +
> +	wait_for_completion_timeout(&test->irq_raised, msecs_to_jiffies(1000));
> +
> +	status = pci_endpoint_test_readl(test, PCI_ENDPOINT_TEST_STATUS);
> +	if (status & STATUS_DOORBELL_SUCCESS)
> +		return true;
> +
> +	return false;
> +}
> +
>   static long pci_endpoint_test_ioctl(struct file *file, unsigned int cmd,
>   				    unsigned long arg)
>   {
> @@ -760,6 +802,9 @@ static long pci_endpoint_test_ioctl(struct file *file, unsigned int cmd,
>   	case PCITEST_CLEAR_IRQ:
>   		ret = pci_endpoint_test_clear_irq(test);
>   		break;
> +	case PCITEST_DOORBELL:
> +		ret = pci_endpoint_test_doorbell(test);
> +		break;
>   	}
>   
>   ret:
> @@ -887,6 +932,9 @@ static int pci_endpoint_test_probe(struct pci_dev *pdev,
>   	misc_device->parent = &pdev->dev;
>   	misc_device->fops = &pci_endpoint_test_fops;
>   
> +	test->version = FIELD_GET(PCI_MAGIC_VERSION_MASK,
> +				  pci_endpoint_test_readl(test, PCI_ENDPOINT_TEST_MAGIC));

After running BAR test, the value in MAGIC register would get 
over-written and this is bound to break.

IIUC you are also not handling the case where BAR test would write to DB 
BARS.

IMO handling the above two is important than trying to find whether the 
endpoint device supports DB. In the worst case, DB interrupt would not 
be triggered which is okay IMO.

Thanks,
Kishon

> +
>   	err = misc_register(misc_device);
>   	if (err) {
>   		dev_err(dev, "Failed to register device\n");
> diff --git a/include/uapi/linux/pcitest.h b/include/uapi/linux/pcitest.h
> index f9c1af8d141b4..479ca1aa3ae0b 100644
> --- a/include/uapi/linux/pcitest.h
> +++ b/include/uapi/linux/pcitest.h
> @@ -20,6 +20,7 @@
>   #define PCITEST_SET_IRQTYPE	_IOW('P', 0x8, int)
>   #define PCITEST_GET_IRQTYPE	_IO('P', 0x9)
>   #define PCITEST_CLEAR_IRQ	_IO('P', 0x10)
> +#define PCITEST_DOORBELL	_IO('P', 0x11)
>   
>   #define PCITEST_FLAGS_USE_DMA	0x00000001
>