Commit 392188bb authored by Manivannan Sadhasivam's avatar Manivannan Sadhasivam Committed by Bjorn Helgaas
Browse files

selftests: pci_endpoint: Migrate to Kselftest framework 

Migrate the PCI endpoint test to Kselftest framework. All the tests that
were part of the previous pcitest.sh file were migrated.

Below is the list of tests converted:

   1. BAR0 Test
   2. BAR1 Test
   3. BAR2 Test
   4. BAR3 Test
   5. BAR4 Test
   6. BAR5 Test
   7. Consecutive BAR Tests
   8. Legacy IRQ Tests
   9. MSI Interrupt Tests (MSI1 to MSI32)
  10. MSI-X Interrupt Tests (MSI-X1 to MSI-X2048)
  11. Read Tests - MEMCPY (For 1, 1024, 1025, 1024000, 1024001 Bytes)
  12. Write Tests - MEMCPY (For 1, 1024, 1025, 1024000, 1024001 Bytes)
  13. Copy Tests - MEMCPY (For 1, 1024, 1025, 1024000, 1024001 Bytes)
  14. Read Tests - DMA (For 1, 1024, 1025, 1024000, 1024001 Bytes)
  15. Write Tests - DMA (For 1, 1024, 1025, 1024000, 1024001 Bytes)
  16. Copy Tests - DMA (For 1, 1024, 1025, 1024000, 1024001 Bytes)

BAR, DMA and MEMCPY tests are added as fixture variants and can be executed
separately as below:

  $ pci_endpoint_test -v BAR0
  $ pci_endpoint_test -v dma
  $ pci_endpoint_test -v memcpy

Link: https://lore.kernel.org/r/20250116171650.33585-5-manivannan.sadhasivam@linaro.org


Co-developed-by: default avatarAman Gupta <aman1.gupta@samsung.com>
Co-developed-by: default avatarPadmanabhan Rajanbabu <p.rajanbabu@samsung.com>
[mani: reworked based on the IOCTL fix, cleanups, documentation, commit message]
Signed-off-by: default avatarAman Gupta <aman1.gupta@samsung.com>
Signed-off-by: default avatarPadmanabhan Rajanbabu <p.rajanbabu@samsung.com>
Signed-off-by: default avatarManivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
Signed-off-by: default avatarBjorn Helgaas <bhelgaas@google.com>
Tested-by: default avatarNiklas Cassel <cassel@kernel.org>
Reviewed-by: default avatarNiklas Cassel <cassel@kernel.org>
parent e19bde22

Documentation/PCI/endpoint/pci-test-howto.rst

+71 −102
Original line number Diff line number Diff line
@@ -81,8 +81,8 @@ device, the following commands can be used:: 


	# echo 0x104c > functions/pci_epf_test/func1/vendorid

	# echo 0xb500 > functions/pci_epf_test/func1/deviceid

	# echo 16 > functions/pci_epf_test/func1/msi_interrupts

	# echo 8 > functions/pci_epf_test/func1/msix_interrupts

	# echo 32 > functions/pci_epf_test/func1/msi_interrupts

	# echo 2048 > functions/pci_epf_test/func1/msix_interrupts





Binding pci-epf-test Device to EP Controller
@@ -123,9 +123,9 @@ above:: 
Using Endpoint Test function Device

-----------------------------------



pcitest.sh added in tools/testing/selftests/pci_endpoint can be used to run all

the default PCI endpoint tests. To compile this tool the following commands

should be used::

Kselftest added in tools/testing/selftests/pci_endpoint can be used to run all

the default PCI endpoint tests. To build the Kselftest for PCI endpoint

subsystem, the following commands should be used::



	# cd <kernel-dir>

	# make -C tools/testing/selftests/pci_endpoint
@@ -133,104 +133,73 @@ should be used:: 
or if you desire to compile and install in your system::



	# cd <kernel-dir>

	# make -C tools/testing/selftests/pci_endpoint install

	# make -C tools/testing/selftests/pci_endpoint INSTALL_PATH=/usr/bin install



The tool and script will be located in <rootfs>/usr/bin/

The test will be located in <rootfs>/usr/bin/





pcitest.sh Output

~~~~~~~~~~~~~~~~~

Kselftest Output

~~~~~~~~~~~~~~~~

