usb_phy.h

00001 /*
00002  * Copyright (c) 2015, Freescale Semiconductor, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  *
00008  * o Redistributions of source code must retain the above copyright notice, this list
00009  *   of conditions and the following disclaimer.
00010  *
00011  * o Redistributions in binary form must reproduce the above copyright notice, this
00012  *   list of conditions and the following disclaimer in the documentation and/or
00013  *   other materials provided with the distribution.
00014  *
00015  * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
00016  *   contributors may be used to endorse or promote products derived from this
00017  *   software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00020  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00023  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00026  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  */
00030 #ifndef __USB_PHY_H__
00031 #define __USB_PHY_H__
00032 
00033 /*!
00034  * @brief EHCI PHY initialization.
00035  *
00036  * This function initializes the EHCI PHY IP.
00037  *
00038  * @param[in] controllerId    EHCI controller ID; See the #usb_controller_index_t.
00039  * @param[in] freq            The external input clock.
00040  *
00041  * @retval kStatus_USB_Success      Cancel successfully.
00042  * @retval kStatus_USB_Error        The freq value is incorrect.
00043  */
00044 extern uint32_t USB_EhciPhyInit(uint8_t controllerId, uint32_t freq);
00045 
00046 /*!
00047  * @brief ehci phy initialization for suspend and resume.
00048  *
00049  * This function initialize ehci phy IP for suspend and resume.
00050  *
00051  * @param[in] controllerId   ehci controller id, please reference to #usb_controller_index_t.
00052  * @param[in] freq            the external input clock.
00053  *                            for example: if the external input clock is 16M, the parameter freq should be 16000000.
00054  *
00055  * @retval kStatus_USB_Success      cancel successfully.
00056  * @retval kStatus_USB_Error        the freq value is incorrect.
00057  */
00058 extern uint32_t USB_EhciLowPowerPhyInit(uint8_t controllerId, uint32_t freq);
00059 
00060 /*!
00061  * @brief EHCI PHY deinitialization.
00062  *
00063  * This function deinitializes the EHCI PHY IP.
00064  *
00065  * @param[in] controllerId   EHCI controller ID; See #usb_controller_index_t.
00066  */
00067 extern void USB_EhciPhyDeinit(uint8_t controllerId);
00068 
00069 /*!
00070  * @brief EHCI PHY disconnect detection enable or disable.
00071  *
00072  * This function enable/disable the host EHCI disconnect detection.
00073  *
00074  * @param[in] controllerId   EHCI controller ID; See #usb_controller_index_t.
00075  * @param[in] enable
00076  *            1U - enable;
00077  *            0U - disable;
00078  */
00079 extern void USB_EhcihostPhyDisconnectDetectCmd(uint8_t controllerId, uint8_t enable);
00080 
00081 #endif /* __USB_PHY_H__ */