2022-04-08 14:46:35 +00:00
<!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.5" / >
2023-11-30 12:55:00 +00:00
< title > MCUXpresso SDK API Reference Manual: SGTL5000 Driver< / title >
2022-04-08 14:46:35 +00:00
< 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 = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
$(window).load(resizeHeight);
< / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "customdoxygen.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" > < img alt = "Logo" src = "fs_logo.gif" / > < / td >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > MCUXpresso SDK API Reference Manual
2024-03-18 15:15:10 +00:00
  < span id = "projectnumber" > Rev 2.15.000< / span >
2022-04-08 14:46:35 +00:00
< / div >
< div id = "projectbrief" > NXP Semiconductors< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
< 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  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related  Pages< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > API  Reference< / 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 > <!-- 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" >
$(document).ready(function(){initNavTree('a00073.html','');});
< / 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)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Data Structures< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Pages< / 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 >
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#define-members" > Macros< / a > |
2024-03-18 15:15:10 +00:00
< a href = "#typedef-members" > Typedefs< / a > |
2022-04-08 14:46:35 +00:00
< a href = "#enum-members" > Enumerations< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
2023-11-30 12:55:00 +00:00
< div class = "title" > SGTL5000 Driver< div class = "ingroups" > < a class = "el" href = "a00299.html" > CODEC Driver< / a > < / div > < / div > < / div >
2022-04-08 14:46:35 +00:00
< / div > <!-- header -->
< div class = "contents" >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Overview< / h2 >
2023-11-30 12:55:00 +00:00
< p > The sgtl5000 driver provides a codec control interface. < / p >
2022-04-08 14:46:35 +00:00
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:a00519" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a00519" > _sgtl_audio_format< / a > < / td > < / tr >
< tr class = "memdesc:a00519" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Audio format configuration. < a href = "a00073.html#a00519" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a00519" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a00520" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a00520" > _sgtl_config< / a > < / td > < / tr >
< tr class = "memdesc:a00520" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initailize structure of sgtl5000. < a href = "a00073.html#a00520" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a00520" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a00521" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a00521" > _sgtl_handle< / a > < / td > < / tr >
< tr class = "memdesc:a00521" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > SGTL codec handler. < a href = "a00073.html#a00521" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a00521" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "define-members" > < / a >
Macros< / h2 > < / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memitem:gab0aa3e54cd2934b67b9882957456c391" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gab0aa3e54cd2934b67b9882957456c391" > CHIP_ID< / a >       0x0000U< / td > < / tr >
< tr class = "memdesc:gab0aa3e54cd2934b67b9882957456c391" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Define the register address of sgtl5000. < a href = "#gab0aa3e54cd2934b67b9882957456c391" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gab0aa3e54cd2934b67b9882957456c391" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga5b4c16e15a52d1a940e4d47bf3574752" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga5b4c16e15a52d1a940e4d47bf3574752" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga5b4c16e15a52d1a940e4d47bf3574752" > SGTL5000_HEADPHONE_MAX_VOLUME_VALUE< / a >       0x7FU< / td > < / tr >
< tr class = "memdesc:ga5b4c16e15a52d1a940e4d47bf3574752" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > SGTL5000 volume setting range. < br / > < / td > < / tr >
< tr class = "separator:ga5b4c16e15a52d1a940e4d47bf3574752" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga58ceb20f920b2b006c74eeeae992830a" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga58ceb20f920b2b006c74eeeae992830a" > SGTL5000_I2C_ADDR< / a >       0x0A< / td > < / tr >
< tr class = "memdesc:ga58ceb20f920b2b006c74eeeae992830a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > SGTL5000 I2C address. < a href = "#ga58ceb20f920b2b006c74eeeae992830a" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga58ceb20f920b2b006c74eeeae992830a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga5a006451f9e990a4d3255ed7265ff1ad" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga5a006451f9e990a4d3255ed7265ff1ad" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga5a006451f9e990a4d3255ed7265ff1ad" > SGTL_I2C_HANDLER_SIZE< / a >       < a class = "el" href = "a00015.html#ga708be0fda3516367fe0461a5f054118c" > CODEC_I2C_MASTER_HANDLER_SIZE< / a > < / td > < / tr >
< tr class = "memdesc:ga5a006451f9e990a4d3255ed7265ff1ad" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl handle size < br / > < / td > < / tr >
< tr class = "separator:ga5a006451f9e990a4d3255ed7265ff1ad" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga7bf82c8b0e6415457b6f42f50af4230d" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga7bf82c8b0e6415457b6f42f50af4230d" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga7bf82c8b0e6415457b6f42f50af4230d" > SGTL_I2C_BITRATE< / a >       100000U< / td > < / tr >
< tr class = "memdesc:ga7bf82c8b0e6415457b6f42f50af4230d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl i2c baudrate < br / > < / td > < / tr >
< tr class = "separator:ga7bf82c8b0e6415457b6f42f50af4230d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table > < table class = "memberdecls" >
2024-03-18 15:15:10 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
< tr class = "memitem:ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > < td class = "memItemLeft" align = "right" valign = "top" > typedef enum < a class = "el" href = "a00073.html#ga8f64b804a9c2ab9412f5a2aa348e0795" > _sgtl5000_module< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > < / td > < / tr >
< tr class = "memdesc:ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Modules in Sgtl5000 board. < a href = "#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga7d97f5b5552db956cdeb7ad0ec70efeb" > < td class = "memItemLeft" align = "right" valign = "top" > typedef enum < a class = "el" href = "a00073.html#ga2f39070b1aca54ecf0d46af5cda78cc1" > _sgtl_route< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga7d97f5b5552db956cdeb7ad0ec70efeb" > sgtl_route_t< / a > < / td > < / tr >
< tr class = "memdesc:ga7d97f5b5552db956cdeb7ad0ec70efeb" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sgtl5000 data route. < a href = "#ga7d97f5b5552db956cdeb7ad0ec70efeb" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga7d97f5b5552db956cdeb7ad0ec70efeb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gabb24e1c0a6f4f885b77508c575382082" > < td class = "memItemLeft" align = "right" valign = "top" > typedef enum < a class = "el" href = "a00073.html#ga8edcd60c410ff680100e07e7badbe7b3" > _sgtl_protocol< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gabb24e1c0a6f4f885b77508c575382082" > sgtl_protocol_t< / a > < / td > < / tr >
< tr class = "memdesc:gabb24e1c0a6f4f885b77508c575382082" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The audio data transfer protocol choice. < a href = "#gabb24e1c0a6f4f885b77508c575382082" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gabb24e1c0a6f4f885b77508c575382082" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaa442de703d57f173c868a86709eca130" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "gaa442de703d57f173c868a86709eca130" > < / a >
typedef enum < a class = "el" href = "a00073.html#ga4afcde26974cb123a18b38138dffbb71" > _sgtl_sclk_edge< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gaa442de703d57f173c868a86709eca130" > sgtl_sclk_edge_t< / a > < / td > < / tr >
< tr class = "memdesc:gaa442de703d57f173c868a86709eca130" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > SGTL SCLK valid edge. < br / > < / td > < / tr >
< tr class = "separator:gaa442de703d57f173c868a86709eca130" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gac39b9431fec36a8a0d2b18f44213b5c1" > < td class = "memItemLeft" align = "right" valign = "top" > typedef struct < a class = "el" href = "a00073.html#a00519" > _sgtl_audio_format< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gac39b9431fec36a8a0d2b18f44213b5c1" > sgtl_audio_format_t< / a > < / td > < / tr >
< tr class = "memdesc:gac39b9431fec36a8a0d2b18f44213b5c1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Audio format configuration. < a href = "#gac39b9431fec36a8a0d2b18f44213b5c1" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gac39b9431fec36a8a0d2b18f44213b5c1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga04f368cf5c75e66ff28894ec9194a2f8" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga04f368cf5c75e66ff28894ec9194a2f8" > < / a >
typedef struct < a class = "el" href = "a00073.html#a00520" > _sgtl_config< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga04f368cf5c75e66ff28894ec9194a2f8" > sgtl_config_t< / a > < / td > < / tr >
< tr class = "memdesc:ga04f368cf5c75e66ff28894ec9194a2f8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initailize structure of sgtl5000. < br / > < / td > < / tr >
< tr class = "separator:ga04f368cf5c75e66ff28894ec9194a2f8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga9460fe6fb4321e52ff2069361a6f8a12" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga9460fe6fb4321e52ff2069361a6f8a12" > < / a >
typedef struct < a class = "el" href = "a00073.html#a00521" > _sgtl_handle< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > < / td > < / tr >
< tr class = "memdesc:ga9460fe6fb4321e52ff2069361a6f8a12" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > SGTL codec handler. < br / > < / td > < / tr >
< tr class = "separator:ga9460fe6fb4321e52ff2069361a6f8a12" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
2022-04-08 14:46:35 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga8f64b804a9c2ab9412f5a2aa348e0795" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga8f64b804a9c2ab9412f5a2aa348e0795" > _sgtl5000_module< / a > { < br / >
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795aeff780e31f47de5bd4ae4f7c2247a943" > kSGTL_ModuleADC< / a > = 0x0,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795ac97955a1a57467c8a7a93629468c0ae5" > kSGTL_ModuleDAC< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795a6db304a2a1838b8733167b535efd1cc6" > kSGTL_ModuleDAP< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795a7c3ca8ea568a0109f5858469734f1f22" > kSGTL_ModuleHP< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795a5eec6607385362c2f1f67574f98bab7f" > kSGTL_ModuleI2SIN< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795ad549fbd25f776da2e48029e7defb136d" > kSGTL_ModuleI2SOUT< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795a3cf24e3ca184744b13ce10adb648afcd" > kSGTL_ModuleLineIn< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795a04e0f93df81aacf8114308d95703248f" > kSGTL_ModuleLineOut< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8f64b804a9c2ab9412f5a2aa348e0795a4d7e27445f7842c7d420a3621ac73e72" > kSGTL_ModuleMicin< / a >
2023-11-30 12:55:00 +00:00
< br / >
2022-04-08 14:46:35 +00:00
}< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memdesc:ga8f64b804a9c2ab9412f5a2aa348e0795" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Modules in Sgtl5000 board. < a href = "a00073.html#ga8f64b804a9c2ab9412f5a2aa348e0795" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8f64b804a9c2ab9412f5a2aa348e0795" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga2f39070b1aca54ecf0d46af5cda78cc1" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga2f39070b1aca54ecf0d46af5cda78cc1" > _sgtl_route< / a > { < br / >
    < a class = "el" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1a1ea39c5bbafcc616613e8755b70573e9" > kSGTL_RouteBypass< / a > = 0x0,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1ad379b8e67ddbbb27bc44c6d6f3cf7c0e" > kSGTL_RoutePlayback< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1ae11f7c67b7d1ab7e4dce3d927be7da00" > kSGTL_RoutePlaybackandRecord< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1ae79c7286d52a67b618e4e23a1f1306b6" > kSGTL_RoutePlaybackwithDAP< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1a53052344996dc1f90cf6457e2b81eb18" > kSGTL_RoutePlaybackwithDAPandRecord< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1a0c28a072be0500106b9b32a16f05f000" > kSGTL_RouteRecord< / a >