::



	# pcitest.sh

	BAR tests



	BAR0:           OKAY

	BAR1:           OKAY

	BAR2:           OKAY

	BAR3:           OKAY

	BAR4:           NOT OKAY

	BAR5:           NOT OKAY



	Interrupt tests



	SET IRQ TYPE TO LEGACY:         OKAY

	LEGACY IRQ:     NOT OKAY

	SET IRQ TYPE TO MSI:            OKAY

	MSI1:           OKAY

	MSI2:           OKAY

	MSI3:           OKAY

	MSI4:           OKAY

	MSI5:           OKAY

	MSI6:           OKAY

	MSI7:           OKAY

	MSI8:           OKAY

	MSI9:           OKAY

	MSI10:          OKAY

	MSI11:          OKAY

	MSI12:          OKAY

	MSI13:          OKAY

	MSI14:          OKAY

	MSI15:          OKAY

	MSI16:          OKAY

	MSI17:          NOT OKAY

	MSI18:          NOT OKAY

	MSI19:          NOT OKAY

	MSI20:          NOT OKAY

	MSI21:          NOT OKAY

	MSI22:          NOT OKAY

	MSI23:          NOT OKAY

	MSI24:          NOT OKAY

	MSI25:          NOT OKAY

	MSI26:          NOT OKAY

	MSI27:          NOT OKAY

	MSI28:          NOT OKAY

	MSI29:          NOT OKAY

	MSI30:          NOT OKAY

	MSI31:          NOT OKAY

	MSI32:          NOT OKAY

	SET IRQ TYPE TO MSI-X:          OKAY

	MSI-X1:         OKAY

	MSI-X2:         OKAY

	MSI-X3:         OKAY

	MSI-X4:         OKAY

	MSI-X5:         OKAY

	MSI-X6:         OKAY

	MSI-X7:         OKAY

	MSI-X8:         OKAY

	MSI-X9:         NOT OKAY

	MSI-X10:        NOT OKAY

	MSI-X11:        NOT OKAY

	MSI-X12:        NOT OKAY

	MSI-X13:        NOT OKAY

	MSI-X14:        NOT OKAY

	MSI-X15:        NOT OKAY

	MSI-X16:        NOT OKAY

	[...]

	MSI-X2047:      NOT OKAY

	MSI-X2048:      NOT OKAY



	Read Tests



	SET IRQ TYPE TO MSI:            OKAY

	READ (      1 bytes):           OKAY

	READ (   1024 bytes):           OKAY

	READ (   1025 bytes):           OKAY

	READ (1024000 bytes):           OKAY

	READ (1024001 bytes):           OKAY



	Write Tests



	WRITE (      1 bytes):          OKAY

	WRITE (   1024 bytes):          OKAY

	WRITE (   1025 bytes):          OKAY

	WRITE (1024000 bytes):          OKAY

	WRITE (1024001 bytes):          OKAY



	Copy Tests



	COPY (      1 bytes):           OKAY

	COPY (   1024 bytes):           OKAY

	COPY (   1025 bytes):           OKAY

	COPY (1024000 bytes):           OKAY

	COPY (1024001 bytes):           OKAY
 
	# pci_endpoint_test

	TAP version 13

	1..16

	# Starting 16 tests from 9 test cases.

	#  RUN           pci_ep_bar.BAR0.BAR_TEST ...

	#            OK  pci_ep_bar.BAR0.BAR_TEST

	ok 1 pci_ep_bar.BAR0.BAR_TEST

	#  RUN           pci_ep_bar.BAR1.BAR_TEST ...

	#            OK  pci_ep_bar.BAR1.BAR_TEST

	ok 2 pci_ep_bar.BAR1.BAR_TEST

	#  RUN           pci_ep_bar.BAR2.BAR_TEST ...

	#            OK  pci_ep_bar.BAR2.BAR_TEST

	ok 3 pci_ep_bar.BAR2.BAR_TEST

	#  RUN           pci_ep_bar.BAR3.BAR_TEST ...

	#            OK  pci_ep_bar.BAR3.BAR_TEST

	ok 4 pci_ep_bar.BAR3.BAR_TEST

	#  RUN           pci_ep_bar.BAR4.BAR_TEST ...

	#            OK  pci_ep_bar.BAR4.BAR_TEST

	ok 5 pci_ep_bar.BAR4.BAR_TEST

	#  RUN           pci_ep_bar.BAR5.BAR_TEST ...

	#            OK  pci_ep_bar.BAR5.BAR_TEST

	ok 6 pci_ep_bar.BAR5.BAR_TEST

	#  RUN           pci_ep_basic.CONSECUTIVE_BAR_TEST ...

	#            OK  pci_ep_basic.CONSECUTIVE_BAR_TEST

	ok 7 pci_ep_basic.CONSECUTIVE_BAR_TEST

	#  RUN           pci_ep_basic.LEGACY_IRQ_TEST ...

	#            OK  pci_ep_basic.LEGACY_IRQ_TEST

	ok 8 pci_ep_basic.LEGACY_IRQ_TEST

	#  RUN           pci_ep_basic.MSI_TEST ...

	#            OK  pci_ep_basic.MSI_TEST

	ok 9 pci_ep_basic.MSI_TEST

	#  RUN           pci_ep_basic.MSIX_TEST ...

	#            OK  pci_ep_basic.MSIX_TEST

	ok 10 pci_ep_basic.MSIX_TEST

	#  RUN           pci_ep_data_transfer.memcpy.READ_TEST ...

	#            OK  pci_ep_data_transfer.memcpy.READ_TEST

	ok 11 pci_ep_data_transfer.memcpy.READ_TEST

	#  RUN           pci_ep_data_transfer.memcpy.WRITE_TEST ...

	#            OK  pci_ep_data_transfer.memcpy.WRITE_TEST

	ok 12 pci_ep_data_transfer.memcpy.WRITE_TEST

	#  RUN           pci_ep_data_transfer.memcpy.COPY_TEST ...

	#            OK  pci_ep_data_transfer.memcpy.COPY_TEST

	ok 13 pci_ep_data_transfer.memcpy.COPY_TEST

	#  RUN           pci_ep_data_transfer.dma.READ_TEST ...

	#            OK  pci_ep_data_transfer.dma.READ_TEST

	ok 14 pci_ep_data_transfer.dma.READ_TEST

	#  RUN           pci_ep_data_transfer.dma.WRITE_TEST ...

	#            OK  pci_ep_data_transfer.dma.WRITE_TEST

	ok 15 pci_ep_data_transfer.dma.WRITE_TEST

	#  RUN           pci_ep_data_transfer.dma.COPY_TEST ...

	#            OK  pci_ep_data_transfer.dma.COPY_TEST

	ok 16 pci_ep_data_transfer.dma.COPY_TEST

	# PASSED: 16 / 16 tests passed.

	# Totals: pass:16 fail:0 xfail:0 xpass:0 skip:0 error:0





