tmk_core/protocol/arm_atsam/usb/usb_main.h

   1 /**
   2  * \file
   3  *
   4  * \brief Declaration of main function used by HID keyboard example
   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 _MAIN_H_
  48 #define _MAIN_H_
  49
  50 //Enters the application in low power mode
  51 //Callback called when USB host sets USB line in suspend state
  52 void main_suspend_action(void);
  53
  54 //Called by UDD when the USB line exit of suspend state
  55 void main_resume_action(void);
  56
  57 //Called when a start of frame is received on USB line
  58 void main_sof_action(void);
  59
  60 //Called by UDC when USB Host request to enable remote wakeup
  61 void main_remotewakeup_enable(void);
  62
  63 //Called by UDC when USB Host request to disable remote wakeup
  64 void main_remotewakeup_disable(void);
  65
  66
  67 #ifdef KBD
  68 extern volatile bool main_b_kbd_enable;
  69 bool main_kbd_enable(void);
  70 void main_kbd_disable(void);
  71 #endif //KBD
  72
  73 #ifdef NKRO
  74 extern volatile bool main_b_nkro_enable;
  75 bool main_nkro_enable(void);
  76 void main_nkro_disable(void);
  77 #endif //NKRO
  78
  79 #ifdef EXK
  80 extern volatile bool main_b_exk_enable;
  81 bool main_exk_enable(void);
  82 void main_exk_disable(void);
  83 #endif //EXK
  84
  85 #ifdef MOU
  86 extern volatile bool main_b_mou_enable;
  87 bool main_mou_enable(void);
  88 void main_mou_disable(void);
  89 #endif //MOU
  90
  91 #ifdef RAW
  92 extern volatile bool main_b_raw_enable;
  93 bool main_raw_enable(void);
  94 void main_raw_disable(void);
  95 #endif //RAW
  96
  97 #endif // _MAIN_H_