takashi kadono / Mbed OS Nucleo446_SSD1331

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.

Dependencies:   ssd1331

mbed-os/features/netsocket/EMAC.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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