2021-03-23 12:43:48 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2013-01-30 22:00:18 +01:00
< 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" / >
2021-03-23 12:43:48 +01:00
< meta name = "generator" content = "Doxygen 1.8.17" / >
2020-11-18 20:17:17 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2013-02-17 01:37:13 +01:00
< title > USB Host Shield 2.0: hiduniversal.h Source File< / title >
2013-01-30 22:00:18 +01: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 = "search/search.css" rel = "stylesheet" type = "text/css" / >
2019-08-31 18:18:58 +02:00
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
2013-01-30 22:00:18 +01:00
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
2013-02-05 22:39:56 +01:00
< link href = "imageStyle.css" rel = "stylesheet" type = "text/css" / >
2013-01-30 22:00:18 +01:00
< / 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;" >
2019-08-31 18:18:58 +02:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2013-02-17 01:37:13 +01:00
< div id = "projectname" > USB Host Shield 2.0
2013-01-30 22:00:18 +01:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-03-23 12:43:48 +01:00
<!-- Generated by Doxygen 1.8.17 -->
2013-01-30 22:00:18 +01:00
< script type = "text/javascript" >
2021-03-23 12:43:48 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2013-01-30 22:00:18 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2021-03-23 12:43:48 +01:00
/* @license-end */
2013-01-30 22:00:18 +01:00
< / script >
2020-11-18 20:17:17 +01:00
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
2021-03-23 12:43:48 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2020-11-18 20:17:17 +01:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2021-03-23 12:43:48 +01:00
/* @license-end */< / script >
2020-11-18 20:17:17 +01:00
< div id = "main-nav" > < / div >
2018-10-13 16:56:59 +02:00
< / div > <!-- top -->
2013-01-30 22:00:18 +01:00
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
2019-08-31 18:18:58 +02:00
< / div >
2013-01-30 22:00:18 +01:00
<!-- 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 = "headertitle" >
< div class = "title" > hiduniversal.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2021-03-23 12:43:48 +01:00
< a href = "hiduniversal_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > /* Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.< / span > < / div >
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < span class = "comment" > This software may be distributed and modified under the terms of the GNU< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > General Public License version 2 (GPL2) as published by the Free Software< / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > Foundation and appearing in the file GPL2.TXT included in the packaging of< / span > < / div >
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "comment" > this file. Please note that GPL2 Section 2[b] requires that all works based< / span > < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "comment" > on this software must also be made publicly available under the terms of< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "comment" > the GPL2 (" Copyleft" ).< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "comment" > Contact information< / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "comment" > -------------------< / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "comment" > < / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < span class = "comment" > Circuits At Home, LTD< / span > < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "comment" > Web : http://www.circuitsathome.com< / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < span class = "comment" > e-mail : support@circuitsathome.com< / span > < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "comment" > */< / span > < / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < span class = "preprocessor" > #if !defined(__HIDUNIVERSAL_H__)< / span > < / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   < span class = "preprocessor" > #define __HIDUNIVERSAL_H__< / span > < / div >
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "hidcomposite_8h.html" > hidcomposite.h< / a > " < / span > < / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > < a class = "line" href = "class_h_i_d_universal.html" > 23< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "class_h_i_d_universal.html" > HIDUniversal< / a > : < span class = "keyword" > public< / span > < a class = "code" href = "class_h_i_d_composite.html" > HIDComposite< / a > {< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < span class = "keywordtype" > bool< / span > SelectInterface(uint8_t iface __attribute__((unused)), uint8_t proto __attribute__((unused))) < span class = "keyword" > final< / span > {< / div >
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < span class = "comment" > // the original HIDUniversal didn' t have this at all so make it a no-op< / span > < / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < span class = "comment" > // (and made it final so users don' t override this - if they want to use< / span > < / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "comment" > // SelectInterface() they should be deriving from HIDComposite directly)< / span > < / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "keywordflow" > return< / span > < span class = "keyword" > true< / span > ;< / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   }< / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < span class = "keywordtype" > void< / span > ParseHIDData(< a class = "code" href = "class_u_s_b_h_i_d.html" > USBHID< / a > *hid, uint8_t ep __attribute__((unused)), < span class = "keywordtype" > bool< / span > is_rpt_id, uint8_t len, uint8_t *buf) < span class = "keyword" > final< / span > {< / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < span class = "comment" > // override the HIDComposite version of this method to call the HIDUniversal version< / span > < / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   < span class = "comment" > // (which doesn' t use the endpoint), made it final to make sure users< / span > < / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < span class = "comment" > // of HIDUniversal override the right version of ParseHIDData() (the other one, below)< / span > < / div >
< div class = "line" > < a name = "l00036" > < / a > < span class = "lineno" > 36< / span >   ParseHIDData(hid, is_rpt_id, len, buf);< / div >
< div class = "line" > < a name = "l00037" > < / a > < span class = "lineno" > 37< / span >   }< / div >
< div class = "line" > < a name = "l00038" > < / a > < span class = "lineno" > 38< / span >   < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > 39< / span >   < span class = "keyword" > protected< / span > :< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > < a class = "line" href = "class_h_i_d_universal.html#a5d6e27f817d6d2c67692783a02872939" > 40< / a > < / span >   < span class = "keyword" > virtual< / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "class_h_i_d_universal.html#a5d6e27f817d6d2c67692783a02872939" > ParseHIDData< / a > (< a class = "code" href = "class_u_s_b_h_i_d.html" > USBHID< / a > *hid __attribute__((unused)), < span class = "keywordtype" > bool< / span > is_rpt_id __attribute__((unused)), uint8_t len __attribute__((unused)), uint8_t *buf __attribute__((unused))) {< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   }< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > < a class = "line" href = "class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595" > 45< / a > < / span >   < a class = "code" href = "class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595" > HIDUniversal< / a > (< a class = "code" href = "class_u_s_b.html" > USB< / a > *p) : < a class = "code" href = "class_h_i_d_composite.html" > HIDComposite< / a > (p) {}< / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   uint8_t < a class = "code" href = "class_h_i_d_universal.html#a71b7d8e31a4331071bbc0e3b678cdd3f" > Poll< / a > () < span class = "keyword" > override< / span > ;< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   < / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   < span class = "comment" > // UsbConfigXtracter implementation< / span > < / div >
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > < a class = "line" href = "class_h_i_d_universal.html#a230339bc00784715ba1ef9496b033d20" > 50< / a > < / span >   < span class = "keywordtype" > void< / span > < a class = "code" href = "class_h_i_d_universal.html#a230339bc00784715ba1ef9496b033d20" > EndpointXtract< / a > (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, < span class = "keyword" > const< / span > < a class = "code" href = "struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html" > USB_ENDPOINT_DESCRIPTOR< / a > *ep)< span class = "keyword" > override< / span > < / div >
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < span class = "keyword" > < / span > {< / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "comment" > // If the first configuration satisfies, the others are not considered.< / span > < / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "keywordflow" > if< / span > (< a class = "code" href = "class_h_i_d_composite.html#af96da3ba2b0fb46acb2bffb776ac2bf8" > bNumEP< / a > > 1 & & conf != < a class = "code" href = "class_h_i_d_composite.html#a83cf05744c9ebc0090a17727b5a2ce05" > bConfNum< / a > )< / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < span class = "keywordflow" > return< / span > ;< / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   < span class = "comment" > // otherwise HIDComposite does what HIDUniversal needs< / span > < / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < a class = "code" href = "class_h_i_d_composite.html#abdae8ebd9c5cc676c91829e41e3984a2" > HIDComposite::EndpointXtract< / a > (conf, iface, alt, proto, ep);< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   }< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   };< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   < / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   < span class = "preprocessor" > #endif // __HIDUNIVERSAL_H__< / span > < / div >
2013-01-30 22:00:18 +01:00
< / div > <!-- fragment --> < / div > <!-- contents -->
2021-03-23 12:43:48 +01:00
< div class = "ttc" id = "aclass_h_i_d_universal_html_a5d6e27f817d6d2c67692783a02872939" > < div class = "ttname" > < a href = "class_h_i_d_universal.html#a5d6e27f817d6d2c67692783a02872939" > HIDUniversal::ParseHIDData< / a > < / div > < div class = "ttdeci" > virtual void ParseHIDData(USBHID *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hiduniversal_8h_source.html#l00040" > hiduniversal.h:40< / a > < / div > < / div >
< div class = "ttc" id = "astruct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r_html" > < div class = "ttname" > < a href = "struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html" > USB_ENDPOINT_DESCRIPTOR< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usb__ch9_8h_source.html#l00148" > usb_ch9.h:148< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_composite_html_a83cf05744c9ebc0090a17727b5a2ce05" > < div class = "ttname" > < a href = "class_h_i_d_composite.html#a83cf05744c9ebc0090a17727b5a2ce05" > HIDComposite::bConfNum< / a > < / div > < div class = "ttdeci" > uint8_t bConfNum< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hidcomposite_8h_source.html#l00048" > hidcomposite.h:48< / a > < / div > < / div >
< div class = "ttc" id = "ahidcomposite_8h_html" > < div class = "ttname" > < a href = "hidcomposite_8h.html" > hidcomposite.h< / a > < / div > < / div >
2022-04-25 11:00:30 +02:00
< div class = "ttc" id = "aclass_u_s_b_html" > < div class = "ttname" > < a href = "class_u_s_b.html" > USB< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "_usb_core_8h_source.html#l00212" > UsbCore.h:212< / a > < / div > < / div >
2021-03-23 12:43:48 +01:00
< div class = "ttc" id = "aclass_h_i_d_universal_html_abdbac688c7e4b682055cebd82e13a595" > < div class = "ttname" > < a href = "class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595" > HIDUniversal::HIDUniversal< / a > < / div > < div class = "ttdeci" > HIDUniversal(USB *p)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hiduniversal_8h_source.html#l00045" > hiduniversal.h:45< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_composite_html_abdae8ebd9c5cc676c91829e41e3984a2" > < div class = "ttname" > < a href = "class_h_i_d_composite.html#abdae8ebd9c5cc676c91829e41e3984a2" > HIDComposite::EndpointXtract< / a > < / div > < div class = "ttdeci" > void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hidcomposite_8cpp_source.html#l00297" > hidcomposite.cpp:297< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_universal_html" > < div class = "ttname" > < a href = "class_h_i_d_universal.html" > HIDUniversal< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hiduniversal_8h_source.html#l00023" > hiduniversal.h:23< / a > < / div > < / div >
< div class = "ttc" id = "aclass_u_s_b_h_i_d_html" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html" > USBHID< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00143" > usbhid.h:143< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_composite_html_af96da3ba2b0fb46acb2bffb776ac2bf8" > < div class = "ttname" > < a href = "class_h_i_d_composite.html#af96da3ba2b0fb46acb2bffb776ac2bf8" > HIDComposite::bNumEP< / a > < / div > < div class = "ttdeci" > uint8_t bNumEP< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hidcomposite_8h_source.html#l00050" > hidcomposite.h:50< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_composite_html" > < div class = "ttname" > < a href = "class_h_i_d_composite.html" > HIDComposite< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hidcomposite_8h_source.html#l00024" > hidcomposite.h:24< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_universal_html_a71b7d8e31a4331071bbc0e3b678cdd3f" > < div class = "ttname" > < a href = "class_h_i_d_universal.html#a71b7d8e31a4331071bbc0e3b678cdd3f" > HIDUniversal::Poll< / a > < / div > < div class = "ttdeci" > uint8_t Poll() override< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hiduniversal_8cpp_source.html#l00020" > hiduniversal.cpp:20< / a > < / div > < / div >
< div class = "ttc" id = "aclass_h_i_d_universal_html_a230339bc00784715ba1ef9496b033d20" > < div class = "ttname" > < a href = "class_h_i_d_universal.html#a230339bc00784715ba1ef9496b033d20" > HIDUniversal::EndpointXtract< / a > < / div > < div class = "ttdeci" > void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep) override< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hiduniversal_8h_source.html#l00050" > hiduniversal.h:50< / a > < / div > < / div >
2013-01-30 22:00:18 +01:00
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2013-02-17 01:37:13 +01:00
Generated by   < a href = "http://www.doxygen.org/index.html" >
2013-01-30 22:00:18 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
2021-03-23 12:43:48 +01:00
< / a > 1.8.17
2013-01-30 22:00:18 +01:00
< / small > < / address >
< / body >
< / html >
