tinyusb/demos/host/src/keyboard_app.c

/*
 * keyboard_app.c
 *
 *  Created on: Mar 24, 2013
 *      Author: hathach
 */

/*
 * Software License Agreement (BSD License)
 * Copyright (c) 2012, hathach (tinyusb.org)
 * All rights reserved.
 *
 * 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 the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE AUTHOR 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.
 *
 * This file is part of the tiny usb stack.
 */

//--------------------------------------------------------------------+
// INCLUDE
//--------------------------------------------------------------------+
#include "keyboard_app.h"

#if TUSB_CFG_HOST_HID_KEYBOARD

//--------------------------------------------------------------------+
// MACRO CONSTANT TYPEDEF
//--------------------------------------------------------------------+
#define QUEUE_KEYBOARD_REPORT_DEPTH   4

//--------------------------------------------------------------------+
// INTERNAL OBJECT & FUNCTION DECLARATION
//--------------------------------------------------------------------+
typedef enum {
  KEY_STATE_PRESSED = 1,
  KEY_STATE_HOLDING,
  KEY_STATE_RELEASED
}key_state_t;

typedef struct {
  tusb_keyboard_report_t report;
  key_state_t state[6];
} kbd_data_t;

OSAL_TASK_DEF(keyboard_task_def, "keyboard app", keyboard_app_task, 128, KEYBOARD_APP_TASK_PRIO);
OSAL_QUEUE_DEF(queue_kbd_def, QUEUE_KEYBOARD_REPORT_DEPTH, kbd_data_t);

static osal_queue_handle_t queue_kbd_hdl;
static tusb_keyboard_report_t usb_keyboard_report TUSB_CFG_ATTR_USBRAM;

static inline uint8_t keycode_to_ascii(uint8_t modifier, uint8_t keycode) ATTR_CONST ATTR_ALWAYS_INLINE;
static inline void process_kbd_report_isr(tusb_keyboard_report_t const * report);

//--------------------------------------------------------------------+
// tinyusb callback (ISR context)
//--------------------------------------------------------------------+
void tusbh_hid_keyboard_isr(uint8_t dev_addr, uint8_t instance_num, tusb_event_t event)
{
  switch(event)
  {
    case TUSB_EVENT_INTERFACE_OPEN: // application set-up
      osal_queue_flush(queue_kbd_hdl);
      tusbh_hid_keyboard_get_report(dev_addr, instance_num, (uint8_t*) &usb_keyboard_report); // first report
    break;

    case TUSB_EVENT_INTERFACE_CLOSE: // application tear-down

    break;

    case TUSB_EVENT_XFER_COMPLETE:
      process_kbd_report_isr(&usb_keyboard_report);
      tusbh_hid_keyboard_get_report(dev_addr, instance_num, (uint8_t*) &usb_keyboard_report);
    break;

    case TUSB_EVENT_XFER_ERROR:
      tusbh_hid_keyboard_get_report(dev_addr, instance_num, (uint8_t*) &usb_keyboard_report); // ignore & continue
    break;

    default :
    break;
  }
}

//--------------------------------------------------------------------+
// APPLICATION
//--------------------------------------------------------------------+
void keyboard_app_init(void)
{
  memclr_(&usb_keyboard_report, sizeof(tusb_keyboard_report_t));

  ASSERT( TUSB_ERROR_NONE == osal_task_create(&keyboard_task_def), (void) 0 );
  queue_kbd_hdl = osal_queue_create(&queue_kbd_def);
  ASSERT_PTR( queue_kbd_hdl, (void) 0 );
}

//------------- main task -------------//
OSAL_TASK_FUNCTION( keyboard_app_task ) (void* p_task_para)
{
  tusb_error_t error;
  kbd_data_t kbd_data;

  OSAL_TASK_LOOP_BEGIN

  osal_queue_receive(queue_kbd_hdl, &kbd_data, OSAL_TIMEOUT_WAIT_FOREVER, &error);

  //------------- example code ignore control (non-printable) key affects -------------//
  for(uint8_t i = 0; i < 6; i++)
  {
    if ( kbd_data.state[i] == KEY_STATE_PRESSED )
    {
      printf("%c", keycode_to_ascii(kbd_data.report.modifier, kbd_data.report.keycode[i]) );
    }
  }

  OSAL_TASK_LOOP_END
}

//--------------------------------------------------------------------+
// HELPER
//--------------------------------------------------------------------+

// look up new key in previous keys
static inline bool is_key_in_report_isr(tusb_keyboard_report_t const *p_report, uint8_t keycode, uint8_t modifier)
{
  for(uint8_t i=0; i<6; i++)
  {
    if (p_report->keycode[i] == keycode)
    {
      return true;
    }
  }

  return false;
}

static inline void process_kbd_report_isr(tusb_keyboard_report_t const *p_new_report)
{
  static tusb_keyboard_report_t prev_report = { 0 }; // previous report to check key released
  kbd_data_t kbd_data = { 0 };

  for(uint8_t i=0; i<6; i++)
  {
    if ( p_new_report->keycode[i] )
    {
      if ( is_key_in_report_isr(&prev_report, p_new_report->keycode[i], p_new_report->modifier) )
      {
        kbd_data.state[i] =  KEY_STATE_HOLDING; // previously existed means holding
      }else
      {
        kbd_data.state[i] = KEY_STATE_PRESSED;  // previously non-existed means released
      }
    }
    // TODO example skips key released
  }

  prev_report = *p_new_report;
  kbd_data.report = *p_new_report;
  osal_queue_send(queue_kbd_hdl, &kbd_data);
}

static inline uint8_t keycode_to_ascii(uint8_t modifier, uint8_t keycode)
{
  // TODO max of keycode_ascii_tbl
  return keycode > 128 ? 0 :
    hid_keycode_to_ascii_tbl [modifier & (KEYBOARD_MODIFIER_LEFTSHIFT | KEYBOARD_MODIFIER_RIGHTSHIFT) ? 1 : 0] [keycode];
}

#endif