Skip to content
Permalink
72abdecad3
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time
433 lines (414 sloc) 38.5 KB
<!-- HTML header for doxygen 1.8.13-->
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Abstraction Layer (HAL)</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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>
<link href="doxygen_style.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="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Hardware Abstraction Layer (HAL)</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__group__result.html','');});
/* @license-end */
</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)">
</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="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Result Type<div class="ingroups"><a class="el" href="group__group__hal__types.html">HAL General Types/Macros</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Defines a type and related utilities for function result handling. </p>
<p><a class="anchor" id="anchor_general_description"></a>The <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> type is a structured bitfield which encodes information about result type, the originating module, and a code for the specific error (or warning etc). In order to extract these individual fields from a <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> value, the utility macros <a class="el" href="group__group__result.html#ga9ae9b152a38632a9e0f8620845c6cea9">CY_RSLT_GET_TYPE</a>, <a class="el" href="group__group__result.html#gab959fc67da8489c03d3ab631442393b4">CY_RSLT_GET_MODULE</a>, and <a class="el" href="group__group__result.html#ga5a7fc037210b7ff81c65160e11823443">CY_RSLT_GET_CODE</a> are provided. For example: </p><div class="fragment"><div class="line"><a class="code" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> result = cy_hal_do_operation(arg);</div><div class="line"><span class="comment">// Will be CY_RSLT_TYPE_INFO, CY_RSLT_TYPE_WARNING, CY_RSLT_TYPE_ERROR, or CY_RSLT_TYPE_FATAL</span></div><div class="line">uint8_t type = <a class="code" href="group__group__result.html#ga9ae9b152a38632a9e0f8620845c6cea9">CY_RSLT_GET_TYPE</a>(result)</div><div class="line"><span class="comment">// See the &quot;Modules&quot; section for possible values</span></div><div class="line">uint16_t module_id = <a class="code" href="group__group__result.html#gab959fc67da8489c03d3ab631442393b4">CY_RSLT_GET_MODULE</a>(result);</div><div class="line"><span class="comment">// Specific error codes are defined by each module</span></div><div class="line">uint16_t error_code = <a class="code" href="group__group__result.html#ga5a7fc037210b7ff81c65160e11823443">CY_RSLT_GET_CODE</a>(result);</div></div><!-- fragment --> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf58fac450d9fff4472f03ad68f6e546e"><td class="memItemLeft" align="right" valign="top"><a id="gaf58fac450d9fff4472f03ad68f6e546e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gaf58fac450d9fff4472f03ad68f6e546e">CY_RSLT_SUCCESS</a>&#160;&#160;&#160;((<a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a>)0x00000000U)</td></tr>
<tr class="memdesc:gaf58fac450d9fff4472f03ad68f6e546e"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> return value indicating success <br /></td></tr>
<tr class="separator:gaf58fac450d9fff4472f03ad68f6e546e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaca79700fcc701534ce61778a9bcf57d1"><td class="memItemLeft" align="right" valign="top">typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a></td></tr>
<tr class="memdesc:gaca79700fcc701534ce61778a9bcf57d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the result of an operation as a structured bitfield. <a href="#gaca79700fcc701534ce61778a9bcf57d1">More...</a><br /></td></tr>
<tr class="separator:gaca79700fcc701534ce61778a9bcf57d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Fields</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpa4ca5edd20d0b5d502ebece575681f58"></a>Utility macros for constructing result values and extracting individual fields from existing results. </p>
</td></tr>
<tr class="memitem:ga9ae9b152a38632a9e0f8620845c6cea9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga9ae9b152a38632a9e0f8620845c6cea9">CY_RSLT_GET_TYPE</a>(x)&#160;&#160;&#160;(((x) &gt;&gt; CY_RSLT_TYPE_POSITION) &amp; CY_RSLT_TYPE_MASK)</td></tr>
<tr class="memdesc:ga9ae9b152a38632a9e0f8620845c6cea9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the result type field. <a href="#ga9ae9b152a38632a9e0f8620845c6cea9">More...</a><br /></td></tr>
<tr class="separator:ga9ae9b152a38632a9e0f8620845c6cea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab959fc67da8489c03d3ab631442393b4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gab959fc67da8489c03d3ab631442393b4">CY_RSLT_GET_MODULE</a>(x)&#160;&#160;&#160;(((x) &gt;&gt; CY_RSLT_MODULE_POSITION) &amp; CY_RSLT_MODULE_MASK)</td></tr>
<tr class="memdesc:gab959fc67da8489c03d3ab631442393b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the module identifier field. <a href="#gab959fc67da8489c03d3ab631442393b4">More...</a><br /></td></tr>
<tr class="separator:gab959fc67da8489c03d3ab631442393b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a7fc037210b7ff81c65160e11823443"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga5a7fc037210b7ff81c65160e11823443">CY_RSLT_GET_CODE</a>(x)&#160;&#160;&#160;(((x) &gt;&gt; CY_RSLT_CODE_POSITION) &amp; CY_RSLT_CODE_MASK)</td></tr>
<tr class="memdesc:ga5a7fc037210b7ff81c65160e11823443"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the result code field. <a href="#ga5a7fc037210b7ff81c65160e11823443">More...</a><br /></td></tr>
<tr class="separator:ga5a7fc037210b7ff81c65160e11823443"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga711a53e03635b4f3e21c41aaf9459251"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga711a53e03635b4f3e21c41aaf9459251">CY_RSLT_CREATE</a>(type, module, code)</td></tr>
<tr class="memdesc:ga711a53e03635b4f3e21c41aaf9459251"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> value that encodes the specified type, module, and result code. <a href="#ga711a53e03635b4f3e21c41aaf9459251">More...</a><br /></td></tr>
<tr class="separator:ga711a53e03635b4f3e21c41aaf9459251"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Result Types</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpdb574203515eb819dfd259bece7254c3"></a>Defines codes to identify the type of result. </p>
</td></tr>
<tr class="memitem:ga611032ac7ceaccf05943b73868e13438"><td class="memItemLeft" align="right" valign="top"><a id="ga611032ac7ceaccf05943b73868e13438"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga611032ac7ceaccf05943b73868e13438">CY_RSLT_TYPE_INFO</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga611032ac7ceaccf05943b73868e13438"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result code is informational-only. <br /></td></tr>
<tr class="separator:ga611032ac7ceaccf05943b73868e13438"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5aa8f2db241158e42052d8940045d2a0"><td class="memItemLeft" align="right" valign="top"><a id="ga5aa8f2db241158e42052d8940045d2a0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga5aa8f2db241158e42052d8940045d2a0">CY_RSLT_TYPE_WARNING</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga5aa8f2db241158e42052d8940045d2a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result code is warning of a problem but will proceed. <br /></td></tr>
<tr class="separator:ga5aa8f2db241158e42052d8940045d2a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d656d344524464af71296f2140a7b37"><td class="memItemLeft" align="right" valign="top"><a id="ga8d656d344524464af71296f2140a7b37"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga8d656d344524464af71296f2140a7b37">CY_RSLT_TYPE_ERROR</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:ga8d656d344524464af71296f2140a7b37"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result code is an error. <br /></td></tr>
<tr class="separator:ga8d656d344524464af71296f2140a7b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bc4a48af22980d72766f825eda62658"><td class="memItemLeft" align="right" valign="top"><a id="ga2bc4a48af22980d72766f825eda62658"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga2bc4a48af22980d72766f825eda62658">CY_RSLT_TYPE_FATAL</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:ga2bc4a48af22980d72766f825eda62658"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result code is a fatal error. <br /></td></tr>
<tr class="separator:ga2bc4a48af22980d72766f825eda62658"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Modules</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpbf17ac149e2e7a530c677e9bd51d3fd2"></a><a class="anchor" id="anchor_modules"></a>Defines codes to identify the module from which an error originated. For some large libraries, a range of module codes is defined here; see the library documentation for values corresponding to individual modules. Valid range is 0x0000-0x4000. </p>
</td></tr>
<tr class="memitem:gaf229ad57884c3c8e4c5ecc7f217ce8aa"><td class="memItemLeft" align="right" valign="top"><a id="gaf229ad57884c3c8e4c5ecc7f217ce8aa"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gaf229ad57884c3c8e4c5ecc7f217ce8aa">CY_RSLT_MODULE_DRIVERS_PDL_BASE</a>&#160;&#160;&#160;(0x0000U)</td></tr>
<tr class="memdesc:gaf229ad57884c3c8e4c5ecc7f217ce8aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base module identifier for peripheral driver library drivers (0x0000 - 0x007F) <br /></td></tr>
<tr class="separator:gaf229ad57884c3c8e4c5ecc7f217ce8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga328dd4831cad3621a05e3fad151f9cd5"><td class="memItemLeft" align="right" valign="top"><a id="ga328dd4831cad3621a05e3fad151f9cd5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga328dd4831cad3621a05e3fad151f9cd5">CY_RSLT_MODULE_DRIVERS_WHD_BASE</a>&#160;&#160;&#160;(0x0080U)</td></tr>
<tr class="memdesc:ga328dd4831cad3621a05e3fad151f9cd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base module identifier for wireless host driver library modules (0x0080 - 0x00FF) <br /></td></tr>
<tr class="separator:ga328dd4831cad3621a05e3fad151f9cd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba8505defe4e04a5927b6e0590e256f0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gaba8505defe4e04a5927b6e0590e256f0">CY_RSLT_MODULE_ABSTRACTION_HAL_BASE</a>&#160;&#160;&#160;(0x0100U)</td></tr>
<tr class="memdesc:gaba8505defe4e04a5927b6e0590e256f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated. <a href="#gaba8505defe4e04a5927b6e0590e256f0">More...</a><br /></td></tr>
<tr class="separator:gaba8505defe4e04a5927b6e0590e256f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gada155710418c5225c8ccaa8e75e9a577"><td class="memItemLeft" align="right" valign="top"><a id="gada155710418c5225c8ccaa8e75e9a577"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gada155710418c5225c8ccaa8e75e9a577">CY_RSLT_MODULE_ABSTRACTION_HAL</a>&#160;&#160;&#160;(0x0100U)</td></tr>
<tr class="memdesc:gada155710418c5225c8ccaa8e75e9a577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the Hardware Abstraction Layer. <br /></td></tr>
<tr class="separator:gada155710418c5225c8ccaa8e75e9a577"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f6360a8bf5a570d6927d50123e95c1d"><td class="memItemLeft" align="right" valign="top"><a id="ga4f6360a8bf5a570d6927d50123e95c1d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga4f6360a8bf5a570d6927d50123e95c1d">CY_RSLT_MODULE_ABSTRACTION_BSP</a>&#160;&#160;&#160;(0x0180U)</td></tr>
<tr class="memdesc:ga4f6360a8bf5a570d6927d50123e95c1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for board support package. <br /></td></tr>
<tr class="separator:ga4f6360a8bf5a570d6927d50123e95c1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9cde2c478cdd2b7f626bc45c2a4a0543"><td class="memItemLeft" align="right" valign="top"><a id="ga9cde2c478cdd2b7f626bc45c2a4a0543"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga9cde2c478cdd2b7f626bc45c2a4a0543">CY_RSLT_MODULE_ABSTRACTION_FS</a>&#160;&#160;&#160;(0x0181U)</td></tr>
<tr class="memdesc:ga9cde2c478cdd2b7f626bc45c2a4a0543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for file system abstraction. <br /></td></tr>
<tr class="separator:ga9cde2c478cdd2b7f626bc45c2a4a0543"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab757b71680be515dd43368895fa73b7d"><td class="memItemLeft" align="right" valign="top"><a id="gab757b71680be515dd43368895fa73b7d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gab757b71680be515dd43368895fa73b7d">CY_RSLT_MODULE_ABSTRACTION_RESOURCE</a>&#160;&#160;&#160;(0x0182U)</td></tr>
<tr class="memdesc:gab757b71680be515dd43368895fa73b7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for resource abstraction. <br /></td></tr>
<tr class="separator:gab757b71680be515dd43368895fa73b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a59f041b014217d0d699bc3b0ae3cca"><td class="memItemLeft" align="right" valign="top"><a id="ga5a59f041b014217d0d699bc3b0ae3cca"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga5a59f041b014217d0d699bc3b0ae3cca">CY_RSLT_MODULE_ABSTRACTION_OS</a>&#160;&#160;&#160;(0x0183U)</td></tr>
<tr class="memdesc:ga5a59f041b014217d0d699bc3b0ae3cca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for rtos abstraction. <br /></td></tr>
<tr class="separator:ga5a59f041b014217d0d699bc3b0ae3cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1c76e11af277ca324da1c8516d7d31a"><td class="memItemLeft" align="right" valign="top"><a id="gad1c76e11af277ca324da1c8516d7d31a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gad1c76e11af277ca324da1c8516d7d31a">CY_RSLT_MODULE_ABSTRACTION_ENV</a>&#160;&#160;&#160;(0x0184U)</td></tr>
<tr class="memdesc:gad1c76e11af277ca324da1c8516d7d31a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base identifier for environment abstraction modules (0x0184 - 0x01FF) <br /></td></tr>
<tr class="separator:gad1c76e11af277ca324da1c8516d7d31a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga809314d87ef1e8f175564e88ccef70a9"><td class="memItemLeft" align="right" valign="top"><a id="ga809314d87ef1e8f175564e88ccef70a9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga809314d87ef1e8f175564e88ccef70a9">CY_RSLT_MODULE_BOARD_LIB_BASE</a>&#160;&#160;&#160;(0x01A0U)</td></tr>
<tr class="memdesc:ga809314d87ef1e8f175564e88ccef70a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base module identifier for Board Libraries (0x01A0 - 0x01BF) <br /></td></tr>
<tr class="separator:ga809314d87ef1e8f175564e88ccef70a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2424e0be0c1e672c829fb3798720465f"><td class="memItemLeft" align="right" valign="top"><a id="ga2424e0be0c1e672c829fb3798720465f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga2424e0be0c1e672c829fb3798720465f">CY_RSLT_MODULE_BOARD_LIB_RETARGET_IO</a>&#160;&#160;&#160;(0x1A0U)</td></tr>
<tr class="memdesc:ga2424e0be0c1e672c829fb3798720465f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the Retarget IO Board Library. <br /></td></tr>
<tr class="separator:ga2424e0be0c1e672c829fb3798720465f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea80fb321cb0b3e298a3a2e90e445d3d"><td class="memItemLeft" align="right" valign="top"><a id="gaea80fb321cb0b3e298a3a2e90e445d3d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gaea80fb321cb0b3e298a3a2e90e445d3d">CY_RSLT_MODULE_BOARD_LIB_RGB_LED</a>&#160;&#160;&#160;(0x01A1U)</td></tr>
<tr class="memdesc:gaea80fb321cb0b3e298a3a2e90e445d3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the RGB LED Board Library. <br /></td></tr>
<tr class="separator:gaea80fb321cb0b3e298a3a2e90e445d3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ce9bf3fc06bf768cd32558b44aaaf0f"><td class="memItemLeft" align="right" valign="top"><a id="ga0ce9bf3fc06bf768cd32558b44aaaf0f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga0ce9bf3fc06bf768cd32558b44aaaf0f">CY_RSLT_MODULE_BOARD_LIB_SERIAL_FLASH</a>&#160;&#160;&#160;(0x01A2U)</td></tr>
<tr class="memdesc:ga0ce9bf3fc06bf768cd32558b44aaaf0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the Serial Flash Board Library. <br /></td></tr>
<tr class="separator:ga0ce9bf3fc06bf768cd32558b44aaaf0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga927ff40c1f2cbe51a3c5c3f52c533e57"><td class="memItemLeft" align="right" valign="top"><a id="ga927ff40c1f2cbe51a3c5c3f52c533e57"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga927ff40c1f2cbe51a3c5c3f52c533e57">CY_RSLT_MODULE_BOARD_LIB_WHD_INTEGRATION</a>&#160;&#160;&#160;(0x01A3U)</td></tr>
<tr class="memdesc:ga927ff40c1f2cbe51a3c5c3f52c533e57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the WiFi Host Driver + Board Support Integration Library. <br /></td></tr>
<tr class="separator:ga927ff40c1f2cbe51a3c5c3f52c533e57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76bcb30b36e7fea0c8165c55e561de73"><td class="memItemLeft" align="right" valign="top"><a id="ga76bcb30b36e7fea0c8165c55e561de73"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga76bcb30b36e7fea0c8165c55e561de73">CY_RSLT_MODULE_BOARD_SHIELD_BASE</a>&#160;&#160;&#160;(0x01B8U)</td></tr>
<tr class="memdesc:ga76bcb30b36e7fea0c8165c55e561de73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base module identifier for Shield Board Libraries (0x01B8 - 0x01BF) <br /></td></tr>
<tr class="separator:ga76bcb30b36e7fea0c8165c55e561de73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5b8e84947e9bf1a7fb5d8003ef276bf"><td class="memItemLeft" align="right" valign="top"><a id="gaa5b8e84947e9bf1a7fb5d8003ef276bf"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gaa5b8e84947e9bf1a7fb5d8003ef276bf">CY_RSLT_MODULE_BOARD_SHIELD_028_EPD</a>&#160;&#160;&#160;(0x01B8U)</td></tr>
<tr class="memdesc:gaa5b8e84947e9bf1a7fb5d8003ef276bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for Shield Board CY8CKIT-028-EPD. <br /></td></tr>
<tr class="separator:gaa5b8e84947e9bf1a7fb5d8003ef276bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga40e8ea560bec96d98a8397308ce773cd"><td class="memItemLeft" align="right" valign="top"><a id="ga40e8ea560bec96d98a8397308ce773cd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga40e8ea560bec96d98a8397308ce773cd">CY_RSLT_MODULE_BOARD_SHIELD_028_TFT</a>&#160;&#160;&#160;(0x01B9U)</td></tr>
<tr class="memdesc:ga40e8ea560bec96d98a8397308ce773cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for Shield Board CY8CKIT-028-TFT. <br /></td></tr>
<tr class="separator:ga40e8ea560bec96d98a8397308ce773cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad3e437a0d81d24329914409b890d05e9"><td class="memItemLeft" align="right" valign="top"><a id="gad3e437a0d81d24329914409b890d05e9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#gad3e437a0d81d24329914409b890d05e9">CY_RSLT_MODULE_BOARD_SHIELD_032</a>&#160;&#160;&#160;(0x01BAU)</td></tr>
<tr class="memdesc:gad3e437a0d81d24329914409b890d05e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for Shield Board CY8CKIT-032. <br /></td></tr>
<tr class="separator:gad3e437a0d81d24329914409b890d05e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57f83cdac42fe9fc2afbe82609a00d74"><td class="memItemLeft" align="right" valign="top"><a id="ga57f83cdac42fe9fc2afbe82609a00d74"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga57f83cdac42fe9fc2afbe82609a00d74">CY_RSLT_MODULE_BOARD_HARDWARE_BASE</a>&#160;&#160;&#160;(0x01C0U)</td></tr>
<tr class="memdesc:ga57f83cdac42fe9fc2afbe82609a00d74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base module identifier for Board Hardware Libraries (0x01C0 - 0x01FF) <br /></td></tr>
<tr class="separator:ga57f83cdac42fe9fc2afbe82609a00d74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19d6abe548162ac238afbc69ace1a2d4"><td class="memItemLeft" align="right" valign="top"><a id="ga19d6abe548162ac238afbc69ace1a2d4"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga19d6abe548162ac238afbc69ace1a2d4">CY_RSLT_MODULE_BOARD_HARDWARE_BMI160</a>&#160;&#160;&#160;(0x01C0U)</td></tr>
<tr class="memdesc:ga19d6abe548162ac238afbc69ace1a2d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the BMI160 Motion Sensor Library. <br /></td></tr>
<tr class="separator:ga19d6abe548162ac238afbc69ace1a2d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36f615a1ecf7bba46416720e0892c115"><td class="memItemLeft" align="right" valign="top"><a id="ga36f615a1ecf7bba46416720e0892c115"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga36f615a1ecf7bba46416720e0892c115">CY_RSLT_MODULE_BOARD_HARDWARE_E2271CS021</a>&#160;&#160;&#160;(0x01C1U)</td></tr>
<tr class="memdesc:ga36f615a1ecf7bba46416720e0892c115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the E2271CS021 E-Ink Controller Library. <br /></td></tr>
<tr class="separator:ga36f615a1ecf7bba46416720e0892c115"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga052784c9e3c64b33e5d056aa1db57c59"><td class="memItemLeft" align="right" valign="top"><a id="ga052784c9e3c64b33e5d056aa1db57c59"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga052784c9e3c64b33e5d056aa1db57c59">CY_RSLT_MODULE_BOARD_HARDWARE_THERMISTOR</a>&#160;&#160;&#160;(0x01C2U)</td></tr>
<tr class="memdesc:ga052784c9e3c64b33e5d056aa1db57c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the NTC GPIO Thermistor Library. <br /></td></tr>
<tr class="separator:ga052784c9e3c64b33e5d056aa1db57c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9c77295c2fb9f887a857b8b63810f18d"><td class="memItemLeft" align="right" valign="top"><a id="ga9c77295c2fb9f887a857b8b63810f18d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga9c77295c2fb9f887a857b8b63810f18d">CY_RSLT_MODULE_BOARD_HARDWARE_SSD1306</a>&#160;&#160;&#160;(0x01C3U)</td></tr>
<tr class="memdesc:ga9c77295c2fb9f887a857b8b63810f18d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the SSD1306 OLED Controller Library. <br /></td></tr>
<tr class="separator:ga9c77295c2fb9f887a857b8b63810f18d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga646b094bb857dcf1bdf21448224f8b7a"><td class="memItemLeft" align="right" valign="top"><a id="ga646b094bb857dcf1bdf21448224f8b7a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga646b094bb857dcf1bdf21448224f8b7a">CY_RSLT_MODULE_BOARD_HARDWARE_ST7789V</a>&#160;&#160;&#160;(0x01C4U)</td></tr>
<tr class="memdesc:ga646b094bb857dcf1bdf21448224f8b7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the ST7789V TFT Controller Library. <br /></td></tr>
<tr class="separator:ga646b094bb857dcf1bdf21448224f8b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga929b1c06f7aa2a85ea6e3c317c3d5cf6"><td class="memItemLeft" align="right" valign="top"><a id="ga929b1c06f7aa2a85ea6e3c317c3d5cf6"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga929b1c06f7aa2a85ea6e3c317c3d5cf6">CY_RSLT_MODULE_BOARD_HARDWARE_LIGHT_SENSOR</a>&#160;&#160;&#160;(0x01C5U)</td></tr>
<tr class="memdesc:ga929b1c06f7aa2a85ea6e3c317c3d5cf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the Light Sensor Library. <br /></td></tr>
<tr class="separator:ga929b1c06f7aa2a85ea6e3c317c3d5cf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3cb51b341c4dac2984d76e0ab00056bb"><td class="memItemLeft" align="right" valign="top"><a id="ga3cb51b341c4dac2984d76e0ab00056bb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga3cb51b341c4dac2984d76e0ab00056bb">CY_RSLT_MODULE_BOARD_HARDWARE_AK4954A</a>&#160;&#160;&#160;(0x01C6U)</td></tr>
<tr class="memdesc:ga3cb51b341c4dac2984d76e0ab00056bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Module identifier for the AK4954A Audio Codec Library. <br /></td></tr>
<tr class="separator:ga3cb51b341c4dac2984d76e0ab00056bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2db34d05e5194f919d6cc45957dc5047"><td class="memItemLeft" align="right" valign="top"><a id="ga2db34d05e5194f919d6cc45957dc5047"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__result.html#ga2db34d05e5194f919d6cc45957dc5047">CY_RSLT_MODULE_MIDDLEWARE_BASE</a>&#160;&#160;&#160;(0x0200U)</td></tr>
<tr class="memdesc:ga2db34d05e5194f919d6cc45957dc5047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base module identifier for Middleware Libraries (0x0200 - 0x02FF) <br /></td></tr>
<tr class="separator:ga2db34d05e5194f919d6cc45957dc5047"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga9ae9b152a38632a9e0f8620845c6cea9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ae9b152a38632a9e0f8620845c6cea9">&#9670;&nbsp;</a></span>CY_RSLT_GET_TYPE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CY_RSLT_GET_TYPE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td>&#160;&#160;&#160;(((x) &gt;&gt; CY_RSLT_TYPE_POSITION) &amp; CY_RSLT_TYPE_MASK)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of the result type field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> value from which to extract the result type </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab959fc67da8489c03d3ab631442393b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab959fc67da8489c03d3ab631442393b4">&#9670;&nbsp;</a></span>CY_RSLT_GET_MODULE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CY_RSLT_GET_MODULE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td>&#160;&#160;&#160;(((x) &gt;&gt; CY_RSLT_MODULE_POSITION) &amp; CY_RSLT_MODULE_MASK)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of the module identifier field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> value from which to extract the module id </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5a7fc037210b7ff81c65160e11823443"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a7fc037210b7ff81c65160e11823443">&#9670;&nbsp;</a></span>CY_RSLT_GET_CODE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CY_RSLT_GET_CODE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">x</td><td>)</td>
<td>&#160;&#160;&#160;(((x) &gt;&gt; CY_RSLT_CODE_POSITION) &amp; CY_RSLT_CODE_MASK)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the value of the result code field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> value from which to extract the result code </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga711a53e03635b4f3e21c41aaf9459251"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga711a53e03635b4f3e21c41aaf9459251">&#9670;&nbsp;</a></span>CY_RSLT_CREATE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CY_RSLT_CREATE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">module, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">code&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">((((module) &amp; CY_RSLT_MODULE_MASK) &lt;&lt; CY_RSLT_MODULE_POSITION) | \</div><div class="line"> (((code) &amp; CY_RSLT_CODE_MASK) &lt;&lt; CY_RSLT_CODE_POSITION) | \</div><div class="line"> (((type) &amp; CY_RSLT_TYPE_MASK) &lt;&lt; CY_RSLT_TYPE_POSITION))</div></div><!-- fragment -->
<p>Create a new <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a> value that encodes the specified type, module, and result code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>one of <a class="el" href="group__group__result.html#ga611032ac7ceaccf05943b73868e13438">CY_RSLT_TYPE_INFO</a>, <a class="el" href="group__group__result.html#ga5aa8f2db241158e42052d8940045d2a0">CY_RSLT_TYPE_WARNING</a>, <a class="el" href="group__group__result.html#ga8d656d344524464af71296f2140a7b37">CY_RSLT_TYPE_ERROR</a>, <a class="el" href="group__group__result.html#ga2bc4a48af22980d72766f825eda62658">CY_RSLT_TYPE_FATAL</a> </td></tr>
<tr><td class="paramname">module</td><td>Identifies the module where this result originated; see <a class="el" href="group__group__result.html#anchor_modules">Modules</a>. </td></tr>
<tr><td class="paramname">code</td><td>a module-defined identifier to identify the specific situation that this result describes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaba8505defe4e04a5927b6e0590e256f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaba8505defe4e04a5927b6e0590e256f0">&#9670;&nbsp;</a></span>CY_RSLT_MODULE_ABSTRACTION_HAL_BASE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CY_RSLT_MODULE_ABSTRACTION_HAL_BASE&#160;&#160;&#160;(0x0100U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated. </p>
<p>Use <a class="el" href="group__group__result.html#gada155710418c5225c8ccaa8e75e9a577">CY_RSLT_MODULE_ABSTRACTION_HAL</a> </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gaca79700fcc701534ce61778a9bcf57d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca79700fcc701534ce61778a9bcf57d1">&#9670;&nbsp;</a></span>cy_rslt_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t <a class="el" href="group__group__result.html#gaca79700fcc701534ce61778a9bcf57d1">cy_rslt_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the result of an operation as a structured bitfield. </p>
<p>See the <a class="el" href="group__group__result.html#anchor_general_description">General Description</a> for more details on structure and usage. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
<ul>
<li class="footer">
Generated for <b>Hardware Abstraction Layer (HAL)</b> by <b>Cypress Semiconductor Corporation</b>.
All rights reserved.
</li>
</ul>
</div>
-->
</body>
</html>