Mbed OS Reference
Loading...
Searching...
No Matches
usb_phy_api.h
1
2/** \addtogroup hal */
3/** @{*/
4/*
5 * Copyright (c) 2018-2019, Arm Limited and affiliates.
6 * SPDX-License-Identifier: Apache-2.0
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 */
20#ifndef MBED_USB_PHY_API_H
21#define MBED_USB_PHY_API_H
22
23#include "USBPhy.h"
24
25/** Return a the USBPhy instance for this hardware
26 *
27 * For details on adding support for a USBPhy see the specification in USBPhy.h.
28 *
29 * @return A pointer to a USBPhy instance
30 * @note Calling this function on platforms without a USBPhy will result in an
31 * error
32 */
34
35#endif
36
37/** @}*/
Abstract interface to physical USB hardware.
Definition: USBPhy.h:82
USBPhy * get_usb_phy()
Return a the USBPhy instance for this hardware.