Files
discoverpixy/usbh__msc__scsi_8h_source.html
2015-05-12 11:12:43 +02:00

181 lines
19 KiB
HTML

<!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.9.1"/>
<title>discoverpixy: discovery/libs/StmUsbHost/STM32_USB_HOST_Library/Class/MSC/inc/usbh_msc_scsi.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="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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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>Classes</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>File&#160;Members</span></a></li>
</ul>
</div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_84db96586f7d962b526d6d9627d831c2.html">discovery</a></li><li class="navelem"><a class="el" href="dir_07523c13f04fd35d8848cb17a371cb5b.html">libs</a></li><li class="navelem"><a class="el" href="dir_a041ff5c2b284f3abb06af95928aadaf.html">StmUsbHost</a></li><li class="navelem"><a class="el" href="dir_bca67a7d060bcaa9c28f8aab2fffa8aa.html">STM32_USB_HOST_Library</a></li><li class="navelem"><a class="el" href="dir_0df032ba06b8eb810b5f40e1c65a502c.html">Class</a></li><li class="navelem"><a class="el" href="dir_8afe10de55c8b894271ff1b0bd6e1529.html">MSC</a></li><li class="navelem"><a class="el" href="dir_1060172239f126d4aafe962033aac0fb.html">inc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">usbh_msc_scsi.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="usbh__msc__scsi_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;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">/* Define to prevent recursive ----------------------------------------------*/</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef __USBH_MSC_SCSI_H__</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define __USBH_MSC_SCSI_H__</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">/* Includes ------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="usbh__stdreq_8h.html">usbh_stdreq.h</a>&quot;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; USBH_MSC_OK = 0,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; USBH_MSC_FAIL = 1,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; USBH_MSC_PHASE_ERROR = 2,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; USBH_MSC_BUSY = 3</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;}USBH_MSC_Status_TypeDef;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; CMD_UNINITIALIZED_STATE =0,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; CMD_SEND_STATE,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; CMD_WAIT_STATUS</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;} CMD_STATES_TypeDef; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="struct_____mass_storage_parameter.html"> 66</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_____mass_storage_parameter.html">__MassStorageParameter</a></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;{</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; uint32_t MSCapacity;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; uint32_t MSSenseKey; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; uint16_t MSPageLength;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; uint8_t MSBulkOutEp;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; uint8_t MSBulkInEp;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; uint8_t MSWriteProtect;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <a class="code" href="struct_____mass_storage_parameter.html">MassStorageParameter_TypeDef</a>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="preprocessor">#define OPCODE_TEST_UNIT_READY 0X00</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#define OPCODE_READ_CAPACITY10 0x25</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#define OPCODE_MODE_SENSE6 0x1A</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#define OPCODE_READ10 0x28</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="preprocessor">#define OPCODE_WRITE10 0x2A</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="preprocessor">#define OPCODE_REQUEST_SENSE 0x03</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#define DESC_REQUEST_SENSE 0X00</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="preprocessor">#define ALLOCATION_LENGTH_REQUEST_SENSE 63 </span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="preprocessor">#define XFER_LEN_READ_CAPACITY10 8</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="preprocessor">#define XFER_LEN_MODE_SENSE6 63</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="preprocessor">#define MASK_MODE_SENSE_WRITE_PROTECT 0x80</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="preprocessor">#define MODE_SENSE_PAGE_CONTROL_FIELD 0x00</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="preprocessor">#define MODE_SENSE_PAGE_CODE 0x3F</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="preprocessor">#define DISK_WRITE_PROTECTED 0x01</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="keyword">extern</span> <a class="code" href="struct_____mass_storage_parameter.html">MassStorageParameter_TypeDef</a> USBH_MSC_Param;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;uint8_t <a class="code" href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#ga71ac9a063cc9a7a3069779c4b5b54a47">USBH_MSC_TestUnitReady</a>(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;uint8_t <a class="code" href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#ga645e32e306e97eb523ee83bc87700839">USBH_MSC_ReadCapacity10</a>(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev);</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;uint8_t <a class="code" href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#gaa2f373d20f15d4bf45cb62d470cf6ce8">USBH_MSC_ModeSense6</a>(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;uint8_t <a class="code" href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#ga69374f36fd25dee7ef09ec9fbcb5cc61">USBH_MSC_RequestSense</a>(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;uint8_t <a class="code" href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#gaf799b1bfcaf339eec3a4e6d476731e4f">USBH_MSC_Write10</a>(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev,</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; uint8_t *,</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; uint32_t ,</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; uint32_t );</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;uint8_t <a class="code" href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#gaae61bdd987523859e519ccff7496c08b">USBH_MSC_Read10</a>(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev,</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; uint8_t *,</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; uint32_t ,</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; uint32_t );</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<span class="keywordtype">void</span> USBH_MSC_StateMachine(<a class="code" href="struct_u_s_b___o_t_g__handle.html">USB_OTG_CORE_HANDLE</a> *pdev);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="preprocessor">#endif //__USBH_MSC_SCSI_H__</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment">/******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;</div>
<div class="ttc" id="usbh__stdreq_8h_html"><div class="ttname"><a href="usbh__stdreq_8h.html">usbh_stdreq.h</a></div><div class="ttdoc">Header file for usbh_stdreq.c. </div></div>
<div class="ttc" id="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype_html_ga645e32e306e97eb523ee83bc87700839"><div class="ttname"><a href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#ga645e32e306e97eb523ee83bc87700839">USBH_MSC_ReadCapacity10</a></div><div class="ttdeci">uint8_t USBH_MSC_ReadCapacity10(USB_OTG_CORE_HANDLE *pdev)</div><div class="ttdoc">USBH_MSC_ReadCapacity10 Issue the read capacity command to the device. Once the response received...</div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.c:197</div></div>
<div class="ttc" id="struct_____mass_storage_parameter_html"><div class="ttname"><a href="struct_____mass_storage_parameter.html">__MassStorageParameter</a></div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.h:66</div></div>
<div class="ttc" id="struct_u_s_b___o_t_g__handle_html"><div class="ttname"><a href="struct_u_s_b___o_t_g__handle.html">USB_OTG_handle</a></div><div class="ttdef"><b>Definition:</b> usb_core.h:287</div></div>
<div class="ttc" id="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype_html_gaa2f373d20f15d4bf45cb62d470cf6ce8"><div class="ttname"><a href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#gaa2f373d20f15d4bf45cb62d470cf6ce8">USBH_MSC_ModeSense6</a></div><div class="ttdeci">uint8_t USBH_MSC_ModeSense6(USB_OTG_CORE_HANDLE *pdev)</div><div class="ttdoc">USBH_MSC_ModeSense6 Issue the Mode Sense6 Command to the device. This function is used for reading th...</div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.c:283</div></div>
<div class="ttc" id="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype_html_gaf799b1bfcaf339eec3a4e6d476731e4f"><div class="ttname"><a href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#gaf799b1bfcaf339eec3a4e6d476731e4f">USBH_MSC_Write10</a></div><div class="ttdeci">uint8_t USBH_MSC_Write10(USB_OTG_CORE_HANDLE *pdev, uint8_t *, uint32_t, uint32_t)</div><div class="ttdoc">USBH_MSC_Write10 Issue the write command to the device. Once the response received, it updates the status to upper layer. </div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.c:471</div></div>
<div class="ttc" id="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype_html_ga69374f36fd25dee7ef09ec9fbcb5cc61"><div class="ttname"><a href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#ga69374f36fd25dee7ef09ec9fbcb5cc61">USBH_MSC_RequestSense</a></div><div class="ttdeci">uint8_t USBH_MSC_RequestSense(USB_OTG_CORE_HANDLE *pdev)</div><div class="ttdoc">USBH_MSC_RequestSense Issues the Request Sense command to the device. Once the response received...</div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.c:375</div></div>
<div class="ttc" id="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype_html_gaae61bdd987523859e519ccff7496c08b"><div class="ttname"><a href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#gaae61bdd987523859e519ccff7496c08b">USBH_MSC_Read10</a></div><div class="ttdeci">uint8_t USBH_MSC_Read10(USB_OTG_CORE_HANDLE *pdev, uint8_t *, uint32_t, uint32_t)</div><div class="ttdoc">USBH_MSC_Read10 Issue the read command to the device. Once the response received, it updates the stat...</div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.c:559</div></div>
<div class="ttc" id="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype_html_ga71ac9a063cc9a7a3069779c4b5b54a47"><div class="ttname"><a href="group___u_s_b_h___m_s_c___s_c_s_i___exported___functions_prototype.html#ga71ac9a063cc9a7a3069779c4b5b54a47">USBH_MSC_TestUnitReady</a></div><div class="ttdeci">uint8_t USBH_MSC_TestUnitReady(USB_OTG_CORE_HANDLE *pdev)</div><div class="ttdoc">USBH_MSC_TestUnitReady Issues &#39;Test unit ready&#39; command to the device. Once the response received...</div><div class="ttdef"><b>Definition:</b> usbh_msc_scsi.c:125</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun May 10 2015 15:15:18 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>