tmk_core/protocol/arm_atsam/usb/udi_hid_kbd.h

   1 /**
   2  * \file
   3  *
   4  * \brief USB Device Human Interface Device (HID) keyboard interface.
   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 _UDC_HID_KBD_H_
  48 #define _UDC_HID_KBD_H_
  49
  50 #include "udc_desc.h"
  51 #include "udi.h"
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 //******************************************************************************
  58 // Keyboard interface definitions
  59 //******************************************************************************
  60 #ifdef KBD
  61 extern UDC_DESC_STORAGE udi_api_t udi_api_hid_kbd;
  62 extern bool udi_hid_kbd_b_report_valid;
  63 extern volatile bool udi_hid_kbd_b_report_trans_ongoing;
  64 extern uint8_t udi_hid_kbd_report_set;
  65 bool udi_hid_kbd_send_report(void);
  66 #endif //KBD
  67
  68 //********************************************************************************************
  69 // NKRO Keyboard
  70 //********************************************************************************************
  71 #ifdef NKRO
  72 extern UDC_DESC_STORAGE udi_api_t udi_api_hid_nkro;
  73 extern bool udi_hid_nkro_b_report_valid;
  74 extern volatile bool udi_hid_nkro_b_report_trans_ongoing;
  75 bool udi_hid_nkro_send_report(void);
  76 #endif //NKRO
  77
  78 //********************************************************************************************
  79 // SYS-CTRL interface
  80 //********************************************************************************************
  81 #ifdef EXK
  82 extern UDC_DESC_STORAGE udi_api_t udi_api_hid_exk;
  83 extern bool udi_hid_exk_b_report_valid;
  84 extern uint8_t udi_hid_exk_report_set;
  85 bool udi_hid_exk_send_report(void);
  86 #endif //EXK
  87
  88 //********************************************************************************************
  89 // MOU Mouse
  90 //********************************************************************************************
  91 #ifdef MOU
  92 extern UDC_DESC_STORAGE udi_api_t udi_api_hid_mou;
  93 extern bool udi_hid_mou_b_report_valid;
  94 bool udi_hid_mou_send_report(void);
  95 #endif //MOU
  96
  97 //********************************************************************************************
  98 // RAW Raw
  99 //********************************************************************************************
 100 #ifdef RAW
 101 extern UDC_DESC_STORAGE udi_api_t udi_api_hid_raw;
 102 bool udi_hid_raw_send_report(void);
 103 #endif //RAW
 104
 105 //@}
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif // _UDC_HID_KBD_H_