usb.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Koen Zandberg <koen@bergzand.net>
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for
 * more details.
 */
#ifndef USB_H
#define USB_H

#ifdef __cplusplus
extern "C" {
#endif

#include "board.h"

/* These can be overridden by boards that should come up with their board
 * supplier VID/PID pair. Boards should only override this if the RIOT built-in
 * peripherals are compatible with whatever is usually shipped with that pair
 * */
#ifndef INTERNAL_PERIPHERAL_VID

#define INTERNAL_PERIPHERAL_VID (0x1209)
#endif
#ifndef INTERNAL_PERIPHERAL_PID

#define INTERNAL_PERIPHERAL_PID (0x7D00)
#endif

#if !(defined(CONFIG_USB_VID) && defined(CONFIG_USB_PID))
#ifdef USB_H_USER_IS_RIOT_INTERNAL
#define CONFIG_USB_VID INTERNAL_PERIPHERAL_VID
#define CONFIG_USB_PID INTERNAL_PERIPHERAL_PID
#else
#error Please configure your vendor and product IDs. For development, you may \
    set USB_VID=${USB_VID_TESTING} USB_PID=${USB_PID_TESTING}.
#endif
#endif

#ifdef DOXYGEN
#define CONFIG_USB_VID
#endif

#ifdef DOXYGEN
#define CONFIG_USB_PID
#endif

#ifndef CONFIG_USB_MANUF_STR
#define CONFIG_USB_MANUF_STR   "RIOT-os.org"
#endif

#ifndef CONFIG_USB_PRODUCT_STR
#define CONFIG_USB_PRODUCT_STR  "USB device"
#endif

#ifndef CONFIG_USB_CONFIGURATION_STR
#define CONFIG_USB_CONFIGURATION_STR    "USB config"
#endif

#ifdef DOXYGEN
#define CONFIG_USB_SERIAL_STR           "RIOT-12345"
#endif

#if !defined(CONFIG_USB_SERIAL_STR) && !defined(CONFIG_USB_SERIAL_BYTE_LENGTH)
#define CONFIG_USB_SERIAL_BYTE_LENGTH 8
#endif

#ifndef CONFIG_USB_PRODUCT_BCDVERSION
#define CONFIG_USB_PRODUCT_BCDVERSION   0x0100
#endif

#ifndef CONFIG_USB_SPEC_BCDVERSION
#if defined(CONFIG_USB_SPEC_BCDVERSION_1_1)
#define CONFIG_USB_SPEC_BCDVERSION      0x0110
#elif defined(CONFIG_USB_SPEC_BCDVERSION_2_0)
#define CONFIG_USB_SPEC_BCDVERSION      0x0200
#else
#define CONFIG_USB_SPEC_BCDVERSION      0x0200
#endif
#endif

#ifndef CONFIG_USB_SELF_POWERED
#define CONFIG_USB_SELF_POWERED   (0)
#endif

#ifndef CONFIG_USB_MAX_POWER
#define CONFIG_USB_MAX_POWER   (100)
#endif

#ifndef CONFIG_USB_DEFAULT_LANGID
#define CONFIG_USB_DEFAULT_LANGID   0x0409 /* EN-US */
#endif

#ifdef DOXYGEN
#define USB_H_USER_IS_RIOT_INTERNAL
#endif

typedef enum {
    USB_VERSION_1x,     /* USB 1.0 or 1.1 device    */
    USB_VERSION_20,     /* USB 2.0 device           */
} usb_version_t;

typedef enum {
    USB_SPEED_LOW,      /* Low speed (1.5Mbit/s)    */
    USB_SPEED_FULL,     /* Full speed (12Mbit/s)    */
    USB_SPEED_HIGH,     /* High speed (480Mbit/s)   */
} usb_speed_t;

typedef enum {
    USB_EP_TYPE_NONE = 0,       
    USB_EP_TYPE_CONTROL,        
    USB_EP_TYPE_INTERRUPT,      
    USB_EP_TYPE_BULK,           
    USB_EP_TYPE_ISOCHRONOUS,    
} usb_ep_type_t;

typedef enum {
    USB_EP_DIR_OUT, 
    USB_EP_DIR_IN,  
} usb_ep_dir_t;

#ifdef __cplusplus
}
#endif

#endif /* USB_H */