SAMV71 Xplained Ultra Software Package 1.5

HIDReportRequest.c

Go to the documentation of this file.
00001 /* ---------------------------------------------------------------------------- */
00002 /*                  Atmel Microcontroller Software Support                      */
00003 /*                       SAM Software Package License                           */
00004 /* ---------------------------------------------------------------------------- */
00005 /* Copyright (c) 2015, Atmel Corporation                                        */
00006 /*                                                                              */
00007 /* All rights reserved.                                                         */
00008 /*                                                                              */
00009 /* Redistribution and use in source and binary forms, with or without           */
00010 /* modification, are permitted provided that the following condition is met:    */
00011 /*                                                                              */
00012 /* - Redistributions of source code must retain the above copyright notice,     */
00013 /* this list of conditions and the disclaimer below.                            */
00014 /*                                                                              */
00015 /* Atmel's name may not be used to endorse or promote products derived from     */
00016 /* this software without specific prior written permission.                     */
00017 /*                                                                              */
00018 /* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
00019 /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
00020 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
00021 /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
00022 /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
00023 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
00024 /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
00025 /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
00026 /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
00027 /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
00028 /* ---------------------------------------------------------------------------- */
00029 
00030 /**\file
00031     Title: HIDReportRequest implementation
00032 
00033     About: Purpose
00034         Implementation of the HIDReportRequest methods.
00035 */
00036 
00037 /**\addtogroup usb_hid
00038  *@{
00039  */
00040 
00041 /*------------------------------------------------------------------------------
00042  *         Headers
00043  *------------------------------------------------------------------------------*/
00044 
00045 #include "HIDRequests.h"
00046 
00047 /*------------------------------------------------------------------------------
00048  *         Exported functions
00049  *------------------------------------------------------------------------------*/
00050 
00051 /**
00052  * Indicates the type of report targeted by a SET_REPORT or GET_REPORT
00053  * request.
00054  * \param request Pointer to a USBGenericRequest instance.
00055  * \return Requested report type (see "HID Report Types").
00056  */
00057 uint8_t HIDReportRequest_GetReportType(const USBGenericRequest *request)
00058 {
00059     return ((USBGenericRequest_GetValue(request) >> 8) & 0xFF);
00060 }
00061 
00062 /**
00063  * Indicates the ID of the report targeted by a SET_REPORT or GET_REPORT
00064  * request. This value should be 0 if report IDs are not used.
00065  * \param request Pointer to a USBGenericRequest instance.
00066  * \return Requested report ID.
00067  */
00068 uint8_t HIDReportRequest_GetReportId(const USBGenericRequest *request)
00069 {
00070     return (USBGenericRequest_GetValue(request) & 0xFF);
00071 }
00072 
00073 /**@}*/
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines