mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
127 lines
15 KiB
HTML
127 lines
15 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: mmc_spi.h File Reference</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.html"><span>Main Page</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>
|
|
</ul>
|
|
</div>
|
|
<div 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>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Defines</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>mmc_spi.h File Reference</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
|
|
<p>MMC over SPI driver header.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><a href="mmc__spi_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_m_c_config.html">MMCConfig</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Driver configuration structure. <a href="struct_m_m_c_config.html#_details">More...</a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_m_c_driver.html">MMCDriver</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure representing a MMC driver. <a href="struct_m_m_c_driver.html#_details">More...</a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="define-members"></a>
|
|
Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga502a0143be4c303f3006c0888e1cec82">MMC_SECTOR_SIZE</a> 512</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Block size for MMC transfers. <a href="group___m_m_c___s_p_i.html#ga502a0143be4c303f3006c0888e1cec82"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga3087dfffa81dd8a0a80ee92746e65fe2">MMC_NICE_WAITING</a> TRUE</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delays insertions. <a href="group___m_m_c___s_p_i.html#ga3087dfffa81dd8a0a80ee92746e65fe2"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#gac57e95210b57d6699c23bfb648e0904d">MMC_POLLING_INTERVAL</a> 10</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of positive insertion queries before generating the insertion event. <a href="group___m_m_c___s_p_i.html#gac57e95210b57d6699c23bfb648e0904d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga6d164ed93ae233b2dc0c35bd19f75224">MMC_POLLING_DELAY</a> 10</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interval, in milliseconds, between insertion queries. <a href="group___m_m_c___s_p_i.html#ga6d164ed93ae233b2dc0c35bd19f75224"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga08e8051df6339895618dbbfada225952">mmcGetDriverState</a>(mmcp) ((mmcp)->mmc_state)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the driver state. <a href="group___m_m_c___s_p_i.html#ga08e8051df6339895618dbbfada225952"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga2f69ba255b397f2d5f09cf1fe26a953f">mmcIsWriteProtected</a>(mmcp) ((mmcp)->mmc_is_protected())</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the write protect status. <a href="group___m_m_c___s_p_i.html#ga2f69ba255b397f2d5f09cf1fe26a953f"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#gaa7dbe27afa62f18e545ddea6a20bfa51">mmcquery_t</a> )(void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function used to query some hardware status bits. <a href="group___m_m_c___s_p_i.html#gaa7dbe27afa62f18e545ddea6a20bfa51"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga1e31b816b56d556a1ec664e8edf337e2">mmcstate_t</a> { <br/>
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a821452d1fa810c7e04db973f4b84b19e">MMC_UNINIT</a> = 0,
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a529707805e8f215249b55f9ed7178adb">MMC_STOP</a> = 1,
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a2b8fbb3f5c6f86872e6dc988ceb972f1">MMC_WAIT</a> = 2,
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a9d9f024996941451f3b45bf667620630">MMC_INSERTED</a> = 3,
|
|
<br/>
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a47f89e40b37a17a6fa062b7c2349f5ca">MMC_READY</a> = 4,
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a6f5a49bec04454f10207a1cf654bdb86">MMC_READING</a> = 5,
|
|
<a class="el" href="group___m_m_c___s_p_i.html#gga1e31b816b56d556a1ec664e8edf337e2a06ee52028fd244138137e731f9d1c1d6">MMC_WRITING</a> = 6
|
|
<br/>
|
|
}</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Driver state machine possible states. </p>
|
|
<a href="group___m_m_c___s_p_i.html#ga1e31b816b56d556a1ec664e8edf337e2">More...</a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga351951c841ece80fc692195ab37b2f06">mmcInit</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">MMC over SPI driver initialization. <a href="group___m_m_c___s_p_i.html#ga351951c841ece80fc692195ab37b2f06"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga44df4f9091614cab6de8d79c3c6b1a14">mmcObjectInit</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp, <a class="el" href="struct_s_p_i_driver.html">SPIDriver</a> *spip, const <a class="el" href="struct_s_p_i_config.html">SPIConfig</a> *lscfg, const <a class="el" href="struct_s_p_i_config.html">SPIConfig</a> *hscfg, <a class="el" href="group___m_m_c___s_p_i.html#gaa7dbe27afa62f18e545ddea6a20bfa51">mmcquery_t</a> is_protected, <a class="el" href="group___m_m_c___s_p_i.html#gaa7dbe27afa62f18e545ddea6a20bfa51">mmcquery_t</a> is_inserted)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes an instance. <a href="group___m_m_c___s_p_i.html#ga44df4f9091614cab6de8d79c3c6b1a14"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga076506461b42641a9fe632cc3e72dab5">mmcStart</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp, const <a class="el" href="struct_m_m_c_config.html">MMCConfig</a> *config)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configures and activates the MMC peripheral. <a href="group___m_m_c___s_p_i.html#ga076506461b42641a9fe632cc3e72dab5"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga27833cde77794f914e4802c7e65281a5">mmcStop</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disables the MMC peripheral. <a href="group___m_m_c___s_p_i.html#ga27833cde77794f914e4802c7e65281a5"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga9ff4f12fa759c3cb4aca2b64b11f1d22">mmcConnect</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Performs the initialization procedure on the inserted card. <a href="group___m_m_c___s_p_i.html#ga9ff4f12fa759c3cb4aca2b64b11f1d22"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#gab90f252316351a93ec38b11f7eaf1f16">mmcDisconnect</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Brings the driver in a state safe for card removal. <a href="group___m_m_c___s_p_i.html#gab90f252316351a93ec38b11f7eaf1f16"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga6c62caa5d008460e7319fb2c36518ddc">mmcStartSequentialRead</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp, <a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> startblk)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a sequential read. <a href="group___m_m_c___s_p_i.html#ga6c62caa5d008460e7319fb2c36518ddc"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga7e02b9210a8d3d9f8465b8000983dadf">mmcSequentialRead</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp, <a class="el" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buffer)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a block within a sequential read operation. <a href="group___m_m_c___s_p_i.html#ga7e02b9210a8d3d9f8465b8000983dadf"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#gaf55b97f76be81f4ce5cde415f3131400">mmcStopSequentialRead</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops a sequential read gracefully. <a href="group___m_m_c___s_p_i.html#gaf55b97f76be81f4ce5cde415f3131400"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga8031c8222f92a0c6632b36ff943fe825">mmcStartSequentialWrite</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp, <a class="el" href="group___s_t_m8___c_o_r_e.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> startblk)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a sequential write. <a href="group___m_m_c___s_p_i.html#ga8031c8222f92a0c6632b36ff943fe825"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#ga9ce0adb181138efc1f835aff6d8eb203">mmcSequentialWrite</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp, const <a class="el" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buffer)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a block within a sequential write operation. <a href="group___m_m_c___s_p_i.html#ga9ce0adb181138efc1f835aff6d8eb203"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de">bool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___m_m_c___s_p_i.html#gae84abdd53540f03262822aa1f9a213b5">mmcStopSequentialWrite</a> (<a class="el" href="struct_m_m_c_driver.html">MMCDriver</a> *mmcp)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stops a sequential write gracefully. <a href="group___m_m_c___s_p_i.html#gae84abdd53540f03262822aa1f9a213b5"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>MMC over SPI driver header. </p>
|
|
|
|
<p>Definition in file <a class="el" href="mmc__spi_8h_source.html">mmc_spi.h</a>.</p>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Nov 28 2010 14:09:50 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|