2023-11-30 12:55:00 +00:00
< br / >
2022-04-08 14:46:35 +00:00
}< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memdesc:ga2f39070b1aca54ecf0d46af5cda78cc1" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sgtl5000 data route. < a href = "a00073.html#ga2f39070b1aca54ecf0d46af5cda78cc1" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga2f39070b1aca54ecf0d46af5cda78cc1" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga8edcd60c410ff680100e07e7badbe7b3" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga8edcd60c410ff680100e07e7badbe7b3" > _sgtl_protocol< / a > { < br / >
    < a class = "el" href = "a00073.html#gga8edcd60c410ff680100e07e7badbe7b3ab56aded98ae08bb3dd4c431e036eb9b7" > kSGTL_BusI2S< / a > = 0x0,
2022-04-08 14:46:35 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8edcd60c410ff680100e07e7badbe7b3a99d80a1bbb2ca42f8d8b9ded7d0fe156" > kSGTL_BusLeftJustified< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8edcd60c410ff680100e07e7badbe7b3a742196d31e1ede4eb6d0b1bd6afcdc50" > kSGTL_BusRightJustified< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8edcd60c410ff680100e07e7badbe7b3aae65c2ae38164483661ce81683e2cf6d" > kSGTL_BusPCMA< / a > ,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga8edcd60c410ff680100e07e7badbe7b3a165348d47026247f859a40813f449cfd" > kSGTL_BusPCMB< / a >
2022-04-08 14:46:35 +00:00
< br / >
}< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memdesc:ga8edcd60c410ff680100e07e7badbe7b3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The audio data transfer protocol choice. < a href = "a00073.html#ga8edcd60c410ff680100e07e7badbe7b3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8edcd60c410ff680100e07e7badbe7b3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memitem:ga97f905ac94bfebd46e50e32c7389e6eb" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > { < br / >
    < a class = "el" href = "a00073.html#gga97f905ac94bfebd46e50e32c7389e6eba4438d9d23b966a384697ac3959ec180c" > kSGTL_HeadphoneLeft< / a > = 0,
< br / >
    < a class = "el" href = "a00073.html#gga97f905ac94bfebd46e50e32c7389e6eba7c3a64195b071d4d17957f2de39a45a7" > kSGTL_HeadphoneRight< / a > = 1,
2022-04-08 14:46:35 +00:00
< br / >
2023-11-30 12:55:00 +00:00
    < a class = "el" href = "a00073.html#gga97f905ac94bfebd46e50e32c7389e6ebaea79ecce1f81bf12000fcf64671502ea" > kSGTL_LineoutLeft< / a > = 2,
2022-04-08 14:46:35 +00:00
< br / >
2023-11-30 12:55:00 +00:00
    < a class = "el" href = "a00073.html#gga97f905ac94bfebd46e50e32c7389e6ebabe25d4199f174f03f271a2ac335904bb" > kSGTL_LineoutRight< / a > = 3
2022-04-08 14:46:35 +00:00
< br / >
}< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga97f905ac94bfebd46e50e32c7389e6eb" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl play channel < a href = "a00073.html#ga97f905ac94bfebd46e50e32c7389e6eb" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga97f905ac94bfebd46e50e32c7389e6eb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga9b29769343da78881f442e657eb62b6e" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > { < br / >
    < a class = "el" href = "a00073.html#gga9b29769343da78881f442e657eb62b6ea358889525fbd4a6d5998c17a2382ac16" > kSGTL_RecordSourceLineIn< / a > = 0U,
