Page Comparison

Image Added

USBD_DEV_CFG  USBD_DevCfg_Template = {                                        (1)
    0xFFFE,                                                                   (2)
    0x1234,
    0x0100,
   "OEM MANUFACTURER",                                                        (3)
   "OEM PRODUCT",
   "1234567890ABCDEF",
    USBD_LANG_ID_ENGLISH_US                                                   (4)
};

(1) Give your device configuration a meaningful name by replacing the word “Template”.

(2) Assign the Vendor ID, Product ID and Device Release Number. For development purposes you can use the default values, but once you decide to release your product, you must contact the USB Implementers Forum (USB-IF) at www.usb.org in order to get valid IDs. USB-IF is a non-profit organization that among other activities, maintains all USB Vendor ID and Product ID numbers.

(3) Specify human readable Vendor ID, Product ID, and Device Release Number strings.

(4) A USB device can store strings in multiple languages. Specify the language used in your strings. The #defines for the other languages are defined in the file usbd_core.h in the section “Language Identifiers”.

USBD_DRV_CFG USBD_DrvCfg_Template = {                                         (1)
    0x00000000,                                                               (2)
    0x00000000,                                                               (3)
    0u,
    USBD_DEV_SPD_FULL,                                                        (4)
    USBD_DrvEP_InfoTbl_Template                                               (5)
};

(1) Give your driver configuration a meaningful name by replacing the word “Template”.

(2) Specify the base address of your USB device controller.

(3) If your target has dedicated memory for the USB controller, you can specify its base address and size here. Depending on the USB controller, dedicated memory can be used to allocate driver buffers or DMA descriptors.

(4) Specify the USB device controller speed: USBD_DEV_SPD_HIGH if your controller supports high-speed or USBD_DEV_SPD_FULL if your controller supports only full-speed.

(5) Specify the endpoint information table. The endpoint information table should be defined in your USB device controller BSP files. Refer to Endpoint Information Table for more details on the endpoint information table.

#include  <usbd_bsp_template.h>                                               (1)

CPU_BOOLEAN  App_USBD_Init (void)
{
    CPU_INT08U   dev_nbr;
    CPU_INT08U   cfg_fs_nbr;
    USBD_ERR     err;
 
 
    USBD_Init(&err);                                                          (2)
 
    dev_nbr = USBD_DevAdd(&USBD_DevCfg_Template,                              (3)
                          &App_USBD_BusFncts,                                 (4)
                          &USBD_DrvAPI_Template,                              (5)
                          &USBD_DrvCfg_Template,                              (6)
                          &USBD_DrvBSP_Template,                              (7)
                          &err);
 
    if (USBD_DrvCfg_Template.Spd == USBD_DEV_SPD_HIGH) {                      (8)
        cfg_hs_nbr = USBD_CfgAdd(dev_nbr,
                                 USBD_DEV_ATTRIB_SELF_POWERED,
                                 100u,
                                 USBD_DEV_SPD_HIGH,
                                "HS configuration",
                                &err);
    }
....
}

(1) Include the USB driver BSP header file that is specific to your board. This file can be found in the following folder: \Micrium\Software\uC-USB-Device\Drivers\<controller>\BSP\<board name>

(2) Initialize the USB device stack’s internal variables, structures and core RTOS port.

(3) Specify the address of the device configuration structure that you modified in the section "Modify Device Configuration".

(4) Specify the address of the Bus Event callbacks structure. See section Bus Event Callback Structure for more details on this structure.

(5) Specify the address of the driver’s API structure. The driver’s API structure is defined in the driver’s header file named usbd_drv_<controller>.h.

(6) Specify the address of the driver configuration structure that you modified in the section "Modify Driver Configuration".

(7) Specify the address of the driver’s BSP API structure. The driver’s BSP API structure is defined in the driver’s BSP header file named usbd_bsp_<controller>.h.

(8) If the device controller supports high-speed, create a high-speed configuration for the specified device.

Image Added

#define  APP_CFG_USBD_EN                        DEF_ENABLED                   (1)

#define  USBD_OS_CFG_CORE_TASK_PRIO                      6u                   (2)
#define  USBD_OS_CFG_TRACE_TASK_PRIO                     7u
#define  USBD_OS_CFG_CORE_TASK_STK_SIZE                256u
#define  USBD_OS_CFG_TRACE_TASK_STK_SIZE               256u
 
#define  LIB_MEM_CFG_OPTIMIZE_ASM_EN            DEF_DISABLED                  (3)
#define  LIB_MEM_CFG_ARG_CHK_EXT_EN             DEF_ENABLED
#define  LIB_MEM_CFG_ALLOC_EN                   DEF_ENABLED
#define  LIB_MEM_CFG_HEAP_SIZE                        1024u
 
#define  TRACE_LEVEL_OFF                                 0u                   (4)
#define  TRACE_LEVEL_INFO                                1u
#define  TRACE_LEVEL_DBG                                 2u
 
#define  APP_CFG_TRACE_LEVEL                    TRACE_LEVEL_DBG               (5)
#define  APP_CFG_TRACE                          printf                        (6)
 
#define  APP_TRACE_INFO(x)   ((APP_CFG_TRACE_LEVEL >= TRACE_LEVEL_INFO)  ? (void)(APP_CFG_TRACE x) : (void)0)
#define  APP_TRACE_DBG(x)    ((APP_CFG_TRACE_LEVEL >= TRACE_LEVEL_DBG)   ? (void)(APP_CFG_TRACE x) : (void)0)

(1) APP_CFG_USBD_EN enables or disables the USB application initialization code.

(2) These #defines relate to the µC/USB-Device OS port. The µC/USB-Device core requires only one task to manage control requests and asynchronous transfers, and a second, optional task to output trace events (if trace capability is enabled). To properly set the priority of the core and debug tasks, refer to Task Priorities.

(3) Configure the desired size of the heap memory. Heap memory used for µC/USB-Device drivers that use internal buffers and DMA descriptors which are allocated at run-time and to allocate internal buffers that require memory alignment. Refer to the µC/LIB documentation for more details on the other µC/LIB constants.

(4) Most Micrium examples contain application trace macros to output human-readable debugging information. Two levels of tracing are enabled: INFO and DBG. INFO traces high-level operations, and DBG traces high-level operations and return errors. Application-level tracing is different from µC/USB-Device tracing (refer to Debug and Trace for more details).

(5) Define the application trace level.

(6) Specify which function should be used to redirect the output of human-readable application tracing. You can select the standard output via printf(), or another output such as a text terminal using a serial interface.

#define  APP_CFG_USBD_AUDIO_EN                  DEF_DISABLED                  (1)
#define  APP_CFG_USBD_CDC_EN                    DEF_ENABLED
#define  APP_CFG_USBD_CDC_EEM_EN                DEF_ENABLED
#define  APP_CFG_USBD_HID_EN                    DEF_DISABLED
#define  APP_CFG_USBD_MSC_EN                    DEF_DISABLED
#define  APP_CFG_USBD_PHDC_EN                   DEF_DISABLED
#define  APP_CFG_USBD_VENDOR_EN                 DEF_DISABLED

(1) This #define enables the USB class-specific demo. You can enable one or more USB class-specific demos. If you enable several USB class-specific demos, your device will be a composite device.