uofw/group__Clockgen.html
2015-05-28 23:10:41 +00:00

379 lines
17 KiB
HTML

<!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"/>
<title>uOFW: Clockgen Module</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">uOFW
</div>
<div id="projectbrief">Reverse engineered PSP kernel 6.60.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Clockgen Module</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga97954aafe7bb6e94625f7dba8d36875b">sceClockgenSetup</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga398e118119f3c1694a1ae53647052828">sceClockgenSetSpectrumSpreading</a> (s32 mode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#gad23a070a8ed72ae0ff833bc60ad7772d">sceClockgenInit</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#gaa08d7cafa3a8aec90c2b50deab238599">sceClockgenEnd</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga5332cdfdbc8a278f80e5459b586ea308">sceClockgenSetProtocol</a> (u32 prot)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga277df285f8d5acab0f745ab3c1afbc8c">sceClockgenGetRevision</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#gabf906219aee75da899a55d9302941fa7">sceClockgenGetRegValue</a> (u32 idx)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga60020ebc68fb8e64aec301c42686a573">sceClockgenAudioClkSetFreq</a> (u32 freq)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#gab8e470deb2df78e279ebb386de2d0aab">sceClockgenAudioClkEnable</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga401a8802a15c9df3699beaff0bc6679e">sceClockgenAudioClkDisable</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga38f2955e342cfde58cdc05aafcbf09fc">sceClockgenLeptonClkEnable</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Clockgen.html#ga99a6b886efaf0be8456ef06b3c2cdc11">sceClockgenLeptonClkDisable</a> (void)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Clock generator management. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga97954aafe7bb6e94625f7dba8d36875b"></a><!-- doxytag: member="clockgen.h::sceClockgenSetup" ref="ga97954aafe7bb6e94625f7dba8d36875b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga97954aafe7bb6e94625f7dba8d36875b">sceClockgenSetup</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setups the module by retrieving all hardware registers to memory.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0 on error. </dd></dl>
</div>
</div>
<a class="anchor" id="ga398e118119f3c1694a1ae53647052828"></a><!-- doxytag: member="clockgen.h::sceClockgenSetSpectrumSpreading" ref="ga398e118119f3c1694a1ae53647052828" args="(s32 mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga398e118119f3c1694a1ae53647052828">sceClockgenSetSpectrumSpreading</a> </td>
<td>(</td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the spectrum spreading mode.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>The new spectrum spreading mode. Unknown unit.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0 on error. </dd></dl>
</div>
</div>
<a class="anchor" id="gad23a070a8ed72ae0ff833bc60ad7772d"></a><!-- doxytag: member="clockgen.h::sceClockgenInit" ref="gad23a070a8ed72ae0ff833bc60ad7772d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#gad23a070a8ed72ae0ff833bc60ad7772d">sceClockgenInit</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inits the module.</p>
<p>Sets up the I2C bus speed, creates the mutex and registers the sysevent handler.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0 on error. </dd></dl>
</div>
</div>
<a class="anchor" id="gaa08d7cafa3a8aec90c2b50deab238599"></a><!-- doxytag: member="clockgen.h::sceClockgenEnd" ref="gaa08d7cafa3a8aec90c2b50deab238599" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#gaa08d7cafa3a8aec90c2b50deab238599">sceClockgenEnd</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Terminates the module.</p>
<p>Deletes the mutex and unregisters the sysevent handler.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5332cdfdbc8a278f80e5459b586ea308"></a><!-- doxytag: member="clockgen.h::sceClockgenSetProtocol" ref="ga5332cdfdbc8a278f80e5459b586ea308" args="(u32 prot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga5332cdfdbc8a278f80e5459b586ea308">sceClockgenSetProtocol</a> </td>
<td>(</td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>prot</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the protocol.</p>
<p>Changes the behavior of <a class="el" href="group__Clockgen.html#ga97954aafe7bb6e94625f7dba8d36875b">sceClockgenSetup()</a>. Non-zero will retrieve the hardware registers with a single command.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">prot</td><td>Boolean.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK. </dd></dl>
</div>
</div>
<a class="anchor" id="ga277df285f8d5acab0f745ab3c1afbc8c"></a><!-- doxytag: member="clockgen.h::sceClockgenGetRevision" ref="ga277df285f8d5acab0f745ab3c1afbc8c" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga277df285f8d5acab0f745ab3c1afbc8c">sceClockgenGetRevision</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the CY27040 chip revision.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Likely 3, 4, 7, 8, 9, 10 or 15. Another value may indicate that you work at SCE. </dd></dl>
</div>
</div>
<a class="anchor" id="gabf906219aee75da899a55d9302941fa7"></a><!-- doxytag: member="clockgen.h::sceClockgenGetRegValue" ref="gabf906219aee75da899a55d9302941fa7" args="(u32 idx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#gabf906219aee75da899a55d9302941fa7">sceClockgenGetRegValue</a> </td>
<td>(</td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>idx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the CY27040 hardware register value as stored in memory.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>An index where 0 &lt;= idx &lt; 3.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The register value, otherwise &lt;0. </dd></dl>
</div>
</div>
<a class="anchor" id="ga60020ebc68fb8e64aec301c42686a573"></a><!-- doxytag: member="clockgen.h::sceClockgenAudioClkSetFreq" ref="ga60020ebc68fb8e64aec301c42686a573" args="(u32 freq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga60020ebc68fb8e64aec301c42686a573">sceClockgenAudioClkSetFreq</a> </td>
<td>(</td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>freq</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the audio clock frequency.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">freq</td><td>A sample rate frequency in Hz. 44100 or 48000.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0. </dd></dl>
</div>
</div>
<a class="anchor" id="gab8e470deb2df78e279ebb386de2d0aab"></a><!-- doxytag: member="clockgen.h::sceClockgenAudioClkEnable" ref="gab8e470deb2df78e279ebb386de2d0aab" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#gab8e470deb2df78e279ebb386de2d0aab">sceClockgenAudioClkEnable</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables the audio clock.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0. </dd></dl>
</div>
</div>
<a class="anchor" id="ga401a8802a15c9df3699beaff0bc6679e"></a><!-- doxytag: member="clockgen.h::sceClockgenAudioClkDisable" ref="ga401a8802a15c9df3699beaff0bc6679e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga401a8802a15c9df3699beaff0bc6679e">sceClockgenAudioClkDisable</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disables the audio clock.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0. </dd></dl>
</div>
</div>
<a class="anchor" id="ga38f2955e342cfde58cdc05aafcbf09fc"></a><!-- doxytag: member="clockgen.h::sceClockgenLeptonClkEnable" ref="ga38f2955e342cfde58cdc05aafcbf09fc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga38f2955e342cfde58cdc05aafcbf09fc">sceClockgenLeptonClkEnable</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enables the lepton clock (managing the UMD reader).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0. </dd></dl>
</div>
</div>
<a class="anchor" id="ga99a6b886efaf0be8456ef06b3c2cdc11"></a><!-- doxytag: member="clockgen.h::sceClockgenLeptonClkDisable" ref="ga99a6b886efaf0be8456ef06b3c2cdc11" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">s32 <a class="el" href="group__Clockgen.html#ga99a6b886efaf0be8456ef06b3c2cdc11">sceClockgenLeptonClkDisable</a> </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disables the lepton clock (managing the UMD reader).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>SCE_ERROR_OK, otherwise &lt;0. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></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>
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 28 2015 23:10:39 for uOFW by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>