Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

features/net/FEATURE_IPV4/lwip-interface/EthernetInterface.h@1:d96dbedaebdb, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:54:50 2016 +0000
Revision:
1:d96dbedaebdb
Parent:
0:6c56fb4bc5f0 
Removed extra directories for other platforms

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nexpaq 0:6c56fb4bc5f0 1 /* LWIP implementation of NetworkInterfaceAPI
nexpaq 0:6c56fb4bc5f0 2 * Copyright (c) 2015 ARM Limited
nexpaq 0:6c56fb4bc5f0 3 *
nexpaq 0:6c56fb4bc5f0 4 * Licensed under the Apache License, Version 2.0 (the "License");
nexpaq 0:6c56fb4bc5f0 5 * you may not use this file except in compliance with the License.
nexpaq 0:6c56fb4bc5f0 6 * You may obtain a copy of the License at
nexpaq 0:6c56fb4bc5f0 7 *
nexpaq 0:6c56fb4bc5f0 8 * http://www.apache.org/licenses/LICENSE-2.0
nexpaq 0:6c56fb4bc5f0 9 *
nexpaq 0:6c56fb4bc5f0 10 * Unless required by applicable law or agreed to in writing, software
nexpaq 0:6c56fb4bc5f0 11 * distributed under the License is distributed on an "AS IS" BASIS,
nexpaq 0:6c56fb4bc5f0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
nexpaq 0:6c56fb4bc5f0 13 * See the License for the specific language governing permissions and
nexpaq 0:6c56fb4bc5f0 14 * limitations under the License.
nexpaq 0:6c56fb4bc5f0 15 */
nexpaq 0:6c56fb4bc5f0 16
nexpaq 0:6c56fb4bc5f0 17 #ifndef ETHERNET_INTERFACE_H
nexpaq 0:6c56fb4bc5f0 18 #define ETHERNET_INTERFACE_H
nexpaq 0:6c56fb4bc5f0 19
nexpaq 0:6c56fb4bc5f0 20 #include "nsapi.h"
nexpaq 0:6c56fb4bc5f0 21 #include "rtos.h"
nexpaq 0:6c56fb4bc5f0 22 #include "lwip/netif.h"
nexpaq 0:6c56fb4bc5f0 23
nexpaq 0:6c56fb4bc5f0 24 // Forward declaration
nexpaq 0:6c56fb4bc5f0 25 class NetworkStack;
nexpaq 0:6c56fb4bc5f0 26
nexpaq 0:6c56fb4bc5f0 27
nexpaq 0:6c56fb4bc5f0 28 /** EthernetInterface class
nexpaq 0:6c56fb4bc5f0 29 * Implementation of the NetworkStack for LWIP
nexpaq 0:6c56fb4bc5f0 30 */
nexpaq 0:6c56fb4bc5f0 31 class EthernetInterface : public EthInterface
nexpaq 0:6c56fb4bc5f0 32 {
nexpaq 0:6c56fb4bc5f0 33 public:
nexpaq 0:6c56fb4bc5f0 34 /** Start the interface
nexpaq 0:6c56fb4bc5f0 35 * @return 0 on success, negative on failure
nexpaq 0:6c56fb4bc5f0 36 */
nexpaq 0:6c56fb4bc5f0 37 virtual int connect();
nexpaq 0:6c56fb4bc5f0 38
nexpaq 0:6c56fb4bc5f0 39 /** Stop the interface
nexpaq 0:6c56fb4bc5f0 40 * @return 0 on success, negative on failure
nexpaq 0:6c56fb4bc5f0 41 */
nexpaq 0:6c56fb4bc5f0 42 virtual int disconnect();
nexpaq 0:6c56fb4bc5f0 43
nexpaq 0:6c56fb4bc5f0 44 /** Get the internally stored IP address
nexpaq 0:6c56fb4bc5f0 45 * @return IP address of the interface or null if not yet connected
nexpaq 0:6c56fb4bc5f0 46 */
nexpaq 0:6c56fb4bc5f0 47 virtual const char *get_ip_address();
nexpaq 0:6c56fb4bc5f0 48
nexpaq 0:6c56fb4bc5f0 49 /** Get the internally stored MAC address
nexpaq 0:6c56fb4bc5f0 50 * @return MAC address of the interface
nexpaq 0:6c56fb4bc5f0 51 */
nexpaq 0:6c56fb4bc5f0 52 virtual const char *get_mac_address();
nexpaq 0:6c56fb4bc5f0 53
nexpaq 0:6c56fb4bc5f0 54 protected:
nexpaq 0:6c56fb4bc5f0 55 /** Provide access to the underlying stack
nexpaq 0:6c56fb4bc5f0 56 *
nexpaq 0:6c56fb4bc5f0 57 * @return The underlying network stack
nexpaq 0:6c56fb4bc5f0 58 */
nexpaq 0:6c56fb4bc5f0 59 virtual NetworkStack *get_stack();
nexpaq 0:6c56fb4bc5f0 60 };
nexpaq 0:6c56fb4bc5f0 61
nexpaq 0:6c56fb4bc5f0 62
nexpaq 0:6c56fb4bc5f0 63 #endif