ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Doxygen fixes to \param directives to give data direction in all projects. Make HID item filtering routines clearer in the HID WithParser demos.

Browse source
This commit is contained in:
Dean Camera 2009-09-24 02:05:33 +00:00
parent 573a27d90a
commit 409c49f057
12 changed files with 51 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Demos/Host/ClassDriver/KeyboardHostWithParser/KeyboardHostWithParser.c
View file

@ -251,20 +251,15 @@ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8
* we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
* have occupied).
*
* \param CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
* \param[in] CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
*
* \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
{
/* Check the attributes of the current item - see if we are interested in it or not */
if (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
{
/* Only store KEYBOARD usage page items into the Processed HID Report structure to save RAM */
return true;
}
else
{
return false;
}
/* Check the attributes of the current item - see if we are interested in it or not;
* only store KEYBOARD usage page items into the Processed HID Report structure to
* save RAM and ignore the rest
*/
return (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
}

19
Demos/Host/ClassDriver/MouseHostWithParser/MouseHostWithParser.c
View file

@ -250,21 +250,16 @@ void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8
* we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
* have occupied).
*
* \param CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
* \param[in] CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
*
* \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
{
/* Check the attributes of the current item - see if we are interested in it or not */
if ((CurrentItemAttributes->Usage.Page == USAGE_PAGE_BUTTON) ||
(CurrentItemAttributes->Usage.Page == USAGE_PAGE_GENERIC_DCTRL))
{
/* Only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report structure to save RAM */
return true;
}
else
{
return false;
}
/* Check the attributes of the current item - see if we are interested in it or not;
* only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
* structure to save RAM and ignore the rest
*/
return ((CurrentItemAttributes->Usage.Page == USAGE_PAGE_BUTTON) ||
(CurrentItemAttributes->Usage.Page == USAGE_PAGE_GENERIC_DCTRL))
}

17
Demos/Host/LowLevel/KeyboardHostWithParser/HIDReport.c
View file

@ -75,20 +75,15 @@ uint8_t GetHIDReportData(void)
* we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
* have occupied).
*
* \param CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
* \param[in] CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
*
* \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
{
/* Check the attributes of the current item - see if we are interested in it or not */
if (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
{
/* Only store KEYBOARD usage page items into the Processed HID Report structure to save RAM */
return true;
}
else
{
return false;
}
/* Check the attributes of the current item - see if we are interested in it or not;
* only store KEYBOARD usage page items into the Processed HID Report structure to
* save RAM and ignore the rest
*/
return (CurrentItemAttributes->Usage.Page == USAGE_PAGE_KEYBOARD)
}

19
Demos/Host/LowLevel/MouseHostWithParser/HIDReport.c
View file

@ -75,21 +75,16 @@ uint8_t GetHIDReportData(void)
* we aren't interested in (preventing us from being able to extract them later on, but saving on the RAM they would
* have occupied).
*
* \param CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
* \param[in] CurrentItemAttributes Pointer to the attrbutes of the item the HID report parser is currently working with
*
* \return Boolean true if the item should be stored into the HID report structure, false if it should be discarded
*/
bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes)
{
/* Check the attributes of the current item - see if we are interested in it or not */
if ((CurrentItemAttributes->Usage.Page == USAGE_PAGE_BUTTON) ||
(CurrentItemAttributes->Usage.Page == USAGE_PAGE_GENERIC_DCTRL))
{
/* Only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report structure to save RAM */
return true;
}
else
{
return false;
}
/* Check the attributes of the current item - see if we are interested in it or not;
* only store BUTTON and GENERIC_DESKTOP_CONTROL items into the Processed HID Report
* structure to save RAM and ignore the rest
*/
return ((CurrentItemAttributes->Usage.Page == USAGE_PAGE_BUTTON) ||
(CurrentItemAttributes->Usage.Page == USAGE_PAGE_GENERIC_DCTRL))
}