< br / >
    < a class = "el" href = "a00073.html#gga9b29769343da78881f442e657eb62b6ea3c1289899ca6bdbe2ee24346890a19e2" > kSGTL_RecordSourceMic< / a > = 1U
< br / >
}< / td > < / tr >
< tr class = "memdesc:ga9b29769343da78881f442e657eb62b6e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl record source _sgtl_record_source < a href = "a00073.html#ga9b29769343da78881f442e657eb62b6e" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga9b29769343da78881f442e657eb62b6e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga1e8054db89feba236b2235d16d0bd1ad" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > { < br / >
    < a class = "el" href = "a00073.html#gga1e8054db89feba236b2235d16d0bd1adad99308b50ee139be94b584a66d999caf" > kSGTL_PlaySourceLineIn< / a > = 0U,
< br / >
    < a class = "el" href = "a00073.html#gga1e8054db89feba236b2235d16d0bd1ada9c7fa540632ee8e4c733fb4ccebc8601" > kSGTL_PlaySourceDAC< / a > = 1U
< br / >
}< / td > < / tr >
< tr class = "memdesc:ga1e8054db89feba236b2235d16d0bd1ad" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl play source _stgl_play_source < a href = "a00073.html#ga1e8054db89feba236b2235d16d0bd1ad" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga1e8054db89feba236b2235d16d0bd1ad" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga4afcde26974cb123a18b38138dffbb71" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga4afcde26974cb123a18b38138dffbb71" > _sgtl_sclk_edge< / a > { < br / >
    < a class = "el" href = "a00073.html#gga4afcde26974cb123a18b38138dffbb71aa89baee03025ca12e2fd8eb03909724c" > kSGTL_SclkValidEdgeRising< / a > = 0U,
2023-11-30 12:55:00 +00:00
< br / >
2024-03-18 15:15:10 +00:00
    < a class = "el" href = "a00073.html#gga4afcde26974cb123a18b38138dffbb71a0e8f446d380d7f3c859b68ffe5a64a08" > kSGTL_SclkValidEdgeFailling< / a > = 1U