Testcase 16 (pci_ep_data_transfer.dma.COPY_TEST) will fail for most of the DMA

capable endpoint controllers due to the absence of the MEMCPY over DMA. For such

controllers, it is advisable to skip this testcase using this

command::



	# pci_endpoint_test -f pci_ep_bar -f pci_ep_basic -v memcpy -T COPY_TEST -v dma

tools/testing/selftests/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ TARGETS += net/packetdrill 
TARGETS += net/rds

TARGETS += net/tcp_ao

TARGETS += nsfs

TARGETS += pci_endpoint

TARGETS += pcie_bwctrl

TARGETS += perf_events

TARGETS += pidfd

tools/testing/selftests/pci_endpoint/.gitignore

+1 −2
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0-only

*.o

pcitest
 
pci_endpoint_test

tools/testing/selftests/pci_endpoint/Build

deleted100644 → 0
+0 −1
Original line number Diff line number Diff line 
pcitest-y += pcitest.o

tools/testing/selftests/pci_endpoint/Makefile

+4 −55
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

include ../../../scripts/Makefile.include

CFLAGS += -O2 -Wl,-no-as-needed -Wall $(KHDR_INCLUDES)

LDFLAGS += -lrt -lpthread -lm



bindir ?= /usr/bin

TEST_GEN_PROGS = pci_endpoint_test



ifeq ($(srctree),)

srctree := $(patsubst %/tools/testing/selftests/,%,$(dir $(CURDIR)))

endif



# Do not use make's built-in rules

# (this improves performance and avoids hard-to-debug behaviour);

MAKEFLAGS += -r



CFLAGS += -O2 -Wall -g -D_GNU_SOURCE -I$(OUTPUT)include



ALL_TARGETS := pcitest

ALL_PROGRAMS := $(patsubst %,$(OUTPUT)%,$(ALL_TARGETS))



SCRIPTS := pcitest.sh



all: $(ALL_PROGRAMS)



export srctree OUTPUT CC LD CFLAGS

include $(srctree)/tools/build/Makefile.include



#

# We need the following to be outside of kernel tree

#

$(OUTPUT)include/linux/: ../../../../include/uapi/linux/

	mkdir -p $(OUTPUT)include/linux/ 2>&1 || true

	ln -sf $(CURDIR)/../../../../include/uapi/linux/pcitest.h $@



$(info ${CURDIR})

prepare: $(OUTPUT)include/linux/



PCITEST_IN := $(OUTPUT)pcitest-in.o

$(PCITEST_IN): prepare FORCE

	$(Q)$(MAKE) $(build)=pcitest

$(OUTPUT)pcitest: $(PCITEST_IN)

	$(QUIET_LINK)$(CC) $(CFLAGS) $(LDFLAGS) $< -o $@



clean:

	rm -f $(ALL_PROGRAMS)

	rm -rf $(OUTPUT)include/

	find $(or $(OUTPUT),.) -name '*.o' -delete -o -name '\.*.cmd' -delete -o -name '\.*.d' -delete



install: $(ALL_PROGRAMS)

	install -d -m 755 $(DESTDIR)$(bindir);		\

	for program in $(ALL_PROGRAMS); do		\

		install $$program $(DESTDIR)$(bindir);	\

	done;						\

	for script in $(SCRIPTS); do			\

		install $$script $(DESTDIR)$(bindir);	\

	done



FORCE:



.PHONY: all install clean FORCE prepare
 
include ../lib.mk