2014-03-31 10:50:52 +02:00
<!-- HTML header for doxygen 1.8.6 -->
2014-03-26 10:38:58 +01: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.6" / >
< title > tinyusb: Board API< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
$(window).load(resizeHeight);
< / script >
2014-03-27 12:34:18 +01:00
< 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 >
2014-03-26 10:38:58 +01:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
2014-03-31 10:50:52 +02:00
< table width = "100%" cellspacing = "0" cellpadding = "0" >
2014-03-26 10:38:58 +01:00
< tbody >
< tr style = "height: 56px;" >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > tinyusb
2014-03-31 10:50:52 +02:00
  < span id = "projectnumber" > 0.4< / span >
2014-03-26 10:38:58 +01:00
< / div >
< / td >
2014-03-31 10:50:52 +02:00
< td align = "right" >
< a href = "https://pledgie.com/campaigns/24694" > < img border = "0" src = "https://pledgie.com/campaigns/24694.png?skin_name=chrome" alt = "Click here to lend your support to tinyusb donation and make a donation at pledgie.com" > < / a >
< / td >
2014-03-26 10:38:58 +01:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
2014-03-27 12:34:18 +01:00
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
2014-03-26 10:38:58 +01:00
< 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 > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data  Structures< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
2014-03-27 12:34:18 +01:00
< 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 >
2014-03-26 10:38:58 +01:00
< / 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('group__group__board__api.html','');});
< / script >
< div id = "doc-content" >
2014-03-27 12:34:18 +01:00
<!-- 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 > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(9)" > < 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 >
2014-03-26 10:38:58 +01:00
< div class = "header" >
< div class = "summary" >
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Board API< div class = "ingroups" > < a class = "el" href = "group__group__board.html" > Boards Abstraction Layer< / a > < / div > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > All the board must support these APIs.
< a href = "#details" > More...< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:ga916f2adc2080b4fe88034086d107a8dc" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga916f2adc2080b4fe88034086d107a8dc" > < / a >
void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__group__board__api.html#ga916f2adc2080b4fe88034086d107a8dc" > board_init< / a > (void)< / td > < / tr >
< tr class = "memdesc:ga916f2adc2080b4fe88034086d107a8dc" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initialize all required peripherals on board including uart, led, buttons etc ... < br / > < / td > < / tr >
< tr class = "separator:ga916f2adc2080b4fe88034086d107a8dc" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga92863b323080baae31555ea45d93c404" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__group__board__api.html#ga92863b323080baae31555ea45d93c404" > board_leds< / a > (uint32_t on_mask, uint32_t off_mask)< / td > < / tr >
< tr class = "memdesc:ga92863b323080baae31555ea45d93c404" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Turns on and off leds on the board. < a href = "#ga92863b323080baae31555ea45d93c404" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga92863b323080baae31555ea45d93c404" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gaa1139dcc4b60a802b8e0978340d8b148" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__group__board__api.html#gaa1139dcc4b60a802b8e0978340d8b148" > board_buttons< / a > (void)< / td > < / tr >
< tr class = "memdesc:gaa1139dcc4b60a802b8e0978340d8b148" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get the current state of the buttons on the board. < a href = "#gaa1139dcc4b60a802b8e0978340d8b148" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaa1139dcc4b60a802b8e0978340d8b148" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga498fb2d18978388757e4f0f5b243baf2" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__group__board__api.html#ga498fb2d18978388757e4f0f5b243baf2" > board_uart_getchar< / a > (void)< / td > < / tr >
< tr class = "memdesc:ga498fb2d18978388757e4f0f5b243baf2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Get a character input from UART. < a href = "#ga498fb2d18978388757e4f0f5b243baf2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga498fb2d18978388757e4f0f5b243baf2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga6883b7ee5aea9c69789e582cb0316fe0" > < td class = "memItemLeft" align = "right" valign = "top" > void  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__group__board__api.html#ga6883b7ee5aea9c69789e582cb0316fe0" > board_uart_putchar< / a > (uint8_t c)< / td > < / tr >
< tr class = "memdesc:ga6883b7ee5aea9c69789e582cb0316fe0" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Send a character to UART. < a href = "#ga6883b7ee5aea9c69789e582cb0316fe0" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga6883b7ee5aea9c69789e582cb0316fe0" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< p > All the board must support these APIs. < / p >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "gaa1139dcc4b60a802b8e0978340d8b148" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint32_t board_buttons < / td >
< td > (< / td >
< td class = "paramtype" > void  < / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get the current state of the buttons on the board. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > Bitmask where a '1' means active (pressed), a '0' means inactive. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga92863b323080baae31555ea45d93c404" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void board_leds < / td >
< td > (< / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > on_mask< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > off_mask< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Turns on and off leds on the board. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > on_mask< / td > < td > Bitmask for LED's numbers is turning ON < / td > < / tr >
< tr > < td class = "paramdir" > [out]< / td > < td class = "paramname" > off_mask< / td > < td > Bitmask for LED's numbers is turning OFF < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section note" > < dt > Note< / dt > < dd > the < em > on_mask< / em > is more priority then < em > off_mask< / em > , if an led's number is present on both. It will be turned ON. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga498fb2d18978388757e4f0f5b243baf2" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t board_uart_getchar < / td >
< td > (< / td >
< td class = "paramtype" > void  < / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Get a character input from UART. < / p >
< dl class = "section return" > < dt > Returns< / dt > < dd > ASCII code of the input character or zero if none. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga6883b7ee5aea9c69789e582cb0316fe0" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void board_uart_putchar < / td >
< td > (< / td >
< td class = "paramtype" > uint8_t  < / td >
< td class = "paramname" > < em > c< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Send a character to UART. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > c< / td > < td > the character to be sent < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2014-04-15 07:05:21 +02:00
< li class = "footer" > Generated on Tue Apr 15 2014 10:49:29 for tinyusb by
2014-03-26 10:38:58 +01:00
< a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.6 < / li >
< / ul >
< / div >
< / body >
< / html >