History

drm/xe/uapi: Fix documentation indentation

Fix these issues: Documentation/gpu/driver-uapi:29: include/uapi/drm/xe_drm.h:817: WARNING: +Bullet list ends without a blank line; unexpected unindent. Documentation/gpu/driver-uapi:29: include/uapi/drm/xe_drm.h:835: WARNING: +Definition list ends without a blank line; unexpected unindent.

Rodrigo Vivi committed 1 year ago

Commit a46ea121 parent f3b59451 file · +18 −18Browse files

Unified · Split

include/uapi/drm/xe_drm.h+18−18
@@ -814,29 +814,29 @@ struct drm_xe_gem_create { · 813 unmodified lines
814 *814 *
815 * The @flags can be:815 * The @flags can be:
816 * - %DRM_XE_MMAP_OFFSET_FLAG_PCI_BARRIER - For user to query special offset816 * - %DRM_XE_MMAP_OFFSET_FLAG_PCI_BARRIER - For user to query special offset
817 * for use in mmap ioctl. Writing to the returned mmap address will generate a817 * for use in mmap ioctl. Writing to the returned mmap address will generate a
818 * PCI memory barrier with low overhead (avoiding IOCTL call as well as writing818 * PCI memory barrier with low overhead (avoiding IOCTL call as well as writing
819 * to VRAM which would also add overhead), acting like an MI_MEM_FENCE819 * to VRAM which would also add overhead), acting like an MI_MEM_FENCE
820 * instruction.820 * instruction.
821 *821 *
822 * Note: The mmap size can be at most 4K, due to HW limitations. As a result822 * Note: The mmap size can be at most 4K, due to HW limitations. As a result
823 * this interface is only supported on CPU architectures that support 4K page823 * this interface is only supported on CPU architectures that support 4K page
824 * size. The mmap_offset ioctl will detect this and gracefully return an824 * size. The mmap_offset ioctl will detect this and gracefully return an
825 * error, where userspace is expected to have a different fallback method for825 * error, where userspace is expected to have a different fallback method for
826 * triggering a barrier.826 * triggering a barrier.
827 *827 *
828 * Roughly the usage would be as follows:828 * Roughly the usage would be as follows:
829 *829 *
830 * .. code-block:: C830 * .. code-block:: C
831 *831 *
832 * struct drm_xe_gem_mmap_offset mmo = {832 * struct drm_xe_gem_mmap_offset mmo = {
833 * .handle = 0, // must be set to 0833 * .handle = 0, // must be set to 0
834 * .flags = DRM_XE_MMAP_OFFSET_FLAG_PCI_BARRIER,834 * .flags = DRM_XE_MMAP_OFFSET_FLAG_PCI_BARRIER,
835 * };835 * };
836 *836 *
837 * err = ioctl(fd, DRM_IOCTL_XE_GEM_MMAP_OFFSET, &mmo);837 * err = ioctl(fd, DRM_IOCTL_XE_GEM_MMAP_OFFSET, &mmo);
838 * map = mmap(NULL, size, PROT_WRITE, MAP_SHARED, fd, mmo.offset);838 * map = mmap(NULL, size, PROT_WRITE, MAP_SHARED, fd, mmo.offset);
839 * map[i] = 0xdeadbeaf; // issue barrier839 * map[i] = 0xdeadbeaf; // issue barrier
840 */840 */
841struct drm_xe_gem_mmap_offset {841struct drm_xe_gem_mmap_offset {
842 /** @extensions: Pointer to the first extension struct, if any */842 /** @extensions: Pointer to the first extension struct, if any */