[linux.git] / tools / pci / pcitest.c

// SPDX-License-Identifier: GPL-2.0-only
/**
 * Userspace PCI Endpoint Test Module
 *
 * Copyright (C) 2017 Texas Instruments
 * Author: Kishon Vijay Abraham I <[email protected]>
 */

#include <errno.h>
#include <fcntl.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/ioctl.h>
#include <unistd.h>

#include <linux/pcitest.h>

#define BILLION 1E9

static char *result[] = { "NOT OKAY", "OKAY" };
static char *irq[] = { "LEGACY", "MSI", "MSI-X" };

struct pci_test {
	char		*device;
	char		barnum;
	bool		legacyirq;
	unsigned int	msinum;
	unsigned int	msixnum;
	int		irqtype;
	bool		set_irqtype;
	bool		get_irqtype;
	bool		clear_irq;
	bool		read;
	bool		write;
	bool		copy;
	unsigned long	size;
	bool		use_dma;
};

static int run_test(struct pci_test *test)
{
	struct pci_endpoint_test_xfer_param param;
	int ret = -EINVAL;
	int fd;

	fd = open(test->device, O_RDWR);
	if (fd < 0) {
		perror("can't open PCI Endpoint Test device");
		return -ENODEV;
	}

	if (test->barnum >= 0 && test->barnum <= 5) {
		ret = ioctl(fd, PCITEST_BAR, test->barnum);
		fprintf(stdout, "BAR%d:\t\t", test->barnum);
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->set_irqtype) {
		ret = ioctl(fd, PCITEST_SET_IRQTYPE, test->irqtype);
		fprintf(stdout, "SET IRQ TYPE TO %s:\t\t", irq[test->irqtype]);
		if (ret < 0)
			fprintf(stdout, "FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->get_irqtype) {
		ret = ioctl(fd, PCITEST_GET_IRQTYPE);
		fprintf(stdout, "GET IRQ TYPE:\t\t");
		if (ret < 0)
			fprintf(stdout, "FAILED\n");
		else
			fprintf(stdout, "%s\n", irq[ret]);
	}

	if (test->clear_irq) {
		ret = ioctl(fd, PCITEST_CLEAR_IRQ);
		fprintf(stdout, "CLEAR IRQ:\t\t");
		if (ret < 0)
			fprintf(stdout, "FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->legacyirq) {
		ret = ioctl(fd, PCITEST_LEGACY_IRQ, 0);
		fprintf(stdout, "LEGACY IRQ:\t");
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->msinum > 0 && test->msinum <= 32) {
		ret = ioctl(fd, PCITEST_MSI, test->msinum);
		fprintf(stdout, "MSI%d:\t\t", test->msinum);
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->msixnum > 0 && test->msixnum <= 2048) {
		ret = ioctl(fd, PCITEST_MSIX, test->msixnum);
		fprintf(stdout, "MSI-X%d:\t\t", test->msixnum);
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->write) {
		param.size = test->size;
		if (test->use_dma)
			param.flags = PCITEST_FLAGS_USE_DMA;
		ret = ioctl(fd, PCITEST_WRITE, &param);
		fprintf(stdout, "WRITE (%7ld bytes):\t\t", test->size);
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->read) {
		param.size = test->size;
		if (test->use_dma)
			param.flags = PCITEST_FLAGS_USE_DMA;
		ret = ioctl(fd, PCITEST_READ, &param);
		fprintf(stdout, "READ (%7ld bytes):\t\t", test->size);
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	if (test->copy) {
		param.size = test->size;
		if (test->use_dma)
			param.flags = PCITEST_FLAGS_USE_DMA;
		ret = ioctl(fd, PCITEST_COPY, &param);
		fprintf(stdout, "COPY (%7ld bytes):\t\t", test->size);
		if (ret < 0)
			fprintf(stdout, "TEST FAILED\n");
		else
			fprintf(stdout, "%s\n", result[ret]);
	}

	fflush(stdout);
	close(fd);
	return (ret < 0) ? ret : 1 - ret; /* return 0 if test succeeded */
}

int main(int argc, char **argv)
{
	int c;
	struct pci_test *test;

	test = calloc(1, sizeof(*test));
	if (!test) {
		perror("Fail to allocate memory for pci_test\n");
		return -ENOMEM;
	}

	/* since '0' is a valid BAR number, initialize it to -1 */
	test->barnum = -1;

	/* set default size as 100KB */
	test->size = 0x19000;

	/* set default endpoint device */
	test->device = "/dev/pci-endpoint-test.0";

	while ((c = getopt(argc, argv, "D:b:m:x:i:deIlhrwcs:")) != EOF)
	switch (c) {
	case 'D':
		test->device = optarg;
		continue;
	case 'b':
		test->barnum = atoi(optarg);
		if (test->barnum < 0 || test->barnum > 5)
			goto usage;
		continue;
	case 'l':
		test->legacyirq = true;
		continue;
	case 'm':
		test->msinum = atoi(optarg);
		if (test->msinum < 1 || test->msinum > 32)
			goto usage;
		continue;
	case 'x':
		test->msixnum = atoi(optarg);
		if (test->msixnum < 1 || test->msixnum > 2048)
			goto usage;
		continue;
	case 'i':
		test->irqtype = atoi(optarg);
		if (test->irqtype < 0 || test->irqtype > 2)
			goto usage;
		test->set_irqtype = true;
		continue;
	case 'I':
		test->get_irqtype = true;
		continue;
	case 'r':
		test->read = true;
		continue;
	case 'w':
		test->write = true;
		continue;
	case 'c':
		test->copy = true;
		continue;
	case 'e':
		test->clear_irq = true;
		continue;
	case 's':
		test->size = strtoul(optarg, NULL, 0);
		continue;
	case 'd':
		test->use_dma = true;
		continue;
	case 'h':
	default:
usage:
		fprintf(stderr,
			"usage: %s [options]\n"
			"Options:\n"
			"\t-D <dev>		PCI endpoint test device {default: /dev/pci-endpoint-test.0}\n"
			"\t-b <bar num>		BAR test (bar number between 0..5)\n"
			"\t-m <msi num>		MSI test (msi number between 1..32)\n"
			"\t-x <msix num>	\tMSI-X test (msix number between 1..2048)\n"
			"\t-i <irq type>	\tSet IRQ type (0 - Legacy, 1 - MSI, 2 - MSI-X)\n"
			"\t-e			Clear IRQ\n"
			"\t-I			Get current IRQ type configured\n"
			"\t-d			Use DMA\n"
			"\t-l			Legacy IRQ test\n"
			"\t-r			Read buffer test\n"
			"\t-w			Write buffer test\n"
			"\t-c			Copy buffer test\n"
			"\t-s <size>		Size of buffer {default: 100KB}\n"
			"\t-h			Print this help message\n",
			argv[0]);
		return -EINVAL;
	}

	return run_test(test);
}
Commit	Line	Data
6b1baefe	1	// SPDX-License-Identifier: GPL-2.0-only
3f2ed813 KVA	2	/**
	3	* Userspace PCI Endpoint Test Module
	4	*
	5	* Copyright (C) 2017 Texas Instruments
	6	* Author: Kishon Vijay Abraham I <[email protected]>
3f2ed813 KVA	7	*/
	8
	9	#include <errno.h>
	10	#include <fcntl.h>
	11	#include <stdbool.h>
	12	#include <stdio.h>
	13	#include <stdlib.h>
	14	#include <sys/ioctl.h>
3f2ed813 KVA	15	#include <unistd.h>
	16
	17	#include <linux/pcitest.h>
	18
	19	#define BILLION 1E9
	20
	21	static char *result[] = { "NOT OKAY", "OKAY" };
0653217c	22	static char *irq[] = { "LEGACY", "MSI", "MSI-X" };
3f2ed813 KVA	23
	24	struct pci_test {
	25	char *device;
	26	char barnum;
	27	bool legacyirq;
	28	unsigned int msinum;
0653217c GP	29	unsigned int msixnum;
	30	int irqtype;
	31	bool set_irqtype;
	32	bool get_irqtype;
74d60b28	33	bool clear_irq;
3f2ed813 KVA	34	bool read;
	35	bool write;
	36	bool copy;
	37	unsigned long size;
73c57626	38	bool use_dma;
3f2ed813 KVA	39	};
3f2ed813 KVA	40
8a5e0af2	41	static int run_test(struct pci_test *test)
3f2ed813	42	{
73c57626	43	struct pci_endpoint_test_xfer_param param;
8a5e0af2	44	int ret = -EINVAL;
3f2ed813	45	int fd;
3f2ed813 KVA	46
	47	fd = open(test->device, O_RDWR);
	48	if (fd < 0) {
	49	perror("can't open PCI Endpoint Test device");
8a5e0af2	50	return -ENODEV;
3f2ed813 KVA	51	}
	52
	53	if (test->barnum >= 0 && test->barnum <= 5) {
	54	ret = ioctl(fd, PCITEST_BAR, test->barnum);
	55	fprintf(stdout, "BAR%d:\t\t", test->barnum);
	56	if (ret < 0)
	57	fprintf(stdout, "TEST FAILED\n");
	58	else
	59	fprintf(stdout, "%s\n", result[ret]);
	60	}
	61
0653217c GP	62	if (test->set_irqtype) {
	63	ret = ioctl(fd, PCITEST_SET_IRQTYPE, test->irqtype);
	64	fprintf(stdout, "SET IRQ TYPE TO %s:\t\t", irq[test->irqtype]);
	65	if (ret < 0)
	66	fprintf(stdout, "FAILED\n");
	67	else
	68	fprintf(stdout, "%s\n", result[ret]);
	69	}
	70
	71	if (test->get_irqtype) {
	72	ret = ioctl(fd, PCITEST_GET_IRQTYPE);
	73	fprintf(stdout, "GET IRQ TYPE:\t\t");
	74	if (ret < 0)
	75	fprintf(stdout, "FAILED\n");
	76	else
	77	fprintf(stdout, "%s\n", irq[ret]);
	78	}
	79
74d60b28 KVA	80	if (test->clear_irq) {
	81	ret = ioctl(fd, PCITEST_CLEAR_IRQ);
	82	fprintf(stdout, "CLEAR IRQ:\t\t");
	83	if (ret < 0)
	84	fprintf(stdout, "FAILED\n");
	85	else
	86	fprintf(stdout, "%s\n", result[ret]);
	87	}
	88
3f2ed813 KVA	89	if (test->legacyirq) {
	90	ret = ioctl(fd, PCITEST_LEGACY_IRQ, 0);
	91	fprintf(stdout, "LEGACY IRQ:\t");
	92	if (ret < 0)
	93	fprintf(stdout, "TEST FAILED\n");
	94	else
	95	fprintf(stdout, "%s\n", result[ret]);
	96	}
	97
	98	if (test->msinum > 0 && test->msinum <= 32) {
	99	ret = ioctl(fd, PCITEST_MSI, test->msinum);
	100	fprintf(stdout, "MSI%d:\t\t", test->msinum);
	101	if (ret < 0)
	102	fprintf(stdout, "TEST FAILED\n");
	103	else
	104	fprintf(stdout, "%s\n", result[ret]);
	105	}
	106
0653217c GP	107	if (test->msixnum > 0 && test->msixnum <= 2048) {
	108	ret = ioctl(fd, PCITEST_MSIX, test->msixnum);
	109	fprintf(stdout, "MSI-X%d:\t\t", test->msixnum);
	110	if (ret < 0)
	111	fprintf(stdout, "TEST FAILED\n");
	112	else
	113	fprintf(stdout, "%s\n", result[ret]);
	114	}
	115
3f2ed813	116	if (test->write) {
73c57626 KVA	117	param.size = test->size;
	118	if (test->use_dma)
	119	param.flags = PCITEST_FLAGS_USE_DMA;
	120	ret = ioctl(fd, PCITEST_WRITE, &param);
3f2ed813 KVA	121	fprintf(stdout, "WRITE (%7ld bytes):\t\t", test->size);
	122	if (ret < 0)
	123	fprintf(stdout, "TEST FAILED\n");
	124	else
	125	fprintf(stdout, "%s\n", result[ret]);
	126	}
	127
	128	if (test->read) {
73c57626 KVA	129	param.size = test->size;
	130	if (test->use_dma)
	131	param.flags = PCITEST_FLAGS_USE_DMA;
	132	ret = ioctl(fd, PCITEST_READ, &param);
3f2ed813 KVA	133	fprintf(stdout, "READ (%7ld bytes):\t\t", test->size);
	134	if (ret < 0)
	135	fprintf(stdout, "TEST FAILED\n");
	136	else
	137	fprintf(stdout, "%s\n", result[ret]);
	138	}
	139
	140	if (test->copy) {
73c57626 KVA	141	param.size = test->size;
	142	if (test->use_dma)
	143	param.flags = PCITEST_FLAGS_USE_DMA;
	144	ret = ioctl(fd, PCITEST_COPY, &param);
3f2ed813 KVA	145	fprintf(stdout, "COPY (%7ld bytes):\t\t", test->size);
	146	if (ret < 0)
	147	fprintf(stdout, "TEST FAILED\n");
	148	else
	149	fprintf(stdout, "%s\n", result[ret]);
	150	}
	151
	152	fflush(stdout);
3c379a59	153	close(fd);
b71f0a0b	154	return (ret < 0) ? ret : 1 - ret; /* return 0 if test succeeded */
3f2ed813 KVA	155	}
	156
	157	int main(int argc, char **argv)
	158	{
	159	int c;
	160	struct pci_test *test;
	161
	162	test = calloc(1, sizeof(*test));
	163	if (!test) {
	164	perror("Fail to allocate memory for pci_test\n");
	165	return -ENOMEM;
	166	}
	167
	168	/* since '0' is a valid BAR number, initialize it to -1 */
	169	test->barnum = -1;
	170
	171	/* set default size as 100KB */
	172	test->size = 0x19000;
	173
	174	/* set default endpoint device */
	175	test->device = "/dev/pci-endpoint-test.0";
	176
74d60b28	177	while ((c = getopt(argc, argv, "D:b:m:x:i:deIlhrwcs:")) != EOF)
3f2ed813 KVA	178	switch (c) {
	179	case 'D':
	180	test->device = optarg;
	181	continue;
	182	case 'b':
	183	test->barnum = atoi(optarg);
	184	if (test->barnum < 0 \|\| test->barnum > 5)
	185	goto usage;
	186	continue;
	187	case 'l':
	188	test->legacyirq = true;
	189	continue;
	190	case 'm':
	191	test->msinum = atoi(optarg);
	192	if (test->msinum < 1 \|\| test->msinum > 32)
	193	goto usage;
	194	continue;
0653217c GP	195	case 'x':
	196	test->msixnum = atoi(optarg);
	197	if (test->msixnum < 1 \|\| test->msixnum > 2048)
	198	goto usage;
	199	continue;
	200	case 'i':
	201	test->irqtype = atoi(optarg);
	202	if (test->irqtype < 0 \|\| test->irqtype > 2)
	203	goto usage;
	204	test->set_irqtype = true;
	205	continue;
	206	case 'I':
	207	test->get_irqtype = true;
	208	continue;
3f2ed813 KVA	209	case 'r':
	210	test->read = true;
	211	continue;
	212	case 'w':
	213	test->write = true;
	214	continue;
	215	case 'c':
	216	test->copy = true;
	217	continue;
74d60b28 KVA	218	case 'e':
	219	test->clear_irq = true;
	220	continue;
3f2ed813 KVA	221	case 's':
	222	test->size = strtoul(optarg, NULL, 0);
	223	continue;
73c57626 KVA	224	case 'd':
	225	test->use_dma = true;
	226	continue;
3f2ed813 KVA	227	case 'h':
	228	default:
	229	usage:
	230	fprintf(stderr,
	231	"usage: %s [options]\n"
	232	"Options:\n"
	233	"\t-D <dev> PCI endpoint test device {default: /dev/pci-endpoint-test.0}\n"
	234	"\t-b <bar num> BAR test (bar number between 0..5)\n"
	235	"\t-m <msi num> MSI test (msi number between 1..32)\n"
0653217c GP	236	"\t-x <msix num> \tMSI-X test (msix number between 1..2048)\n"
0653217c GP	237	"\t-i <irq type> \tSet IRQ type (0 - Legacy, 1 - MSI, 2 - MSI-X)\n"
74d60b28	238	"\t-e Clear IRQ\n"
0653217c	239	"\t-I Get current IRQ type configured\n"
73c57626	240	"\t-d Use DMA\n"
e4758422	241	"\t-l Legacy IRQ test\n"
3f2ed813 KVA	242	"\t-r Read buffer test\n"
	243	"\t-w Write buffer test\n"
	244	"\t-c Copy buffer test\n"
81cb4203	245	"\t-s <size> Size of buffer {default: 100KB}\n"
fbca0b28	246	"\t-h Print this help message\n",
3f2ed813 KVA	247	argv[0]);
	248	return -EINVAL;
	249	}
	250
b71f0a0b	251	return run_test(test);
3f2ed813	252	}