00001 /* ---------------------------------------------------------------------------- 00002 * ATMEL Microcontroller Software Support 00003 * ---------------------------------------------------------------------------- 00004 * Copyright (c) 2008, 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 * Implementation of the HIDDKeyboardOutputReport class. 00032 */ 00033 00034 /** \addtogroup usbd_hid_key 00035 *@{ 00036 */ 00037 00038 /*------------------------------------------------------------------------------ 00039 * Headers 00040 *------------------------------------------------------------------------------*/ 00041 00042 #include <HIDDKeyboard.h> 00043 00044 /*------------------------------------------------------------------------------ 00045 * Exported functions 00046 *------------------------------------------------------------------------------*/ 00047 00048 /** 00049 * Initializes a keyboard output report. 00050 * \param report Pointer to a HIDDKeyboardOutputReport instance. 00051 */ 00052 void HIDDKeyboardOutputReport_Initialize(HIDDKeyboardOutputReport *report) 00053 { 00054 report->numLockStatus = 0; 00055 report->capsLockStatus = 0; 00056 report->scrollLockStatus = 0; 00057 report->padding = 0; 00058 } 00059 00060 /** 00061 * Indicates the current status of the num. lock LED according to the 00062 * given report. 00063 * \param report Pointer to a HIDDKeyboardOutputReport instance. 00064 * \return 1 if the num. lock LED is light on; otherwise 0. 00065 */ 00066 unsigned char HIDDKeyboardOutputReport_GetNumLockStatus( 00067 const HIDDKeyboardOutputReport *report) 00068 { 00069 return report->numLockStatus; 00070 } 00071 00072 /** 00073 * Indicates the current status of the caps lock LED according to the 00074 * given report. 00075 * \param report Pointer to a HIDDKeyboardOutputReport instance. 00076 * \return 1 if the caps lock LED is light on; otherwise 0. 00077 */ 00078 unsigned char HIDDKeyboardOutputReport_GetCapsLockStatus( 00079 const HIDDKeyboardOutputReport *report) 00080 { 00081 return report->capsLockStatus; 00082 } 00083 00084 /** 00085 * Indicates the current status of the scroll lock LED according to the 00086 * given report. 00087 * \param report Pointer to a HIDDKeyboardOutputReport instance. 00088 * \return 1 if the scroll lock LED is light on; otherwise 0. 00089 */ 00090 unsigned char HIDDKeyboardOutputReport_GetScrollLockStatus( 00091 const HIDDKeyboardOutputReport *report) 00092 { 00093 return report->scrollLockStatus; 00094 } 00095 00096 /**@}*/