Keyboard.c

Go to the documentation of this file.

/*
 * @brief Make your board becomes a USB keyboard
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
 * Copyright(C) Dean Camera, 2011, 2012
 * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#include "Keyboard.h"

/*****************************************************************************
 * Private types/enumerations/variables
 ****************************************************************************/

static uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];

static USB_ClassInfo_HID_Device_t Keyboard_HID_Interface = {
 .Config = {
  .InterfaceNumber              = 0,

  .ReportINEndpointNumber       = KEYBOARD_EPNUM,
  .ReportINEndpointSize         = KEYBOARD_EPSIZE,
  .ReportINEndpointDoubleBank   = false,

  .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,
  .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),
  .PortNumber             = 0,
 },
};

/*****************************************************************************
 * Public types/enumerations/variables
 ****************************************************************************/

/*****************************************************************************
 * Private functions
 ****************************************************************************/


/* Configures the board hardware and chip peripherals for the demo's
   functionality */
static void SetupHardware(void)
{
 Board_Init();
 Board_Buttons_Init();
 Board_Joystick_Init();
 USB_Init(Keyboard_HID_Interface.Config.PortNumber, USB_MODE_Device);
#if defined(USB_DEVICE_ROM_DRIVER)
 UsbdHid_Init();
#endif
}

/*****************************************************************************
 * Public functions
 ****************************************************************************/

#if defined(USB_DEVICE_ROM_DRIVER)
extern void CALLBACK_UsbdHid_SetReportChange(bool newstate);
#endif

int main(void)
{
 SetupHardware();
 for (;; ) {
  #if defined(USB_DEVICE_ROM_DRIVER)
  USB_KeyboardReport_Data_t report;
  uint16_t reportsize;
  uint8_t reportID = 0;

  memset(&report, 0, sizeof(USB_KeyboardReport_Data_t));
  CALLBACK_HID_Device_CreateHIDReport(&Keyboard_HID_Interface,
           &reportID,
           HID_REPORT_ITEM_In,
           &report,
           &reportsize);
  if (memcmp(&report, Keyboard_HID_Interface.Config.PrevReportINBuffer,
       Keyboard_HID_Interface.Config.PrevReportINBufferSize)) {
   memcpy(Keyboard_HID_Interface.Config.PrevReportINBuffer,
       &report,
       Keyboard_HID_Interface.Config.PrevReportINBufferSize);
   CALLBACK_UsbdHid_SetReportChange(true);
  }
  #else
  HID_Device_USBTask(&Keyboard_HID_Interface);
  USB_USBTask(Keyboard_HID_Interface.Config.PortNumber, USB_MODE_Device);
  #endif
 }
}

/* Event handler for the library USB Connection event */
void EVENT_USB_Device_Connect(void)
{
}

/* Event handler for the library USB Disconnection event */
void EVENT_USB_Device_Disconnect(void)
{
}

/* Event handler for the library USB Configuration Changed event */
void EVENT_USB_Device_ConfigurationChanged(void)
{
 bool ConfigSuccess = true;

 ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);

 USB_Device_EnableSOFEvents();
}

/* Event handler for the library USB Control Request reception event */
void EVENT_USB_Device_ControlRequest(void)
{
 HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
}

/* Event handler for the USB device Start Of Frame event */
void EVENT_USB_Device_StartOfFrame(void)
{
 HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
}

/* HID class driver callback function for the creation of HID reports to the host */
bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo, uint8_t *const ReportID,
           const uint8_t ReportType, void *ReportData, uint16_t *const ReportSize)
{
 USB_KeyboardReport_Data_t *KeyboardReport = (USB_KeyboardReport_Data_t *) ReportData;

 uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 uint8_t ButtonStatus_LCL = Buttons_GetStatus();

 uint8_t UsedKeyCodes = 0;

 if (JoyStatus_LCL & JOY_UP) {
  KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_A;
 }
 else if (JoyStatus_LCL & JOY_DOWN) {
  KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_B;
 }

 if (JoyStatus_LCL & JOY_LEFT) {
  KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_C;
 }
 else if (JoyStatus_LCL & JOY_RIGHT) {
  KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_D;
 }

 if (JoyStatus_LCL & JOY_PRESS) {
  KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_E;
 }

 if (ButtonStatus_LCL & BUTTONS_BUTTON1) {
  KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_F;
 }

 if (UsedKeyCodes) {
  KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 }

 *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 return false;
}

/* HID class driver callback function for the processing of HID reports from the host */
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo,
            const uint8_t ReportID,
            const uint8_t ReportType,
            const void *ReportData,
            const uint16_t ReportSize)
{
 uint8_t  LEDMask   = LEDS_NO_LEDS;
 uint8_t *LEDReport = (uint8_t *) ReportData;

 if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK) {
  LEDMask |= LEDS_LED1;
 }

 if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK) {
  LEDMask |= LEDS_LED3;
 }

 if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK) {
  LEDMask |= LEDS_LED4;
 }
}