Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/EthInterface.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /*
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2015 ARM Limited
kenjiArai 0:5b88d5760320 3 *
kenjiArai 0:5b88d5760320 4 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 5 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 6 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 7 *
kenjiArai 0:5b88d5760320 8 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 9 *
kenjiArai 0:5b88d5760320 10 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 11 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 13 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 14 * limitations under the License.
kenjiArai 0:5b88d5760320 15 */
kenjiArai 0:5b88d5760320 16
kenjiArai 0:5b88d5760320 17 /* @file EthInterface.h Common interface between Ethernet hardware */
kenjiArai 0:5b88d5760320 18 /** \addtogroup netinterface */
kenjiArai 0:5b88d5760320 19 /** @{*/
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 #ifndef ETH_INTERFACE_H
kenjiArai 0:5b88d5760320 22 #define ETH_INTERFACE_H
kenjiArai 0:5b88d5760320 23
kenjiArai 0:5b88d5760320 24 #include "netsocket/NetworkInterface.h"
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26
kenjiArai 0:5b88d5760320 27 /** Common interface between Ethernet hardware.
kenjiArai 0:5b88d5760320 28 */
kenjiArai 0:5b88d5760320 29 class EthInterface : public virtual NetworkInterface {
kenjiArai 0:5b88d5760320 30 public:
kenjiArai 0:5b88d5760320 31
kenjiArai 0:5b88d5760320 32 /** @copydoc NetworkInterface::ethInterface
kenjiArai 0:5b88d5760320 33 */
kenjiArai 0:5b88d5760320 34 virtual EthInterface *ethInterface()
kenjiArai 0:5b88d5760320 35 {
kenjiArai 0:5b88d5760320 36 return this;
kenjiArai 0:5b88d5760320 37 }
kenjiArai 0:5b88d5760320 38
kenjiArai 0:5b88d5760320 39 /** Get the default Ethernet interface.
kenjiArai 0:5b88d5760320 40 *
kenjiArai 0:5b88d5760320 41 * This is provided as a weak method so applications can override it.
kenjiArai 0:5b88d5760320 42 * Default behavior is to get the target's default interface, if
kenjiArai 0:5b88d5760320 43 * any.
kenjiArai 0:5b88d5760320 44 *
kenjiArai 0:5b88d5760320 45 * @return Pointer to interface, if one exists.
kenjiArai 0:5b88d5760320 46 */
kenjiArai 0:5b88d5760320 47 static EthInterface *get_default_instance();
kenjiArai 0:5b88d5760320 48
kenjiArai 0:5b88d5760320 49 #if !defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 50 protected:
kenjiArai 0:5b88d5760320 51
kenjiArai 0:5b88d5760320 52 /** Get the target's default Ethernet interface.
kenjiArai 0:5b88d5760320 53 *
kenjiArai 0:5b88d5760320 54 * This is provided as a weak method so targets can override it. The
kenjiArai 0:5b88d5760320 55 * default implementation invokes EthernetInterface with the
kenjiArai 0:5b88d5760320 56 * default EMAC and default network stack, if DEVICE_EMAC is set.
kenjiArai 0:5b88d5760320 57 *
kenjiArai 0:5b88d5760320 58 * @return Pointer to interface, if one exists.
kenjiArai 0:5b88d5760320 59 */
kenjiArai 0:5b88d5760320 60 static EthInterface *get_target_default_instance();
kenjiArai 0:5b88d5760320 61 #endif //!defined(DOXYGEN_ONLY)
kenjiArai 0:5b88d5760320 62 };
kenjiArai 0:5b88d5760320 63
kenjiArai 0:5b88d5760320 64
kenjiArai 0:5b88d5760320 65 #endif
kenjiArai 0:5b88d5760320 66
kenjiArai 0:5b88d5760320 67 /** @}*/