190 lines
18 KiB
HTML
190 lines
18 KiB
HTML
<!-- HTML header for doxygen 1.8.6-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.6"/>
|
|
<title>tinyusb: tinyusb/class/msc_host.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="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.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 width="100%" cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">tinyusb
|
|
 <span id="projectnumber">0.4</span>
|
|
</div>
|
|
</td>
|
|
<td align="right">
|
|
<a href="https://pledgie.com/campaigns/24694"><img border="0" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com"></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('msc__host_8h.html','');});
|
|
</script>
|
|
<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)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">msc_host.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="common_8h_source.html">common/common.h</a>"</code><br/>
|
|
<code>#include "<a class="el" href="usbh_8h_source.html">host/usbh.h</a>"</code><br/>
|
|
<code>#include "<a class="el" href="msc_8h_source.html">msc.h</a>"</code><br/>
|
|
</div>
|
|
<p><a href="msc__host_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaf823d310e293579f62f7c78888980619"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gaf823d310e293579f62f7c78888980619">tusbh_msc_is_mounted</a> (uint8_t dev_addr) <a class="el" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:gaf823d310e293579f62f7c78888980619"><td class="mdescLeft"> </td><td class="mdescRight">Check if device supports MassStorage interface or not. <a href="group___m_s_c___host.html#gaf823d310e293579f62f7c78888980619">More...</a><br/></td></tr>
|
|
<tr class="separator:gaf823d310e293579f62f7c78888980619"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa6cc5099b9bb874fb13e6e2e4fd1b4fc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gaa6cc5099b9bb874fb13e6e2e4fd1b4fc">tusbh_msc_is_busy</a> (uint8_t dev_addr) <a class="el" href="group___group___func_attr.html#ga477faefde32bfd89d5b5b40d70b1a998">ATTR_PURE</a> <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:gaa6cc5099b9bb874fb13e6e2e4fd1b4fc"><td class="mdescLeft"> </td><td class="mdescRight">Check if the interface is currently busy or not. <a href="group___m_s_c___host.html#gaa6cc5099b9bb874fb13e6e2e4fd1b4fc">More...</a><br/></td></tr>
|
|
<tr class="separator:gaa6cc5099b9bb874fb13e6e2e4fd1b4fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4e5db3391a76dfa58c0b8d257de8a66b"><td class="memItemLeft" align="right" valign="top">uint8_t const * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#ga4e5db3391a76dfa58c0b8d257de8a66b">tusbh_msc_get_vendor_name</a> (uint8_t dev_addr)</td></tr>
|
|
<tr class="memdesc:ga4e5db3391a76dfa58c0b8d257de8a66b"><td class="mdescLeft"> </td><td class="mdescRight">Get SCSI vendor's name of MassStorage device. <a href="group___m_s_c___host.html#ga4e5db3391a76dfa58c0b8d257de8a66b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga4e5db3391a76dfa58c0b8d257de8a66b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga54ac5a96247f082a0588af2453e61fd7"><td class="memItemLeft" align="right" valign="top">uint8_t const * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#ga54ac5a96247f082a0588af2453e61fd7">tusbh_msc_get_product_name</a> (uint8_t dev_addr)</td></tr>
|
|
<tr class="memdesc:ga54ac5a96247f082a0588af2453e61fd7"><td class="mdescLeft"> </td><td class="mdescRight">Get SCSI product's name of MassStorage device. <a href="group___m_s_c___host.html#ga54ac5a96247f082a0588af2453e61fd7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga54ac5a96247f082a0588af2453e61fd7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga426e1167966e5288fba25969dce279d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#ga426e1167966e5288fba25969dce279d0">tusbh_msc_get_capacity</a> (uint8_t dev_addr, uint32_t *p_last_lba, uint32_t *p_block_size)</td></tr>
|
|
<tr class="memdesc:ga426e1167966e5288fba25969dce279d0"><td class="mdescLeft"> </td><td class="mdescRight">Get SCSI Capacity of MassStorage device. <a href="group___m_s_c___host.html#ga426e1167966e5288fba25969dce279d0">More...</a><br/></td></tr>
|
|
<tr class="separator:ga426e1167966e5288fba25969dce279d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga902d4394f85f043d50f29fe5fc085b73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#ga902d4394f85f043d50f29fe5fc085b73">tusbh_msc_read10</a> (uint8_t dev_addr, uint8_t lun, void *p_buffer, uint32_t lba, uint16_t block_count) <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:ga902d4394f85f043d50f29fe5fc085b73"><td class="mdescLeft"> </td><td class="mdescRight">Perform SCSI READ 10 command to read data from MassStorage device. <a href="group___m_s_c___host.html#ga902d4394f85f043d50f29fe5fc085b73">More...</a><br/></td></tr>
|
|
<tr class="separator:ga902d4394f85f043d50f29fe5fc085b73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae2e0d9cc75723cc2c9a78605d737f801"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gae2e0d9cc75723cc2c9a78605d737f801">tusbh_msc_write10</a> (uint8_t dev_addr, uint8_t lun, void const *p_buffer, uint32_t lba, uint16_t block_count) <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:gae2e0d9cc75723cc2c9a78605d737f801"><td class="mdescLeft"> </td><td class="mdescRight">Perform SCSI WRITE 10 command to write data to MassStorage device. <a href="group___m_s_c___host.html#gae2e0d9cc75723cc2c9a78605d737f801">More...</a><br/></td></tr>
|
|
<tr class="separator:gae2e0d9cc75723cc2c9a78605d737f801"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae7888d752d47cb1f52ede7e367630117"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gae7888d752d47cb1f52ede7e367630117">tusbh_msc_request_sense</a> (uint8_t dev_addr, uint8_t lun, uint8_t *p_data)</td></tr>
|
|
<tr class="memdesc:gae7888d752d47cb1f52ede7e367630117"><td class="mdescLeft"> </td><td class="mdescRight">Perform SCSI REQUEST SENSE command, used to retrieve sense data from MassStorage device. <a href="group___m_s_c___host.html#gae7888d752d47cb1f52ede7e367630117">More...</a><br/></td></tr>
|
|
<tr class="separator:gae7888d752d47cb1f52ede7e367630117"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab8b66e4a24a08259b5456dae8fe5f64b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gab8b66e4a24a08259b5456dae8fe5f64b">tusbh_msc_test_unit_ready</a> (uint8_t dev_addr, uint8_t lun, <a class="el" href="structmsc__cmd__status__wrapper__t.html">msc_cmd_status_wrapper_t</a> *p_csw) <a class="el" href="group___group___func_attr.html#gaa61f3d1a169c3d97d95072b1ee6493fd">ATTR_WARN_UNUSED_RESULT</a></td></tr>
|
|
<tr class="memdesc:gab8b66e4a24a08259b5456dae8fe5f64b"><td class="mdescLeft"> </td><td class="mdescRight">Perform SCSI TEST UNIT READY command to test if MassStorage device is ready. <a href="group___m_s_c___host.html#gab8b66e4a24a08259b5456dae8fe5f64b">More...</a><br/></td></tr>
|
|
<tr class="separator:gab8b66e4a24a08259b5456dae8fe5f64b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab45280faacbb4169a7fb6773d9a5c2b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gab45280faacbb4169a7fb6773d9a5c2b4">tusbh_msc_mounted_cb</a> (uint8_t dev_addr)</td></tr>
|
|
<tr class="memdesc:gab45280faacbb4169a7fb6773d9a5c2b4"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that will be invoked when a device with MassStorage interface is mounted. <a href="group___m_s_c___host.html#gab45280faacbb4169a7fb6773d9a5c2b4">More...</a><br/></td></tr>
|
|
<tr class="separator:gab45280faacbb4169a7fb6773d9a5c2b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gababef5335d6f4dba72b30128dabaa0ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#gababef5335d6f4dba72b30128dabaa0ec">tusbh_msc_unmounted_cb</a> (uint8_t dev_addr)</td></tr>
|
|
<tr class="memdesc:gababef5335d6f4dba72b30128dabaa0ec"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that will be invoked when a device with MassStorage interface is unmounted. <a href="group___m_s_c___host.html#gababef5335d6f4dba72b30128dabaa0ec">More...</a><br/></td></tr>
|
|
<tr class="separator:gababef5335d6f4dba72b30128dabaa0ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga58e35f8eaf7c01cb3ff650da6fa222c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_s_c___host.html#ga58e35f8eaf7c01cb3ff650da6fa222c8">tusbh_msc_isr</a> (uint8_t dev_addr, tusb_event_t event, uint32_t xferred_bytes)</td></tr>
|
|
<tr class="memdesc:ga58e35f8eaf7c01cb3ff650da6fa222c8"><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is invoked when an transferring event occurred. <a href="group___m_s_c___host.html#ga58e35f8eaf7c01cb3ff650da6fa222c8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga58e35f8eaf7c01cb3ff650da6fa222c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>hathach (tinyusb.org)</dd></dl>
|
|
<h1><a class="anchor" id="LICENSE"></a>
|
|
LICENSE</h1>
|
|
<p>Software License Agreement (BSD License)</p>
|
|
<p>Copyright (c) 2013, hathach (tinyusb.org) All rights reserved.</p>
|
|
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p>
|
|
<ol type="1">
|
|
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
|
|
<li>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.</li>
|
|
<li>Neither the name of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</li>
|
|
</ol>
|
|
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''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 HOLDER 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.</p>
|
|
<p>This file is part of the tinyusb stack. </p>
|
|
|
|
<p>Definition in file <a class="el" href="msc__host_8h_source.html">msc_host.h</a>.</p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_f44c0f1c8d3a85cc1de1e7f4648a56e6.html">tinyusb</a></li><li class="navelem"><a class="el" href="dir_c0cc4bd312f8dff81e67f48a71e5871f.html">class</a></li><li class="navelem"><a class="el" href="msc__host_8h.html">msc_host.h</a></li>
|
|
<li class="footer">Generated on Tue Apr 15 2014 10:49:26 for tinyusb by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|