tmk_core/protocol/arm_atsam/usb/ui.h

   1 /**
   2  * \file
   3  *
   4  * \brief Common User Interface for HID Keyboard application
   5  *
   6  * Copyright (c) 2009-2015 Atmel Corporation. All rights reserved.
   7  *
   8  * \asf_license_start
   9  *
  10  * \page License
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions are met:
  14  *
  15  * 1. Redistributions of source code must retain the above copyright notice,
  16  *    this list of conditions and the following disclaimer.
  17  *
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,
  19  *    this list of conditions and the following disclaimer in the documentation
  20  *    and/or other materials provided with the distribution.
  21  *
  22  * 3. The name of Atmel may not be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  * 4. This software may only be redistributed and used in connection with an
  26  *    Atmel microcontroller product.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
  29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
  32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * \asf_license_stop
  41  *
  42  */
  43 /*
  44  * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
  45  */
  46
  47 #ifndef _UI_H_
  48 #define _UI_H_
  49
  50 //! \brief Initializes the user interface
  51 void ui_init(void);
  52
  53 //! \brief Enters the user interface in power down mode
  54 void ui_powerdown(void);
  55
  56 //! \brief Enables the asynchronous interrupts of the user interface
  57 void ui_wakeup_enable(void);
  58
  59 //! \brief Disables the asynchronous interrupts of the user interface
  60 void ui_wakeup_disable(void);
  61
  62 //! \brief Exits the user interface of power down mode
  63 void ui_wakeup(void);
  64
  65 /*! \brief This process is called each 1ms
  66  * It is called only if the USB interface is enabled.
  67  *
  68  * \param framenumber  Current frame number
  69  */
  70 void ui_process(uint16_t framenumber);
  71
  72 /*! \brief Turn on or off the keyboard LEDs
  73  */
  74 void ui_kbd_led(uint8_t value);
  75
  76 #endif // _UI_H_