Ram Gandikota
A metronome using the FRDM K64F board
pal/Docs/html/d9/d16/pal_8h.html@0:a7a43371b306, 2017-05-14 (annotated)
- Committer:
- ram54288
- Date:
- Sun May 14 18:40:18 2017 +0000
- Revision:
- 0:a7a43371b306
Initial commit
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| ram54288 | 0:a7a43371b306 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| ram54288 | 0:a7a43371b306 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| ram54288 | 0:a7a43371b306 | 3 | <head> |
| ram54288 | 0:a7a43371b306 | 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| ram54288 | 0:a7a43371b306 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| ram54288 | 0:a7a43371b306 | 6 | <meta name="generator" content="Doxygen 1.8.11"/> |
| ram54288 | 0:a7a43371b306 | 7 | <title>PAL: C:/work/PAL/zolFull/mbed-client-pal/Source/PAL-Impl/Services-API/pal.h File Reference</title> |
| ram54288 | 0:a7a43371b306 | 8 | <link href="../../tabs.css" rel="stylesheet" type="text/css"/> |
| ram54288 | 0:a7a43371b306 | 9 | <script type="text/javascript" src="../../jquery.js"></script> |
| ram54288 | 0:a7a43371b306 | 10 | <script type="text/javascript" src="../../dynsections.js"></script> |
| ram54288 | 0:a7a43371b306 | 11 | <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> |
| ram54288 | 0:a7a43371b306 | 12 | </head> |
| ram54288 | 0:a7a43371b306 | 13 | <body> |
| ram54288 | 0:a7a43371b306 | 14 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| ram54288 | 0:a7a43371b306 | 15 | <div id="titlearea"> |
| ram54288 | 0:a7a43371b306 | 16 | <table cellspacing="0" cellpadding="0"> |
| ram54288 | 0:a7a43371b306 | 17 | <tbody> |
| ram54288 | 0:a7a43371b306 | 18 | <tr style="height: 56px;"> |
| ram54288 | 0:a7a43371b306 | 19 | <td id="projectalign" style="padding-left: 0.5em;"> |
| ram54288 | 0:a7a43371b306 | 20 | <div id="projectname">PAL |
| ram54288 | 0:a7a43371b306 | 21 | </div> |
| ram54288 | 0:a7a43371b306 | 22 | <div id="projectbrief">A Platform Abstraction Layer connects the mbed-client with the underlying platform.</div> |
| ram54288 | 0:a7a43371b306 | 23 | </td> |
| ram54288 | 0:a7a43371b306 | 24 | </tr> |
| ram54288 | 0:a7a43371b306 | 25 | </tbody> |
| ram54288 | 0:a7a43371b306 | 26 | </table> |
| ram54288 | 0:a7a43371b306 | 27 | </div> |
| ram54288 | 0:a7a43371b306 | 28 | <!-- end header part --> |
| ram54288 | 0:a7a43371b306 | 29 | <!-- Generated by Doxygen 1.8.11 --> |
| ram54288 | 0:a7a43371b306 | 30 | <div id="navrow1" class="tabs"> |
| ram54288 | 0:a7a43371b306 | 31 | <ul class="tablist"> |
| ram54288 | 0:a7a43371b306 | 32 | <li><a href="../../index.html"><span>Main Page</span></a></li> |
| ram54288 | 0:a7a43371b306 | 33 | <li><a href="../../annotated.html"><span>Data Structures</span></a></li> |
| ram54288 | 0:a7a43371b306 | 34 | <li class="current"><a href="../../files.html"><span>Files</span></a></li> |
| ram54288 | 0:a7a43371b306 | 35 | </ul> |
| ram54288 | 0:a7a43371b306 | 36 | </div> |
| ram54288 | 0:a7a43371b306 | 37 | <div id="navrow2" class="tabs2"> |
| ram54288 | 0:a7a43371b306 | 38 | <ul class="tablist"> |
| ram54288 | 0:a7a43371b306 | 39 | <li><a href="../../files.html"><span>File List</span></a></li> |
| ram54288 | 0:a7a43371b306 | 40 | <li><a href="../../globals.html"><span>Globals</span></a></li> |
| ram54288 | 0:a7a43371b306 | 41 | </ul> |
| ram54288 | 0:a7a43371b306 | 42 | </div> |
| ram54288 | 0:a7a43371b306 | 43 | <div id="nav-path" class="navpath"> |
| ram54288 | 0:a7a43371b306 | 44 | <ul> |
| ram54288 | 0:a7a43371b306 | 45 | <li class="navelem"><a class="el" href="../../dir_74389ed8173ad57b461b9d623a1f3867.html">Source</a></li><li class="navelem"><a class="el" href="../../dir_8a9a67948239eaee56ff05ba80ad2d3c.html">PAL-Impl</a></li><li class="navelem"><a class="el" href="../../dir_18cc01a76aedd55acdee1b7ef37dd546.html">Services-API</a></li> </ul> |
| ram54288 | 0:a7a43371b306 | 46 | </div> |
| ram54288 | 0:a7a43371b306 | 47 | </div><!-- top --> |
| ram54288 | 0:a7a43371b306 | 48 | <div class="header"> |
| ram54288 | 0:a7a43371b306 | 49 | <div class="summary"> |
| ram54288 | 0:a7a43371b306 | 50 | <a href="#func-members">Functions</a> </div> |
| ram54288 | 0:a7a43371b306 | 51 | <div class="headertitle"> |
| ram54288 | 0:a7a43371b306 | 52 | <div class="title">pal.h File Reference</div> </div> |
| ram54288 | 0:a7a43371b306 | 53 | </div><!--header--> |
| ram54288 | 0:a7a43371b306 | 54 | <div class="contents"> |
| ram54288 | 0:a7a43371b306 | 55 | <div class="textblock"><code>#include "<a class="el" href="../../db/dcf/pal__macros_8h_source.html">pal_macros.h</a>"</code><br /> |
| ram54288 | 0:a7a43371b306 | 56 | <code>#include "<a class="el" href="../../d2/d87/pal__configuration_8h_source.html">pal_configuration.h</a>"</code><br /> |
| ram54288 | 0:a7a43371b306 | 57 | <code>#include "<a class="el" href="../../da/dfe/pal__errors_8h_source.html">pal_errors.h</a>"</code><br /> |
| ram54288 | 0:a7a43371b306 | 58 | <code>#include "<a class="el" href="../../d6/dc2/pal__types_8h_source.html">pal_types.h</a>"</code><br /> |
| ram54288 | 0:a7a43371b306 | 59 | <code>#include "<a class="el" href="../../d4/d01/pal__rtos_8h_source.html">pal_rtos.h</a>"</code><br /> |
| ram54288 | 0:a7a43371b306 | 60 | </div> |
| ram54288 | 0:a7a43371b306 | 61 | <p><a href="../../d9/d16/pal_8h_source.html">Go to the source code of this file.</a></p> |
| ram54288 | 0:a7a43371b306 | 62 | <table class="memberdecls"> |
| ram54288 | 0:a7a43371b306 | 63 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| ram54288 | 0:a7a43371b306 | 64 | Functions</h2></td></tr> |
| ram54288 | 0:a7a43371b306 | 65 | <tr class="memitem:a28095bec6e2c1c74ad3b08414f44b9d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d6/dc2/pal__types_8h.html#a160277354e86b9aea01d7689ec26d88d">palStatus_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d16/pal_8h.html#a28095bec6e2c1c74ad3b08414f44b9d6">pal_init</a> ()</td></tr> |
| ram54288 | 0:a7a43371b306 | 66 | <tr class="separator:a28095bec6e2c1c74ad3b08414f44b9d6"><td class="memSeparator" colspan="2"> </td></tr> |
| ram54288 | 0:a7a43371b306 | 67 | <tr class="memitem:a312dfda15122dbd2abff67b580c811ad"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d16/pal_8h.html#a312dfda15122dbd2abff67b580c811ad">pal_destroy</a> ()</td></tr> |
| ram54288 | 0:a7a43371b306 | 68 | <tr class="separator:a312dfda15122dbd2abff67b580c811ad"><td class="memSeparator" colspan="2"> </td></tr> |
| ram54288 | 0:a7a43371b306 | 69 | </table> |
| ram54288 | 0:a7a43371b306 | 70 | <h2 class="groupheader">Function Documentation</h2> |
| ram54288 | 0:a7a43371b306 | 71 | <a class="anchor" id="a312dfda15122dbd2abff67b580c811ad"></a> |
| ram54288 | 0:a7a43371b306 | 72 | <div class="memitem"> |
| ram54288 | 0:a7a43371b306 | 73 | <div class="memproto"> |
| ram54288 | 0:a7a43371b306 | 74 | <table class="memname"> |
| ram54288 | 0:a7a43371b306 | 75 | <tr> |
| ram54288 | 0:a7a43371b306 | 76 | <td class="memname">void pal_destroy </td> |
| ram54288 | 0:a7a43371b306 | 77 | <td>(</td> |
| ram54288 | 0:a7a43371b306 | 78 | <td class="paramname"></td><td>)</td> |
| ram54288 | 0:a7a43371b306 | 79 | <td></td> |
| ram54288 | 0:a7a43371b306 | 80 | </tr> |
| ram54288 | 0:a7a43371b306 | 81 | </table> |
| ram54288 | 0:a7a43371b306 | 82 | </div><div class="memdoc"> |
| ram54288 | 0:a7a43371b306 | 83 | <p>PAL destruction This function will call each module's destroy function (if exist) to free resources. </p> |
| ram54288 | 0:a7a43371b306 | 84 | |
| ram54288 | 0:a7a43371b306 | 85 | </div> |
| ram54288 | 0:a7a43371b306 | 86 | </div> |
| ram54288 | 0:a7a43371b306 | 87 | <a class="anchor" id="a28095bec6e2c1c74ad3b08414f44b9d6"></a> |
| ram54288 | 0:a7a43371b306 | 88 | <div class="memitem"> |
| ram54288 | 0:a7a43371b306 | 89 | <div class="memproto"> |
| ram54288 | 0:a7a43371b306 | 90 | <table class="memname"> |
| ram54288 | 0:a7a43371b306 | 91 | <tr> |
| ram54288 | 0:a7a43371b306 | 92 | <td class="memname"><a class="el" href="../../d6/dc2/pal__types_8h.html#a160277354e86b9aea01d7689ec26d88d">palStatus_t</a> pal_init </td> |
| ram54288 | 0:a7a43371b306 | 93 | <td>(</td> |
| ram54288 | 0:a7a43371b306 | 94 | <td class="paramname"></td><td>)</td> |
| ram54288 | 0:a7a43371b306 | 95 | <td></td> |
| ram54288 | 0:a7a43371b306 | 96 | </tr> |
| ram54288 | 0:a7a43371b306 | 97 | </table> |
| ram54288 | 0:a7a43371b306 | 98 | </div><div class="memdoc"> |
| ram54288 | 0:a7a43371b306 | 99 | <p>PAL initialization This function will call each module's initialization function (if exist) to allocate required resources and initiate them. </p><dl class="section return"><dt>Returns</dt><dd>the function returns the status in the form of palStatus_t which will be <a class="el" href="../../d6/dc2/pal__types_8h.html#a92e2ad3a6b8c71818b6a08720fa84ba5">PAL_SUCCESS(0)</a> in case of success and another negative value indicating a specific error code in case of failure </dd></dl> |
| ram54288 | 0:a7a43371b306 | 100 | |
| ram54288 | 0:a7a43371b306 | 101 | </div> |
| ram54288 | 0:a7a43371b306 | 102 | </div> |
| ram54288 | 0:a7a43371b306 | 103 | </div><!-- contents --> |
| ram54288 | 0:a7a43371b306 | 104 | <!-- start footer part --> |
| ram54288 | 0:a7a43371b306 | 105 | <hr class="footer"/><address class="footer"><small> |
| ram54288 | 0:a7a43371b306 | 106 | Generated by  <a href="http://www.doxygen.org/index.html"> |
| ram54288 | 0:a7a43371b306 | 107 | <img class="footer" src="../../doxygen.png" alt="doxygen"/> |
| ram54288 | 0:a7a43371b306 | 108 | </a> 1.8.11 |
| ram54288 | 0:a7a43371b306 | 109 | </small></address> |
| ram54288 | 0:a7a43371b306 | 110 | </body> |
| ram54288 | 0:a7a43371b306 | 111 | </html> |