usb_init.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef INCLUDE_USB_INIT_PARAMS_H_
#define INCLUDE_USB_INIT_PARAMS_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define USB_INSTANCE_0   (0x00U)
 
#define USB_CLK_SEL_HFOSC0_CLKOUT   (0x00U)
 
#define USB_CLK_SEL_HFOSC1_CLKOUT   (0x01U)
 
#define USB_MAIN_PLL3_HSDIV4_CLKOUT (0x02U)
 
#define USB_MAIN_PLL2_HSDIV4_CLKOUT (0x03U)
 
#define USB_PLL_REF_CLK_9P6MHZ          (0x00)
 
#define USB_PLL_REF_CLK_10MHZ           (0x01)
 
#define USB_PLL_REF_CLK_12MHZ           (0x02)
 
#define USB_PLL_REF_CLK_19P2MHZ         (0x03)
 
#define USB_PLL_REF_CLK_20MHZ           (0x04)
 
#define USB_PLL_REF_CLK_24MHZ           (0x05)
 
#define USB_PLL_REF_CLK_25MHZ           (0x06)
 
#define USB_PLL_REF_CLK_26MHZ           (0x07)
 
#define USB_PLL_REF_CLK_38P4MHZ         (0x08)
 
#define USB_PLL_REF_CLK_40MHZ           (0x09)
 
#define USB_PLL_REF_CLK_48MHZ           (0x0A)
 
#define USB_PLL_REF_CLK_50MHZ           (0x0B)
 
#define USB_PLL_REF_CLK_52MHZ           (0x0C)
 
#define USB_MODE_3P0                    (0x0)
 
#define USB_MODE_2P0                    (0x1)
 
#define USB_PIPE_RX_INVERT_POLARITY_DISABLED        (0x0)
 
#define USB_PIPE_RX_INVERT_POLARITY_ENABLED         (0x1)
 
#define USB_VBUS_EXT_DIV3_INACTIVE      (0x0)
 
#define USB_VBUS_EXT_DIV3_ACTIVE        (0x1)
 
#define USB_HOST_MODE_DISABLED        (0x0)
 
#define USB_HOST_MODE_ENABLED         (0x1)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef struct usb_init_param_s {
    uint32_t instanceNum;
    uint32_t clkSrcSel;
    uint32_t pllRefSel;
    uint32_t usb2Enable;
    uint32_t invertPolarity;
    uint32_t vbusSel;
    uint32_t isHostMode;
} usb_init_param_t;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void usb_init(usb_init_param_t *usbInitParamPtr);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* INCLUDE_USB_INIT_PARAMS_H_ */