Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/netsocket/EMACInterface.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 /* LWIP implementation of NetworkInterfaceAPI
kevman 0:38ceb79fef03 2 * Copyright (c) 2015 ARM Limited
kevman 0:38ceb79fef03 3 *
kevman 0:38ceb79fef03 4 * Licensed under the Apache License, Version 2.0 (the "License");
kevman 0:38ceb79fef03 5 * you may not use this file except in compliance with the License.
kevman 0:38ceb79fef03 6 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 7 *
kevman 0:38ceb79fef03 8 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 9 *
kevman 0:38ceb79fef03 10 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 11 * distributed under the License is distributed on an "AS IS" BASIS,
kevman 0:38ceb79fef03 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 13 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 14 * limitations under the License.
kevman 0:38ceb79fef03 15 */
kevman 0:38ceb79fef03 16
kevman 0:38ceb79fef03 17 #ifndef EMAC_INTERFACE_H
kevman 0:38ceb79fef03 18 #define EMAC_INTERFACE_H
kevman 0:38ceb79fef03 19
kevman 0:38ceb79fef03 20 #include "nsapi.h"
kevman 0:38ceb79fef03 21 #include "EMAC.h"
kevman 0:38ceb79fef03 22 #include "OnboardNetworkStack.h"
kevman 0:38ceb79fef03 23
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 /** EMACInterface class
kevman 0:38ceb79fef03 26 * Implementation of the NetworkInterface for an EMAC-based driver
kevman 0:38ceb79fef03 27 *
kevman 0:38ceb79fef03 28 * This class provides the necessary glue logic to create a NetworkInterface
kevman 0:38ceb79fef03 29 * based on an EMAC and an OnboardNetworkStack. EthernetInterface and
kevman 0:38ceb79fef03 30 * EMAC-based Wi-Fi drivers derive from it.
kevman 0:38ceb79fef03 31 *
kevman 0:38ceb79fef03 32 * Drivers derived from EMACInterface should be constructed so that their
kevman 0:38ceb79fef03 33 * EMAC is functional without the need to call `connect()`. For example
kevman 0:38ceb79fef03 34 * a Wi-Fi driver should permit `WiFi::get_emac().power_up()` as soon as
kevman 0:38ceb79fef03 35 * the credentials have been set. This is necessary to support specialised
kevman 0:38ceb79fef03 36 * applications such as 6LoWPAN mesh border routers.
kevman 0:38ceb79fef03 37 */
kevman 0:38ceb79fef03 38 class EMACInterface : public virtual NetworkInterface {
kevman 0:38ceb79fef03 39 public:
kevman 0:38ceb79fef03 40 /** Create an EMAC-based network interface.
kevman 0:38ceb79fef03 41 *
kevman 0:38ceb79fef03 42 * The default arguments obtain the default EMAC, which will be target-
kevman 0:38ceb79fef03 43 * dependent (and the target may have some JSON option to choose which
kevman 0:38ceb79fef03 44 * is the default, if there are multiple). The default stack is configured
kevman 0:38ceb79fef03 45 * by JSON option nsapi.default-stack.
kevman 0:38ceb79fef03 46 *
kevman 0:38ceb79fef03 47 * Due to inability to return errors from the constructor, no real
kevman 0:38ceb79fef03 48 * work is done until the first call to connect().
kevman 0:38ceb79fef03 49 *
kevman 0:38ceb79fef03 50 * @param emac Reference to EMAC to use
kevman 0:38ceb79fef03 51 * @param stack Reference to onboard-network stack to use
kevman 0:38ceb79fef03 52 */
kevman 0:38ceb79fef03 53 EMACInterface(EMAC &emac = EMAC::get_default_instance(),
kevman 0:38ceb79fef03 54 OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
kevman 0:38ceb79fef03 55
kevman 0:38ceb79fef03 56 /** Set a static IP address
kevman 0:38ceb79fef03 57 *
kevman 0:38ceb79fef03 58 * Configures this network interface to use a static IP address.
kevman 0:38ceb79fef03 59 * Implicitly disables DHCP, which can be enabled in set_dhcp.
kevman 0:38ceb79fef03 60 * Requires that the network is disconnected.
kevman 0:38ceb79fef03 61 *
kevman 0:38ceb79fef03 62 * @param ip_address Null-terminated representation of the local IP address
kevman 0:38ceb79fef03 63 * @param netmask Null-terminated representation of the local network mask
kevman 0:38ceb79fef03 64 * @param gateway Null-terminated representation of the local gateway
kevman 0:38ceb79fef03 65 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 66 */
kevman 0:38ceb79fef03 67 virtual nsapi_error_t set_network(const char *ip_address, const char *netmask, const char *gateway);
kevman 0:38ceb79fef03 68
kevman 0:38ceb79fef03 69 /** Enable or disable DHCP on the network
kevman 0:38ceb79fef03 70 *
kevman 0:38ceb79fef03 71 * Requires that the network is disconnected
kevman 0:38ceb79fef03 72 *
kevman 0:38ceb79fef03 73 * @param dhcp False to disable dhcp (defaults to enabled)
kevman 0:38ceb79fef03 74 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 75 */
kevman 0:38ceb79fef03 76 virtual nsapi_error_t set_dhcp(bool dhcp);
kevman 0:38ceb79fef03 77
kevman 0:38ceb79fef03 78 /** Start the interface
kevman 0:38ceb79fef03 79 * @return 0 on success, negative on failure
kevman 0:38ceb79fef03 80 */
kevman 0:38ceb79fef03 81 virtual nsapi_error_t connect();
kevman 0:38ceb79fef03 82
kevman 0:38ceb79fef03 83 /** Stop the interface
kevman 0:38ceb79fef03 84 * @return 0 on success, negative on failure
kevman 0:38ceb79fef03 85 */
kevman 0:38ceb79fef03 86 virtual nsapi_error_t disconnect();
kevman 0:38ceb79fef03 87
kevman 0:38ceb79fef03 88 /** Get the local MAC address
kevman 0:38ceb79fef03 89 *
kevman 0:38ceb79fef03 90 * Provided MAC address is intended for info or debug purposes and
kevman 0:38ceb79fef03 91 * may not be provided if the underlying network interface does not
kevman 0:38ceb79fef03 92 * provide a MAC address
kevman 0:38ceb79fef03 93 *
kevman 0:38ceb79fef03 94 * @return Null-terminated representation of the local MAC address
kevman 0:38ceb79fef03 95 * or null if no MAC address is available
kevman 0:38ceb79fef03 96 */
kevman 0:38ceb79fef03 97 virtual const char *get_mac_address();
kevman 0:38ceb79fef03 98
kevman 0:38ceb79fef03 99 /** Get the local IP address
kevman 0:38ceb79fef03 100 *
kevman 0:38ceb79fef03 101 * @return Null-terminated representation of the local IP address
kevman 0:38ceb79fef03 102 * or null if no IP address has been recieved
kevman 0:38ceb79fef03 103 */
kevman 0:38ceb79fef03 104 virtual const char *get_ip_address();
kevman 0:38ceb79fef03 105
kevman 0:38ceb79fef03 106 /** Get the local network mask
kevman 0:38ceb79fef03 107 *
kevman 0:38ceb79fef03 108 * @return Null-terminated representation of the local network mask
kevman 0:38ceb79fef03 109 * or null if no network mask has been recieved
kevman 0:38ceb79fef03 110 */
kevman 0:38ceb79fef03 111 virtual const char *get_netmask();
kevman 0:38ceb79fef03 112
kevman 0:38ceb79fef03 113 /** Get the local gateways
kevman 0:38ceb79fef03 114 *
kevman 0:38ceb79fef03 115 * @return Null-terminated representation of the local gateway
kevman 0:38ceb79fef03 116 * or null if no network mask has been recieved
kevman 0:38ceb79fef03 117 */
kevman 0:38ceb79fef03 118 virtual const char *get_gateway();
kevman 0:38ceb79fef03 119
kevman 0:38ceb79fef03 120 /** Register callback for status reporting
kevman 0:38ceb79fef03 121 *
kevman 0:38ceb79fef03 122 * @param status_cb The callback for status changes
kevman 0:38ceb79fef03 123 */
kevman 0:38ceb79fef03 124 virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb);
kevman 0:38ceb79fef03 125
kevman 0:38ceb79fef03 126 /** Get the connection status
kevman 0:38ceb79fef03 127 *
kevman 0:38ceb79fef03 128 * @return The connection status according to nsapi_connection_status_t
kevman 0:38ceb79fef03 129 */
kevman 0:38ceb79fef03 130 virtual nsapi_connection_status_t get_connection_status() const;
kevman 0:38ceb79fef03 131
kevman 0:38ceb79fef03 132 /** Set blocking status of connect() which by default should be blocking
kevman 0:38ceb79fef03 133 *
kevman 0:38ceb79fef03 134 * @param blocking true if connect is blocking
kevman 0:38ceb79fef03 135 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 136 */
kevman 0:38ceb79fef03 137 virtual nsapi_error_t set_blocking(bool blocking);
kevman 0:38ceb79fef03 138
kevman 0:38ceb79fef03 139 /** Provide access to the EMAC
kevman 0:38ceb79fef03 140 *
kevman 0:38ceb79fef03 141 * This should be used with care - normally the network stack would
kevman 0:38ceb79fef03 142 * control the EMAC, so manipulating the EMAC while the stack
kevman 0:38ceb79fef03 143 * is also using it (ie after connect) will likely cause problems.
kevman 0:38ceb79fef03 144 *
kevman 0:38ceb79fef03 145 * @return Reference to the EMAC in use
kevman 0:38ceb79fef03 146 */
kevman 0:38ceb79fef03 147 EMAC &get_emac() const
kevman 0:38ceb79fef03 148 {
kevman 0:38ceb79fef03 149 return _emac;
kevman 0:38ceb79fef03 150 }
kevman 0:38ceb79fef03 151
kevman 0:38ceb79fef03 152 virtual EMACInterface *emacInterface()
kevman 0:38ceb79fef03 153 {
kevman 0:38ceb79fef03 154 return this;
kevman 0:38ceb79fef03 155 }
kevman 0:38ceb79fef03 156
kevman 0:38ceb79fef03 157 protected:
kevman 0:38ceb79fef03 158 /** Provide access to the underlying stack
kevman 0:38ceb79fef03 159 *
kevman 0:38ceb79fef03 160 * @return The underlying network stack
kevman 0:38ceb79fef03 161 */
kevman 0:38ceb79fef03 162 virtual NetworkStack *get_stack();
kevman 0:38ceb79fef03 163
kevman 0:38ceb79fef03 164 EMAC &_emac;
kevman 0:38ceb79fef03 165 OnboardNetworkStack &_stack;
kevman 0:38ceb79fef03 166 OnboardNetworkStack::Interface *_interface;
kevman 0:38ceb79fef03 167 bool _dhcp;
kevman 0:38ceb79fef03 168 bool _blocking;
kevman 0:38ceb79fef03 169 char _mac_address[NSAPI_MAC_SIZE];
kevman 0:38ceb79fef03 170 char _ip_address[NSAPI_IPv6_SIZE];
kevman 0:38ceb79fef03 171 char _netmask[NSAPI_IPv4_SIZE];
kevman 0:38ceb79fef03 172 char _gateway[NSAPI_IPv4_SIZE];
kevman 0:38ceb79fef03 173 mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
kevman 0:38ceb79fef03 174 };
kevman 0:38ceb79fef03 175
kevman 0:38ceb79fef03 176 #endif