Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/EMACInterface.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

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