00001 /* ---------------------------------------------------------------------------- 00002 * SAM Software Package License 00003 * ---------------------------------------------------------------------------- 00004 * Copyright (c) 2014, Atmel Corporation 00005 * 00006 * All rights reserved. 00007 * 00008 * Redistribution and use in source and binary forms, with or without 00009 * modification, are permitted provided that the following conditions are met: 00010 * 00011 * - Redistributions of source code must retain the above copyright notice, 00012 * this list of conditions and the disclaimer below. 00013 * 00014 * Atmel's name may not be used to endorse or promote products derived from 00015 * this software without specific prior written permission. 00016 * 00017 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR 00018 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 00019 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE 00020 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, 00021 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00022 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 00023 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00024 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00025 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 00026 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00027 * ---------------------------------------------------------------------------- 00028 */ 00029 00030 /**\file 00031 Title: HIDIdleRequest implementation 00032 00033 About: Purpose 00034 Implementation of the HIDIdleRequest 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 ID of the report targeted by a SET_IDLE or GET_IDLE 00053 * request. This value should be 0 if report IDs are not used. 00054 * \param request Pointer to a USBGenericRequest instance. 00055 * \return Requested report ID. 00056 */ 00057 uint8_t HIDIdleRequest_GetReportId(const USBGenericRequest *request) 00058 { 00059 return (USBGenericRequest_GetValue(request) & 0xFF); 00060 } 00061 00062 /** 00063 * Retrieves the Idle rate (in milliseconds) indicated by a SET_IDLE 00064 * request. 00065 * \param request Pointer to a USBGenericRequest instance. 00066 * \return New idle rate for the report. 00067 */ 00068 uint8_t HIDIdleRequest_GetIdleRate(const USBGenericRequest *request) 00069 { 00070 return ((USBGenericRequest_GetValue(request) >> 8) & 0xFF); 00071 } 00072 00073 /**@}*/