/******************************************************************** FileName: USBConfig.h Dependencies: Always: GenericTypeDefs.h, usbd.h Situational: hid.h, cdc.h, msd.h, etc. Processor: PIC18 USB Microcontrollers Hardware: Complier: Microchip C18 Company: Microchip Technology, Inc. Software License Agreement: The software supplied herewith by Microchip Technology Incorporated (the “Company”) for its PICmicro® Microcontroller is intended and supplied to you, the Company’s customer, for use solely and exclusively on Microchip PICmicro Microcontroller products. The software is owned by the Company and/or its supplier, and is protected under applicable copyright laws. All rights are reserved. Any use in violation of the foregoing restrictions may subject the user to criminal sanctions under applicable laws, as well as to civil liability for the breach of the terms and conditions of this license. THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER. ******************************************************************** File Description: Change History: Rev Date Description 1.0 11/19/2004 Initial release 2.1 02/26/2007 Updated for simplicity and to use common coding style 5/6/08 Modified for generic HID application (Jan Axelson) *******************************************************************/ /********************************************************************* * Descriptor specific type definitions are defined in: usbd.h ********************************************************************/ #ifndef USBCFG_H #define USBCFG_H /** INCLUDES *******************************************************/ // including hid.h here so that it can be auto-generated by a GUI tool. //#include "./USB/usb_function_hid.h" //#include "generic_hid.h" /** DEFINITIONS ****************************************************/ #define EP0_BUFF_SIZE 8 // 8, 16, 32, or 64 #define USB_MAX_NUM_INT 1 // For tracking Alternate Setting #define HID_EP 1 //the maximum transfer size of EP1 #define USB_MAX_DATA_SIZE_EP1 64 #define USB_NUM_MESSAGES_EP1 1 #define USB_PING_PONG__NO_PING_PONG 0x00 //0b00 #define USB_PING_PONG__EP0_OUT_ONLY 0x01 //0b01 #define USB_PING_PONG__FULL_PING_PONG 0x02 //0b10 #define USB_PING_PONG__ALL_BUT_EP0 0x03 //0b11 #if defined (__18CXX) #define USB_PING_PONG_MODE USB_PING_PONG__NO_PING_PONG #elif defined (__C32__) #define USB_PING_PONG_MODE USB_PING_PONG__FULL_PING_PONG #endif //#define USB_PING_PONG_MODE USB_PING_PONG__EP0_OUT_ONLY //NOTE: this is not supported in 18F4550 rev Ax //#define USB_PING_PONG_MODE USB_PING_PONG__ALL_BUT_EP0 #define USB_EP0_BUFF_SIZE 8 #define USB_POLLING /* Parameter definitions are defined in usb_device.h */ #define USB_PULLUP_OPTION USB_PULLUP_ENABLE //#define USB_PULLUP_OPTION USB_PULLUP_DISABLED #define USB_TRANSCEIVER_OPTION USB_INTERNAL_TRANSCEIVER //External Transceiver support is not available on all product families. Please // refer to the product family datasheet for more information if this feature // is available on the target processor. //#define USB_TRANSCEIVER_OPTION USB_EXTERNAL_TRANSCEIVER #define USB_SPEED_OPTION USB_FULL_SPEED //#define USB_SPEED_OPTION USB_LOW_SPEED //(not valid option for PIC24F devices) //------------------------------------------------------------------------------------------------------------------ //Option to enable auto-arming of the status stage of control transfers, if no //"progress" has been made for the USB_STATUS_STAGE_TIMEOUT value. //If progress is made (any successful transactions completing on EP0 IN or OUT) //the timeout counter gets reset to the USB_STATUS_STAGE_TIMEOUT value. // //During normal control transfer processing, the USB stack or the application //firmware will call USBCtrlEPAllowStatusStage() as soon as the firmware is finished //processing the control transfer. Therefore, the status stage completes as //quickly as is physically possible. The USB_ENABLE_STATUS_STAGE_TIMEOUTS //feature, and the USB_STATUS_STAGE_TIMEOUT value are only relevant, when: //1. The application uses the USBDeferStatusStage() API function, but never calls // USBCtrlEPAllowStatusStage(). Or: //2. The application uses host to device (OUT) control transfers with data stage, // and some abnormal error occurs, where the host might try to abort the control // transfer, before it has sent all of the data it claimed it was going to send. // //If the application firmware never uses the USBDeferStatusStage() API function, //and it never uses host to device control transfers with data stage, then //it is not required to enable the USB_ENABLE_STATUS_STAGE_TIMEOUTS feature. #define USB_ENABLE_STATUS_STAGE_TIMEOUTS //Comment this out to disable this feature. //Section 9.2.6 of the USB 2.0 specifications indicate that: //1. Control transfers with no data stage: Status stage must complete within // 50ms of the start of the control transfer. //2. Control transfers with (IN) data stage: Status stage must complete within // 50ms of sending the last IN data packet in fullfilment of the data stage. //3. Control transfers with (OUT) data stage: No specific status stage timing // requirement. However, the total time of the entire control transfer (ex: // including the OUT data stage and IN status stage) must not exceed 5 seconds. // //Therefore, if the USB_ENABLE_STATUS_STAGE_TIMEOUTS feature is used, it is suggested //to set the USB_STATUS_STAGE_TIMEOUT value to timeout in less than 50ms. If the //USB_ENABLE_STATUS_STAGE_TIMEOUTS feature is not enabled, then the USB_STATUS_STAGE_TIMEOUT //parameter is not relevant. #define USB_STATUS_STAGE_TIMEOUT (BYTE)45 //Approximate timeout in milliseconds, except when //USB_POLLING mode is used, and USBDeviceTasks() is called at < 1kHz //In this special case, the timeout becomes approximately: //Timeout(in milliseconds) = ((1000 * (USB_STATUS_STAGE_TIMEOUT - 1)) / (USBDeviceTasks() polling frequency in Hz)) //------------------------------------------------------------------------------------------------------------------ #define USB_SUPPORT_DEVICE #define USB_NUM_STRING_DESCRIPTORS 3 //#define USB_INTERRUPT_LEGACY_CALLBACKS #define USB_ENABLE_ALL_HANDLERS //#define USB_ENABLE_SUSPEND_HANDLER //#define USB_ENABLE_WAKEUP_FROM_SUSPEND_HANDLER //#define USB_ENABLE_SOF_HANDLER //#define USB_ENABLE_ERROR_HANDLER //#define USB_ENABLE_OTHER_REQUEST_HANDLER //#define USB_ENABLE_SET_DESCRIPTOR_HANDLER //#define USB_ENABLE_INIT_EP_HANDLER //#define USB_ENABLE_EP0_DATA_HANDLER //#define USB_ENABLE_TRANSFER_COMPLETE_HANDLER /** DEVICE CLASS USAGE *********************************************/ #define USB_USE_HID #define USB_MAX_EP_NUMBER 2 /* Parameter definitions are defined in usbd.h */ #define MODE_PP USB_PING_PONG_MODE #define UCFG_VAL _PUEN|_TRINT|_FS|MODE_PP //#define USE_SELF_POWER_SENSE_IO //#define USE_USB_BUS_SENSE_IO #define USE_USB_BOOTLOADER #define SUPPORT_SET_DSC #define SUPPORT_SYNC_FRAME //#define USB_DYNAMIC_EP_CONFIG /** DEVICE CLASS USAGE *********************************************/ #define USB_USE_HID #define USB_SUPPORT_DEVICE /** ENDPOINTS ALLOCATION *******************************************/ /* HID */ #define HID_INTF_ID 0x00 #define HID_UEP UEP1 #define HID_BD_OUT USB_EP_1_OUT #define HID_INT_OUT_EP_SIZE 3 #define HID_BD_IN USB_EP_1_IN #define HID_INT_IN_EP_SIZE 3 #define HID_NUM_OF_DSC 1 #define HID_RPT01_SIZE 47 // The number of bytes in each report, // calculated from Report Size and Report Count in the report descriptor: #define HID_INPUT_REPORT_BYTES 2 #define HID_OUTPUT_REPORT_BYTES 2 #define HID_FEATURE_REPORT_BYTES 2 #define USB_HID_SET_REPORT_HANDLER mySetReportHandler #define USBGEN_EP_SIZE 64 #define HID_INTF_ID 0x00 #define HID_NUM_OF_DSC 1 /** DEFINITIONS ****************************************************/ extern BYTE hid_report_feature[HID_FEATURE_REPORT_BYTES]; #endif //USBCFG_H