2022-08-23 15:00:33 +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-08-31 15:30:31 +00:00
< title > MCUXpresso SDK API Reference Manual: CODEC I2C Driver< / title >
2022-08-23 15:00:33 +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-15 14:23:36 +00:00
  < span id = "projectnumber" > Rev 2.15.000< / span >
2022-08-23 15:00:33 +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('a00015.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-15 14:23:36 +00:00
< a href = "#typedef-members" > Typedefs< / a > |
2022-08-23 15:00:33 +00:00
< a href = "#enum-members" > Enumerations< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
2023-08-31 15:30:31 +00:00
< div class = "title" > CODEC I2C Driver< div class = "ingroups" > < a class = "el" href = "a00287.html" > CODEC Driver< / a > < / div > < / div > < / div >
2022-08-23 15:00:33 +00:00
< / div > <!-- header -->
< div class = "contents" >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Overview< / h2 >
2023-08-31 15:30:31 +00:00
< p > The codec common driver provides a codec control abstraction interface. < / p >
2022-08-23 15:00:33 +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-15 14:23:36 +00:00
< tr class = "memitem:a00318" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#a00318" > _codec_i2c_config< / a > < / td > < / tr >
< tr class = "memdesc:a00318" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CODEC I2C configurations structure. < a href = "a00015.html#a00318" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:a00318" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-08-23 15:00:33 +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-08-31 15:30:31 +00:00
< tr class = "memitem:ga708be0fda3516367fe0461a5f054118c" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga708be0fda3516367fe0461a5f054118c" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#ga708be0fda3516367fe0461a5f054118c" > CODEC_I2C_MASTER_HANDLER_SIZE< / a >       HAL_I2C_MASTER_HANDLE_SIZE< / td > < / tr >
< tr class = "memdesc:ga708be0fda3516367fe0461a5f054118c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec i2c handler < br / > < / td > < / tr >
< tr class = "separator:ga708be0fda3516367fe0461a5f054118c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table > < table class = "memberdecls" >
2024-03-15 14:23:36 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "typedef-members" > < / a >
Typedefs< / h2 > < / td > < / tr >
< tr class = "memitem:ga90c62d9a9e394ab582060679be5cb554" > < td class = "memItemLeft" align = "right" valign = "top" > typedef enum < a class = "el" href = "a00015.html#ga5a34176c2a3f609443b47b9330229d9b" > _codec_reg_addr< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#ga90c62d9a9e394ab582060679be5cb554" > codec_reg_addr_t< / a > < / td > < / tr >
< tr class = "memdesc:ga90c62d9a9e394ab582060679be5cb554" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CODEC device register address type. < a href = "#ga90c62d9a9e394ab582060679be5cb554" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga90c62d9a9e394ab582060679be5cb554" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gad3867f845f6ad48a4949239d71241c88" > < td class = "memItemLeft" align = "right" valign = "top" > typedef enum < a class = "el" href = "a00015.html#gaadb6fb128d5ed1fb9edcdb1e533dd218" > _codec_reg_width< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#gad3867f845f6ad48a4949239d71241c88" > codec_reg_width_t< / a > < / td > < / tr >
< tr class = "memdesc:gad3867f845f6ad48a4949239d71241c88" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CODEC device register width. < a href = "#gad3867f845f6ad48a4949239d71241c88" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gad3867f845f6ad48a4949239d71241c88" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga7cef6c41744cbf081437214aa3a6acec" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga7cef6c41744cbf081437214aa3a6acec" > < / a >
typedef struct < a class = "el" href = "a00015.html#a00318" > _codec_i2c_config< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#ga7cef6c41744cbf081437214aa3a6acec" > codec_i2c_config_t< / a > < / td > < / tr >
< tr class = "memdesc:ga7cef6c41744cbf081437214aa3a6acec" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CODEC I2C configurations structure. < br / > < / td > < / tr >
< tr class = "separator:ga7cef6c41744cbf081437214aa3a6acec" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
2022-08-23 15:00:33 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "enum-members" > < / a >
Enumerations< / h2 > < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga5a34176c2a3f609443b47b9330229d9b" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#ga5a34176c2a3f609443b47b9330229d9b" > _codec_reg_addr< / a > { < br / >
    < a class = "el" href = "a00015.html#gga5a34176c2a3f609443b47b9330229d9ba1ee21f0f2d15f0a1e3708aa041c67977" > kCODEC_RegAddr8Bit< / a > = 1U,
2022-08-23 15:00:33 +00:00
< br / >
2024-03-15 14:23:36 +00:00
    < a class = "el" href = "a00015.html#gga5a34176c2a3f609443b47b9330229d9ba6bb003f6339c896cab91d395e515431d" > kCODEC_RegAddr16Bit< / a > = 2U
2022-08-23 15:00:33 +00:00
< br / >
}< / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memdesc:ga5a34176c2a3f609443b47b9330229d9b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CODEC device register address type. < a href = "a00015.html#ga5a34176c2a3f609443b47b9330229d9b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga5a34176c2a3f609443b47b9330229d9b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaadb6fb128d5ed1fb9edcdb1e533dd218" > < td class = "memItemLeft" align = "right" valign = "top" > enum   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#gaadb6fb128d5ed1fb9edcdb1e533dd218" > _codec_reg_width< / a > { < br / >
    < a class = "el" href = "a00015.html#ggaadb6fb128d5ed1fb9edcdb1e533dd218a6924318365a3be4d1f806bbf822f24a7" > kCODEC_RegWidth8Bit< / a > = 1U,
2022-08-23 15:00:33 +00:00
< br / >
2024-03-15 14:23:36 +00:00
    < a class = "el" href = "a00015.html#ggaadb6fb128d5ed1fb9edcdb1e533dd218adcf918639278d1d38a99f9b40030861a" > kCODEC_RegWidth16Bit< / a > = 2U,
2022-08-23 15:00:33 +00:00
< br / >
2024-03-15 14:23:36 +00:00
    < a class = "el" href = "a00015.html#ggaadb6fb128d5ed1fb9edcdb1e533dd218a1135b4284f4e9e0d83113250763b955f" > kCODEC_RegWidth32Bit< / a > = 4U
2022-08-23 15:00:33 +00:00
< br / >
}< / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memdesc:gaadb6fb128d5ed1fb9edcdb1e533dd218" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > CODEC device register width. < a href = "a00015.html#gaadb6fb128d5ed1fb9edcdb1e533dd218" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaadb6fb128d5ed1fb9edcdb1e533dd218" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-08-23 15:00:33 +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-15 14:23:36 +00:00
< tr class = "memitem:gadf64ef142b3bbc5a2f9ba1b7e01e5356" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#gadf64ef142b3bbc5a2f9ba1b7e01e5356" > CODEC_I2C_Init< / a > (void *handle, uint32_t i2cInstance, uint32_t i2cBaudrate, uint32_t i2cSourceClockHz)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gadf64ef142b3bbc5a2f9ba1b7e01e5356" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Codec i2c bus initilization. < a href = "#gadf64ef142b3bbc5a2f9ba1b7e01e5356" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gadf64ef142b3bbc5a2f9ba1b7e01e5356" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga2c33fdd5bd6fe377e53f92cbbb03223b" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#ga2c33fdd5bd6fe377e53f92cbbb03223b" > CODEC_I2C_Deinit< / a > (void *handle)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga2c33fdd5bd6fe377e53f92cbbb03223b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Codec i2c de-initilization. < a href = "#ga2c33fdd5bd6fe377e53f92cbbb03223b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga2c33fdd5bd6fe377e53f92cbbb03223b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gaadd85b986313b7ee984cd57bc9b883b4" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#gaadd85b986313b7ee984cd57bc9b883b4" > CODEC_I2C_Send< / a > (void *handle, uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint8_t *txBuff, uint8_t txBuffSize)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gaadd85b986313b7ee984cd57bc9b883b4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec i2c send function. < a href = "#gaadd85b986313b7ee984cd57bc9b883b4" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaadd85b986313b7ee984cd57bc9b883b4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gae0da3dcb4574fedde25b82432890e2ec" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#gae0da3dcb4574fedde25b82432890e2ec" > CODEC_I2C_Receive< / a > (void *handle, uint8_t deviceAddress, uint32_t subAddress, uint8_t subaddressSize, uint8_t *rxBuff, uint8_t rxBuffSize)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gae0da3dcb4574fedde25b82432890e2ec" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec i2c receive function. < a href = "#gae0da3dcb4574fedde25b82432890e2ec" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gae0da3dcb4574fedde25b82432890e2ec" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
< hr / > < h2 class = "groupheader" > Data Structure Documentation< / h2 >
2024-03-15 14:23:36 +00:00
< a name = "a00318" id = "a00318" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > struct _codec_i2c_config< / td >
2022-08-23 15:00:33 +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-15 14:23:36 +00:00
< tr class = "memitem:a3ec85738d9527900de39508911dd0169" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a3ec85738d9527900de39508911dd0169" > < / a >
uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#a3ec85738d9527900de39508911dd0169" > codecI2CInstance< / a > < / td > < / tr >
< tr class = "memdesc:a3ec85738d9527900de39508911dd0169" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > i2c bus instance < br / > < / td > < / tr >
< tr class = "separator:a3ec85738d9527900de39508911dd0169" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a562815d5c51bef1ccb7f5655173ace47" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "a562815d5c51bef1ccb7f5655173ace47" > < / a >
uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00015.html#a562815d5c51bef1ccb7f5655173ace47" > codecI2CSourceClock< / a > < / td > < / tr >
< tr class = "memdesc:a562815d5c51bef1ccb7f5655173ace47" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > i2c bus source clock frequency < br / > < / td > < / tr >
< tr class = "separator:a562815d5c51bef1ccb7f5655173ace47" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
2024-03-15 14:23:36 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
< a class = "anchor" id = "ga90c62d9a9e394ab582060679be5cb554" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef enum < a class = "el" href = "a00015.html#ga5a34176c2a3f609443b47b9330229d9b" > _codec_reg_addr< / a > < a class = "el" href = "a00015.html#ga90c62d9a9e394ab582060679be5cb554" > codec_reg_addr_t< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< a class = "anchor" id = "gad3867f845f6ad48a4949239d71241c88" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > typedef enum < a class = "el" href = "a00015.html#gaadb6fb128d5ed1fb9edcdb1e533dd218" > _codec_reg_width< / a > < a class = "el" href = "a00015.html#gad3867f845f6ad48a4949239d71241c88" > codec_reg_width_t< / a > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
2022-08-23 15:00:33 +00:00
< / div >
< / div >
< h2 class = "groupheader" > Enumeration Type Documentation< / h2 >
2024-03-15 14:23:36 +00:00
< a class = "anchor" id = "ga5a34176c2a3f609443b47b9330229d9b" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > enum < a class = "el" href = "a00015.html#ga5a34176c2a3f609443b47b9330229d9b" > _codec_reg_addr< / a > < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< table class = "fieldtable" >
2024-03-15 14:23:36 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga5a34176c2a3f609443b47b9330229d9ba1ee21f0f2d15f0a1e3708aa041c67977" > < / a > kCODEC_RegAddr8Bit< / em > < / td > < td class = "fielddoc" >
2023-08-31 15:30:31 +00:00
< p > 8-bit register address. < / p >
2022-08-23 15:00:33 +00:00
< / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "gga5a34176c2a3f609443b47b9330229d9ba6bb003f6339c896cab91d395e515431d" > < / a > kCODEC_RegAddr16Bit< / em > < / td > < td class = "fielddoc" >
2023-08-31 15:30:31 +00:00
< p > 16-bit register address. < / p >
2022-08-23 15:00:33 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
2024-03-15 14:23:36 +00:00
< a class = "anchor" id = "gaadb6fb128d5ed1fb9edcdb1e533dd218" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > enum < a class = "el" href = "a00015.html#gaadb6fb128d5ed1fb9edcdb1e533dd218" > _codec_reg_width< / a > < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< table class = "fieldtable" >
2024-03-15 14:23:36 +00:00
< tr > < th colspan = "2" > Enumerator< / th > < / tr > < tr > < td class = "fieldname" > < em > < a class = "anchor" id = "ggaadb6fb128d5ed1fb9edcdb1e533dd218a6924318365a3be4d1f806bbf822f24a7" > < / a > kCODEC_RegWidth8Bit< / em > < / td > < td class = "fielddoc" >
2023-08-31 15:30:31 +00:00
< p > 8-bit register width. < / p >
2022-08-23 15:00:33 +00:00
< / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "ggaadb6fb128d5ed1fb9edcdb1e533dd218adcf918639278d1d38a99f9b40030861a" > < / a > kCODEC_RegWidth16Bit< / em > < / td > < td class = "fielddoc" >
2023-08-31 15:30:31 +00:00
< p > 16-bit register width. < / p >
2022-08-23 15:00:33 +00:00
< / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr > < td class = "fieldname" > < em > < a class = "anchor" id = "ggaadb6fb128d5ed1fb9edcdb1e533dd218a1135b4284f4e9e0d83113250763b955f" > < / a > kCODEC_RegWidth32Bit< / em > < / td > < td class = "fielddoc" >
2023-08-31 15:30:31 +00:00
< p > 32-bit register width. < / p >
2022-08-23 15:00:33 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
< h2 class = "groupheader" > Function Documentation< / h2 >
2023-08-31 15:30:31 +00:00
< a class = "anchor" id = "gadf64ef142b3bbc5a2f9ba1b7e01e5356" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > CODEC_I2C_Init < / td >
2022-08-23 15:00:33 +00:00
< td > (< / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > void *  < / td >
2022-08-23 15:00:33 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > i2cInstance< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > i2cBaudrate< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > i2cSourceClockHz< / em >   < / td >
2022-08-23 15:00:33 +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-08-31 15:30:31 +00:00
< tr > < td class = "paramname" > handle< / td > < td > i2c master handle. < / td > < / tr >
< tr > < td class = "paramname" > i2cInstance< / td > < td > instance number of the i2c bus, such as 0 is corresponding to I2C0. < / td > < / tr >
< tr > < td class = "paramname" > i2cBaudrate< / td > < td > i2c baudrate. < / td > < / tr >
< tr > < td class = "paramname" > i2cSourceClockHz< / td > < td > i2c source clock frequency. < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
< / dd >
< / dl >
2023-08-31 15:30:31 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_HAL_I2cSuccess is success, else initial failed. < / dd > < / dl >
2022-08-23 15:00:33 +00:00
< / div >
< / div >
2023-08-31 15:30:31 +00:00
< a class = "anchor" id = "ga2c33fdd5bd6fe377e53f92cbbb03223b" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > CODEC_I2C_Deinit < / td >
2022-08-23 15:00:33 +00:00
< td > (< / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > < / td > < td > )< / td >
2022-08-23 15:00:33 +00:00
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
2023-08-31 15:30:31 +00:00
< tr > < td class = "paramname" > handle< / td > < td > i2c master handle. < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
< / dd >
< / dl >
2023-08-31 15:30:31 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_HAL_I2cSuccess is success, else deinitial failed. < / dd > < / dl >
2022-08-23 15:00:33 +00:00
< / div >
< / div >
2023-08-31 15:30:31 +00:00
< a class = "anchor" id = "gaadd85b986313b7ee984cd57bc9b883b4" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > CODEC_I2C_Send < / td >
2022-08-23 15:00:33 +00:00
< td > (< / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > void *  < / td >
2022-08-23 15:00:33 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > deviceAddress< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > subAddress< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > subaddressSize< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > uint8_t *  < / td >
< td class = "paramname" > < em > txBuff< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > txBuffSize< / em >   < / td >
2022-08-23 15:00:33 +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-08-31 15:30:31 +00:00
< tr > < td class = "paramname" > handle< / td > < td > i2c master handle. < / td > < / tr >
< tr > < td class = "paramname" > deviceAddress< / td > < td > codec device address. < / td > < / tr >
< tr > < td class = "paramname" > subAddress< / td > < td > register address. < / td > < / tr >
< tr > < td class = "paramname" > subaddressSize< / td > < td > register address width. < / td > < / tr >
< tr > < td class = "paramname" > txBuff< / td > < td > tx buffer pointer. < / td > < / tr >
< tr > < td class = "paramname" > txBuffSize< / td > < td > tx buffer size. < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
< / dd >
< / dl >
2023-08-31 15:30:31 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_HAL_I2cSuccess is success, else send failed. < / dd > < / dl >
2022-08-23 15:00:33 +00:00
< / div >
< / div >
2023-08-31 15:30:31 +00:00
< a class = "anchor" id = "gae0da3dcb4574fedde25b82432890e2ec" > < / a >
2022-08-23 15:00:33 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > CODEC_I2C_Receive < / td >
2022-08-23 15:00:33 +00:00
< td > (< / td >
2023-08-31 15:30:31 +00:00
< td class = "paramtype" > void *  < / td >
2022-08-23 15:00:33 +00:00
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > deviceAddress< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > subAddress< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > subaddressSize< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t *  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > rxBuff< / em > , < / td >
2022-08-23 15:00:33 +00:00
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint8_t  < / td >
2023-08-31 15:30:31 +00:00
< td class = "paramname" > < em > rxBuffSize< / em >   < / td >
2022-08-23 15:00:33 +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-08-31 15:30:31 +00:00
< tr > < td class = "paramname" > handle< / td > < td > i2c master handle. < / td > < / tr >
< tr > < td class = "paramname" > deviceAddress< / td > < td > codec device address. < / td > < / tr >
< tr > < td class = "paramname" > subAddress< / td > < td > register address. < / td > < / tr >
< tr > < td class = "paramname" > subaddressSize< / td > < td > register address width. < / td > < / tr >
< tr > < td class = "paramname" > rxBuff< / td > < td > rx buffer pointer. < / td > < / tr >
< tr > < td class = "paramname" > rxBuffSize< / td > < td > rx buffer size. < / td > < / tr >
2022-08-23 15:00:33 +00:00
< / table >
< / dd >
< / dl >
2023-08-31 15:30:31 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_HAL_I2cSuccess is success, else receive failed. < / dd > < / dl >
2022-08-23 15:00:33 +00:00
< / 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 >