Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/EMAC.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

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