224 lines
15 KiB
HTML
224 lines
15 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.15.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>L4Re Operating System Framework: L4 VIRTIO Block Device</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="l4re-awesome.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="L4Re_rgb_logo_quer_hg_h55.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">L4Re Operating System Framework
|
|
</div>
|
|
<div id="projectbrief">Interface and Usage Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.15.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('group__l4virtio__block.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">L4 VIRTIO Block Device <div class="ingroups"><a class="el" href="group__l4virtio.html">L4 VIRTIO Interface</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Collaboration diagram for L4 VIRTIO Block Device:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="group__l4virtio__block.svg" width="379" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:l4virtio_5Fblock_5Fheader_5Ft" id="r_l4virtio_5Fblock_5Fheader_5Ft"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structl4virtio__block__header__t.html">l4virtio_block_header_t</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Header structure of a request for a block device. <a href="structl4virtio__block__header__t.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:l4virtio_5Fblock_5Fdiscard_5Ft" id="r_l4virtio_5Fblock_5Fdiscard_5Ft"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structl4virtio__block__discard__t.html">l4virtio_block_discard_t</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure used for the write zeroes and discard commands. <a href="structl4virtio__block__discard__t.html#details">More...</a><br /></td></tr>
|
|
<tr class="memitem:l4virtio_5Fblock_5Fconfig_5Ft" id="r_l4virtio_5Fblock_5Fconfig_5Ft"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structl4virtio__block__config__t.html">l4virtio_block_config_t</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Device configuration for block devices. <a href="structl4virtio__block__config__t.html#details">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gaff308435ef6047fb0934285b223be657" id="r_gaff308435ef6047fb0934285b223be657"><td class="memItemLeft" align="right" valign="top"><a id="gaff308435ef6047fb0934285b223be657" name="gaff308435ef6047fb0934285b223be657"></a>
|
|
typedef struct l4virtio_block_header_t </td><td class="memItemRight" valign="bottom"><b>l4virtio_block_header_t</b></td></tr>
|
|
<tr class="memdesc:gaff308435ef6047fb0934285b223be657"><td class="mdescLeft"> </td><td class="mdescRight">Header structure of a request for a block device. <br /></td></tr>
|
|
<tr class="memitem:ga3bf4996a97f916b24a84c2e7adf832ba" id="r_ga3bf4996a97f916b24a84c2e7adf832ba"><td class="memItemLeft" align="right" valign="top"><a id="ga3bf4996a97f916b24a84c2e7adf832ba" name="ga3bf4996a97f916b24a84c2e7adf832ba"></a>
|
|
typedef struct l4virtio_block_discard_t </td><td class="memItemRight" valign="bottom"><b>l4virtio_block_discard_t</b></td></tr>
|
|
<tr class="memdesc:ga3bf4996a97f916b24a84c2e7adf832ba"><td class="mdescLeft"> </td><td class="mdescRight">Structure used for the write zeroes and discard commands. <br /></td></tr>
|
|
<tr class="memitem:ga8820a62d50d11986b9adf545e1c160a0" id="r_ga8820a62d50d11986b9adf545e1c160a0"><td class="memItemLeft" align="right" valign="top"><a id="ga8820a62d50d11986b9adf545e1c160a0" name="ga8820a62d50d11986b9adf545e1c160a0"></a>
|
|
typedef struct l4virtio_block_config_t </td><td class="memItemRight" valign="bottom"><b>l4virtio_block_config_t</b></td></tr>
|
|
<tr class="memdesc:ga8820a62d50d11986b9adf545e1c160a0"><td class="mdescLeft"> </td><td class="mdescRight">Device configuration for block devices. <br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga9ef2000d81e91613a9f39ef12a0ec52d" id="r_ga9ef2000d81e91613a9f39ef12a0ec52d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9ef2000d81e91613a9f39ef12a0ec52d">L4virtio_block_operations</a> { <br />
|
|
  <a class="el" href="#gga9ef2000d81e91613a9f39ef12a0ec52daa0a6fc1b7956ec00ba3128faf185c680">L4VIRTIO_BLOCK_T_IN</a> = 0
|
|
, <a class="el" href="#gga9ef2000d81e91613a9f39ef12a0ec52daa85ec590b2a7f0c5c27f9b2dbe6d1863">L4VIRTIO_BLOCK_T_OUT</a> = 1
|
|
, <a class="el" href="#gga9ef2000d81e91613a9f39ef12a0ec52da5aa7f985f0af737980e39fc98f6574a0">L4VIRTIO_BLOCK_T_FLUSH</a> = 4
|
|
, <a class="el" href="#gga9ef2000d81e91613a9f39ef12a0ec52da24408f89b892da0cf1f448064cf3e20e">L4VIRTIO_BLOCK_T_GET_ID</a> = 8
|
|
, <br />
|
|
  <a class="el" href="#gga9ef2000d81e91613a9f39ef12a0ec52da06358452282b6237efb751b56ffcda59">L4VIRTIO_BLOCK_T_DISCARD</a> = 11
|
|
, <a class="el" href="#gga9ef2000d81e91613a9f39ef12a0ec52dac893404d90eed7cd41929bc710249c49">L4VIRTIO_BLOCK_T_WRITE_ZEROES</a> = 13
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ga9ef2000d81e91613a9f39ef12a0ec52d"><td class="mdescLeft"> </td><td class="mdescRight">Kinds of operation over a block device. <a href="#ga9ef2000d81e91613a9f39ef12a0ec52d">More...</a><br /></td></tr>
|
|
<tr class="memitem:gafefb8205febb8b89e612e86f0c89eaa9" id="r_gafefb8205febb8b89e612e86f0c89eaa9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafefb8205febb8b89e612e86f0c89eaa9">L4virtio_block_status</a> { <a class="el" href="#ggafefb8205febb8b89e612e86f0c89eaa9a52c6169e59039d478b7f4a9faec15f33">L4VIRTIO_BLOCK_S_OK</a> = 0
|
|
, <a class="el" href="#ggafefb8205febb8b89e612e86f0c89eaa9a3a9cefa75787e83824fe4e6e4352aeec">L4VIRTIO_BLOCK_S_IOERR</a> = 1
|
|
, <a class="el" href="#ggafefb8205febb8b89e612e86f0c89eaa9a408aaf74a3018b24bd955ec694840d35">L4VIRTIO_BLOCK_S_UNSUPP</a> = 2
|
|
}</td></tr>
|
|
<tr class="memdesc:gafefb8205febb8b89e612e86f0c89eaa9"><td class="mdescLeft"> </td><td class="mdescRight">Status of a finished block request. <a href="#gafefb8205febb8b89e612e86f0c89eaa9">More...</a><br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga9ef2000d81e91613a9f39ef12a0ec52d" name="ga9ef2000d81e91613a9f39ef12a0ec52d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9ef2000d81e91613a9f39ef12a0ec52d">◆ </a></span>L4virtio_block_operations</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#ga9ef2000d81e91613a9f39ef12a0ec52d">L4virtio_block_operations</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Kinds of operation over a block device. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9ef2000d81e91613a9f39ef12a0ec52daa0a6fc1b7956ec00ba3128faf185c680" name="gga9ef2000d81e91613a9f39ef12a0ec52daa0a6fc1b7956ec00ba3128faf185c680"></a>L4VIRTIO_BLOCK_T_IN </td><td class="fielddoc"><p>Read from device. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9ef2000d81e91613a9f39ef12a0ec52daa85ec590b2a7f0c5c27f9b2dbe6d1863" name="gga9ef2000d81e91613a9f39ef12a0ec52daa85ec590b2a7f0c5c27f9b2dbe6d1863"></a>L4VIRTIO_BLOCK_T_OUT </td><td class="fielddoc"><p>Write to device. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9ef2000d81e91613a9f39ef12a0ec52da5aa7f985f0af737980e39fc98f6574a0" name="gga9ef2000d81e91613a9f39ef12a0ec52da5aa7f985f0af737980e39fc98f6574a0"></a>L4VIRTIO_BLOCK_T_FLUSH </td><td class="fielddoc"><p>Flush data to disk. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9ef2000d81e91613a9f39ef12a0ec52da24408f89b892da0cf1f448064cf3e20e" name="gga9ef2000d81e91613a9f39ef12a0ec52da24408f89b892da0cf1f448064cf3e20e"></a>L4VIRTIO_BLOCK_T_GET_ID </td><td class="fielddoc"><p>Get device ID. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9ef2000d81e91613a9f39ef12a0ec52da06358452282b6237efb751b56ffcda59" name="gga9ef2000d81e91613a9f39ef12a0ec52da06358452282b6237efb751b56ffcda59"></a>L4VIRTIO_BLOCK_T_DISCARD </td><td class="fielddoc"><p>Discard a range of sectors. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9ef2000d81e91613a9f39ef12a0ec52dac893404d90eed7cd41929bc710249c49" name="gga9ef2000d81e91613a9f39ef12a0ec52dac893404d90eed7cd41929bc710249c49"></a>L4VIRTIO_BLOCK_T_WRITE_ZEROES </td><td class="fielddoc"><p>Write zeroes to a range of sectors. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="virtio__block_8h_source.html#l00019">19</a> of file <a class="el" href="virtio__block_8h_source.html">virtio_block.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gafefb8205febb8b89e612e86f0c89eaa9" name="gafefb8205febb8b89e612e86f0c89eaa9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gafefb8205febb8b89e612e86f0c89eaa9">◆ </a></span>L4virtio_block_status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#gafefb8205febb8b89e612e86f0c89eaa9">L4virtio_block_status</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Status of a finished block request. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggafefb8205febb8b89e612e86f0c89eaa9a52c6169e59039d478b7f4a9faec15f33" name="ggafefb8205febb8b89e612e86f0c89eaa9a52c6169e59039d478b7f4a9faec15f33"></a>L4VIRTIO_BLOCK_S_OK </td><td class="fielddoc"><p>Request finished successfully. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggafefb8205febb8b89e612e86f0c89eaa9a3a9cefa75787e83824fe4e6e4352aeec" name="ggafefb8205febb8b89e612e86f0c89eaa9a3a9cefa75787e83824fe4e6e4352aeec"></a>L4VIRTIO_BLOCK_S_IOERR </td><td class="fielddoc"><p>IO error on device. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggafefb8205febb8b89e612e86f0c89eaa9a408aaf74a3018b24bd955ec694840d35" name="ggafefb8205febb8b89e612e86f0c89eaa9a408aaf74a3018b24bd955ec694840d35"></a>L4VIRTIO_BLOCK_S_UNSUPP </td><td class="fielddoc"><p>Operation is not supported. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="virtio__block_8h_source.html#l00032">32</a> of file <a class="el" href="virtio__block_8h_source.html">virtio_block.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- HTML footer for doxygen 1.9.1-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for L4Re Operating System Framework by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|