Skip to content
Snippets Groups Projects
usb_desc.h 4.55 KiB
Newer Older
  • Learn to ignore specific revisions
  • /* Teensyduino Core Library
     * http://www.pjrc.com/teensy/
     * Copyright (c) 2013 PJRC.COM, LLC.
     *
     * Permission is hereby granted, free of charge, to any person obtaining
     * a copy of this software and associated documentation files (the
     * "Software"), to deal in the Software without restriction, including
     * without limitation the rights to use, copy, modify, merge, publish,
     * distribute, sublicense, and/or sell copies of the Software, and to
     * permit persons to whom the Software is furnished to do so, subject to
     * the following conditions:
     *
     * 1. The above copyright notice and this permission notice shall be 
     * included in all copies or substantial portions of the Software.
     *
     * 2. If the Software is incorporated into a build system that allows 
     * selection among a list of target devices, then similar target
     * devices manufactured by PJRC.COM must be included in the list of
     * target devices and selectable in the same manner.
     *
     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
     * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
     * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
     * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     * SOFTWARE.
     */
    
    #ifndef _usb_desc_h_
    #define _usb_desc_h_
    
    
    #include <stdint.h>
    #include <stddef.h>
    
    
    #define ENDPOINT_UNUSED     0x00
    #define ENDPOINT_TRANSIMIT_ONLY   0x15
    #define ENDPOINT_RECEIVE_ONLY   0x19
    #define ENDPOINT_TRANSMIT_AND_RECEIVE 0x1D
    
    
    /*
    To modify a USB Type to have different interfaces, start in this
    file.  Delete the XYZ_INTERFACE lines for any interfaces you
    wish to remove, and copy them from another USB Type for any you
    want to add.
    
    Give each interface a unique number, and edit NUM_INTERFACE to
    reflect the number of interfaces.
    
    Within each interface, make sure it uses a unique set of endpoints.
    Edit NUM_ENDPOINTS to be at least the largest endpoint number used.
    Then edit the ENDPOINT*_CONFIG lines so each endpoint is configured
    the proper way (transmit, receive, or both).
    
    The CONFIG_DESC_SIZE and any XYZ_DESC_OFFSET numbers must be
    edited to the correct sizes.  See usb_desc.c for the giant array
    of bytes.  Someday these may be done automatically..... (but how?)
    
    If you are using existing interfaces, the code in each file should
    automatically adapt to the changes you specify.  If you need to
    create a new type of interface, you'll need to write the code which
    sends and receives packets, and presents an API to the user.
    
    Finally, edit usb_inst.cpp, which creats instances of the C++
    objects for each combination.
    
    Some operating systems, especially Windows, may cache USB device
    info.  Changes to the device name may not update on the same
    computer unless the vendor or product ID numbers change, or the
    "bcdDevice" revision code is increased.
    
    If these instructions are missing steps or could be improved, please
    let me know?  http://forum.pjrc.com/forums/4-Suggestions-amp-Bug-Reports
    */
    
    #define USB_FADECANDY
    
      #define MANUFACTURER_NAME         {'s','c','a','n','l','i','m','e'}
      #define MANUFACTURER_NAME_LEN     8
      #define PRODUCT_NAME              {'F','a','d','e','c','a','n','d','y'}
      #define PRODUCT_NAME_LEN          9
    
      #define DFU_NAME                  {'F','a','d','e','c','a','n','d','y',' ','B','o','o','t','l','o','a','d','e','r'}
      #define DFU_NAME_LEN              20
    
      #define EP0_SIZE                  64
      #define NUM_ENDPOINTS             1
    
      #define FC_INTERFACE              0
      #define FC_OUT_ENDPOINT           1
      #define FC_OUT_SIZE               64
    
      #define DFU_INTERFACE             1
      #define DFU_DETACH_TIMEOUT        10000     // 10 seconds
      #define DFU_TRANSFER_SIZE         1024      // Flash sector size
      #define CONFIG_DESC_SIZE          (9+9+7+9+9)
    
      #define ENDPOINT1_CONFIG          ENDPOINT_RECEIVE_ONLY
    
    // Microsoft Compatible ID Feature Descriptor
    
    #define MSFT_VENDOR_CODE    '~'     // Arbitrary, but should be printable ASCII
    
    extern const uint8_t usb_microsoft_wcid[];
    extern const uint8_t usb_microsoft_extprop[];
    
    // NUM_ENDPOINTS = number of non-zero endpoints (0 to 15)
    extern const uint8_t usb_endpoint_config_table[NUM_ENDPOINTS];
    
    typedef struct {
    
        uint16_t  wValue;
        const uint8_t *addr;
        uint16_t  length;
    
    } usb_descriptor_list_t;
    
    extern const usb_descriptor_list_t usb_descriptor_list[];
    
    char * ultoa(unsigned long val, char *buf, int radix);
    
    #endif