Ram Gandikota / Mbed OS IOTMetronome

FRDM K64F Metronome

pal/Docs/html/d9/d16/pal_8h.html

Committer:
ram54288
Date:
2017-05-14
Revision:
0:dbad57390bd1

File content as of revision 0:dbad57390bd1:

<!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.11"/>
<title>PAL: C:/work/PAL/zolFull/mbed-client-pal/Source/PAL-Impl/Services-API/pal.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="../../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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">PAL
   </div>
   <div id="projectbrief">A Platform Abstraction Layer connects the mbed-client with the underlying platform.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>Main&#160;Page</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>
    </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 id="nav-path" class="navpath">
  <ul>
<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>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">pal.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../db/dcf/pal__macros_8h_source.html">pal_macros.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d2/d87/pal__configuration_8h_source.html">pal_configuration.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../da/dfe/pal__errors_8h_source.html">pal_errors.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d6/dc2/pal__types_8h_source.html">pal_types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d4/d01/pal__rtos_8h_source.html">pal_rtos.h</a>&quot;</code><br />
</div>
<p><a href="../../d9/d16/pal_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:a28095bec6e2c1c74ad3b08414f44b9d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d6/dc2/pal__types_8h.html#a160277354e86b9aea01d7689ec26d88d">palStatus_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d16/pal_8h.html#a28095bec6e2c1c74ad3b08414f44b9d6">pal_init</a> ()</td></tr>
<tr class="separator:a28095bec6e2c1c74ad3b08414f44b9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a312dfda15122dbd2abff67b580c811ad"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/d16/pal_8h.html#a312dfda15122dbd2abff67b580c811ad">pal_destroy</a> ()</td></tr>
<tr class="separator:a312dfda15122dbd2abff67b580c811ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a312dfda15122dbd2abff67b580c811ad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void pal_destroy </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>PAL destruction This function will call each module's destroy function (if exist) to free resources. </p>

</div>
</div>
<a class="anchor" id="a28095bec6e2c1c74ad3b08414f44b9d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d6/dc2/pal__types_8h.html#a160277354e86b9aea01d7689ec26d88d">palStatus_t</a> pal_init </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>