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

ata: Documentation, fix function names

ata_qc_prep no longer exists, there are ata_bmdma_qc_prep and
ata_bmdma_dumb_qc_prep instead. And most drivers do not use them, so
reword the paragraph.

ata_qc_issue_prot was renamed to ata_sff_qc_issue. ->tf_load is now
->sff_tf_load. Fix them.

And fix spelling supercede -> supersede.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-ide@vger.kernel.org
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Jiri Slaby and committed by
Jens Axboe
0fb596ed 130f4caf

+6 -6
+6 -6
Documentation/driver-api/libata.rst
··· 254 254 int (*qc_issue) (struct ata_queued_cmd *qc); 255 255 256 256 257 - Higher-level hooks, these two hooks can potentially supercede several of 257 + Higher-level hooks, these two hooks can potentially supersede several of 258 258 the above taskfile/DMA engine hooks. ``->qc_prep`` is called after the 259 259 buffers have been DMA-mapped, and is typically used to populate the 260 - hardware's DMA scatter-gather table. Most drivers use the standard 261 - :c:func:`ata_qc_prep` helper function, but more advanced drivers roll their 262 - own. 260 + hardware's DMA scatter-gather table. Some drivers use the standard 261 + :c:func:`ata_bmdma_qc_prep` and :c:func:`ata_bmdma_dumb_qc_prep` helper 262 + functions, but more advanced drivers roll their own. 263 263 264 264 ``->qc_issue`` is used to make a command active, once the hardware and S/G 265 265 tables have been prepared. IDE BMDMA drivers use the helper function 266 - :c:func:`ata_qc_issue_prot` for taskfile protocol-based dispatch. More 266 + :c:func:`ata_sff_qc_issue` for taskfile protocol-based dispatch. More 267 267 advanced drivers implement their own ``->qc_issue``. 268 268 269 - :c:func:`ata_qc_issue_prot` calls ``->tf_load()``, ``->bmdma_setup()``, and 269 + :c:func:`ata_sff_qc_issue` calls ``->sff_tf_load()``, ``->bmdma_setup()``, and 270 270 ``->bmdma_start()`` as necessary to initiate a transfer. 271 271 272 272 Exception and probe handling (EH)