224 lines
17 KiB
HTML
224 lines
17 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/re/c/dma_space.h File Reference</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('dma__space_8h.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">dma_space.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>DMA space C interface.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="compiler_8h_source.html">l4/sys/compiler.h</a>></code><br />
|
|
<code>#include <<a class="el" href="l4_2sys_2types_8h_source.html">l4/sys/types.h</a>></code><br />
|
|
<code>#include <<a class="el" href="dataspace_8h_source.html">l4/re/c/dataspace.h</a>></code><br />
|
|
</div><div class="textblock"><div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"><span class="dynarrow"><span class="arrowhead closed"></span></span>Include dependency graph for dma_space.h:</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="dma__space_8h__incl.svg" width="626" height="403"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
|
|
</div>
|
|
</div>
|
|
<p><a href="dma__space_8h_source.html">Go to the source code of this file.</a></p>
|
|
<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:ga0a28e1f39a38aab07a01706ebd22e432" id="r_ga0a28e1f39a38aab07a01706ebd22e432"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__dma.html#ga0a28e1f39a38aab07a01706ebd22e432">l4re_dma_space_t</a></td></tr>
|
|
<tr class="memdesc:ga0a28e1f39a38aab07a01706ebd22e432"><td class="mdescLeft"> </td><td class="mdescRight">DMA space capability type. <br /></td></tr>
|
|
<tr class="memitem:a2081e44de64ea44d6d5baab98996c46a" id="r_a2081e44de64ea44d6d5baab98996c46a"><td class="memItemLeft" align="right" valign="top"><a id="a2081e44de64ea44d6d5baab98996c46a" name="a2081e44de64ea44d6d5baab98996c46a"></a>
|
|
typedef <a class="el" href="group__l4__basic__types.html#gaf3331c485014bd12a9e4f9d27a55e689">l4_uint64_t</a> </td><td class="memItemRight" valign="bottom"><b>l4re_dma_space_dma_addr_t</b></td></tr>
|
|
<tr class="memdesc:a2081e44de64ea44d6d5baab98996c46a"><td class="mdescLeft"> </td><td class="mdescRight">Data type for DMA addresses. <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:acb95dc82018a9c1693d03fe0709c0d23" id="r_acb95dc82018a9c1693d03fe0709c0d23"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23">l4re_dma_space_direction</a> { <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23a41bb4f0cbba17438d6ff1e6890996e8f">L4RE_DMA_SPACE_BIDIRECTIONAL</a>
|
|
, <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23ac656250a1a7e5929d16e2b5f8c8eb624">L4RE_DMA_SPACE_TO_DEVICE</a>
|
|
, <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23af7020306f3a3959ea2046f8815055f33">L4RE_DMA_SPACE_FROM_DEVICE</a>
|
|
, <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23a903e34d1d6080e0a49297f3b6b405842">L4RE_DMA_SPACE_NONE</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:acb95dc82018a9c1693d03fe0709c0d23"><td class="mdescLeft"> </td><td class="mdescRight">Direction of the DMA transfers. <a href="#acb95dc82018a9c1693d03fe0709c0d23">More...</a><br /></td></tr>
|
|
<tr class="memitem:adef1eb8ee81d36e1b440a1e46cb16708" id="r_adef1eb8ee81d36e1b440a1e46cb16708"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#adef1eb8ee81d36e1b440a1e46cb16708">l4re_dma_space_space_attribs</a> { <a class="el" href="#adef1eb8ee81d36e1b440a1e46cb16708a901dea72f532be6393283884fe162c35">L4RE_DMA_SPACE_COHERENT</a> = 1 << 0
|
|
, <a class="el" href="#adef1eb8ee81d36e1b440a1e46cb16708a6283ff48b8c70b8a2f5ea4fbb27c6b1b">L4RE_DMA_SPACE_PHYS_SPACE</a> = 1 << 1
|
|
}</td></tr>
|
|
<tr class="memdesc:adef1eb8ee81d36e1b440a1e46cb16708"><td class="mdescLeft"> </td><td class="mdescRight">Attributes assigned to the DMA space when associated with a specific device. <a href="#adef1eb8ee81d36e1b440a1e46cb16708">More...</a><br /></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga75e9157b3c56fc666f818068cfb9dbf2" id="r_ga75e9157b3c56fc666f818068cfb9dbf2"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__dma.html#ga75e9157b3c56fc666f818068cfb9dbf2">l4re_dma_space_map</a> (<a class="el" href="group__api__l4re__c__dma.html#ga0a28e1f39a38aab07a01706ebd22e432">l4re_dma_space_t</a> dma, <a class="el" href="group__api__l4re__c__ds.html#ga3e06beeed375dd29e0fd6fb89c5d9a39">l4re_ds_t</a> src, l4re_ds_offset_t offset, <a class="el" href="group__l4__basic__types.html#ga08c1e83a068ded7add134b188cd44967">l4_size_t</a> *size, unsigned long attrs, enum <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23">l4re_dma_space_direction</a> dir, <a class="el" href="#a2081e44de64ea44d6d5baab98996c46a">l4re_dma_space_dma_addr_t</a> *dma_addr) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga75e9157b3c56fc666f818068cfb9dbf2"><td class="mdescLeft"> </td><td class="mdescRight">Map the given part of this data space into the DMA address space. <br /></td></tr>
|
|
<tr class="memitem:ga07ceb9a3b19a1a6cedf5b7a742df4abb" id="r_ga07ceb9a3b19a1a6cedf5b7a742df4abb"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__dma.html#ga07ceb9a3b19a1a6cedf5b7a742df4abb">l4re_dma_space_unmap</a> (<a class="el" href="group__api__l4re__c__dma.html#ga0a28e1f39a38aab07a01706ebd22e432">l4re_dma_space_t</a> dma, <a class="el" href="#a2081e44de64ea44d6d5baab98996c46a">l4re_dma_space_dma_addr_t</a> dma_addr, <a class="el" href="group__l4__basic__types.html#ga08c1e83a068ded7add134b188cd44967">l4_size_t</a> size, unsigned long attrs, enum <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23">l4re_dma_space_direction</a> dir) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga07ceb9a3b19a1a6cedf5b7a742df4abb"><td class="mdescLeft"> </td><td class="mdescRight">Unmap the given part of this data space from the DMA address space. <br /></td></tr>
|
|
<tr class="memitem:ga0e15313b07dd7910b88e4662226e1bbc" id="r_ga0e15313b07dd7910b88e4662226e1bbc"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__dma.html#ga0e15313b07dd7910b88e4662226e1bbc">l4re_dma_space_associate</a> (<a class="el" href="group__api__l4re__c__dma.html#ga0a28e1f39a38aab07a01706ebd22e432">l4re_dma_space_t</a> dma, <a class="el" href="group__l4__cap__api.html#ga1445e923ce73029130d569d6e69a4dd8">l4_cap_idx_t</a> dma_task, unsigned long attr) <a class="el" href="group__l4sys__defines.html#ga362dfa378e662dd04f710a23fc7ea931">L4_NOTHROW</a></td></tr>
|
|
<tr class="memdesc:ga0e15313b07dd7910b88e4662226e1bbc"><td class="mdescLeft"> </td><td class="mdescRight">Associate a (kernel) <a class="el" href="group__l4__kernel__object__dmar__space.html">DMA space</a> for a device to this Dma_space. <br /></td></tr>
|
|
<tr class="memitem:ga04f2e0fd5bd58aa97b610b519e402244" id="r_ga04f2e0fd5bd58aa97b610b519e402244"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="group__api__l4re__c__dma.html#ga04f2e0fd5bd58aa97b610b519e402244">l4re_dma_space_disassociate</a> (<a class="el" href="group__api__l4re__c__dma.html#ga0a28e1f39a38aab07a01706ebd22e432">l4re_dma_space_t</a> dma)</td></tr>
|
|
<tr class="memdesc:ga04f2e0fd5bd58aa97b610b519e402244"><td class="mdescLeft"> </td><td class="mdescRight">Disassociate the (kernel) <a class="el" href="group__l4__kernel__object__dmar__space.html">DMA space</a> from this Dma_space. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>DMA space C interface. </p>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="dma__space_8h_source.html">dma_space.h</a>.</p>
|
|
</div><a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="acb95dc82018a9c1693d03fe0709c0d23" name="acb95dc82018a9c1693d03fe0709c0d23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb95dc82018a9c1693d03fe0709c0d23">◆ </a></span>l4re_dma_space_direction</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#acb95dc82018a9c1693d03fe0709c0d23">l4re_dma_space_direction</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Direction of the DMA transfers. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acb95dc82018a9c1693d03fe0709c0d23a41bb4f0cbba17438d6ff1e6890996e8f" name="acb95dc82018a9c1693d03fe0709c0d23a41bb4f0cbba17438d6ff1e6890996e8f"></a>L4RE_DMA_SPACE_BIDIRECTIONAL </td><td class="fielddoc"><p>device reads and writes to the memory </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="acb95dc82018a9c1693d03fe0709c0d23ac656250a1a7e5929d16e2b5f8c8eb624" name="acb95dc82018a9c1693d03fe0709c0d23ac656250a1a7e5929d16e2b5f8c8eb624"></a>L4RE_DMA_SPACE_TO_DEVICE </td><td class="fielddoc"><p>device reads the memory </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="acb95dc82018a9c1693d03fe0709c0d23af7020306f3a3959ea2046f8815055f33" name="acb95dc82018a9c1693d03fe0709c0d23af7020306f3a3959ea2046f8815055f33"></a>L4RE_DMA_SPACE_FROM_DEVICE </td><td class="fielddoc"><p>device writes to the memory </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="acb95dc82018a9c1693d03fe0709c0d23a903e34d1d6080e0a49297f3b6b405842" name="acb95dc82018a9c1693d03fe0709c0d23a903e34d1d6080e0a49297f3b6b405842"></a>L4RE_DMA_SPACE_NONE </td><td class="fielddoc"><p>device is coherently connected </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dma__space_8h_source.html#l00027">27</a> of file <a class="el" href="dma__space_8h_source.html">dma_space.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adef1eb8ee81d36e1b440a1e46cb16708" name="adef1eb8ee81d36e1b440a1e46cb16708"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adef1eb8ee81d36e1b440a1e46cb16708">◆ </a></span>l4re_dma_space_space_attribs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#adef1eb8ee81d36e1b440a1e46cb16708">l4re_dma_space_space_attribs</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Attributes assigned to the DMA space when associated with a specific device. </p>
|
|
<dl class="section see"><dt>See also</dt><dd>Space_attribs </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adef1eb8ee81d36e1b440a1e46cb16708a901dea72f532be6393283884fe162c35" name="adef1eb8ee81d36e1b440a1e46cb16708a901dea72f532be6393283884fe162c35"></a>L4RE_DMA_SPACE_COHERENT </td><td class="fielddoc"><p>The device is connected coherently with the cache. </p>
|
|
<p>This means that the map() and unmap() do not need to sync CPU caches before and after DMA. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="adef1eb8ee81d36e1b440a1e46cb16708a6283ff48b8c70b8a2f5ea4fbb27c6b1b" name="adef1eb8ee81d36e1b440a1e46cb16708a6283ff48b8c70b8a2f5ea4fbb27c6b1b"></a>L4RE_DMA_SPACE_PHYS_SPACE </td><td class="fielddoc"><p>The DMA space has no DMA task assigned and uses the CPUs physical memory. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="dma__space_8h_source.html#l00038">38</a> of file <a class="el" href="dma__space_8h_source.html">dma_space.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="navelem"><b>l4</b></li><li class="navelem"><b>re</b></li><li class="navelem"><b>c</b></li><li class="navelem"><a href="dma__space_8h.html">dma_space.h</a></li>
|
|
<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>
|