Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/netsocket/EMAC.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 /* mbed Microcontroller Library
kevman 0:38ceb79fef03 2 * Copyright (c) 2016 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_H
kevman 0:38ceb79fef03 18 #define EMAC_H
kevman 0:38ceb79fef03 19
kevman 0:38ceb79fef03 20 #include <stdbool.h>
kevman 0:38ceb79fef03 21 #include "Callback.h"
kevman 0:38ceb79fef03 22 #include "EMACMemoryManager.h"
kevman 0:38ceb79fef03 23
kevman 0:38ceb79fef03 24 // Nuvoton platform headers define EMAC - avoid the collision
kevman 0:38ceb79fef03 25 #undef EMAC
kevman 0:38ceb79fef03 26
kevman 0:38ceb79fef03 27 /**
kevman 0:38ceb79fef03 28 * This interface should be used to abstract low level access to networking hardware
kevman 0:38ceb79fef03 29 * All operations receive a `void *` hw pointer which an emac device provides when
kevman 0:38ceb79fef03 30 * it is registered with a stack.
kevman 0:38ceb79fef03 31 */
kevman 0:38ceb79fef03 32 class EMAC {
kevman 0:38ceb79fef03 33 public:
kevman 0:38ceb79fef03 34
kevman 0:38ceb79fef03 35 /** Return the default on-board EMAC
kevman 0:38ceb79fef03 36 *
kevman 0:38ceb79fef03 37 * Returns the default on-board EMAC - this will be target-specific, and
kevman 0:38ceb79fef03 38 * may not be available on all targets.
kevman 0:38ceb79fef03 39 */
kevman 0:38ceb79fef03 40 static EMAC &get_default_instance();
kevman 0:38ceb79fef03 41
kevman 0:38ceb79fef03 42 /**
kevman 0:38ceb79fef03 43 * Callback to be register with Emac interface and to be called for received packets
kevman 0:38ceb79fef03 44 *
kevman 0:38ceb79fef03 45 * @param buf Received data
kevman 0:38ceb79fef03 46 */
kevman 0:38ceb79fef03 47 //typedef void (*emac_link_input_fn)(void *data, emac_mem_buf_t *buf);
kevman 0:38ceb79fef03 48 typedef mbed::Callback<void (emac_mem_buf_t *buf)> emac_link_input_cb_t;
kevman 0:38ceb79fef03 49
kevman 0:38ceb79fef03 50 /**
kevman 0:38ceb79fef03 51 * Callback to be register with Emac interface and to be called for link status changes
kevman 0:38ceb79fef03 52 *
kevman 0:38ceb79fef03 53 * @param up Link status
kevman 0:38ceb79fef03 54 */
kevman 0:38ceb79fef03 55 //typedef void (*emac_link_state_change_fn)(void *data, bool up);
kevman 0:38ceb79fef03 56 typedef mbed::Callback<void (bool up)> emac_link_state_change_cb_t;
kevman 0:38ceb79fef03 57
kevman 0:38ceb79fef03 58 /**
kevman 0:38ceb79fef03 59 * Return maximum transmission unit
kevman 0:38ceb79fef03 60 *
kevman 0:38ceb79fef03 61 * @return MTU in bytes
kevman 0:38ceb79fef03 62 */
kevman 0:38ceb79fef03 63 virtual uint32_t get_mtu_size() const = 0;
kevman 0:38ceb79fef03 64
kevman 0:38ceb79fef03 65 /**
kevman 0:38ceb79fef03 66 * Gets memory buffer alignment preference
kevman 0:38ceb79fef03 67 *
kevman 0:38ceb79fef03 68 * Gets preferred memory buffer alignment of the Emac device. IP stack may or may not
kevman 0:38ceb79fef03 69 * align link out memory buffer chains using the alignment.
kevman 0:38ceb79fef03 70 *
kevman 0:38ceb79fef03 71 * @return Memory alignment requirement in bytes
kevman 0:38ceb79fef03 72 */
kevman 0:38ceb79fef03 73 virtual uint32_t get_align_preference() const = 0;
kevman 0:38ceb79fef03 74
kevman 0:38ceb79fef03 75 /**
kevman 0:38ceb79fef03 76 * Return interface name
kevman 0:38ceb79fef03 77 *
kevman 0:38ceb79fef03 78 * @param name Pointer to where the name should be written
kevman 0:38ceb79fef03 79 * @param size Maximum number of character to copy
kevman 0:38ceb79fef03 80 */
kevman 0:38ceb79fef03 81 virtual void get_ifname(char *name, uint8_t size) const = 0;
kevman 0:38ceb79fef03 82
kevman 0:38ceb79fef03 83 /**
kevman 0:38ceb79fef03 84 * Returns size of the underlying interface HW address size.
kevman 0:38ceb79fef03 85 *
kevman 0:38ceb79fef03 86 * @return HW address size in bytes
kevman 0:38ceb79fef03 87 */
kevman 0:38ceb79fef03 88 virtual uint8_t get_hwaddr_size() const = 0;
kevman 0:38ceb79fef03 89
kevman 0:38ceb79fef03 90 /**
kevman 0:38ceb79fef03 91 * Return interface-supplied HW address
kevman 0:38ceb79fef03 92 *
kevman 0:38ceb79fef03 93 * Copies HW address to provided memory, @param addr has to be of correct size see @a get_hwaddr_size
kevman 0:38ceb79fef03 94 *
kevman 0:38ceb79fef03 95 * HW address need not be provided if this interface does not have its own HW
kevman 0:38ceb79fef03 96 * address configuration; stack will choose address from central system
kevman 0:38ceb79fef03 97 * configuration if the function returns false and does not write to addr.
kevman 0:38ceb79fef03 98 *
kevman 0:38ceb79fef03 99 * @param addr HW address for underlying interface
kevman 0:38ceb79fef03 100 * @return true if HW address is available
kevman 0:38ceb79fef03 101 */
kevman 0:38ceb79fef03 102 virtual bool get_hwaddr(uint8_t *addr) const = 0;
kevman 0:38ceb79fef03 103
kevman 0:38ceb79fef03 104 /**
kevman 0:38ceb79fef03 105 * Set HW address for interface
kevman 0:38ceb79fef03 106 *
kevman 0:38ceb79fef03 107 * Provided address has to be of correct size, see @a get_hwaddr_size
kevman 0:38ceb79fef03 108 *
kevman 0:38ceb79fef03 109 * Called to set the MAC address to actually use - if @a get_hwaddr is provided
kevman 0:38ceb79fef03 110 * the stack would normally use that, but it could be overridden, eg for test
kevman 0:38ceb79fef03 111 * purposes.
kevman 0:38ceb79fef03 112 *
kevman 0:38ceb79fef03 113 * @param addr Address to be set
kevman 0:38ceb79fef03 114 */
kevman 0:38ceb79fef03 115 virtual void set_hwaddr(const uint8_t *addr) = 0;
kevman 0:38ceb79fef03 116
kevman 0:38ceb79fef03 117 /**
kevman 0:38ceb79fef03 118 * Sends the packet over the link
kevman 0:38ceb79fef03 119 *
kevman 0:38ceb79fef03 120 * That can not be called from an interrupt context.
kevman 0:38ceb79fef03 121 *
kevman 0:38ceb79fef03 122 * @param buf Packet to be send
kevman 0:38ceb79fef03 123 * @return True if the packet was send successfully, False otherwise
kevman 0:38ceb79fef03 124 */
kevman 0:38ceb79fef03 125 virtual bool link_out(emac_mem_buf_t *buf) = 0;
kevman 0:38ceb79fef03 126
kevman 0:38ceb79fef03 127 /**
kevman 0:38ceb79fef03 128 * Initializes the HW
kevman 0:38ceb79fef03 129 *
kevman 0:38ceb79fef03 130 * @return True on success, False in case of an error.
kevman 0:38ceb79fef03 131 */
kevman 0:38ceb79fef03 132 virtual bool power_up() = 0;
kevman 0:38ceb79fef03 133
kevman 0:38ceb79fef03 134 /**
kevman 0:38ceb79fef03 135 * Deinitializes the HW
kevman 0:38ceb79fef03 136 *
kevman 0:38ceb79fef03 137 */
kevman 0:38ceb79fef03 138 virtual void power_down() = 0;
kevman 0:38ceb79fef03 139
kevman 0:38ceb79fef03 140 /**
kevman 0:38ceb79fef03 141 * Sets a callback that needs to be called for packets received for that interface
kevman 0:38ceb79fef03 142 *
kevman 0:38ceb79fef03 143 * @param input_cb Function to be register as a callback
kevman 0:38ceb79fef03 144 */
kevman 0:38ceb79fef03 145 virtual void set_link_input_cb(emac_link_input_cb_t input_cb) = 0;
kevman 0:38ceb79fef03 146
kevman 0:38ceb79fef03 147 /**
kevman 0:38ceb79fef03 148 * Sets a callback that needs to be called on link status changes for given interface
kevman 0:38ceb79fef03 149 *
kevman 0:38ceb79fef03 150 * @param state_cb Function to be register as a callback
kevman 0:38ceb79fef03 151 */
kevman 0:38ceb79fef03 152 virtual void set_link_state_cb(emac_link_state_change_cb_t state_cb) = 0;
kevman 0:38ceb79fef03 153
kevman 0:38ceb79fef03 154 /** Add device to a multicast group
kevman 0:38ceb79fef03 155 *
kevman 0:38ceb79fef03 156 * @param address A multicast group hardware address
kevman 0:38ceb79fef03 157 */
kevman 0:38ceb79fef03 158 virtual void add_multicast_group(const uint8_t *address) = 0;
kevman 0:38ceb79fef03 159
kevman 0:38ceb79fef03 160 /** Remove device from a multicast group
kevman 0:38ceb79fef03 161 *
kevman 0:38ceb79fef03 162 * @param address A multicast group hardware address
kevman 0:38ceb79fef03 163 */
kevman 0:38ceb79fef03 164 virtual void remove_multicast_group(const uint8_t *address) = 0;
kevman 0:38ceb79fef03 165
kevman 0:38ceb79fef03 166 /** Request reception of all multicast packets
kevman 0:38ceb79fef03 167 *
kevman 0:38ceb79fef03 168 * @param all True to receive all multicasts
kevman 0:38ceb79fef03 169 * False to receive only multicasts addressed to specified groups
kevman 0:38ceb79fef03 170 */
kevman 0:38ceb79fef03 171 virtual void set_all_multicast(bool all) = 0;
kevman 0:38ceb79fef03 172
kevman 0:38ceb79fef03 173 /** Sets memory manager that is used to handle memory buffers
kevman 0:38ceb79fef03 174 *
kevman 0:38ceb79fef03 175 * @param mem_mngr Pointer to memory manager
kevman 0:38ceb79fef03 176 */
kevman 0:38ceb79fef03 177 virtual void set_memory_manager(EMACMemoryManager &mem_mngr) = 0;
kevman 0:38ceb79fef03 178 };
kevman 0:38ceb79fef03 179
kevman 0:38ceb79fef03 180
kevman 0:38ceb79fef03 181 /** These need to be defined by targets wishing to provide an Ethernet driver using EMAC interface. It will
kevman 0:38ceb79fef03 182 * be used by the EMACInterface class's default constructor to initialise the networking subsystem.
kevman 0:38ceb79fef03 183 */
kevman 0:38ceb79fef03 184 //extern const emac_interface_ops_t mbed_emac_eth_ops_default;
kevman 0:38ceb79fef03 185 //extern void *mbed_emac_eth_hw_default;
kevman 0:38ceb79fef03 186
kevman 0:38ceb79fef03 187 #endif /* EMAC_H */