2023-11-30 12:55:00 +00:00
< br / >
}< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memdesc:ga4afcde26974cb123a18b38138dffbb71" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > SGTL SCLK valid edge. < a href = "a00073.html#ga4afcde26974cb123a18b38138dffbb71" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga4afcde26974cb123a18b38138dffbb71" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga5dd1b8225b23f6e47c4abed5bf74709f" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga5dd1b8225b23f6e47c4abed5bf74709f" > SGTL_Init< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga04f368cf5c75e66ff28894ec9194a2f8" > sgtl_config_t< / a > *config)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga5dd1b8225b23f6e47c4abed5bf74709f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl5000 initialize function. < a href = "#ga5dd1b8225b23f6e47c4abed5bf74709f" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga5dd1b8225b23f6e47c4abed5bf74709f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga1ef9c339bf1ac795d7e5f3c42cebafb7" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga1ef9c339bf1ac795d7e5f3c42cebafb7" > SGTL_SetDataRoute< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga7d97f5b5552db956cdeb7ad0ec70efeb" > sgtl_route_t< / a > route)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga1ef9c339bf1ac795d7e5f3c42cebafb7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set audio data route in sgtl5000. < a href = "#ga1ef9c339bf1ac795d7e5f3c42cebafb7" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga1ef9c339bf1ac795d7e5f3c42cebafb7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga8087efbfa0ae9c2644d6191f441d9df0" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga8087efbfa0ae9c2644d6191f441d9df0" > SGTL_SetProtocol< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#gabb24e1c0a6f4f885b77508c575382082" > sgtl_protocol_t< / a > protocol)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga8087efbfa0ae9c2644d6191f441d9df0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the audio transfer protocol. < a href = "#ga8087efbfa0ae9c2644d6191f441d9df0" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8087efbfa0ae9c2644d6191f441d9df0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga872cb128c9d0445c60dee6dbc044c7b3" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga872cb128c9d0445c60dee6dbc044c7b3" > SGTL_SetMasterSlave< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, bool master)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga872cb128c9d0445c60dee6dbc044c7b3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set sgtl5000 as master or slave. < a href = "#ga872cb128c9d0445c60dee6dbc044c7b3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga872cb128c9d0445c60dee6dbc044c7b3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga88af855c5959f6d814bd8f8327e168d5" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga88af855c5959f6d814bd8f8327e168d5" > SGTL_SetVolume< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > module, uint32_t volume)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga88af855c5959f6d814bd8f8327e168d5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the volume of different modules in sgtl5000. < a href = "#ga88af855c5959f6d814bd8f8327e168d5" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga88af855c5959f6d814bd8f8327e168d5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga6d0af6998eff44ee5765988e05d68434" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga6d0af6998eff44ee5765988e05d68434" > SGTL_GetVolume< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > module)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga6d0af6998eff44ee5765988e05d68434" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the volume of different modules in sgtl5000. < a href = "#ga6d0af6998eff44ee5765988e05d68434" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga6d0af6998eff44ee5765988e05d68434" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga4c3a087636393265417c9435b6fc57c2" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga4c3a087636393265417c9435b6fc57c2" > SGTL_SetMute< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > module, bool mute)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga4c3a087636393265417c9435b6fc57c2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Mute/unmute modules in sgtl5000. < a href = "#ga4c3a087636393265417c9435b6fc57c2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga4c3a087636393265417c9435b6fc57c2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga51bf307e712104f5942d4cf64c60e624" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga51bf307e712104f5942d4cf64c60e624" > SGTL_EnableModule< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > module)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga51bf307e712104f5942d4cf64c60e624" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Enable expected devices. < a href = "#ga51bf307e712104f5942d4cf64c60e624" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga51bf307e712104f5942d4cf64c60e624" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga26a3dba16af7a79e072f71d179dc00e6" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga26a3dba16af7a79e072f71d179dc00e6" > SGTL_DisableModule< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > module)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga26a3dba16af7a79e072f71d179dc00e6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Disable expected devices. < a href = "#ga26a3dba16af7a79e072f71d179dc00e6" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga26a3dba16af7a79e072f71d179dc00e6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga27221640262b10948a03f3178e379814" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga27221640262b10948a03f3178e379814" > SGTL_Deinit< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga27221640262b10948a03f3178e379814" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Deinit the sgtl5000 codec. < a href = "#ga27221640262b10948a03f3178e379814" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga27221640262b10948a03f3178e379814" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga120c853dc3a86f5c70c4fbef309b6ef5" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga120c853dc3a86f5c70c4fbef309b6ef5" > SGTL_ConfigDataFormat< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, uint32_t mclk, uint32_t sample_rate, uint32_t bits)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga120c853dc3a86f5c70c4fbef309b6ef5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Configure the data format of audio data. < a href = "#ga120c853dc3a86f5c70c4fbef309b6ef5" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga120c853dc3a86f5c70c4fbef309b6ef5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga3052a63c17bdfdfeac94d1011434af5d" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga3052a63c17bdfdfeac94d1011434af5d" > SGTL_SetPlay< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, uint32_t playSource)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga3052a63c17bdfdfeac94d1011434af5d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > select SGTL codec play source. < a href = "#ga3052a63c17bdfdfeac94d1011434af5d" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga3052a63c17bdfdfeac94d1011434af5d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:gaf929ad37a6dd584cd5f17d52560ef7df" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gaf929ad37a6dd584cd5f17d52560ef7df" > SGTL_SetRecord< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, uint32_t recordSource)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:gaf929ad37a6dd584cd5f17d52560ef7df" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > select SGTL codec record source. < a href = "#gaf929ad37a6dd584cd5f17d52560ef7df" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaf929ad37a6dd584cd5f17d52560ef7df" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga1f0eb0cad0476f34f65811b99d58752f" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga1f0eb0cad0476f34f65811b99d58752f" > SGTL_WriteReg< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, uint16_t reg, uint16_t val)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga1f0eb0cad0476f34f65811b99d58752f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Write register to sgtl using I2C. < a href = "#ga1f0eb0cad0476f34f65811b99d58752f" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga1f0eb0cad0476f34f65811b99d58752f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:gad044b5a578bac8480229730d610f22b6" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gad044b5a578bac8480229730d610f22b6" > SGTL_ReadReg< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, uint16_t reg, uint16_t *val)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:gad044b5a578bac8480229730d610f22b6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Read register from sgtl using I2C. < a href = "#gad044b5a578bac8480229730d610f22b6" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gad044b5a578bac8480229730d610f22b6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ga43f1ac7cec503ad6e6ea178b6fb691ac" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ga43f1ac7cec503ad6e6ea178b6fb691ac" > SGTL_ModifyReg< / a > (< a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *handle, uint16_t reg, uint16_t clr_mask, uint16_t val)< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:ga43f1ac7cec503ad6e6ea178b6fb691ac" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Modify some bits in the register using I2C. < a href = "#ga43f1ac7cec503ad6e6ea178b6fb691ac" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga43f1ac7cec503ad6e6ea178b6fb691ac" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "member-group" > < / a >
Driver version< / h2 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:gacb25f9b960a10309cc4b9b2cb0f0c063" > < td class = "memItemLeft" align = "right" valign = "top" > #define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#gacb25f9b960a10309cc4b9b2cb0f0c063" > FSL_SGTL5000_DRIVER_VERSION< / a >       (< a class = "el" href = "a00272.html#ga812138aa3315b0c6953c1a26130bcc37" > MAKE_VERSION< / a > (2, 1, 1))< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr class = "memdesc:gacb25f9b960a10309cc4b9b2cb0f0c063" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CLOCK driver version 2.1.1. < a href = "#gacb25f9b960a10309cc4b9b2cb0f0c063" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gacb25f9b960a10309cc4b9b2cb0f0c063" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< hr / > < h2 class = "groupheader" > Data Structure Documentation< / h2 >
2024-03-18 15:15:10 +00:00
< a name = "a00519" id = "a00519" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > struct _sgtl_audio_format< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< div class = "textblock" > < / div > < table class = "memberdecls" >
< tr > < td colspan = "2" > < h3 > Data Fields< / h3 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:a38a947cae212e2c07c91e17ba432bced" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a38a947cae212e2c07c91e17ba432bced" > < / a >
uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a38a947cae212e2c07c91e17ba432bced" > mclk_HZ< / a > < / td > < / tr >
< tr class = "memdesc:a38a947cae212e2c07c91e17ba432bced" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > master clock < br / > < / td > < / tr >
< tr class = "separator:a38a947cae212e2c07c91e17ba432bced" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a0ac8e8cd01a893684b47e1434361d46d" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a0ac8e8cd01a893684b47e1434361d46d" > < / a >
uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a0ac8e8cd01a893684b47e1434361d46d" > sampleRate< / a > < / td > < / tr >
< tr class = "memdesc:a0ac8e8cd01a893684b47e1434361d46d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Sample rate. < br / > < / td > < / tr >
< tr class = "separator:a0ac8e8cd01a893684b47e1434361d46d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:adf36766a1bcbd3d5099ff71e0bb97334" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "adf36766a1bcbd3d5099ff71e0bb97334" > < / a >
uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#adf36766a1bcbd3d5099ff71e0bb97334" > bitWidth< / a > < / td > < / tr >
< tr class = "memdesc:adf36766a1bcbd3d5099ff71e0bb97334" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Bit width. < br / > < / td > < / tr >
< tr class = "separator:adf36766a1bcbd3d5099ff71e0bb97334" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:afa5919b175c7190ac1cb31951f295cf5" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "afa5919b175c7190ac1cb31951f295cf5" > < / a >
< a class = "el" href = "a00073.html#gaa442de703d57f173c868a86709eca130" > sgtl_sclk_edge_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#afa5919b175c7190ac1cb31951f295cf5" > sclkEdge< / a > < / td > < / tr >
< tr class = "memdesc:afa5919b175c7190ac1cb31951f295cf5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sclk valid edge < br / > < / td > < / tr >
< tr class = "separator:afa5919b175c7190ac1cb31951f295cf5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-30 12:55:00 +00:00
< / table >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2024-03-18 15:15:10 +00:00
< a name = "a00520" id = "a00520" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > struct _sgtl_config< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< div class = "textblock" > < / div > < table class = "memberdecls" >
< tr > < td colspan = "2" > < h3 > Data Fields< / h3 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:ae8e0a67de0bfb62cabceb62177a3a6c8" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00073.html#ga7d97f5b5552db956cdeb7ad0ec70efeb" > sgtl_route_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ae8e0a67de0bfb62cabceb62177a3a6c8" > route< / a > < / td > < / tr >
< tr class = "memdesc:ae8e0a67de0bfb62cabceb62177a3a6c8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Audio data route. < a href = "#ae8e0a67de0bfb62cabceb62177a3a6c8" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ae8e0a67de0bfb62cabceb62177a3a6c8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ab65d798b15243d3ea37fbefee94ff170" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ab65d798b15243d3ea37fbefee94ff170" > < / a >
< a class = "el" href = "a00073.html#gabb24e1c0a6f4f885b77508c575382082" > sgtl_protocol_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#ab65d798b15243d3ea37fbefee94ff170" > bus< / a > < / td > < / tr >
< tr class = "memdesc:ab65d798b15243d3ea37fbefee94ff170" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Audio transfer protocol. < br / > < / td > < / tr >
< tr class = "separator:ab65d798b15243d3ea37fbefee94ff170" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a4c46befc8581a0d5af0266950e2405a3" > < td class = "memItemLeft" align = "right" valign = "top" > bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a4c46befc8581a0d5af0266950e2405a3" > master_slave< / a > < / td > < / tr >
< tr class = "memdesc:a4c46befc8581a0d5af0266950e2405a3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Master or slave. < a href = "#a4c46befc8581a0d5af0266950e2405a3" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a4c46befc8581a0d5af0266950e2405a3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a960282a5a6515e911f2936b5eeed5b24" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a960282a5a6515e911f2936b5eeed5b24" > < / a >
< a class = "el" href = "a00073.html#gac39b9431fec36a8a0d2b18f44213b5c1" > sgtl_audio_format_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a960282a5a6515e911f2936b5eeed5b24" > format< / a > < / td > < / tr >
< tr class = "memdesc:a960282a5a6515e911f2936b5eeed5b24" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > audio format < br / > < / td > < / tr >
< tr class = "separator:a960282a5a6515e911f2936b5eeed5b24" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a2608b29dc436a7a3acbd067d95d59a87" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a2608b29dc436a7a3acbd067d95d59a87" > < / a >
uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a2608b29dc436a7a3acbd067d95d59a87" > slaveAddress< / a > < / td > < / tr >
< tr class = "memdesc:a2608b29dc436a7a3acbd067d95d59a87" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > code device slave address < br / > < / td > < / tr >
< tr class = "separator:a2608b29dc436a7a3acbd067d95d59a87" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a6f3c3705606cd36ed6122b5a0ce50128" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a6f3c3705606cd36ed6122b5a0ce50128" > < / a >
< a class = "el" href = "a00015.html#ga7cef6c41744cbf081437214aa3a6acec" > codec_i2c_config_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#a6f3c3705606cd36ed6122b5a0ce50128" > i2cConfig< / a > < / td > < / tr >
< tr class = "memdesc:a6f3c3705606cd36ed6122b5a0ce50128" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > i2c bus configuration < br / > < / td > < / tr >
< tr class = "separator:a6f3c3705606cd36ed6122b5a0ce50128" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< h4 class = "groupheader" > Field Documentation< / h4 >
2024-03-18 15:15:10 +00:00
< a class = "anchor" id = "ae8e0a67de0bfb62cabceb62177a3a6c8" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00073.html#ga7d97f5b5552db956cdeb7ad0ec70efeb" > sgtl_route_t< / a > _sgtl_config::route< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
2024-03-18 15:15:10 +00:00
< a class = "anchor" id = "a4c46befc8581a0d5af0266950e2405a3" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > bool _sgtl_config::master_slave< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > True means master, false means slave. < / p >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< / div >
< / div >
2024-03-18 15:15:10 +00:00
< a name = "a00521" id = "a00521" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > struct _sgtl_handle< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< div class = "textblock" > < / div > < table class = "memberdecls" >
< tr > < td colspan = "2" > < h3 > Data Fields< / h3 > < / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr class = "memitem:aff102977588ebfd7bb704fa6e78cbf04" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aff102977588ebfd7bb704fa6e78cbf04" > < / a >
< a class = "el" href = "a00073.html#ga04f368cf5c75e66ff28894ec9194a2f8" > sgtl_config_t< / a > *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#aff102977588ebfd7bb704fa6e78cbf04" > config< / a > < / td > < / tr >
< tr class = "memdesc:aff102977588ebfd7bb704fa6e78cbf04" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > sgtl config pointer < br / > < / td > < / tr >
< tr class = "separator:aff102977588ebfd7bb704fa6e78cbf04" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa947e0901c2f8abcc1389fd7756aafb8" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "aa947e0901c2f8abcc1389fd7756aafb8" > < / a >
uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00073.html#aa947e0901c2f8abcc1389fd7756aafb8" > i2cHandle< / a > [< a class = "el" href = "a00073.html#ga5a006451f9e990a4d3255ed7265ff1ad" > SGTL_I2C_HANDLER_SIZE< / a > ]< / td > < / tr >
< tr class = "memdesc:aa947e0901c2f8abcc1389fd7756aafb8" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > i2c handle < br / > < / td > < / tr >
< tr class = "separator:aa947e0901c2f8abcc1389fd7756aafb8" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-11-30 12:55:00 +00:00
< / table >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< h2 class = "groupheader" > Macro Definition Documentation< / h2 >
< a class = "anchor" id = "gacb25f9b960a10309cc4b9b2cb0f0c063" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > #define FSL_SGTL5000_DRIVER_VERSION      (< a class = "el" href = "a00272.html#ga812138aa3315b0c6953c1a26130bcc37" > MAKE_VERSION< / a > (2, 1, 1))< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "gab0aa3e54cd2934b67b9882957456c391" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > #define CHIP_ID      0x0000U< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga58ceb20f920b2b006c74eeeae992830a" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > #define SGTL5000_I2C_ADDR      0x0A< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2024-03-18 15:15:10 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
< a class = "anchor" id = "ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef enum < a class = "el" href = "a00073.html#ga8f64b804a9c2ab9412f5a2aa348e0795" > _sgtl5000_module< / a > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a class = "anchor" id = "ga7d97f5b5552db956cdeb7ad0ec70efeb" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef enum < a class = "el" href = "a00073.html#ga2f39070b1aca54ecf0d46af5cda78cc1" > _sgtl_route< / a > < a class = "el" href = "a00073.html#ga7d97f5b5552db956cdeb7ad0ec70efeb" > sgtl_route_t< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "section note" > < dt > Note< / dt > < dd > Only provide some typical data route, not all route listed. Users cannot combine any routes, once a new route is set, the precios one would be replaced. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gabb24e1c0a6f4f885b77508c575382082" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef enum < a class = "el" href = "a00073.html#ga8edcd60c410ff680100e07e7badbe7b3" > _sgtl_protocol< / a > < a class = "el" href = "a00073.html#gabb24e1c0a6f4f885b77508c575382082" > sgtl_protocol_t< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Sgtl5000 only supports I2S format and PCM format. < / p >
< / div >
< / div >
< a class = "anchor" id = "gac39b9431fec36a8a0d2b18f44213b5c1" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef struct < a class = "el" href = "a00073.html#a00519" > _sgtl_audio_format< / a > < a class = "el" href = "a00073.html#gac39b9431fec36a8a0d2b18f44213b5c1" > sgtl_audio_format_t< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< h2 class = "groupheader" > Enumeration Type Documentation< / h2 >
2024-03-18 15:15:10 +00:00
< a class = "anchor" id = "ga8f64b804a9c2ab9412f5a2aa348e0795" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > enum < a class = "el" href = "a00073.html#ga8f64b804a9c2ab9412f5a2aa348e0795" > _sgtl5000_module< / a > < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< table class = "fieldtable" >
2024-03-18 15:15:10 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795aeff780e31f47de5bd4ae4f7c2247a943" > < / a > kSGTL_ModuleADC< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > ADC module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795ac97955a1a57467c8a7a93629468c0ae5" > < / a > kSGTL_ModuleDAC< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > DAC module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795a6db304a2a1838b8733167b535efd1cc6" > < / a > kSGTL_ModuleDAP< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > DAP module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795a7c3ca8ea568a0109f5858469734f1f22" > < / a > kSGTL_ModuleHP< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > Headphone module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795a5eec6607385362c2f1f67574f98bab7f" > < / a > kSGTL_ModuleI2SIN< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2S-IN module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795ad549fbd25f776da2e48029e7defb136d" > < / a > kSGTL_ModuleI2SOUT< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2S-OUT module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795a3cf24e3ca184744b13ce10adb648afcd" > < / a > kSGTL_ModuleLineIn< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > Line-in moudle in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795a04e0f93df81aacf8114308d95703248f" > < / a > kSGTL_ModuleLineOut< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > Line-out module in SGTL5000. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8f64b804a9c2ab9412f5a2aa348e0795a4d7e27445f7842c7d420a3621ac73e72" > < / a > kSGTL_ModuleMicin< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > Micphone module in SGTL5000. < / p >
< / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / div >
< / div >
2024-03-18 15:15:10 +00:00
< a class = "anchor" id = "ga2f39070b1aca54ecf0d46af5cda78cc1" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > enum < a class = "el" href = "a00073.html#ga2f39070b1aca54ecf0d46af5cda78cc1" > _sgtl_route< / a > < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< dl class = "section note" > < dt > Note< / dt > < dd > Only provide some typical data route, not all route listed. Users cannot combine any routes, once a new route is set, the precios one would be replaced. < / dd > < / dl >
2022-04-08 14:46:35 +00:00
< table class = "fieldtable" >
2024-03-18 15:15:10 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga2f39070b1aca54ecf0d46af5cda78cc1a1ea39c5bbafcc616613e8755b70573e9" > < / a > kSGTL_RouteBypass< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > LINEIN-> Headphone. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga2f39070b1aca54ecf0d46af5cda78cc1ad379b8e67ddbbb27bc44c6d6f3cf7c0e" > < / a > kSGTL_RoutePlayback< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2SIN-> DAC-> Headphone. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga2f39070b1aca54ecf0d46af5cda78cc1ae11f7c67b7d1ab7e4dce3d927be7da00" > < / a > kSGTL_RoutePlaybackandRecord< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2SIN-> DAC-> Headphone, LINEIN-> ADC-> I2SOUT. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga2f39070b1aca54ecf0d46af5cda78cc1ae79c7286d52a67b618e4e23a1f1306b6" > < / a > kSGTL_RoutePlaybackwithDAP< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2SIN-> DAP-> DAC-> Headphone. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga2f39070b1aca54ecf0d46af5cda78cc1a53052344996dc1f90cf6457e2b81eb18" > < / a > kSGTL_RoutePlaybackwithDAPandRecord< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2SIN-> DAP-> DAC-> HP, LINEIN-> ADC-> I2SOUT. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga2f39070b1aca54ecf0d46af5cda78cc1a0c28a072be0500106b9b32a16f05f000" > < / a > kSGTL_RouteRecord< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > LINEIN-> ADC-> I2SOUT. < / p >
2022-04-08 14:46:35 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
2024-03-18 15:15:10 +00:00
< a class = "anchor" id = "ga8edcd60c410ff680100e07e7badbe7b3" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > enum < a class = "el" href = "a00073.html#ga8edcd60c410ff680100e07e7badbe7b3" > _sgtl_protocol< / a > < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > Sgtl5000 only supports I2S format and PCM format. < / p >
2022-04-08 14:46:35 +00:00
< table class = "fieldtable" >
2024-03-18 15:15:10 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8edcd60c410ff680100e07e7badbe7b3ab56aded98ae08bb3dd4c431e036eb9b7" > < / a > kSGTL_BusI2S< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > I2S Type. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8edcd60c410ff680100e07e7badbe7b3a99d80a1bbb2ca42f8d8b9ded7d0fe156" > < / a > kSGTL_BusLeftJustified< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > Left justified. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8edcd60c410ff680100e07e7badbe7b3a742196d31e1ede4eb6d0b1bd6afcdc50" > < / a > kSGTL_BusRightJustified< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > Right Justified. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8edcd60c410ff680100e07e7badbe7b3aae65c2ae38164483661ce81683e2cf6d" > < / a > kSGTL_BusPCMA< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > PCMA. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga8edcd60c410ff680100e07e7badbe7b3a165348d47026247f859a40813f449cfd" > < / a > kSGTL_BusPCMB< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > PCMB. < / p >
2022-04-08 14:46:35 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga97f905ac94bfebd46e50e32c7389e6eb" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > anonymous enum< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > < a class = "anchor" id = "_sgtl_play_channel" > < / a > < / p >
2022-04-08 14:46:35 +00:00
< table class = "fieldtable" >
2023-11-30 12:55:00 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga97f905ac94bfebd46e50e32c7389e6eba4438d9d23b966a384697ac3959ec180c" > < / a > kSGTL_HeadphoneLeft< / em > < / td > < td class = "fielddoc" >
< p > headphone left channel < / p >
2022-04-08 14:46:35 +00:00
< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga97f905ac94bfebd46e50e32c7389e6eba7c3a64195b071d4d17957f2de39a45a7" > < / a > kSGTL_HeadphoneRight< / em > < / td > < td class = "fielddoc" >
< p > headphone right channel < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga97f905ac94bfebd46e50e32c7389e6ebaea79ecce1f81bf12000fcf64671502ea" > < / a > kSGTL_LineoutLeft< / em > < / td > < td class = "fielddoc" >
< p > lineout left channel < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga97f905ac94bfebd46e50e32c7389e6ebabe25d4199f174f03f271a2ac335904bb" > < / a > kSGTL_LineoutRight< / em > < / td > < td class = "fielddoc" >
< p > lineout right channel < / p >
2022-04-08 14:46:35 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga9b29769343da78881f442e657eb62b6e" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > anonymous enum< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< table class = "fieldtable" >
2023-11-30 12:55:00 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga9b29769343da78881f442e657eb62b6ea358889525fbd4a6d5998c17a2382ac16" > < / a > kSGTL_RecordSourceLineIn< / em > < / td > < td class = "fielddoc" >
< p > record source line in < / p >
2022-04-08 14:46:35 +00:00
< / td > < / tr >
2023-11-30 12:55:00 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga9b29769343da78881f442e657eb62b6ea3c1289899ca6bdbe2ee24346890a19e2" > < / a > kSGTL_RecordSourceMic< / em > < / td > < td class = "fielddoc" >
< p > record source single end < / p >
2022-04-08 14:46:35 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga1e8054db89feba236b2235d16d0bd1ad" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > anonymous enum< / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< table class = "fieldtable" >
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga1e8054db89feba236b2235d16d0bd1adad99308b50ee139be94b584a66d999caf" > < / a > kSGTL_PlaySourceLineIn< / em > < / td > < td class = "fielddoc" >
< p > play source line in < / p >
< / td > < / tr >
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga1e8054db89feba236b2235d16d0bd1ada9c7fa540632ee8e4c733fb4ccebc8601" > < / a > kSGTL_PlaySourceDAC< / em > < / td > < td class = "fielddoc" >
< p > play source line in < / p >
< / td > < / tr >
< / table >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2024-03-18 15:15:10 +00:00
< a class = "anchor" id = "ga4afcde26974cb123a18b38138dffbb71" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > enum < a class = "el" href = "a00073.html#ga4afcde26974cb123a18b38138dffbb71" > _sgtl_sclk_edge< / a > < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< table class = "fieldtable" >
2024-03-18 15:15:10 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga4afcde26974cb123a18b38138dffbb71aa89baee03025ca12e2fd8eb03909724c" > < / a > kSGTL_SclkValidEdgeRising< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > SCLK valid edge. < / p >
< / td > < / tr >
2024-03-18 15:15:10 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga4afcde26974cb123a18b38138dffbb71a0e8f446d380d7f3c859b68ffe5a64a08" > < / a > kSGTL_SclkValidEdgeFailling< / em > < / td > < td class = "fielddoc" >
2023-11-30 12:55:00 +00:00
< p > SCLK failling edge. < / p >
< / td > < / tr >
< / table >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "ga5dd1b8225b23f6e47c4abed5bf74709f" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_Init < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga04f368cf5c75e66ff28894ec9194a2f8" > sgtl_config_t< / a > *  < / td >
2022-04-08 14:46:35 +00:00
< td class = "paramname" > < em > config< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > This function calls SGTL_I2CInit(), and in this function, some configurations are fixed. The second parameter can be NULL. If users want to change the SGTL5000 settings, a configure structure should be prepared. < / p >
< dl class = "section note" > < dt > Note< / dt > < dd > If the codec_config is NULL, it would initialize sgtl5000 using default settings. The default setting: < div class = "fragment" > < div class = "line" > * sgtl_init_t codec_config< / div >
2024-03-18 15:15:10 +00:00
< div class = "line" > * codec_config.route = < a class = "code" href = "a00073.html#gga2f39070b1aca54ecf0d46af5cda78cc1ae11f7c67b7d1ab7e4dce3d927be7da00" > kSGTL_RoutePlaybackandRecord< / a > < / div >
< div class = "line" > * codec_config.bus = < a class = "code" href = "a00073.html#gga8edcd60c410ff680100e07e7badbe7b3ab56aded98ae08bb3dd4c431e036eb9b7" > kSGTL_BusI2S< / a > < / div >
2023-11-30 12:55:00 +00:00
< div class = "line" > * codec_config.master = slave< / div >
2022-04-08 14:46:35 +00:00
< div class = "line" > * < / div >
2023-11-30 12:55:00 +00:00
< / div > <!-- fragment --> < / dd > < / dl >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2022-04-08 14:46:35 +00:00
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > config< / td > < td > sgtl5000 configuration structure. If this pointer equals to NULL, it means using the default configuration. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
2023-11-30 12:55:00 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > Initialization status < / dd > < / dl >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga1ef9c339bf1ac795d7e5f3c42cebafb7" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_SetDataRoute < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga7d97f5b5552db956cdeb7ad0ec70efeb" > sgtl_route_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > route< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > This function would set the data route according to route. The route cannot be combined, as all route would enable different modules.< / p >
< dl class = "section note" > < dt > Note< / dt > < dd > If a new route is set, the previous route would not work. < / dd > < / dl >
2022-04-08 14:46:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > route< / td > < td > Audio data route in sgtl5000. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga8087efbfa0ae9c2644d6191f441d9df0" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_SetProtocol < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#gabb24e1c0a6f4f885b77508c575382082" > sgtl_protocol_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > protocol< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > Sgtl5000 only supports I2S, I2S left, I2S right, PCM A, PCM B format. < / p >
2022-04-08 14:46:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > protocol< / td > < td > Audio data transfer protocol. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga872cb128c9d0445c60dee6dbc044c7b3" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > void SGTL_SetMasterSlave < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > master< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > master< / td > < td > 1 represent master, 0 represent slave. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga88af855c5959f6d814bd8f8327e168d5" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_SetVolume < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > module< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > volume< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > This function would set the volume of sgtl5000 modules. This interface set module volume. The function assume that left channel and right channel has the same volume.< / p >
< p > kSGTL_ModuleADC volume range: 0 - 0xF, 0dB - 22.5dB kSGTL_ModuleDAC volume range: 0x3C - 0xF0, 0dB - -90dB kSGTL_ModuleHP volume range: 0 - 0x7F, 12dB - -51.5dB kSGTL_ModuleLineOut volume range: 0 - 0x1F, 0.5dB steps< / p >
2022-04-08 14:46:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > Sgtl5000 module, such as DAC, ADC and etc. < / td > < / tr >
< tr > < td class = "paramname" > volume< / td > < td > Volume value need to be set. The value is the exact value in register. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga6d0af6998eff44ee5765988e05d68434" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "memname" > uint32_t SGTL_GetVolume < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > module< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > This function gets the volume of sgtl5000 modules. This interface get DAC module volume. The function assume that left channel and right channel has the same volume. < / p >
2022-04-08 14:46:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > Sgtl5000 module, such as DAC, ADC and etc. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
2023-11-30 12:55:00 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > Module value, the value is exact value in register. < / dd > < / dl >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga4c3a087636393265417c9435b6fc57c2" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_SetMute < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > module< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > mute< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > Sgtl5000 module, such as DAC, ADC and etc. < / td > < / tr >
< tr > < td class = "paramname" > mute< / td > < td > True means mute, and false means unmute. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga51bf307e712104f5942d4cf64c60e624" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_EnableModule < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
2022-04-08 14:46:35 +00:00
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > module< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td > )< / td >
< td > < / td > < td > < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > Module expected to enable. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga26a3dba16af7a79e072f71d179dc00e6" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_DisableModule < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga8daa03b90ec34beec5c4a9bcc5b0cbd3" > sgtl_module_t< / a >   < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > module< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > Module expected to enable. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga27221640262b10948a03f3178e379814" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_Deinit < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > < / td > < td > )< / td >
2022-04-08 14:46:35 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > Shut down Sgtl5000 modules. < / p >
2022-04-08 14:46:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure pointer. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga120c853dc3a86f5c70c4fbef309b6ef5" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_ConfigDataFormat < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "paramkey" > < / td >
2022-04-08 14:46:35 +00:00
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > mclk< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > sample_rate< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > bits< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2023-11-30 12:55:00 +00:00
< p > This function would configure the registers about the sample rate, bit depths. < / p >
2022-04-08 14:46:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure pointer. < / td > < / tr >
< tr > < td class = "paramname" > mclk< / td > < td > Master clock frequency of I2S. < / td > < / tr >
< tr > < td class = "paramname" > sample_rate< / td > < td > Sample rate of audio file running in sgtl5000. Sgtl5000 now supports 8k, 11.025k, 12k, 16k, 22.05k, 24k, 32k, 44.1k, 48k and 96k sample rate. < / td > < / tr >
< tr > < td class = "paramname" > bits< / td > < td > Bit depth of audio file (Sgtl5000 only supports 16bit, 20bit, 24bit and 32 bit in HW). < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga3052a63c17bdfdfeac94d1011434af5d" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_SetPlay < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
2022-04-08 14:46:35 +00:00
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playSource< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td > )< / td >
< td > < / td > < td > < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure pointer. < / td > < / tr >
< tr > < td class = "paramname" > playSource< / td > < td > play source value, reference _sgtl_play_source.< / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
2023-11-30 12:55:00 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success, else failed. < / dd > < / dl >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "gaf929ad37a6dd584cd5f17d52560ef7df" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_SetRecord < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > recordSource< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure pointer. < / td > < / tr >
< tr > < td class = "paramname" > recordSource< / td > < td > record source value, reference _sgtl_record_source.< / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
2023-11-30 12:55:00 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success, else failed. < / dd > < / dl >
2022-04-08 14:46:35 +00:00
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga1f0eb0cad0476f34f65811b99d58752f" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_WriteReg < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > reg< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > val< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > reg< / td > < td > The register address in sgtl. < / td > < / tr >
< tr > < td class = "paramname" > val< / td > < td > Value needs to write into the register. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "gad044b5a578bac8480229730d610f22b6" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_ReadReg < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > reg< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint16_t *  < / td >
< td class = "paramname" > < em > val< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > reg< / td > < td > The register address in sgtl. < / td > < / tr >
< tr > < td class = "paramname" > val< / td > < td > Value written to. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-11-30 12:55:00 +00:00
< a class = "anchor" id = "ga43f1ac7cec503ad6e6ea178b6fb691ac" > < / a >
2022-04-08 14:46:35 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-18 15:15:10 +00:00
< td class = "memname" > < a class = "el" href = "a00272.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > SGTL_ModifyReg < / td >
2022-04-08 14:46:35 +00:00
< td > (< / td >
2024-03-18 15:15:10 +00:00
< td class = "paramtype" > < a class = "el" href = "a00073.html#ga9460fe6fb4321e52ff2069361a6f8a12" > sgtl_handle_t< / a > *  < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > reg< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
2023-11-30 12:55:00 +00:00
< td class = "paramkey" > < / td >
2022-04-08 14:46:35 +00:00
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > clr_mask< / em > , < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-11-30 12:55:00 +00:00
< td class = "paramtype" > uint16_t  < / td >
< td class = "paramname" > < em > val< / em >   < / td >
2022-04-08 14:46:35 +00:00
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-11-30 12:55:00 +00:00
< tr > < td class = "paramname" > handle< / td > < td > Sgtl5000 handle structure. < / td > < / tr >
< tr > < td class = "paramname" > reg< / td > < td > The register address in sgtl. < / td > < / tr >
< tr > < td class = "paramname" > clr_mask< / td > < td > The mask code for the bits want to write. The bit you want to write should be 0. < / td > < / tr >
< tr > < td class = "paramname" > val< / td > < td > Value needs to write into the register. < / td > < / tr >
2022-04-08 14:46:35 +00:00
< / table >
< / dd >
< / dl >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- HTML footer for doxygen 1.8.5 -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul class = "foot" >
< li class = "footer" > © 2016 NXP Semiconductors. All rights reserved.
< / li >
< / ul >
< / div >
< / body >
< / html >