usb_phy_api.h

00001 
00002 /** \addtogroup hal */
00003 /** @{*/
00004 /*
00005  * Copyright (c) 2018-2019, Arm Limited and affiliates.
00006  * SPDX-License-Identifier: Apache-2.0
00007  *
00008  * Licensed under the Apache License, Version 2.0 (the "License");
00009  * you may not use this file except in compliance with the License.
00010  * You may obtain a copy of the License at
00011  *
00012  *     http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  * Unless required by applicable law or agreed to in writing, software
00015  * distributed under the License is distributed on an "AS IS" BASIS,
00016  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00017  * See the License for the specific language governing permissions and
00018  * limitations under the License.
00019  */
00020 #ifndef MBED_USB_PHY_API_H
00021 #define MBED_USB_PHY_API_H
00022 
00023 #include "USBPhy.h"
00024 
00025 /** Return a the USBPhy instance for this hardware
00026  *
00027  * For details on adding support for a USBPhy see the specification in USBPhy.h.
00028  *
00029  * @return A pointer to a USBPhy instance
00030  * @note Calling this function on platforms without a USBPhy will result in an
00031  * error
00032  */
00033 USBPhy *get_usb_phy();
00034 
00035 #endif
00036 
00037 /** @}*/