PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/features/FEATURE_LWIP/lwip-interface/EthernetInterface.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /* LWIP implementation of NetworkInterfaceAPI
demayer 0:6bf0743ece18 2 * Copyright (c) 2015 ARM Limited
demayer 0:6bf0743ece18 3 *
demayer 0:6bf0743ece18 4 * Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 5 * you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 6 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 7 *
demayer 0:6bf0743ece18 8 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 9 *
demayer 0:6bf0743ece18 10 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 11 * distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 13 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 14 * limitations under the License.
demayer 0:6bf0743ece18 15 */
demayer 0:6bf0743ece18 16
demayer 0:6bf0743ece18 17 #ifndef ETHERNET_INTERFACE_H
demayer 0:6bf0743ece18 18 #define ETHERNET_INTERFACE_H
demayer 0:6bf0743ece18 19
demayer 0:6bf0743ece18 20 #include "nsapi.h"
demayer 0:6bf0743ece18 21 #include "rtos.h"
demayer 0:6bf0743ece18 22 #include "lwip/netif.h"
demayer 0:6bf0743ece18 23
demayer 0:6bf0743ece18 24 // Forward declaration
demayer 0:6bf0743ece18 25 class NetworkStack;
demayer 0:6bf0743ece18 26
demayer 0:6bf0743ece18 27
demayer 0:6bf0743ece18 28 /** EthernetInterface class
demayer 0:6bf0743ece18 29 * Implementation of the NetworkStack for LWIP
demayer 0:6bf0743ece18 30 */
demayer 0:6bf0743ece18 31 class EthernetInterface : public EthInterface
demayer 0:6bf0743ece18 32 {
demayer 0:6bf0743ece18 33 public:
demayer 0:6bf0743ece18 34 /** EthernetInterface lifetime
demayer 0:6bf0743ece18 35 */
demayer 0:6bf0743ece18 36 EthernetInterface();
demayer 0:6bf0743ece18 37
demayer 0:6bf0743ece18 38 /** Set a static IP address
demayer 0:6bf0743ece18 39 *
demayer 0:6bf0743ece18 40 * Configures this network interface to use a static IP address.
demayer 0:6bf0743ece18 41 * Implicitly disables DHCP, which can be enabled in set_dhcp.
demayer 0:6bf0743ece18 42 * Requires that the network is disconnected.
demayer 0:6bf0743ece18 43 *
demayer 0:6bf0743ece18 44 * @param address Null-terminated representation of the local IP address
demayer 0:6bf0743ece18 45 * @param netmask Null-terminated representation of the local network mask
demayer 0:6bf0743ece18 46 * @param gateway Null-terminated representation of the local gateway
demayer 0:6bf0743ece18 47 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 48 */
demayer 0:6bf0743ece18 49 virtual nsapi_error_t set_network(
demayer 0:6bf0743ece18 50 const char *ip_address, const char *netmask, const char *gateway);
demayer 0:6bf0743ece18 51
demayer 0:6bf0743ece18 52 /** Enable or disable DHCP on the network
demayer 0:6bf0743ece18 53 *
demayer 0:6bf0743ece18 54 * Requires that the network is disconnected
demayer 0:6bf0743ece18 55 *
demayer 0:6bf0743ece18 56 * @param dhcp False to disable dhcp (defaults to enabled)
demayer 0:6bf0743ece18 57 * @return 0 on success, negative error code on failure
demayer 0:6bf0743ece18 58 */
demayer 0:6bf0743ece18 59 virtual nsapi_error_t set_dhcp(bool dhcp);
demayer 0:6bf0743ece18 60
demayer 0:6bf0743ece18 61 /** Start the interface
demayer 0:6bf0743ece18 62 * @return 0 on success, negative on failure
demayer 0:6bf0743ece18 63 */
demayer 0:6bf0743ece18 64 virtual nsapi_error_t connect();
demayer 0:6bf0743ece18 65
demayer 0:6bf0743ece18 66 /** Stop the interface
demayer 0:6bf0743ece18 67 * @return 0 on success, negative on failure
demayer 0:6bf0743ece18 68 */
demayer 0:6bf0743ece18 69 virtual nsapi_error_t disconnect();
demayer 0:6bf0743ece18 70
demayer 0:6bf0743ece18 71 /** Get the local MAC address
demayer 0:6bf0743ece18 72 *
demayer 0:6bf0743ece18 73 * Provided MAC address is intended for info or debug purposes and
demayer 0:6bf0743ece18 74 * may not be provided if the underlying network interface does not
demayer 0:6bf0743ece18 75 * provide a MAC address
demayer 0:6bf0743ece18 76 *
demayer 0:6bf0743ece18 77 * @return Null-terminated representation of the local MAC address
demayer 0:6bf0743ece18 78 * or null if no MAC address is available
demayer 0:6bf0743ece18 79 */
demayer 0:6bf0743ece18 80 virtual const char *get_mac_address();
demayer 0:6bf0743ece18 81
demayer 0:6bf0743ece18 82 /** Get the local IP address
demayer 0:6bf0743ece18 83 *
demayer 0:6bf0743ece18 84 * @return Null-terminated representation of the local IP address
demayer 0:6bf0743ece18 85 * or null if no IP address has been recieved
demayer 0:6bf0743ece18 86 */
demayer 0:6bf0743ece18 87 virtual const char *get_ip_address();
demayer 0:6bf0743ece18 88
demayer 0:6bf0743ece18 89 /** Get the local network mask
demayer 0:6bf0743ece18 90 *
demayer 0:6bf0743ece18 91 * @return Null-terminated representation of the local network mask
demayer 0:6bf0743ece18 92 * or null if no network mask has been recieved
demayer 0:6bf0743ece18 93 */
demayer 0:6bf0743ece18 94 virtual const char *get_netmask();
demayer 0:6bf0743ece18 95
demayer 0:6bf0743ece18 96 /** Get the local gateways
demayer 0:6bf0743ece18 97 *
demayer 0:6bf0743ece18 98 * @return Null-terminated representation of the local gateway
demayer 0:6bf0743ece18 99 * or null if no network mask has been recieved
demayer 0:6bf0743ece18 100 */
demayer 0:6bf0743ece18 101 virtual const char *get_gateway();
demayer 0:6bf0743ece18 102
demayer 0:6bf0743ece18 103 protected:
demayer 0:6bf0743ece18 104 /** Provide access to the underlying stack
demayer 0:6bf0743ece18 105 *
demayer 0:6bf0743ece18 106 * @return The underlying network stack
demayer 0:6bf0743ece18 107 */
demayer 0:6bf0743ece18 108 virtual NetworkStack *get_stack();
demayer 0:6bf0743ece18 109
demayer 0:6bf0743ece18 110 bool _dhcp;
demayer 0:6bf0743ece18 111 char _ip_address[IPADDR_STRLEN_MAX];
demayer 0:6bf0743ece18 112 char _netmask[NSAPI_IPv4_SIZE];
demayer 0:6bf0743ece18 113 char _gateway[NSAPI_IPv4_SIZE];
demayer 0:6bf0743ece18 114 };
demayer 0:6bf0743ece18 115
demayer 0:6bf0743ece18 116
demayer 0:6bf0743ece18 117 #endif