vsf_dwcotg_common.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_DWCOTG_COMMON_H__
#define __VSF_DWCOTG_COMMON_H__
 
/*============================ INCLUDES ======================================*/
 
#include "component/usb/vsf_usb_cfg.h"
 
#if     (VSF_USE_USB_DEVICE == ENABLED && VSF_USBD_USE_DCD_DWCOTG == ENABLED)\
    ||  (VSF_USE_USB_HOST == ENABLED && VSF_USBH_USE_HCD_DWCOTG == ENABLED)
 
#include "hal/vsf_hal.h"
 
#include "./vsf_dwcotg_hw.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
#ifndef VSF_DWCOTG_DCD_CFG_EP_NUM
#   ifdef USB_DWCOTG_MAX_EP_NUM
#       define VSF_DWCOTG_DCD_CFG_EP_NUM        USB_DWCOTG_MAX_EP_NUM
#   else
#       define VSF_DWCOTG_DCD_CFG_EP_NUM        16
#   endif
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
typedef struct vk_dwcotg_param_t {
    union {
        struct {
            uint8_t speed : 4;
            uint8_t ulpi_en : 1;
            uint8_t utmi_en : 1;
            uint8_t vbus_en : 1;
            uint8_t dma_en  : 1;
        };
        uint8_t feature;
    };
} vk_dwcotg_param_t;
 
typedef struct vk_dwcotg_reg_t {
    // Core Global registers starting at offset 000h
    struct dwcotg_core_global_regs_t *global_regs;
    union {
        struct {
            // Host Global Registers starting at offset 400h.
            struct dwcotg_host_global_regs_t *global_regs;
            // Host Port 0 Control and Status Register at offset 440h.
            volatile uint32_t *hprt0;
            // Host Channel Specific Registers at offsets 500h-5FCh.
            struct dwcotg_hc_regs_t *hc_regs;
        } host;
        struct {
            // Device Global Registers starting at offset 800h
            struct dwcotg_dev_global_regs_t *global_regs;
            struct {
                // Device Logical IN Endpoint-Specific Registers 900h-AFCh
                struct dwcotg_dev_in_ep_regs_t *in_regs;
                // Device Logical OUT Endpoint-Specific Registers B00h-CFCh
                struct dwcotg_dev_out_ep_regs_t *out_regs;
            } ep;
        } dev;
    };
    volatile uint32_t * dfifo[VSF_DWCOTG_DCD_CFG_EP_NUM];
} vk_dwcotg_reg_t;
 
typedef struct vk_dwcotg_t {
    vk_dwcotg_reg_t reg;
    uint8_t ep_num;
} vk_dwcotg_t;
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ INCLUDES ======================================*/
/*============================ PROTOTYPES ====================================*/
 
void vk_dwcotg_phy_init(vk_dwcotg_t *dwcotg,
                        const vk_dwcotg_param_t *param,
                        vk_dwcotg_hw_info_t *hw_info);
 
#ifdef __cplusplus
}
#endif
 
#endif
#endif
/* EOF */