[igt-dev] [PATCH i-g-t v4 1/5] lib/igt_pci: helpers to get PCI capabilities offset

[Bernatowicz, Marcin]

On 12/7/2022 11:25 AM, Anshuman Gupta wrote:
> Added helper functions to search for PCI capabilities
> with help of libpciaccess library.
> 
> v2:
> - Added offset == 0 check at starts of capability loop. [Badal]
> - Removed unused macro and removed inline from function. [Kamil]
> - Added assertion when capability offset doesn't terminate. [Kamil]
> - Made find_pci_cap_offset_at() static, exported only
>    find_pci_cap_offset(). [Kamil]
> 
> Cc: Ashutosh Dixit <ashutosh.dixit at intel.com>
> Co-developed-by: Marcin Bernatowicz <marcin.bernatowicz at linux.intel.com>
> Signed-off-by: Marcin Bernatowicz <marcin.bernatowicz at linux.intel.com>
> Signed-off-by: Anshuman Gupta <anshuman.gupta at intel.com>
> ---
>   lib/igt_pci.c   | 56 +++++++++++++++++++++++++++++++++++++++++++++++++
>   lib/igt_pci.h   | 25 ++++++++++++++++++++++
>   lib/meson.build |  1 +
>   3 files changed, 82 insertions(+)
>   create mode 100644 lib/igt_pci.c
>   create mode 100644 lib/igt_pci.h
> 
> diff --git a/lib/igt_pci.c b/lib/igt_pci.c
> new file mode 100644
> index 0000000000..b088835a92
> --- /dev/null
> +++ b/lib/igt_pci.c
> @@ -0,0 +1,56 @@
> +// SPDX-License-Identifier: MIT
> +/*
> + * Copyright © 2022 Intel Corporation
> + */
> +
> +#include <pciaccess.h>
> +#include "igt_core.h"
> +#include "igt_pci.h"
> +
> +static int find_pci_cap_offset_at(struct pci_device *dev, enum pci_cap_id cap_id,
> +				  int start_offset)
> +{
> +	uint8_t offset;
> +	uint16_t cap_header;

maybe if we do not trust pci_device_cfg_read_XXX functions to return 
error when value could not be read or if variable is not assigned
we should initialize them to 0xff

> +	int loop = (PCI_CFG_SPACE_SIZE - PCI_TYPE0_1_HEADER_SIZE)
> +			/ sizeof(cap_header);
> +
> +	if (pci_device_cfg_read_u8(dev, &offset, start_offset))
> +		return -1;
> +
> +	while (loop--) {
> +		igt_assert_f(offset != 0xff, "pci config space inaccessible\n");
> +
> +		if (!offset)
> +			break;
the above is redundant as the next if breaks if offset == 0
> +
> +		if (offset < PCI_TYPE0_1_HEADER_SIZE)
> +			break;
> +
> +		if (pci_device_cfg_read_u16(dev, &cap_header, (offset & 0xFC)))
> +			return -1;
> +
> +		if (!cap_id || cap_id == (cap_header & 0xFF))
> +			return offset;
> +
> +		offset = cap_header >> 8;
> +	}
> +
> +	igt_fail_on_f(loop <= 0 && offset, "pci capability offset doesn't terminate\n");
> +
> +	return 0;
> +}
> +
> +/**
> + * find_pci_cap_offset:
> + * @dev: pci device
> + * @cap_id: searched capability id, 0 means any capability
> + *
> + * return:
> + * -1 on config read error, 0 if capability is not found,
> + * otherwise offset at which capability with cap_id is found
> + */
> +int find_pci_cap_offset(struct pci_device *dev, enum pci_cap_id cap_id)
> +{
> +	return find_pci_cap_offset_at(dev, cap_id, PCI_CAPS_START);
> +}
> diff --git a/lib/igt_pci.h b/lib/igt_pci.h
> new file mode 100644
> index 0000000000..7cb23a26d8
> --- /dev/null
> +++ b/lib/igt_pci.h
> @@ -0,0 +1,25 @@
> +// SPDX-License-Identifier: MIT
> +/*
> + * Copyright © 2022 Intel Corporation
> + */
> +
> +#ifndef __IGT_PCI_H__
> +#define __IGT_PCI_H__
> +
> +#include <stdint.h>
> +#include <endian.h>
> +
> +/* forward declaration */
> +struct pci_device;
> +
> +#define PCI_TYPE0_1_HEADER_SIZE 0x40
> +#define PCI_CAPS_START 0x34
> +#define PCI_CFG_SPACE_SIZE 0x100
> +
> +enum pci_cap_id {
> +	PCI_EXPRESS_CAP_ID = 0x10
> +};
> +
> +int find_pci_cap_offset(struct pci_device *dev, enum pci_cap_id cap_id);
> +
> +#endif
> diff --git a/lib/meson.build b/lib/meson.build
> index 8ae9fe13d1..f4a0bdc29a 100644
> --- a/lib/meson.build
> +++ b/lib/meson.build
> @@ -33,6 +33,7 @@ lib_sources = [
>   	'igt_pipe_crc.c',
>   	'igt_power.c',
>   	'igt_primes.c',
> +	'igt_pci.c',
>   	'igt_rand.c',
>   	'igt_stats.c',
>   	'igt_syncobj.c',