2016-04-19 18:16:46 +02: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" / >
2020-11-18 20:17:17 +01:00
< meta name = "generator" content = "Doxygen 1.8.13" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2016-04-19 18:16:46 +02:00
< title > USB Host Shield 2.0: usbhid.h Source File< / 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 = "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 >
2016-04-19 18:16:46 +02:00
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "imageStyle.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;" >
2019-08-31 18:18:58 +02:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2016-04-19 18:16:46 +02:00
< div id = "projectname" > USB Host Shield 2.0
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2020-11-18 20:17:17 +01:00
<!-- Generated by Doxygen 1.8.13 -->
2016-04-19 18:16:46 +02:00
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / 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" >
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
< / script >
< div id = "main-nav" > < / div >
2018-10-13 16:56:59 +02:00
< / div > <!-- top -->
2016-04-19 18:16:46 +02: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 >
2016-04-19 18:16:46 +02: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" > usbhid.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2021-01-13 10:36:51 +01:00
< a href = "usbhid_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 >   < span class = "preprocessor" > #if !defined(__USBHID_H__)< / span > < / div > < div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < span class = "preprocessor" > #define __USBHID_H__< / span > < / div > < div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   < / div > < div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "_usb_8h.html" > Usb.h< / a > " < / span > < / div > < div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "hidusagestr_8h.html" > hidusagestr.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 = "usbhid_8h.html#aeeb08a8b14bc04296f1c839872abc8af" > 23< / a > < / span >   < span class = "preprocessor" > #define MAX_REPORT_PARSERS 2< / span > < / div > < div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > < a class = "line" href = "usbhid_8h.html#a9901c86718db1fefe5d116aa254361cf" > 24< / a > < / span >   < span class = "preprocessor" > #define HID_MAX_HID_CLASS_DESCRIPTORS 5< / span > < / div > < div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < / div > < div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > < a class = "line" href = "usbhid_8h.html#a80a14b35dd7216f368201bbdc1cb101c" > 26< / a > < / span >   < span class = "preprocessor" > #define DAT
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "class_u_s_b_h_i_d_html_abb120ee1258c49b4af0fbd59ae6903f5" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html#abb120ee1258c49b4af0fbd59ae6903f5" > USBHID::pUsb< / a > < / div > < div class = "ttdeci" > USB * pUsb< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00145" > usbhid.h:145< / a > < / div > < / div >
2018-10-13 15:47:19 +02:00
< div class = "ttc" id = "struct_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 >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_a5d578c79399be5da63790c7396fc5336" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#a5d578c79399be5da63790c7396fc5336" > MainItemIOFeature::bmIsConstantOrData< / a > < / div > < div class = "ttdeci" > uint8_t bmIsConstantOrData< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00126" > usbhid.h:126< / a > < / div > < / div >
2018-10-28 18:24:59 +01:00
< div class = "ttc" id = "class_u_s_b_device_config_html" > < div class = "ttname" > < a href = "class_u_s_b_device_config.html" > USBDeviceConfig< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "_usb_core_8h_source.html#l00134" > UsbCore.h:134< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "_usb_8h_html" > < div class = "ttname" > < a href = "_usb_8h.html" > Usb.h< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_adaf8eafeb85f6aff94e211601e76ee8f" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#adaf8eafeb85f6aff94e211601e76ee8f" > MainItemIOFeature::bmIsArrayOrVariable< / a > < / div > < div class = "ttdeci" > uint8_t bmIsArrayOrVariable< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00127" > usbhid.h:127< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "struct_hid_item_prefix_html_a9c8a256ca8e493adfce8772445fef01e" > < div class = "ttname" > < a href = "struct_hid_item_prefix.html#a9c8a256ca8e493adfce8772445fef01e" > HidItemPrefix::bTag< / a > < / div > < div class = "ttdeci" > uint8_t bTag< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00122" > usbhid.h:122< / a > < / div > < / div >
< div class = "ttc" id = "struct_hid_item_prefix_html_a16874c73fdb809e4c46407ca83684927" > < div class = "ttname" > < a href = "struct_hid_item_prefix.html#a16874c73fdb809e4c46407ca83684927" > HidItemPrefix::bType< / a > < / div > < div class = "ttdeci" > uint8_t bType< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00121" > usbhid.h:121< / a > < / div > < / div >
2018-10-13 15:47:19 +02:00
< div class = "ttc" id = "struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r_html" > < div class = "ttname" > < a href = "struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r.html" > USB_HID_DESCRIPTOR< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usb__ch9_8h_source.html#l00158" > usb_ch9.h:158< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "struct_hid_item_prefix_html_a4b0af0a3d7ac50bdbedcd5fae929200d" > < div class = "ttname" > < a href = "struct_hid_item_prefix.html#a4b0af0a3d7ac50bdbedcd5fae929200d" > HidItemPrefix::bSize< / a > < / div > < div class = "ttdeci" > uint8_t bSize< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00120" > usbhid.h:120< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_a7acdfbb4a6b53046205cccae67fa26d4" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#a7acdfbb4a6b53046205cccae67fa26d4" > MainItemIOFeature::bmIsWrapOrNoWrap< / a > < / div > < div class = "ttdeci" > uint8_t bmIsWrapOrNoWrap< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00129" > usbhid.h:129< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "class_u_s_b_h_i_d_html_ad90bc410a083495a4ddefc2000f67dbd" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html#ad90bc410a083495a4ddefc2000f67dbd" > USBHID::GetUsb< / a > < / div > < div class = "ttdeci" > const USB * GetUsb()< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00168" > usbhid.h:168< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_aaa20e71b24fe2de818a85b0cbdcba33e" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#aaa20e71b24fe2de818a85b0cbdcba33e" > MainItemIOFeature::bmIsVolatileOrNonVolatile< / a > < / div > < div class = "ttdeci" > uint8_t bmIsVolatileOrNonVolatile< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00133" > usbhid.h:133< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "class_u_s_b_h_i_d_html_a35fe591ddd550b290d1e88c321617ab6" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html#a35fe591ddd550b290d1e88c321617ab6" > USBHID::bAddress< / a > < / div > < div class = "ttdeci" > uint8_t bAddress< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00146" > usbhid.h:146< / a > < / div > < / div >
< div class = "ttc" id = "hidusagestr_8h_html" > < div class = "ttname" > < a href = "hidusagestr_8h.html" > hidusagestr.h< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_a9673a5c3415a2f43b488aa32181b1f4c" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#a9673a5c3415a2f43b488aa32181b1f4c" > MainItemIOFeature::bmIsNullOrNoNull< / a > < / div > < div class = "ttdeci" > uint8_t bmIsNullOrNoNull< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00132" > usbhid.h:132< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "class_u_s_b_h_i_d_html_a2d8aa4af4c7d0470d6643fa94e9b39dd" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html#a2d8aa4af4c7d0470d6643fa94e9b39dd" > USBHID::USBHID< / a > < / div > < div class = "ttdeci" > USBHID(USB *pusb)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00165" > usbhid.h:165< / a > < / div > < / div >
2018-10-28 18:24:59 +01:00
< div class = "ttc" id = "class_u_s_b_read_parser_html" > < div class = "ttname" > < a href = "class_u_s_b_read_parser.html" > USBReadParser< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "_usb_core_8h_source.html#l00205" > UsbCore.h:205< / a > < / div > < / div >
2018-10-13 15:47:19 +02:00
< div class = "ttc" id = "class_usb_config_xtracter_html" > < div class = "ttname" > < a href = "class_usb_config_xtracter.html" > UsbConfigXtracter< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "confdescparser_8h_source.html#l00030" > confdescparser.h:30< / a > < / div > < / div >
2019-08-31 18:18:58 +02:00
< div class = "ttc" id = "hidboot_8h_html_aa1e198c16d2e9fad0e5c025e801f2fae" > < div class = "ttname" > < a href = "hidboot_8h.html#aa1e198c16d2e9fad0e5c025e801f2fae" > totalEndpoints< / a > < / div > < div class = "ttdeci" > #define totalEndpoints(p)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "hidboot_8h_source.html#l00033" > hidboot.h:33< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_abbe00a271ed4f5200399dd2ec5d18795" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#abbe00a271ed4f5200399dd2ec5d18795" > MainItemIOFeature::bmIsNonLonearOrLinear< / a > < / div > < div class = "ttdeci" > uint8_t bmIsNonLonearOrLinear< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00130" > usbhid.h:130< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "struct_hid_item_prefix_html" > < div class = "ttname" > < a href = "struct_hid_item_prefix.html" > HidItemPrefix< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00119" > usbhid.h:119< / a > < / div > < / div >
< div class = "ttc" id = "struct_main_item_i_o_feature_html" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html" > MainItemIOFeature< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00125" > usbhid.h:125< / a > < / div > < / div >
< div class = "ttc" id = "class_h_i_d_report_parser_html" > < div class = "ttname" > < a href = "class_h_i_d_report_parser.html" > HIDReportParser< / a > < / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00138" > usbhid.h:138< / a > < / div > < / div >
2018-10-28 18:24:59 +01:00
< div class = "ttc" id = "class_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#l00210" > UsbCore.h:210< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_afd8eca62fe742513103795799d960d01" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#afd8eca62fe742513103795799d960d01" > MainItemIOFeature::bmIsNoPreferedOrPrefered< / a > < / div > < div class = "ttdeci" > uint8_t bmIsNoPreferedOrPrefered< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00131" > usbhid.h:131< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "class_u_s_b_h_i_d_html_a17a732bbb37d8f21181d02d515f40499" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html#a17a732bbb37d8f21181d02d515f40499" > USBHID::SetReportParser< / a > < / div > < div class = "ttdeci" > virtual bool SetReportParser(uint8_t id, HIDReportParser *prs)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00172" > usbhid.h:172< / a > < / div > < / div >
2020-11-18 20:17:17 +01:00
< div class = "ttc" id = "struct_main_item_i_o_feature_html_aeb93d03989043229774d2a6832e48628" > < div class = "ttname" > < a href = "struct_main_item_i_o_feature.html#aeb93d03989043229774d2a6832e48628" > MainItemIOFeature::bmIsRelativeOrAbsolute< / a > < / div > < div class = "ttdeci" > uint8_t bmIsRelativeOrAbsolute< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00128" > usbhid.h:128< / a > < / div > < / div >
2016-04-19 18:16:46 +02:00
< div class = "ttc" id = "class_u_s_b_h_i_d_html_a4be1a2ac35ac7c4babca78b8148116ec" > < div class = "ttname" > < a href = "class_u_s_b_h_i_d.html#a4be1a2ac35ac7c4babca78b8148116ec" > USBHID::GetReportParser< / a > < / div > < div class = "ttdeci" > virtual HIDReportParser * GetReportParser(uint8_t id)< / div > < div class = "ttdef" > < b > Definition:< / b > < a href = "usbhid_8h_source.html#l00159" > usbhid.h:159< / a > < / div > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
Generated by   < a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
2020-11-18 20:17:17 +01:00
< / a > 1.8.13
2016-04-19 18:16:46 +02:00
< / small > < / address >
< / body >
< / html >