77 lines
2.6 KiB
C
77 lines
2.6 KiB
C
/**
|
|
* \file
|
|
*
|
|
* \brief Common User Interface for HID Keyboard application
|
|
*
|
|
* Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
|
|
*
|
|
* \asf_license_start
|
|
*
|
|
* \page License
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
* this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
* this list of conditions and the following disclaimer in the documentation
|
|
* and/or other materials provided with the distribution.
|
|
*
|
|
* 3. The name of Atmel may not be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 4. This software may only be redistributed and used in connection with an
|
|
* Atmel microcontroller product.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
|
* EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* \asf_license_stop
|
|
*
|
|
*/
|
|
/*
|
|
* Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
|
|
*/
|
|
|
|
#ifndef _UI_H_
|
|
#define _UI_H_
|
|
|
|
//! \brief Initializes the user interface
|
|
void ui_init(void);
|
|
|
|
//! \brief Enters the user interface in power down mode
|
|
void ui_powerdown(void);
|
|
|
|
//! \brief Enables the asynchronous interrupts of the user interface
|
|
void ui_wakeup_enable(void);
|
|
|
|
//! \brief Disables the asynchronous interrupts of the user interface
|
|
void ui_wakeup_disable(void);
|
|
|
|
//! \brief Exits the user interface of power down mode
|
|
void ui_wakeup(void);
|
|
|
|
/*! \brief This process is called each 1ms
|
|
* It is called only if the USB interface is enabled.
|
|
*
|
|
* \param framenumber Current frame number
|
|
*/
|
|
void ui_process(uint16_t framenumber);
|
|
|
|
/*! \brief Turn on or off the keyboard LEDs
|
|
*/
|
|
void ui_kbd_led(uint8_t value);
|
|
|
|
#endif // _UI_H_
|