/* * @brief Definitions and declarations of Generic HID device example * * @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 __GENERICHID_H_ #define __GENERICHID_H_ #include "board.h" #include "USB.h" #include #include "Descriptors.h" #ifdef __cplusplus extern "C" { #endif /** @defgroup Generic_HID_Device_18xx43xx Generic Hid Device * @ingroup EXAMPLES_USB_18XX43XX * Example description
* This example implements a generic HID device. It enumerates as a generic HID * device with a simple one byte report and communicates with a simple PC * application that drives LEDs and reports the state of buttons on the board. * * When the example is run and the board is connected to a PC with a USB cable it * will enumerate on the PC as a generic HID device. You should see the device * appear in the "Device Manager" under the "Human Interface Device". * If you right click on USB Input Device->Properties * a window will appear called "USB Input Device Properties". If you * select the "Details" tab you will see a "Properties" drop down, click on it and * select "Hardware Ids". You should see the below entries for Vendor Id and * Product Id. * * USB\\VID_1FC9&PID_0007&REV_0100
* USB\\VID_1FC9&PID_0007 * * This information should match the data in the "Device Descriptor Sturcture" * in the "Descriptors.c" file in the Example_GenericHIDDevice project directory. * * Run the included PC application HIDClient.exe to send reports between the host * and device. * Use the Device: drop down list box to select "LPCUSBlib Generic HID Demo" * Press buttons on the board and see check boxes become checked in the first row * Clieck the check boxes in the second row to light up LEDs on the board.
* * Special connection requirements
* There are no special connection requirements for this example.
* * Build procedures:
* @ref LPCOPEN_18XX43XX_BUILDPROCS_KEIL
* @ref LPCOPEN_18XX43XX_BUILDPROCS_IAR
* @ref LPCOPEN_18XX43XX_BUILDPROCS_XPRESSO
* * Supported boards and board setup:
* @ref LPCOPEN_18XX_BOARD_HITEX1850
* @ref LPCOPEN_43XX_BOARD_HITEX4350
* @ref LPCOPEN_18XX_BOARD_KEIL1857
* @ref LPCOPEN_43XX_BOARD_KEIL4357
* @ref LPCOPEN_18XX_BOARD_NGX1830
* @ref LPCOPEN_43XX_BOARD_NGX4330
* * Submitting LPCOpen issues:
* @ref LPCOPEN_COMMUNITY * @{ */ /** * @} */ /** @defgroup Generic_HID_Device_17xx40xx Generic Hid Device * @ingroup EXAMPLES_USB_17XX40XX * Example description
* This example implements a generic HID device. It enumerates as a generic HID * device with a simple one byte report and communicates with a simple PC * application that drives LEDs and reports the state of buttons on the board. * * When the example is run and the board is connected to a PC with a USB cable it * will enumerate on the PC as a generic HID device. You should see the device * appear in the "Device Manager" under the "Human Interface Device". * If you right click on USB Input Device->Properties * a window will appear called "USB Input Device Properties". If you * select the "Details" tab you will see a "Properties" drop down, click on it and * select "Hardware Ids". You should see the below entries for Vendor Id and * Product Id. * * USB\\VID_1FC9&PID_0007&REV_0100
* USB\\VID_1FC9&PID_0007 * * This information should match the data in the "Device Descriptor Sturcture" * in the "Descriptors.c" file in the Example_GenericHIDDevice project directory. * * Run the included PC application HIDClient.exe to send reports between the host * and device. * Use the Device: drop down list box to select "LPCUSBlib Generic HID Demo" * Press buttons on the board and see check boxes become checked in the first row * Click the check boxes in the second row to light up LEDs on the board.
* * Special connection requirements
* - EA1788 and EA4088 Developer's Kits
* - Short jumper JP15 near 20 pin JTAG connector
* * Build procedures:
* @ref LPCOPEN_17XX40XX_BUILDPROCS_KEIL
* @ref LPCOPEN_17XX40XX_BUILDPROCS_IAR
* @ref LPCOPEN_17XX40XX_BUILDPROCS_XPRESSO
* * Supported boards and board setup:
* @ref LPCOPEN_17XX40XX_BOARD_EA1788
* @ref LPCOPEN_17XX40XX_BOARD_EA4088
* * Submitting LPCOpen issues:
* @ref LPCOPEN_COMMUNITY * @{ */ /** * @} */ /** @defgroup Generic_HID_Device_13xx Generic Hid Device * @ingroup EXAMPLES_USB_13XX * Example description
* This example implements a generic HID device. It enumerates as a generic HID * device with a simple one byte report and communicates with a simple PC * application that drives LEDs and reports the state of buttons on the board. * * When the example is run and the board is connected to a PC with a USB cable it * will enumerate on the PC as a generic HID device. You should see the device * appear in the "Device Manager" under the "Human Interface Device". * If you right click on USB Input Device->Properties * a window will appear called "USB Input Device Properties". If you * select the "Details" tab you will see a "Properties" drop down, click on it and * select "Hardware Ids". You should see the below entries for Vendor Id and * Product Id. * * USB\\VID_1FC9&PID_0007&REV_0100
* USB\\VID_1FC9&PID_0007 * * This information should match the data in the "Device Descriptor Sturcture" * in the "Descriptors.c" file in the Example_GenericHIDDevice project directory. * * Run the included PC application HIDClient.exe to send reports between the host * and device. * Use the Device: drop down list box to select "LPCUSBlib Generic HID Demo" * Press buttons on the board and see check boxes become checked in the first row * Click the check boxes in the second row to light up LEDs on the board.
* * Special connection requirements
* Need to connect with base board for using buttons and joystick * * Build procedures:
* @ref LPCOPEN_13XX_BUILDPROCS_XPRESSO
* @ref LPCOPEN_13XX_BUILDPROCS_KEIL
* @ref LPCOPEN_13XX_BUILDPROCS_IAR
* * Supported boards and board setup:
* @ref LPCOPEN_13XX_BOARD_XPRESSO_1347
* * Submitting LPCOpen issues:
* @ref LPCOPEN_COMMUNITY * @{ */ /** * @} */ /** @defgroup Generic_HID_Device_11Uxx Generic Hid Device * @ingroup EXAMPLES_USB_11UXX * Example description
* This example implements a generic HID device. It enumerates as a generic HID * device with a simple one byte report and communicates with a simple PC * application that drives LEDs and reports the state of buttons on the board. * * When the example is run and the board is connected to a PC with a USB cable it * will enumerate on the PC as a generic HID device. You should see the device * appear in the "Device Manager" under the "Human Interface Device". * If you right click on USB Input Device->Properties * a window will appear called "USB Input Device Properties". If you * select the "Details" tab you will see a "Properties" drop down, click on it and * select "Hardware Ids". You should see the below entries for Vendor Id and * Product Id. * * USB\\VID_1FC9&PID_0007&REV_0100
* USB\\VID_1FC9&PID_0007 * * This information should match the data in the "Device Descriptor Sturcture" * in the "Descriptors.c" file in the Example_GenericHIDDevice project directory. * * Run the included PC application HIDClient.exe to send reports between the host * and device. * Use the Device: drop down list box to select "LPCUSBlib Generic HID Demo" * Press buttons on the board and see check boxes become checked in the first row * Click the check boxes in the second row to light up LEDs on the board.
* Special connection requirements
* Need to connect with base board for using buttons and joystick * * Build procedures:
* @ref LPCOPEN_11XX_BUILDPROCS_XPRESSO
* @ref LPCOPEN_11XX_BUILDPROCS_KEIL
* @ref LPCOPEN_11XX_BUILDPROCS_IAR
* * Supported boards and board setup:
* @ref LPCOPEN_11XX_BOARD_XPRESSO_11U14
* @ref LPCOPEN_11XX_BOARD_XPRESSO_11C24
* * Submitting LPCOpen issues:
* @ref LPCOPEN_COMMUNITY * @{ */ /** * @} */ /** @defgroup Generic_HID_Device_Definition Main definitions * @ingroup Generic_HID_Device_18xx43xx Generic_HID_Device_17xx40xx Generic_HID_Device_11Uxx * @{ */ /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */ #define LEDMASK_USB_NOTREADY LEDS_LED1 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */ #define LEDMASK_USB_ENUMERATING (LEDS_LED2 | LEDS_LED3) /** LED mask for the library LED driver, to indicate that the USB interface is ready. */ #define LEDMASK_USB_READY (LEDS_LED2 | LEDS_LED4) /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */ #define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3) /** * @} */ #ifdef __cplusplus } #endif #endif /* __GENERICHID_H_ */