text: /* SPDX-License-Identifier: MIT */
  /*
   * PCI Backend/Frontend Common Data Structures & Macros
   *
   *   Author: Ryan Wilson <hap9@epoch.ncsc.mil>
   */
  #ifndef __XEN_PCI_COMMON_H__
  #define __XEN_PCI_COMMON_H__
  
  /* Be sure to bump this number if you change this file */
  #define XEN_PCI_MAGIC "7"
  
  /* xen_pci_sharedinfo flags */
  #define	_XEN_PCIF_active		(0)
  #define	XEN_PCIF_active			(1<<_XEN_PCIF_active)
  #define	_XEN_PCIB_AERHANDLER		(1)
  #define	XEN_PCIB_AERHANDLER		(1<<_XEN_PCIB_AERHANDLER)
  #define	_XEN_PCIB_active		(2)
  #define	XEN_PCIB_active			(1<<_XEN_PCIB_active)
  
  /* xen_pci_op commands */
  #define	XEN_PCI_OP_conf_read		(0)
  #define	XEN_PCI_OP_conf_write		(1)
  #define	XEN_PCI_OP_enable_msi		(2)
  #define	XEN_PCI_OP_disable_msi		(3)
  #define	XEN_PCI_OP_enable_msix		(4)
  #define	XEN_PCI_OP_disable_msix		(5)
  #define	XEN_PCI_OP_aer_detected		(6)
  #define	XEN_PCI_OP_aer_resume		(7)
  #define	XEN_PCI_OP_aer_mmio		(8)
  #define	XEN_PCI_OP_aer_slotreset	(9)
  
  /* xen_pci_op error numbers */
  #define	XEN_PCI_ERR_success		(0)
  #define	XEN_PCI_ERR_dev_not_found	(-1)
  #define	XEN_PCI_ERR_invalid_offset	(-2)
  #define	XEN_PCI_ERR_access_denied	(-3)
  #define	XEN_PCI_ERR_not_implemented	(-4)
  /* XEN_PCI_ERR_op_failed - backend failed to complete the operation */
  #define XEN_PCI_ERR_op_failed		(-5)
  
  /*
   * it should be PAGE_SIZE-sizeof(struct xen_pci_op))/sizeof(struct msix_entry))
   * Should not exceed 128
   */
  #define SH_INFO_MAX_VEC			128
  
  struct xen_msix_entry {
  	uint16_t vector;
  	uint16_t entry;
  };
  struct xen_pci_op {
  	/* IN: what action to perform: XEN_PCI_OP_* */
  	uint32_t cmd;
  
  	/* OUT: will contain an error number (if any) from errno.h */
  	int32_t err;
  
  	/* IN: which device to touch */
  	uint32_t domain; /* PCI Domain/Segment */
  	uint32_t bus;
  	uint32_t devfn;
  
  	/* IN: which configuration registers to touch */
  	int32_t offset;
  	int32_t size;
  
  	/* IN/OUT: Contains the result after a READ or the value to WRITE */
  	uint32_t value;
  	/* IN: Contains extra infor for this operation */
  	uint32_t info;
  	/*IN:  param for msi-x */
  	struct xen_msix_entry msix_entries[SH_INFO_MAX_VEC];
  };
  
  /*used for pcie aer handling*/
  struct xen_pcie_aer_op {
  	/* IN: what action to perform: XEN_PCI_OP_* */
  	uint32_t cmd;
  	/*IN/OUT: return aer_op result or carry error_detected state as input*/
  	int32_t err;
  
  	/* IN: which device to touch */
  	uint32_t domain; /* PCI Domain/Segment*/
  	uint32_t bus;
  	uint32_t devfn;
  };
  struct xen_pci_sharedinfo {
  	/* flags - XEN_PCIF_* */
  	uint32_t flags;
  	struct xen_pci_op op;
  	struct xen_pcie_aer_op aer_op;
  };
  
  #endif /* __XEN_PCI_COMMON_H__ */
  