Commit 58ca5c52 authored by Ben Walker's avatar Ben Walker Committed by Jim Harris
Browse files

doc: Convert ioat doc to markdown 



Change-Id: Ic0f8fa4aa57d6fc58813fcbb6d72ff5477ab293f
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 0be12ad7

doc/Doxyfile

+1 −1
Original line number Diff line number Diff line
@@ -761,7 +761,7 @@ WARN_LOGFILE = 
INPUT                  = ../include/spdk \

                         index.md \

                         directory_structure.md \

                         ioat/index.txt \

                         ioat/index.md \

                         nvme/index.md \

                         nvme/async_completion.md \

                         nvme/initialization.md \

doc/index.md

+1 −1
Original line number Diff line number Diff line
@@ -19,5 +19,5 @@ which avoids kernel context switches and eliminates interrupt handling overhead. 


- @ref nvme

- \ref nvmf

- \ref ioat

- @ref ioat

- \ref iscsi

doc/ioat/index.md

0 → 100644
+14 −0
Original line number Diff line number Diff line 
# I/OAT Driver {#ioat}



# Public Interface {#ioat_interface}



- spdk/ioat.h



# Key Functions {#ioat_key_functions}



Function                                | Description

--------------------------------------- | -----------

spdk_ioat_probe()                       | @copybrief spdk_ioat_probe()

spdk_ioat_get_dma_capabilities()        | @copybrief spdk_ioat_get_dma_capabilities()

spdk_ioat_submit_copy()                 | @copybrief spdk_ioat_submit_copy()

spdk_ioat_submit_fill()                 | @copybrief spdk_ioat_submit_fill()

doc/ioat/index.txt

deleted100644 → 0
+0 −51
Original line number Diff line number Diff line 
/*

 *   BSD LICENSE

 *

 *   Copyright (c) Intel Corporation.

 *   All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of Intel Corporation nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



/*!



\page ioat I/OAT Driver



\section ioat_interface Public Interface



- spdk/ioat.h



\section ioat_key_functions Key Functions



Function                                | Description

--------------------------------------- | -----------

spdk_ioat_probe()                       | \copybrief spdk_ioat_probe()

spdk_ioat_get_dma_capabilities()        | \copybrief spdk_ioat_get_dma_capabilities()

spdk_ioat_submit_copy()                 | \copybrief spdk_ioat_submit_copy()

spdk_ioat_submit_fill()                 | \copybrief spdk_ioat_submit_fill()



*/