Merge branch 'topic/doc' into for-linus

This commit is contained in:
Vinod Koul 2017-11-14 10:32:44 +05:30
commit e143132a04

View File

@ -329,7 +329,7 @@ enum dma_slave_buswidth {
* @src_addr_width: this is the width in bytes of the source (RX) * @src_addr_width: this is the width in bytes of the source (RX)
* register where DMA data shall be read. If the source * register where DMA data shall be read. If the source
* is memory this may be ignored depending on architecture. * is memory this may be ignored depending on architecture.
* Legal values: 1, 2, 4, 8. * Legal values: 1, 2, 3, 4, 8, 16, 32, 64.
* @dst_addr_width: same as src_addr_width but for destination * @dst_addr_width: same as src_addr_width but for destination
* target (TX) mutatis mutandis. * target (TX) mutatis mutandis.
* @src_maxburst: the maximum number of words (note: words, as in * @src_maxburst: the maximum number of words (note: words, as in
@ -404,13 +404,15 @@ enum dma_residue_granularity {
DMA_RESIDUE_GRANULARITY_BURST = 2, DMA_RESIDUE_GRANULARITY_BURST = 2,
}; };
/* struct dma_slave_caps - expose capabilities of a slave channel only /**
* * struct dma_slave_caps - expose capabilities of a slave channel only
* @src_addr_widths: bit mask of src addr widths the channel supports * @src_addr_widths: bit mask of src addr widths the channel supports.
* @dst_addr_widths: bit mask of dstn addr widths the channel supports * Width is specified in bytes, e.g. for a channel supporting
* @directions: bit mask of slave direction the channel supported * a width of 4 the mask should have BIT(4) set.
* since the enum dma_transfer_direction is not defined as bits for each * @dst_addr_widths: bit mask of dst addr widths the channel supports
* type of direction, the dma controller should fill (1 << <TYPE>) and same * @directions: bit mask of slave directions the channel supports.
* Since the enum dma_transfer_direction is not defined as bit flag for
* each type, the dma controller should set BIT(<TYPE>) and same
* should be checked by controller as well * should be checked by controller as well
* @max_burst: max burst capability per-transfer * @max_burst: max burst capability per-transfer
* @cmd_pause: true, if pause and thereby resume is supported * @cmd_pause: true, if pause and thereby resume is supported
@ -678,11 +680,13 @@ struct dma_filter {
* @dev_id: unique device ID * @dev_id: unique device ID
* @dev: struct device reference for dma mapping api * @dev: struct device reference for dma mapping api
* @src_addr_widths: bit mask of src addr widths the device supports * @src_addr_widths: bit mask of src addr widths the device supports
* Width is specified in bytes, e.g. for a device supporting
* a width of 4 the mask should have BIT(4) set.
* @dst_addr_widths: bit mask of dst addr widths the device supports * @dst_addr_widths: bit mask of dst addr widths the device supports
* @directions: bit mask of slave direction the device supports since * @directions: bit mask of slave directions the device supports.
* the enum dma_transfer_direction is not defined as bits for * Since the enum dma_transfer_direction is not defined as bit flag for
* each type of direction, the dma controller should fill (1 << * each type, the dma controller should set BIT(<TYPE>) and same
* <TYPE>) and same should be checked by controller as well * should be checked by controller as well
* @max_burst: max burst capability per-transfer * @max_burst: max burst capability per-transfer
* @residue_granularity: granularity of the transfer residue reported * @residue_granularity: granularity of the transfer residue reported
* by tx_status * by tx_status