HIDClassDevice.h

Go to the documentation of this file.

/*
 * @brief Device mode driver for the library USB HID Class driver
 *
 * @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.
 */

#ifndef _HID_CLASS_DEVICE_H_
#define _HID_CLASS_DEVICE_H_

/* Includes: */
  #include "../../USB.h"
  #include "../Common/HIDClassCommon.h"

/* Enable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
extern "C" {
  #endif

/* Preprocessor Checks: */
  #if !defined(__INCLUDE_FROM_HID_DRIVER)
   #error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.
  #endif

/* Public Interface - May be used in end-application: */
/* Type Defines: */
typedef struct {
 const struct {
  uint8_t  InterfaceNumber;    
  uint8_t  ReportINEndpointNumber;   
  uint16_t ReportINEndpointSize;    
  bool     ReportINEndpointDoubleBank;   
  void *PrevReportINBuffer;    
  uint8_t  PrevReportINBufferSize;   
  uint8_t  PortNumber;    
 } Config;    
 struct {
  bool     UsingReportProtocol;    
  uint16_t IdleCount;    
  uint16_t IdleMSRemaining;    
 } State;   
} USB_ClassInfo_HID_Device_t;

/* Function Prototypes: */
bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

void HID_Device_USBTask(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);

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) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);

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) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(4);

/* Inline Functions: */
PRAGMA_ALWAYS_INLINE
static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo) ATTR_ALWAYS_INLINE
ATTR_NON_NULL_PTR_ARG(1);
static inline void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t *const HIDInterfaceInfo)
{
 if (HIDInterfaceInfo->State.IdleMSRemaining) {
  HIDInterfaceInfo->State.IdleMSRemaining--;
 }
}

/* Disable C linkage for C++ Compilers: */
  #if defined(__cplusplus)
}
  #endif

#endif