stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/lib/bsp/xilkernel/doc/html/api/os__config_8h.html
Jagannadha Sutradharudu Teki 2c8f92039d embeddesw: Add initial code support 
Added initial support Xilinx Embedded Software.

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30

333 lines
15 KiB
HTML
Executable file
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>2014.1_doc: os_config.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_U_3A_2Fdoxygen_5Fpublish_2Fsources_2Fbsp_2Fxilkernel_5Fv6_5F0_2Fsrc_2Finclude_2F.html">include</a></div>
<h1>os_config.h File Reference</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fba5b10e3f4bc5c83124ccada35b8e19"></a><!-- doxytag: member="os_config.h::TIMER_TICKS" ref="fba5b10e3f4bc5c83124ccada35b8e19" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#fba5b10e3f4bc5c83124ccada35b8e19">TIMER_TICKS</a>&nbsp;&nbsp;&nbsp;2</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timer ticks value used for scheduling. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#a3f397507cfbdb8648ac2c74a2bdd0fe">MAX_PROCS</a>&nbsp;&nbsp;&nbsp;10</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#d1268e83351d0265c9e3643481dc35a2">MAX_READYQ</a>&nbsp;&nbsp;&nbsp;10</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#403b797a237f25844560747502d2aada">SCHED_TYPE</a>&nbsp;&nbsp;&nbsp;3</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#317b827d129b3a127b8beb9599107858">CONFIG_ELF_PROCESS</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#a4ffbc982c7b91f0666de0009c5b0b45">CONFIG_PTHREAD_SUPPORT</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#f22cd184563084e19cb2a5e891d923c6">CONFIG_SEMA</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include the Semapore module. <a href="#f22cd184563084e19cb2a5e891d923c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#45bca281a003022e5c298909663346ac">CONFIG_PTHREAD_MUTEX</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include the Mutex module. <a href="#45bca281a003022e5c298909663346ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#7747c1a068e54a8183e919690260beae">CONFIG_MSGQ</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Include the Message Queue functionality. <a href="#7747c1a068e54a8183e919690260beae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#22a1f2dacc87820a0f48bf7277bd00ef">CONFIG_SHM</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#af2a4696b7be276ce33d17029453b45f">CONFIG_MALLOC</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#2fcc480aca1b62a7047acf1deb083598">CONFIG_CACHE</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d404652e5b817a0d377f31056ba20e1c"></a><!-- doxytag: member="os_config.h::CONFIG_TIMERS" ref="d404652e5b817a0d377f31056ba20e1c" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#d404652e5b817a0d377f31056ba20e1c">CONFIG_TIMERS</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configure timer functionality. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb991565d9c12b6ba8e177675e8d3b90"></a><!-- doxytag: member="os_config.h::CONFIG_BASE_VECTORS" ref="fb991565d9c12b6ba8e177675e8d3b90" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="os__config_8h.html#fb991565d9c12b6ba8e177675e8d3b90">CONFIG_BASE_VECTORS</a>&nbsp;&nbsp;&nbsp;0x00000000</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vector base address. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This file caontains all the configuration define's for the system. The different modules of the kernel can be configured by changing this file and recompiling the kernel. Some of the modules that are configurable are:<ul>
<li>Process Management</li><li>Thread Management</li><li>Scheduling type</li><li>Semaphore</li><li>Message Queue</li><li>Shared Memory</li><li>Dynamic Buffer Management</li></ul>
<p>
By recompiling, the kernel gets compiled with the defaults for each modules. To further configure the kernel changes may have to be made in the following files:<ul>
<li><a class="el" href="config__param_8h.html">config_param.h</a></li><li><a class="el" href="config__cparam_8h.html">config_cparam.h</a></li><li><a class="el" href="config__init_8h.html">config_init.h</a> </li></ul>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="2fcc480aca1b62a7047acf1deb083598"></a><!-- doxytag: member="os_config.h::CONFIG_CACHE" ref="2fcc480aca1b62a7047acf1deb083598" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_CACHE&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Cache Enable For PPC only Further configuration can be done by modifying sys/main.c Enable caches </td>
</tr>
</table>
<a class="anchor" name="317b827d129b3a127b8beb9599107858"></a><!-- doxytag: member="os_config.h::CONFIG_ELF_PROCESS" ref="317b827d129b3a127b8beb9599107858" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_ELF_PROCESS&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
ELF Process Management Further configuration of this module can be done by modifying <a class="el" href="config__param_8h.html">config_param.h</a>. </td>
</tr>
</table>
<a class="anchor" name="af2a4696b7be276ce33d17029453b45f"></a><!-- doxytag: member="os_config.h::CONFIG_MALLOC" ref="af2a4696b7be276ce33d17029453b45f" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_MALLOC&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Dynamic Buffer Management Further configuration of this module can be done by modifying <a class="el" href="config__cparam_8h.html">config_cparam.h</a> and sys/init.c. Include the Dynamic buffer management functionality. </td>
</tr>
</table>
<a class="anchor" name="7747c1a068e54a8183e919690260beae"></a><!-- doxytag: member="os_config.h::CONFIG_MSGQ" ref="7747c1a068e54a8183e919690260beae" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_MSGQ&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Include the Message Queue functionality.
<p>
Message Queue Further configuration of this module can be done by modifying <a class="el" href="config__cparam_8h.html">config_cparam.h</a> and sys/init.c. </td>
</tr>
</table>
<a class="anchor" name="45bca281a003022e5c298909663346ac"></a><!-- doxytag: member="os_config.h::CONFIG_PTHREAD_MUTEX" ref="45bca281a003022e5c298909663346ac" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_PTHREAD_MUTEX&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Include the Mutex module.
<p>
pthread mutex Further configuration of this module can be done by modifying <a class="el" href="config__param_8h.html">config_param.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a4ffbc982c7b91f0666de0009c5b0b45"></a><!-- doxytag: member="os_config.h::CONFIG_PTHREAD_SUPPORT" ref="a4ffbc982c7b91f0666de0009c5b0b45" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_PTHREAD_SUPPORT&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Thread Management Further configuration of this module can be done by modifying <a class="el" href="config__param_8h.html">config_param.h</a>. </td>
</tr>
</table>
<a class="anchor" name="f22cd184563084e19cb2a5e891d923c6"></a><!-- doxytag: member="os_config.h::CONFIG_SEMA" ref="f22cd184563084e19cb2a5e891d923c6" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_SEMA&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Include the Semapore module.
<p>
Semaphore Further configuration of this module can be done by modifying <a class="el" href="config__param_8h.html">config_param.h</a>. </td>
</tr>
</table>
<a class="anchor" name="22a1f2dacc87820a0f48bf7277bd00ef"></a><!-- doxytag: member="os_config.h::CONFIG_SHM" ref="22a1f2dacc87820a0f48bf7277bd00ef" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define CONFIG_SHM&nbsp;&nbsp;&nbsp;1 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Shared Memory Further configuration of this module can be done by modifying <a class="el" href="config__cparam_8h.html">config_cparam.h</a> and sys/init.c. Include the Shared Memory Functionality </td>
</tr>
</table>
<a class="anchor" name="a3f397507cfbdb8648ac2c74a2bdd0fe"></a><!-- doxytag: member="os_config.h::MAX_PROCS" ref="a3f397507cfbdb8648ac2c74a2bdd0fe" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define MAX_PROCS&nbsp;&nbsp;&nbsp;10 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Process Management. Further configuration of this module can be done by modifying <a class="el" href="config__param_8h.html">config_param.h</a>. The initial system processes are specified in sys/init.c file. </td>
</tr>
</table>
<a class="anchor" name="d1268e83351d0265c9e3643481dc35a2"></a><!-- doxytag: member="os_config.h::MAX_READYQ" ref="d1268e83351d0265c9e3643481dc35a2" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define MAX_READYQ&nbsp;&nbsp;&nbsp;10 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Max. number of Processes in each Priority ready queue. This determines the size of the Ready Queue. This is determined by the type of application. </td>
</tr>
</table>
<a class="anchor" name="403b797a237f25844560747502d2aada"></a><!-- doxytag: member="os_config.h::SCHED_TYPE" ref="403b797a237f25844560747502d2aada" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define SCHED_TYPE&nbsp;&nbsp;&nbsp;3 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Type of process scheduling. There two types of scheduling supported and can be configured during system build. </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Feb 13 14:46:24 2014 for 2014.1_doc by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink