Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/netsocket/EthInterface.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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