EthernetInterface.h

00001 /* LWIP implementation of NetworkInterfaceAPI
00002  * Copyright (c) 2015 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef ETHERNET_INTERFACE_H
00018 #define ETHERNET_INTERFACE_H
00019 
00020 #include "nsapi.h"
00021 #include "rtos.h"
00022 #include "EMACInterface.h"
00023 
00024 
00025 /** EthernetInterface class
00026  *  Implementation of the NetworkStack for an EMAC-based Ethernet driver
00027  */
00028 class EthernetInterface : public EMACInterface, public EthInterface
00029 {
00030 public:
00031     /** Create an EMAC-based ethernet interface.
00032      *
00033      * The default arguments obtain the default EMAC, which will be target-
00034      * dependent (and the target may have some JSON option to choose which
00035      * is the default, if there are multiple). The default stack is configured
00036      * by JSON option nsapi.default-stack.
00037      *
00038      * Due to inability to return errors from the constructor, no real
00039      * work is done until the first call to connect().
00040      *
00041      * @param emac  Reference to EMAC to use
00042      * @param stack Reference to onboard-network stack to use
00043      */
00044     EthernetInterface(
00045             EMAC &emac = EMAC::get_default_instance(),
00046             OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance()) : EMACInterface(emac, stack) { }
00047 };
00048 
00049 #endif