Google Git
Sign in
pigweed/third_party/github/hathach/tinyusb/ccd038a4eb4e3e48240eb1c85909d65068a43424/./0.4/msc__device_8h_source.html
blob: 01491d63317ec13113b2b88c76a51f6ee1eb6c7a [file]
<!-- 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_device.h Source File</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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;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&#160;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__device_8h_source.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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="headertitle">
<div class="title">msc_device.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="msc__device_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**************************************************************************/</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">/**************************************************************************/</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#ifndef _TUSB_MSC_DEVICE_H_</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _TUSB_MSC_DEVICE_H_</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="common_8h.html">common/common.h</a>&quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbd_8h.html">device/usbd.h</a>&quot;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="msc_8h.html">msc.h</a>&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">// APPLICATION API</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment">// APPLICATION CALLBACK API</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="group___m_s_c___device.html#ga73fc3dfbef73f24f29481ef419eb35e5">tusbd_msc_mounted_cb</a>(uint8_t coreid);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___m_s_c___device.html#gab4dbb5340eeaab5cdb4c0b4b03019880">tusbd_msc_unmounted_cb</a>(uint8_t coreid);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;uint16_t <a class="code" href="group___m_s_c___device.html#gaeb64ba2734e3400a0f73f1a140584e5f">tusbd_msc_read10_cb</a> (uint8_t coreid, uint8_t lun, <span class="keywordtype">void</span>** pp_buffer, uint32_t lba, uint16_t block_count);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;uint16_t <a class="code" href="group___m_s_c___device.html#ga5bc4dcb7613a9cfd56ea2da35a4d7944">tusbd_msc_write10_cb</a>(uint8_t coreid, uint8_t lun, <span class="keywordtype">void</span>** pp_buffer, uint32_t lba, uint16_t block_count);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment">// p_length [in,out] allocated/maximum length, application update with actual length</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment"></span><a class="code" href="group___class_driver___m_s_c___common.html#gab78ea3586ce0c7a8bb2680d7fbcca3ae">msc_csw_status_t</a> <a class="code" href="group___m_s_c___device.html#gaa5a5d2d6181e947f02e2790113b84aeb">tusbd_msc_scsi_cb</a> (uint8_t coreid, uint8_t lun, uint8_t scsi_cmd[16], <span class="keywordtype">void</span> <span class="keyword">const</span> ** pp_buffer, uint16_t* p_length);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment">// USBD-CLASS DRIVER API</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment">//--------------------------------------------------------------------+</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="preprocessor">#ifdef _TINY_USB_SOURCE_FILE_</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="keywordtype">void</span> mscd_init(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> mscd_open(uint8_t coreid, <a class="code" href="structtusb__descriptor__interface__t.html">tusb_descriptor_interface_t</a> <span class="keyword">const</span> * p_interface_desc, uint16_t *p_length);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> mscd_control_request_subtask(uint8_t coreid, <a class="code" href="structtusb__control__request__t.html">tusb_control_request_t</a> <span class="keyword">const</span> * p_request);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;<a class="code" href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a> mscd_xfer_cb(<a class="code" href="structendpoint__handle__t.html">endpoint_handle_t</a> edpt_hdl, tusb_event_t event, uint32_t xferred_bytes);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="keywordtype">void</span> mscd_close(uint8_t coreid);</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="preprocessor"></span> }</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* _TUSB_MSC_DEVICE_H_ */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="preprocessor"></span></div>
<div class="ttc" id="structtusb__descriptor__interface__t_html"><div class="ttname"><a href="structtusb__descriptor__interface__t.html">tusb_descriptor_interface_t</a></div><div class="ttdoc">USB Standard Interface Descriptor (section 9.6.1 table 9-12) </div><div class="ttdef"><b>Definition:</b> <a href="std__descriptors_8h_source.html#l00090">std_descriptors.h:90</a></div></div>
<div class="ttc" id="group___m_s_c___device_html_gaeb64ba2734e3400a0f73f1a140584e5f"><div class="ttname"><a href="group___m_s_c___device.html#gaeb64ba2734e3400a0f73f1a140584e5f">tusbd_msc_read10_cb</a></div><div class="ttdeci">uint16_t tusbd_msc_read10_cb(uint8_t coreid, uint8_t lun, void **pp_buffer, uint32_t lba, uint16_t block_count)</div><div class="ttdoc">Callback that is invoked when tinyusb stack received SCSI_CMD_READ_10 command from host...</div></div>
<div class="ttc" id="structtusb__control__request__t_html"><div class="ttname"><a href="structtusb__control__request__t.html">tusb_control_request_t</a></div><div class="ttdef"><b>Definition:</b> <a href="std__request_8h_source.html#l00049">std_request.h:49</a></div></div>
<div class="ttc" id="msc_8h_html"><div class="ttname"><a href="msc_8h.html">msc.h</a></div></div>
<div class="ttc" id="group___m_s_c___device_html_ga73fc3dfbef73f24f29481ef419eb35e5"><div class="ttname"><a href="group___m_s_c___device.html#ga73fc3dfbef73f24f29481ef419eb35e5">tusbd_msc_mounted_cb</a></div><div class="ttdeci">void tusbd_msc_mounted_cb(uint8_t coreid)</div><div class="ttdoc">Callback function that will be invoked when this interface is mounted (configured) by USB host...</div></div>
<div class="ttc" id="structendpoint__handle__t_html"><div class="ttname"><a href="structendpoint__handle__t.html">endpoint_handle_t</a></div><div class="ttdef"><b>Definition:</b> <a href="dcd_8h_source.html#l00052">dcd.h:52</a></div></div>
<div class="ttc" id="group___class_driver___m_s_c___common_html_gab78ea3586ce0c7a8bb2680d7fbcca3ae"><div class="ttname"><a href="group___class_driver___m_s_c___common.html#gab78ea3586ce0c7a8bb2680d7fbcca3ae">msc_csw_status_t</a></div><div class="ttdeci">msc_csw_status_t</div><div class="ttdoc">Command Block Status Values. </div><div class="ttdef"><b>Definition:</b> <a href="msc_8h_source.html#l00090">msc.h:90</a></div></div>
<div class="ttc" id="group___group___error_html_ga225612897c510054ef4026586562f716"><div class="ttname"><a href="group___group___error.html#ga225612897c510054ef4026586562f716">tusb_error_t</a></div><div class="ttdeci">tusb_error_t</div><div class="ttdoc">Error Code returned. </div><div class="ttdef"><b>Definition:</b> <a href="tusb__errors_8h_source.html#l00100">tusb_errors.h:100</a></div></div>
<div class="ttc" id="group___m_s_c___device_html_ga5bc4dcb7613a9cfd56ea2da35a4d7944"><div class="ttname"><a href="group___m_s_c___device.html#ga5bc4dcb7613a9cfd56ea2da35a4d7944">tusbd_msc_write10_cb</a></div><div class="ttdeci">uint16_t tusbd_msc_write10_cb(uint8_t coreid, uint8_t lun, void **pp_buffer, uint32_t lba, uint16_t block_count)</div><div class="ttdoc">Callback that is invoked when tinyusb stack received SCSI_CMD_WRITE_10 command from host...</div></div>
<div class="ttc" id="common_8h_html"><div class="ttname"><a href="common_8h.html">common.h</a></div></div>
<div class="ttc" id="group___m_s_c___device_html_gab4dbb5340eeaab5cdb4c0b4b03019880"><div class="ttname"><a href="group___m_s_c___device.html#gab4dbb5340eeaab5cdb4c0b4b03019880">tusbd_msc_unmounted_cb</a></div><div class="ttdeci">void tusbd_msc_unmounted_cb(uint8_t coreid)</div><div class="ttdoc">Callback function that will be invoked when this interface is unmounted (bus reset/unplugged) ...</div></div>
<div class="ttc" id="group___m_s_c___device_html_gaa5a5d2d6181e947f02e2790113b84aeb"><div class="ttname"><a href="group___m_s_c___device.html#gaa5a5d2d6181e947f02e2790113b84aeb">tusbd_msc_scsi_cb</a></div><div class="ttdeci">msc_csw_status_t tusbd_msc_scsi_cb(uint8_t coreid, uint8_t lun, uint8_t scsi_cmd[16], void const **pp_buffer, uint16_t *p_length)</div><div class="ttdoc">Callback that is invoked when tinyusb stack received an SCSI command other than SCSI_CMD_WRITE_10 and...</div></div>
<div class="ttc" id="usbd_8h_html"><div class="ttname"><a href="usbd_8h.html">usbd.h</a></div></div>
</div><!-- fragment --></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__device_8h.html">msc_device.h</a></li>
<li class="footer">Generated on Mon Mar 31 2014 16:41:48 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>