Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dma-mapping: better document dma_addr_t and DMA_MAPPING_ERROR

Move the comment documenting dma_addr_t away from the dma_map_ops
definition which isn't very related to it, and toward DMA_MAPPING_ERROR,
which is somewhat related. Add a little blurb about DMA_MAPPING_ERROR
as well.

Signed-off-by: Christoph Hellwig <hch@lst.de>

+10 -6
+10 -6
include/linux/dma-mapping.h
··· 67 67 */ 68 68 #define DMA_ATTR_PRIVILEGED (1UL << 9) 69 69 70 - /* 71 - * A dma_addr_t can hold any valid DMA or bus address for the platform. 72 - * It can be given to a device to use as a DMA source or target. A CPU cannot 73 - * reference a dma_addr_t directly because there may be translation between 74 - * its physical address space and the bus address space. 75 - */ 76 70 struct dma_map_ops { 77 71 void* (*alloc)(struct device *dev, size_t size, 78 72 dma_addr_t *dma_handle, gfp_t gfp, ··· 125 131 unsigned long (*get_merge_boundary)(struct device *dev); 126 132 }; 127 133 134 + /* 135 + * A dma_addr_t can hold any valid DMA or bus address for the platform. It can 136 + * be given to a device to use as a DMA source or target. It is specific to a 137 + * given device and there may be a translation between the CPU physical address 138 + * space and the bus address space. 139 + * 140 + * DMA_MAPPING_ERROR is the magic error code if a mapping failed. It should not 141 + * be used directly in drivers, but checked for using dma_mapping_error() 142 + * instead. 143 + */ 128 144 #define DMA_MAPPING_ERROR (~(dma_addr_t)0) 129 145 130 146 extern const struct dma_map_ops dma_virt_ops;