netdev - Re: [PATCH net-next] virtio: kdoc for struct virtio_pci_modern

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Tue, 12 Sep 2023 12:20:26 +0800
From: Jason Wang <jasowang@...hat.com>
To: Shannon Nelson <shannon.nelson@....com>
Cc: kuba@...nel.org, davem@...emloft.net, mst@...hat.com, 
	virtualization@...ts.linux-foundation.org, brett.creeley@....com, 
	netdev@...r.kernel.org, simon.horman@...igine.com, eperezma@...hat.com, 
	drivers@...sando.io
Subject: Re: [PATCH net-next] virtio: kdoc for struct virtio_pci_modern_device

On Tue, Sep 12, 2023 at 5:31 AM Shannon Nelson <shannon.nelson@....com> wrote:
>
> Finally following up to Simon's suggestion for some kdoc attention
> on struct virtio_pci_modern_device.
>
> Link: https://lore.kernel.org/netdev/ZE%2FQS0lnUvxFacjf@corigine.com/
> Cc: Simon Horman <simon.horman@...igine.com>
> Signed-off-by: Shannon Nelson <shannon.nelson@....com>
> Acked-by: Eugenio Pérez <eperezma@...hat.com>

Acked-by: Jason Wang <jasowang@...hat.com>

Thanks

> ---
>  include/linux/virtio_pci_modern.h | 34 ++++++++++++++++++++-----------
>  1 file changed, 22 insertions(+), 12 deletions(-)
>
> diff --git a/include/linux/virtio_pci_modern.h b/include/linux/virtio_pci_modern.h
> index 067ac1d789bc..a38c729d1973 100644
> --- a/include/linux/virtio_pci_modern.h
> +++ b/include/linux/virtio_pci_modern.h
> @@ -12,37 +12,47 @@ struct virtio_pci_modern_common_cfg {
>         __le16 queue_reset;             /* read-write */
>  };
>
> +/**
> + * struct virtio_pci_modern_device - info for modern PCI virtio
> + * @pci_dev:       Ptr to the PCI device struct
> + * @common:        Position of the common capability in the PCI config
> + * @device:        Device-specific data (non-legacy mode)
> + * @notify_base:    Base of vq notifications (non-legacy mode)
> + * @notify_pa:     Physical base of vq notifications
> + * @isr:           Where to read and clear interrupt
> + * @notify_len:            So we can sanity-check accesses
> + * @device_len:            So we can sanity-check accesses
> + * @notify_map_cap: Capability for when we need to map notifications per-vq
> + * @notify_offset_multiplier: Multiply queue_notify_off by this value
> + *                            (non-legacy mode).
> + * @modern_bars:    Bitmask of BARs
> + * @id:                    Device and vendor id
> + * @device_id_check: Callback defined before vp_modern_probe() to be used to
> + *                 verify the PCI device is a vendor's expected device rather
> + *                 than the standard virtio PCI device
> + *                 Returns the found device id or ERRNO
> + * @dma_mask:      Optional mask instead of the traditional DMA_BIT_MASK(64),
> + *                 for vendor devices with DMA space address limitations
> + */
>  struct virtio_pci_modern_device {
>         struct pci_dev *pci_dev;
>
>         struct virtio_pci_common_cfg __iomem *common;
> -       /* Device-specific data (non-legacy mode)  */
>         void __iomem *device;
> -       /* Base of vq notifications (non-legacy mode). */
>         void __iomem *notify_base;
> -       /* Physical base of vq notifications */
>         resource_size_t notify_pa;
> -       /* Where to read and clear interrupt */
>         u8 __iomem *isr;
>
> -       /* So we can sanity-check accesses. */
>         size_t notify_len;
>         size_t device_len;
>
> -       /* Capability for when we need to map notifications per-vq. */
>         int notify_map_cap;
>
> -       /* Multiply queue_notify_off by this value. (non-legacy mode). */
>         u32 notify_offset_multiplier;
> -
>         int modern_bars;
> -
>         struct virtio_device_id id;
>
> -       /* optional check for vendor virtio device, returns dev_id or -ERRNO */
>         int (*device_id_check)(struct pci_dev *pdev);
> -
> -       /* optional mask for devices with limited DMA space */
>         u64 dma_mask;
>  };
>
> --
> 2.17.1
>